New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding links to api spec #56

Open

Vitineth opened this issue Jan 22, 2021 · 1 comment

Labels

Contributor

Vitineth commented Jan 22, 2021

Is your feature request related to a problem? Please describe.
Links are a proposed feature right now and won't need to be included until much later. They are there to allow the API to be navigated without external documentation using HATEOAS (https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#use-hateoas-to-enable-navigation-to-related-resources)

Describe the solution you'd like
Add links to the API spec and make sure that the gateway is compliant

Describe alternatives you've considered
Just not implement them, they're not essential with good documentation.

Vitineth added the enhancement label

Contributor Author

Vitineth commented Jan 22, 2021

This is in reference to #49

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment