Skip to content
This repository has been archived by the owner on Oct 6, 2019. It is now read-only.

Full API documentation #104

Open
Caiyeon opened this issue Jul 2, 2017 · 0 comments
Open

Full API documentation #104

Caiyeon opened this issue Jul 2, 2017 · 0 comments
Labels
Milestone

Comments

@Caiyeon
Copy link
Owner

Caiyeon commented Jul 2, 2017

Since #98 made it possible to use vault token as a header, it is possible to use goldfish's functionality as rest calls, bypassing the UI.

But for this to be fully viable, goldfish's backend API specifications need a proper run-down and needs to be properly documented.

  • All API should be versioned. /v1/ would be sufficient.
  • Once versioned, API should NOT change easily (semantic versioning needs to be taken seriously)
  • Proper documentation of each endpoint, their parameters, and expected results should be made. Perhaps using https://github.com/lord/slate
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

1 participant