Update Swagger tag descriptions to match Berkeley API GUI how-to guide #682
Conversation
This file contains 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
Here's a link to the aforementioned how-to guide: https://github.com/microbiomedata/NMDC_documentation/blob/7f0ce6d7f671785e4733fdc14eac0c2f766b6cb9/docs/howto_guides/api_gui.md
The implementation contained a bug: it relied on a `<details />` element that accepted user clicks; but was within an element that was already listening for user clicks (i.e. the metadata description element). Clicking on the `<details />` element also counted as clicking on all of its parent elements (there was no `event.stopPropagation()` call). As a result, when the `<details />` element was expanded, the endpoints would be collapsed—and vice versa.
|
Merging without review because we are down to the wire, the changes carry nearly no risk of adversely affecting functionality (from my perspective), and the content is a verbatim copy/paste of content that has already been reviewed/approved in a different context. |
eecavanna
deleted the
646-berkeley-synchronize-swagger-ui-documentation-with-standalone-api_guimd-how-to-guide
branch
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
In this branch, I updated Swagger tag descriptions to be consistent with the latest Berkeley Schema-compatible API GUI how-to guide (here). That was my main objective.
While I was at it, I also disabled a buggy feature, where expanding a table within a tag description would simultaneously collapse the endpoints in that tag section; and vice versa. This was happening because the click event was being propagated up the DOM tree, being received be listeners at every level (i.e. there was no
event.stopPropagation()happening within the tag description level). Now, the table is always visible.Fixes #646
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration, if it is not simply
make up-test && make test-run.Configuration Details: none
Definition of Done (DoD) Checklist: