search

UStAEnts / uems-hub

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

(vitineth/patch/api) adding venues api and resource links #49

Closed Vitineth closed 3 years ago

Vitineth commented 4 years ago

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). The venues endpoint is proposed but hopefully is okay as it follows the rest of the style. The changelog is formalised into a type because I wrote a small script that outputs Typescript types for this for the frontend and needed it to be marked as a schema.

Vitineth commented 3 years ago

This request is now defunct as the API has been rewritten and will be imported later on. I will return to the idea of including links but that will be opened as an issue referencing this PR.