UStAEnts / uems-hub

A hub project containing all microservices and frontend files for Union Event Management System (uems)
2 stars 0 forks source link

Adding links to api spec #56

Open Vitineth opened 3 years ago

Vitineth commented 3 years ago

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 commented 3 years ago

This is in reference to #49