Conditional display of header Request #719
Merged
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
|
Visit the preview URL for this PR (updated for commit bb57c36): https://docusaurus-openapi-36b86--pr719-b2aabumc.web.app (expires Thu, 11 Apr 2024 13:38:48 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
|
Hi @chranmat, thanks for the PR. It seems straightforward enough but a cypress test is failing due to a |
|
Never mind, seemed to work on the retry. |
sserrata
approved these changes
Mar 12, 2024
sserrata
pushed a commit
that referenced
this pull request
Mar 15, 2024
Co-authored-by: Christian A. Mathiesen <christian@zaveit.no>
sserrata
added a commit
that referenced
this pull request
Mar 15, 2024
* feat: implement x-tagGroup feature (#737) * impement redoc's x-tagGroup feature * merge main * update documentation * fix filtered tags by group * remove tracked .idea files * add option to readme * merge main * fix lint * revert yarn.lock and linter * cleanup missing types, dup imports and add restaurant example * fix: Guard only undefined and empty strings (#725) * Conditional display of header Request (#719) Co-authored-by: Christian A. Mathiesen <christian@zaveit.no> * update lock file * feat: Implement schema pages behind a config option `showSchemas` (#736) * feat: Implement schema pages behind a config option `showSchemas` * Add `showSchemas` to petstore demo * address linter errors * enable schemas for petstore * update lock file * add missing heading import * address linter errors --------- Co-authored-by: Çağrı S <bencagri@users.noreply.github.com> Co-authored-by: Florian Garcia <garcia.florian.perso@gmail.com> Co-authored-by: chranmat <cam@mathix.net> Co-authored-by: Christian A. Mathiesen <christian@zaveit.no> Co-authored-by: Marc L <littlemarc2020@gmail.com>
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
The change avoids including the single header "Request" when no request body or parameters exist.
Motivation and Context
When a request is without relevant request information (e.g., requestBody, or parameters), the header "Request" is still applied to the markdown. This is inconvenient because there is no reason to have a header without content.
How Has This Been Tested?
It has been tested by running the demo project and verifying that the header does not exist when no requestBody or parameters are present. It's also verified that the header is present when these exist.
Additonally executed normal tests (yarn test).
Screenshots (if appropriate)
Before applying the change, the single header Request is present:
After applying this change, the same page does not display single header Request:
Types of changes
Checklist
Comments: