Skip to content

Comments

Add machine-readable API description#1015

Merged
jtojnar merged 1 commit intomasterfrom
api-docs
Mar 5, 2018
Merged

Add machine-readable API description#1015
jtojnar merged 1 commit intomasterfrom
api-docs

Conversation

@jtojnar
Copy link
Member

@jtojnar jtojnar commented Jan 11, 2018

This patch adds the description of the RESTful API in OpenAPI 3.0 format. Previously, the API was manually documented on the wiki without any guarantee that the description matches reality. Formal description will allow us to check for compliance automatically, as well as use other cool tools like Swagger UI.

For now, you can view the API on https://app.swaggerhub.com/apis/jtojnar/selfoss/2.18-SNAPSHOT

Closes: #993

cc @niol

@jtojnar jtojnar added this to the 2.18 milestone Jan 11, 2018
@jtojnar jtojnar mentioned this pull request Jan 11, 2018
@niol
Copy link
Collaborator

niol commented Jan 12, 2018

From a quick check:

  • GET /logout seems to be missing
  • GET /update seems to be missing
  • GET and POST /opml seem to be missing, GET /opmlexport also
  • GET /items/sync is missing
  • the documented calls are looking consistent with the current implementation

@jtojnar
Copy link
Member Author

jtojnar commented Jan 12, 2018

I only documented the “stable” API calls listed on the wiki. I think /items/sync is internal and only used by web client at the moment, /logout and /update should be documented though.

This patch adds the description of the RESTful API in OpenAPI 3.0 format.
Previously, the API was manually documented on the wiki without any guarantee
that the description matches reality. Formal description will allow us to
check for compliance automatically, as well as use other cool tools like Swagger UI.

Closes: #993
@jtojnar jtojnar merged commit ca1fe83 into master Mar 5, 2018
@jtojnar jtojnar deleted the api-docs branch March 5, 2018 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants