diff options
| author |   Bruno Sakoto <bruno.sakoto@bell.ca> | 2022-03-15 08:09:07 -0400 |
|---|---|---|
| committer | Bruno Sakoto <bruno.sakoto@bell.ca> | 2022-03-15 12:59:49 -0400 |
| commit | a1129b696f3197fc7d8a3b63bcd84b5b2dd8874e (patch) | |
| tree | 17de94d8cb129fdacf633080cc37772517a3ab82 /docs/api/swagger/ncmp | |
| parent | e1f41c3e6591b572a75021f4b51538f8fdbfc88d (diff) | |
Create primary documentation for Jakarta release
* Update release notes
* Update openapi documentation
* Fix section title hierarchy
* Fix admin container directive not found
Issue-ID: CPS-935
Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca>
Change-Id: Iabdc357aa0168c1becafd6de1ac7703ec3bd1afa
Diffstat (limited to 'docs/api/swagger/ncmp')
| -rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 15 | ||||
| -rw-r--r-- | docs/api/swagger/ncmp/openapi.yaml | 26 |
2 files changed, 28 insertions, 13 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml index 154a4411da..30896f6068 100644 --- a/docs/api/swagger/ncmp/openapi-inventory.yaml +++ b/docs/api/swagger/ncmp/openapi-inventory.yaml @@ -86,23 +86,16 @@ 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' removedCmHandles: type: array + example: + - my-cm-handle1 + - my-cm-handle2 + - my-cm-handle3 items: type: string - example: "[\"my-cm-handle1\",\"my-cm-handle2\",\"my-cm-handle3\"]" RestInputCmHandle: required: - cmHandle diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml index b7a65632e7..5a6a600a36 100644 --- a/docs/api/swagger/ncmp/openapi.yaml +++ b/docs/api/swagger/ncmp/openapi.yaml @@ -70,6 +70,17 @@ paths: sample 3: value: options: "(depth=2,fields=book/authors)" + - name: topic + in: query + description: topic parameter in query. + required: false + allowReserved: true + schema: + type: string + examples: + sample 1: + value: + topic: my-topic-name responses: "200": description: OK @@ -184,6 +195,17 @@ paths: sample 3: value: options: "(depth=2,fields=book/authors)" + - name: topic + in: query + description: topic parameter in query. + required: false + allowReserved: true + schema: + type: string + examples: + sample 1: + value: + topic: my-topic-name responses: "200": description: OK @@ -664,7 +686,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/ModuleReference' + $ref: '#/components/schemas/RestModuleReference' "400": description: Bad Request content: @@ -851,7 +873,7 @@ components: type: string details: type: string - ModuleReference: + RestModuleReference: title: Module reference details type: object properties: |