Skip to content

Create Location_API.md#11

Merged
jlurien merged 2 commits intomainfrom
feat/add-location-api-doc
Jan 10, 2023
Merged

Create Location_API.md#11
jlurien merged 2 commits intomainfrom
feat/add-location-api-doc

Conversation

@jlurien
Copy link
Collaborator

@jlurien jlurien commented Jan 10, 2023

The agreed version of this API missed the API doc md that we have for other APIs. I followed the usual template.

Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look almost good.
Only one point: the swagger features a 404 that you did not documented.

BTW I'm not sure about 404 usage - for a request to a subscription which is not managed by the network provider?

@jlurien
Copy link
Collaborator Author

jlurien commented Jan 10, 2023

Look almost good. Only one point: the swagger features a 404 that you did not documented.

BTW I'm not sure about 404 usage - for a request to a subscription which is not managed by the network provider?

Yes, I missed it according to the yaml. Really I think 404 makes no sense for this endpoint as there are no path parameters which could point to a not found resource. All error stuff is just copied and pasted from other APIs, so was not well thought. Anyway, for this V0.1 I will align doc with yaml and let's work on better errors in future versions.

Added 404 error
@jlurien jlurien requested a review from bigludo7 January 10, 2023 15:28
Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks !

@jlurien jlurien merged commit 000a154 into main Jan 10, 2023
@jlurien jlurien deleted the feat/add-location-api-doc branch January 27, 2023 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants