Difference between revisions of "OpenAPI Guidelines"
(Created page with "OpenAPI developement guidelines for ETSI technical bodies and working groups.") |
|||
| Line 1: | Line 1: | ||
OpenAPI developement guidelines for ETSI technical bodies and working groups. | OpenAPI developement guidelines for ETSI technical bodies and working groups. | ||
| + | |||
| + | = Splitting definitions in several files = | ||
| + | |||
| + | The OpenAPI specification API definition splitting: <code>$ref<code> | ||
| + | Already used in Location and RNI OpenAPI description examples below. | ||
| + | |||
| + | <syntaxhighlight lang="yaml"> | ||
| + | get: | ||
| + | description: Used to get a list of identifiers for zones authorized for use by the application. | ||
| + | produces: | ||
| + | - application/json | ||
| + | responses: | ||
| + | '200': | ||
| + | description: Successful response to a query regarding the status of a zone | ||
| + | schema: | ||
| + | properties: | ||
| + | zoneList: | ||
| + | $ref: '#/definitions/ZoneList' | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Also offers the ability to place definitions and other code in a different file | ||
| + | |||
| + | <syntaxhighlight lang="yaml"> | ||
| + | get: | ||
| + | $ref: ./Zones_Get.yaml | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | |||
| + | The file “Zones_Get.yaml” contains everything after <code>get:<code> in the 1st extract. | ||
Revision as of 14:22, 20 September 2017
OpenAPI developement guidelines for ETSI technical bodies and working groups.
Splitting definitions in several files
The OpenAPI specification API definition splitting: $ref<code>
Already used in Location and RNI OpenAPI description examples below.
<syntaxhighlight lang="yaml"> get: description: Used to get a list of identifiers for zones authorized for use by the application. produces: - application/json responses: '200': description: Successful response to a query regarding the status of a zone schema: properties: zoneList: $ref: '#/definitions/ZoneList' </syntaxhighlight>
Also offers the ability to place definitions and other code in a different file
<syntaxhighlight lang="yaml"> get: $ref: ./Zones_Get.yaml </syntaxhighlight>
The file “Zones_Get.yaml” contains everything after <code>get:<code> in the 1st extract.