Update externalDocumentation to a named map #363
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
mtdowling
requested changes
Apr 8, 2020
| @@ -8,7 +8,9 @@ | |||
| "selector": "service" | |||
| }, | |||
| "smithy.api#documentation": "Specifies the source of the caller identifier that will be used to throttle API methods that require a key.", | |||
| "smithy.api#externalDocumentation": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-api-key-source.html", | |||
| "smithy.api#externalDocumentation": { | |||
| "User Guide": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-api-key-source.html" | |||
There was a problem hiding this comment.
Should we call this "Developer Guide" so that it matches the nomenclature of the referenced docs?
smithy-model/src/main/java/software/amazon/smithy/model/traits/ExternalDocumentationTrait.java
Outdated
Show resolved
Hide resolved
smithy-model/src/main/resources/software/amazon/smithy/model/loader/prelude-traits.smithy
Show resolved
Hide resolved
smithy-model/src/main/java/software/amazon/smithy/model/traits/ExternalDocumentationTrait.java
Outdated
Show resolved
Hide resolved
mtdowling
reviewed
Apr 8, 2020
This commit updates the @externalDocumentation trait to be a map of named urls instead of a single url. This provides more context for the given links and enables the ability to have multiple links per trait application. An update to the OpenApi conversion has been made to utilize this when populating "externalDocs" fields. A configurable, priority ordered list of url names is available through `"openapi.externalDocs"`; it defaults to "Homepage", "Api Reference", "User Guide", "Developer Guide", "Reference", and "Guide". This list is compared case insensitively. This also fixes an issue where "externalDocs" fields could be generated as strings instead of the properly formatted external documentation object in the resulting OpenApi document.
mtdowling
approved these changes
Apr 8, 2020
Merged
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.
This commit updates the @externalDocumentation trait to be a map of
named urls instead of a single url. This provides more context for
the given links and enables the ability to have multiple links per
trait application.
An update to the OpenApi conversion has been made to utilize this
when populating "externalDocs" fields. A configurable, priority
ordered list of url names is available through
"openapi.externalDocs"; it defaults to "Homepage", "ApiReference", "User Guide", "Developer Guide", "Reference", and
"Guide". This list is compared case insensitively. This also
fixes an issue where "externalDocs" fields could be generated as
strings instead of the properly formatted external documentation
object in the resulting OpenApi document.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.