External Documentation rendered for groups, operations and schemata. #595
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
RomanHotsiy
requested changes
Sep 5, 2018
| {externalDocs && ( | ||
| <Row> | ||
| <MiddlePanel> | ||
| <p> |
There was a problem hiding this comment.
Do we really need a <p> here?
There was a problem hiding this comment.
That's on purpose. The p adds a margin between the External Documentation link and the description. Without the margin in looks odd. The div is chosen in the schema as it seems to be designed to be very small and therefore without margin, like most other elements in there, too. So I think your suggestion makes things look worse without introducing additional styling per place that it's added to.
| @@ -50,6 +51,11 @@ export class Operation extends React.Component<OperationProps> { | |||
| </H2> | |||
| {options.pathInMiddlePanel && <Endpoint operation={operation} inverted={true} />} | |||
| {description !== undefined && <Description source={description} />} | |||
| {externalDocs && ( | |||
| <p> | |||
RomanHotsiy
approved these changes
Sep 10, 2018
|
I cleaned it up a bit myself! Thanks for the PR. It will land in the upcoming alpha at the end of the week. |
|
Thank you! |
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.
The externalDocs were missing for tags, schemata and operations. Added them with this pull requests. Solves #550.
Additionally, fixes that the URL in External Documentation Object was specified to be optional, which is not correct according to OpenAPI spec.