Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for API users #187

Open
bfreeds opened this issue Mar 5, 2020 · 0 comments
Open

Add documentation for API users #187

bfreeds opened this issue Mar 5, 2020 · 0 comments

Comments

@bfreeds
Copy link

bfreeds commented Mar 5, 2020

Is your feature request related to a problem? Please describe.
Documentation of how to use Layers API. Current documentation is more geared at developers of layers-api, not users of the api.

Describe the solution you'd like

  • "Getting Started" and "Usage" sections that has
    • example request and responses (which show the Schemas, rather than pointing to the code)
      • image
    • documents all available layer groups currently in the api
  • GSA Example of API Documentation

Describe alternatives you've considered

Additional context
Our team is using the free tier of Postman currently, so using it for this purpose would bump us up to a paid plan.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant