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

Improved documentation about admin api #1846

Merged
merged 3 commits into from
Nov 17, 2024

Conversation

doublebyte1
Copy link
Contributor

@doublebyte1 doublebyte1 commented Nov 14, 2024

Overview

The admin API docs are quite brief, although the admin routes are fully documented through Open API.

This PR adds a note telling the user, how to retrieve more information about the available routes.

Additional information

Dependency policy (RFC2)

  • I have ensured that this PR meets RFC2 requirements

Updates to public demo

Contributions and licensing

(as per https://github.com/geopython/pygeoapi/blob/master/CONTRIBUTING.md#contributions-and-licensing)

  • I'd like to contribute [feature X|bugfix Y|docs|something else] to pygeoapi. I confirm that my contributions to pygeoapi will be compatible with the pygeoapi license guidelines at the time of contribution
  • I have already previously agreed to the pygeoapi Contributions and Licensing Guidelines

docs/source/admin-api.rst Outdated Show resolved Hide resolved
@tomkralidis tomkralidis added the documentation Documentation label Nov 14, 2024
@tomkralidis tomkralidis added this to the 0.19.0 milestone Nov 14, 2024
@tomkralidis tomkralidis merged commit 2e4ff71 into geopython:master Nov 17, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants