Swagger Documentation
This pull request is a first attempt at implementing swagger documentation for the cayenne api, it is not yet fully complete but the basic structure is present for a number of the key endpoints.
Funders
/funders
/funders/{id}
/funders/{id}/works
Journals
/journals
/journals/{issn}
/journals/{issn}/works
Works
/works
/works/{doi}
/works/{doi}/agency
/works/{doi}/quality
Prefixes
/prefixes/{prefix}
/prefixes/{prefix}/works
Members
/members/
/members/{id}
/members/{id}/works
Types
/types
/types/{id}
/types/{id}/works
swagger.json
is available at /swagger-docs
and the swagger ui is available at /swagger-ui
.
The following things still need to be finished:
-
Facets -
Field queries -
Markup, perhaps directly pulling in or referencing existing rest-api-docs
There are also a number of other endpoint categories that have lower priority and are yet to be documented:
- cores
- licenses
- styles
- locales
- reverse