diff options
Diffstat (limited to 'cps-ncmp-rest/docs/openapi/components.yaml')
| -rw-r--r-- | cps-ncmp-rest/docs/openapi/components.yaml | 34 |
1 files changed, 23 insertions, 11 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml index 8343c1c26..69225aed2 100644 --- a/cps-ncmp-rest/docs/openapi/components.yaml +++ b/cps-ncmp-rest/docs/openapi/components.yaml @@ -53,23 +53,23 @@ components: $ref: '#/components/schemas/RestInputCmHandle' updatedCmHandles: type: array - example: - cmHandle: my-cm-handle - cmHandleProperties: - add-my-property: add-property - update-my-property: updated-property - delete-my-property: '~' - publicCmHandleProperties: - add-my-property: add-property - update-my-property: updated-property - delete-my-property: '~' items: $ref: '#/components/schemas/RestInputCmHandle' + example: + cmHandle: my-cm-handle + cmHandleProperties: + add-my-property: add-property + update-my-property: updated-property + delete-my-property: '~' + publicCmHandleProperties: + add-my-property: add-property + update-my-property: updated-property + delete-my-property: '~' removedCmHandles: type: array items: type: string - example: [my-cm-handle1, my-cm-handle2, my-cm-handle3] + example: [my-cm-handle1, my-cm-handle2, my-cm-handle3] RestInputCmHandle: required: @@ -329,6 +329,18 @@ components: sample 3: value: options: (depth=2,fields=book/authors) + topicParamInQuery: + name: topic + in: query + description: topic parameter in query. + required: false + schema: + type: string + allowReserved: true + examples: + sample 1: + value: + topic: my-topic-name contentParamInHeader: name: Content-Type in: header |