Skip to content

Referencing the full REST API in the docs site #12

@metazool

Description

@metazool

The docs site for RESTful web services shows a limited set of endpoints:
https://indicia-docs.readthedocs.io/en/latest/developing/rest-web-services/index.html

The docs generated by the API show many more really useful ones:
https://warehouse1.indicia.org.uk/index.php/services/rest

I'm sure I could have read more closely when developing, but it was a long time before it occurred to me to scroll down to the Resources section in the generated docs and see the wider range of endpoints.

I'd suggest either:

  • Updating the docs site to show the full interface of the REST API
  • OR removing that section of the docs and just offering a link to the Indicia Warehouse rendering of the API endpoints

And also adding a prominent link direct to the Resources section at the top of the API documentation root

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions