diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger/cps/openapi.yaml | 52 | ||||
| -rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 23 | ||||
| -rw-r--r-- | docs/api/swagger/ncmp/openapi.yaml | 20 |
3 files changed, 80 insertions, 15 deletions
diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml index 3069b18d1e..3f889c1e6c 100644 --- a/docs/api/swagger/cps/openapi.yaml +++ b/docs/api/swagger/cps/openapi.yaml @@ -1162,6 +1162,15 @@ paths: default: none example: "3" type: string + - description: Content type in header + in: header + name: Content-Type + required: true + schema: + enum: + - application/json + - application/xml + type: string responses: "200": content: @@ -1172,6 +1181,15 @@ paths: value: null schema: type: object + application/xml: + examples: + dataSample: + $ref: '#/components/examples/dataSampleXml' + value: null + schema: + type: object + xml: + name: stores description: OK "400": content: @@ -1347,7 +1365,9 @@ paths: name: Content-Type required: true schema: - example: application/json + enum: + - application/json + - application/xml type: string requestBody: content: @@ -1472,7 +1492,9 @@ paths: name: Content-Type required: true schema: - example: application/json + enum: + - application/json + - application/xml type: string requestBody: content: @@ -1597,7 +1619,9 @@ paths: name: Content-Type required: true schema: - example: application/json + enum: + - application/json + - application/xml type: string requestBody: content: @@ -1788,7 +1812,9 @@ paths: name: Content-Type required: true schema: - example: application/json + enum: + - application/json + - application/xml type: string requestBody: content: @@ -2543,6 +2569,16 @@ components: default: none example: "3" type: string + contentTypeInHeader: + description: Content type in header + in: header + name: Content-Type + required: true + schema: + enum: + - application/json + - application/xml + type: string observedTimestampInQuery: description: observed-timestamp in: query @@ -2551,14 +2587,6 @@ components: schema: example: 2021-03-21T00:10:34.030-0100 type: string - contentTypeInHeader: - description: Content type in header - in: header - name: Content-Type - required: true - schema: - example: application/json - type: string dryRunInQuery: description: "Boolean flag to validate data, without persisting it. Default\ \ value is set to false." diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml index a2c7af6fda..8552ad53e3 100644 --- a/docs/api/swagger/ncmp/openapi-inventory.yaml +++ b/docs/api/swagger/ncmp/openapi-inventory.yaml @@ -131,9 +131,19 @@ paths: - network-cm-proxy-inventory /v1/ch/searches: post: - description: "Query and get CMHandleIds for additional properties, public properties\ - \ and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin)." + description: "Query and get CMHandle references for additional properties, public\ + \ properties and registered DMI plugin (DMI plugin, DMI data plugin, DMI model\ + \ plugin)." operationId: searchCmHandleIds + parameters: + - description: Boolean parameter to determine if returned value(s) will be cmHandle + Ids or Alternate Ids for a given query + in: query + name: outputAlternateId + required: false + schema: + default: false + type: boolean requestBody: content: application/json: @@ -182,6 +192,15 @@ components: schema: example: my-dmi-plugin type: string + outputAlternateIdOptionInQuery: + description: Boolean parameter to determine if returned value(s) will be cmHandle + Ids or Alternate Ids for a given query + in: query + name: outputAlternateId + required: false + schema: + default: false + type: boolean responses: NoContent: content: {} diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml index f93395a6db..aa732c8566 100644 --- a/docs/api/swagger/ncmp/openapi.yaml +++ b/docs/api/swagger/ncmp/openapi.yaml @@ -1129,7 +1129,7 @@ paths: - network-cm-proxy /v1/ch/id-searches: post: - description: Execute cm handle query search and return a list of cm handle ids. + description: Execute cm handle query search and return a list of cm handle references. Any number of conditions can be applied. To be included in the result a cm-handle must fulfill ALL the conditions. An empty collection will be returned in the case that the cm handle does not match a condition. For more on cm handle @@ -1140,6 +1140,15 @@ paths: Path Read the Docs</a>. The cm handle ancestor is automatically returned for this query. operationId: searchCmHandleIds + parameters: + - description: Boolean parameter to determine if returned value(s) will be cmHandle + Ids or Alternate Ids for a given query + in: query + name: outputAlternateId + required: false + schema: + default: false + type: boolean requestBody: content: application/json: @@ -1608,6 +1617,15 @@ components: schema: example: 2024-01-22 type: string + outputAlternateIdOptionInQuery: + description: Boolean parameter to determine if returned value(s) will be cmHandle + Ids or Alternate Ids for a given query + in: query + name: outputAlternateId + required: false + schema: + default: false + type: boolean dataSyncEnabled: description: Is used to enable or disable the data synchronization flag in: query |