Display key patterns for swagger.yaml files
Schema definitions and their properties (except for the top-level title and description
properties) can be defined in swagger.yaml files. Therefore, the key
patterns that can be used in schema.json files can also be used in
swagger.yaml files. The one difference is that the display key
patterns start with schema.<localizationPrefix>, rather than
json.<localizationPrefix>. For a list of these key patterns,
refer to the previous topic.
swagger.yaml files also support an additional set of documentation text.
The following table lists the different types of text and the patterns for the display
keys. Note that the base configuration makes use of some of these patterns, but not all
of them.
| Display key pattern | Example | Notes |
|---|---|---|
| info.title |
swagger.<localizationPrefix>. swagger.claim.v1.info.title |
|
| info.description |
swagger.<localizationPrefix>. swagger.claim.v1.info.description |
|
| info.termsOfService |
swagger.<localizationPrefix>. swagger.claim.v1.info.termsOfService |
|
| info.license.name |
swagger.<localizationPrefix>. swagger.claim.v1.info.license.name |
|
| tags.<name>.description |
swagger.<localizationPrefix>. swagger.claim.v1.tags.claim.description |
"name" refers to the "name" property of the tag itself |
|
tags.<name>. externalDocs.description |
swagger.<localizationPrefix>. swagger.claim.v1.tags.claim. externalDocs.description |
|
|
securityDefinitions.<RefName>. description |
swagger.<localizationPrefix>. swagger.claim.v1.securityDefinitions. oauth.description |
"RefName" refers to the name the top-level security definition is referenced by |
|
parameters.<RefName>. description |
swagger.<localizationPrefix>. swagger.claim.v1.parameters.claimId. description |
"RefName" refers to the name the top-level parameter is referenced by, not to the "name" property of the parameter |
|
parameterSets.<RefName>. <in>.<name>.description |
swagger.<localizationPrefix>. swagger.claim.v1.parameterSets. standardParameters. query.prettyPrint.description |
"RefName" refers to the name of the parameter set, "in" and "name" refer to the respective values of the parameter within the set |
|
responses.<RefName>. description |
swagger.<localizationPrefix>. swagger.claim.v1.responses. standard200.description |
"RefName" refers to the name the top-level response is referenced by |
|
responses.<RefName>. headers.<HeaderName>. description |
swagger.<localizationPrefix>. swagger.claim.v1.responses. standard200.headers. GW-Checksum.description |
"RefName" refers to the name the top-level response is referenced by |
| externalDocs.description |
swagger.<localizationPrefix>. swagger.claim.v1. externalDocs.description |
|
|
operations.<operationId>. summary |
swagger.<localizationPrefix>. swagger.claim.v1.operations. getClaim.summary |
|
|
operations.<operationId>. description |
swagger.<localizationPrefix>. swagger.claim.v1.operations. getClaim.description |
|
|
operations.<operationId>. externalDocs.description |
swagger.<localizationPrefix>. swagger.claim.v1.operations. getClaim.externalDocs.description |
|
|
operations.<operationId>. parameters.<in>.<name>. description |
swagger.<localizationPrefix>. swagger.claim.v1.operations. getClaim.parameters.query. customParam.description |
Note that parameter names are not unique, only the combination of "in" and "name" is unique, so the property path for operation-level parameters must include both pieces |
|
operations.<operationId>. responses.<Code>.description |
swagger.<localizationPrefix>. swagger.claim.v1.operations. getClaim.responses. 200.description |
|
|
operations.<operationId>. responses.<Code>.headers. <HeaderName>.description |
swagger.<localizationPrefix>. swagger.claim.v1.operations. getClaim.responses.200.headers. GW-Checksum.description |
|
|
paths.<Path>.parameters. <in>.<name>.description |
swagger.<localizationPrefix>. swagger.claim.v1.paths.claims. _claimId_.parameters.path. claimId.description |