Skip to content

Update OpenAPI documentation in GitBook #494

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

Open
ngachung opened this issue Dec 20, 2024 · 1 comment
Open

Update OpenAPI documentation in GitBook #494

ngachung opened this issue Dec 20, 2024 · 1 comment
Assignees
Labels

Comments

@ngachung
Copy link
Collaborator

ngachung commented Dec 20, 2024

We include all DS endpoints into a single GitBook page, which is confusing to end users. For example, setting up elasticsearch, auth would only be used by DS admin team and not end users. We should separate the documentation, one for users and one for admin/dev for clarity. Also, group actions by object type e.g. collections, granules, etc.

@ngachung ngachung self-assigned this Dec 20, 2024
@ngachung ngachung added the U-DS label Jan 22, 2025
@ngachung ngachung moved this to Todo in Unity Project Board Jan 22, 2025
@ngachung ngachung moved this from Todo to In Progress in Unity Project Board Jan 31, 2025
@ngachung
Copy link
Collaborator Author

ngachung commented Jan 31, 2025

Made initial pass through the docs.

Created two separate API docs page

Added headers to describe each section, e.g. "API to manage collections", "API to manage items"

Need to update API description in code and reimport updated OpenAPI spec

  • Remove references to Cumulus
  • Describe /am-uds-dapa/collections/{collection_id}/variables/ because it says "Get Granules Dapa"
  • ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: In Progress
Development

No branches or pull requests

1 participant