Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the api_gui.md documentation to reflect the current state of the NMDC Runtime Swagger UI (version 2.13.0). The update includes reorganizing endpoint descriptions, correcting the login flow process, and removing outdated images.
Changes:
- Updated API version from 1.2.0 to 2.13.0
- Reorganized endpoint documentation to match the new five-group structure in the API GUI
- Corrected the login flow to reflect that "Login with ORCID" is now within the Authorization modal (fixes #308)
- Removed unused PNG image files from the repository
Reviewed changes
Copilot reviewed 1 out of 11 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| content/home/src/howto_guides/api_gui.md | Updated documentation to reflect API v2.13.0, reorganized endpoint descriptions from "Find/Metadata" terminology to "Compact syntax/MongoDB-like" terminology, and corrected login instructions |
| content/home/src/_static/images/howto_guides/api_gui/*.png (9 files) | Removed unreferenced image files that are no longer used in the documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
eecavanna
deleted the
308-documentation-about-runtime-api-login-is-out-of-date-contenthomesrchowto_guidesapi_guimd
branch
github-project-automation
bot
moved this from Backlog
to Done
in Documentation Squad Board
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
On this branch, I updated the
api_gui.mdpage to be accurate with respect to the current Runtime Swagger UI page.Details
I also deleted unreferenced PNG files from the repo.
Related issue(s)
Fixes #308
Impacted section(s)