peterportal-public-api
peterportal-public-api copied to clipboard
Implement semantic versioning once we hit v1
As discussed in #145, once we complete all other tasks that are part of the v1 milestone (and have made sure to the best of our ability that future changes will not easily break the API's backward compatibility), we will be moving to semantic versioning.
The following needs to be accomplished for this:
- [ ] Rename
/rest/v0/
to/rest/v1/
and move/rest/v1/router.ts
to/rest/v1router.ts
- [ ] Create a new router called
/rest/v0router.ts
and include it in the/rest/versionController.ts
. At first this will be a carbon copy of/rest/v1router.ts
, but as we implement experimental features we will want to modify this router to serve only the experimental features (which will live in/rest/v0/
), while also serving the unmodified v1 routes. - [ ] :rocket: