micro / services

Real World Micro Services
Apache License 2.0
1.25k stars 136 forks source link

Update API examples #420

Closed cyb3rko closed 1 year ago

cyb3rko commented 1 year ago

I updated the list examples once again, because some entries were still wrong.

Another thing I found is the proxy function for URLs: The description for the parameter shortURL is

short url ID, without the domain, eg. if your short URL is `m3o.one/u/someshorturlid` then pass in `someshorturlid`

But the example request is

-d '{
  "shortURL": "https://m3o.one/u/ck6SGVkYp"
}'

I mean it works but you don't use only the ID as described in the parameter description, should we change it?

cyb3rko commented 1 year ago

Added new ID types to examples

cyb3rko commented 1 year ago

@asim NanoID is implemented through one of the last pull requests, but it is not added as a type. Therefore you can not use it. Am I right?

https://github.com/micro/services/blob/813a9ed4edb07fab062a5cd932ddbbc925510515/id/handler/id.go#L51-L58

asim commented 1 year ago

@asim NanoID is implemented through one of the last pull requests, but it is not added as a type. Therefore you can not use it. Am I right?

https://github.com/micro/services/blob/813a9ed4edb07fab062a5cd932ddbbc925510515/id/handler/id.go#L51-L58

Yea that's right

cyb3rko commented 1 year ago

I will fix this in a seperate PR to keep everything organized

cyb3rko commented 1 year ago

What about the URL thing I mentioned in the PR description above? Should we change something there?

asim commented 1 year ago

What about the URL thing I mentioned in the PR description above? Should we change something there?

Leave the URL for now. I'll look later.

cyb3rko commented 1 year ago

Alright, then you can approve the changes and merge it.