diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger/cps/openapi.yaml | 18 | ||||
| -rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 6 | ||||
| -rw-r--r-- | docs/api/swagger/ncmp/openapi.yaml | 12 | ||||
| -rw-r--r-- | docs/ncmp-cmhandle-querying.rst | 17 | ||||
| -rw-r--r-- | docs/ncmp-data-operation.rst | 4 |
5 files changed, 43 insertions, 14 deletions
diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml index 3f889c1e6c..3b6bd43d6c 100644 --- a/docs/api/swagger/cps/openapi.yaml +++ b/docs/api/swagger/cps/openapi.yaml @@ -2283,6 +2283,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: @@ -2293,6 +2302,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: diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml index d358719a4b..ab83ed2ae6 100644 --- a/docs/api/swagger/ncmp/openapi-inventory.yaml +++ b/docs/api/swagger/ncmp/openapi-inventory.yaml @@ -97,7 +97,7 @@ paths: example: my-dmi-plugin type: string - description: Boolean parameter to determine if returned value(s) will be cm - handle Ids or alternate Ids for a given query + handle ids or alternate ids for a given query in: query name: outputAlternateId required: false @@ -145,7 +145,7 @@ paths: operationId: searchCmHandleIds parameters: - description: Boolean parameter to determine if returned value(s) will be cm - handle Ids or alternate Ids for a given query + handle ids or alternate ids for a given query in: query name: outputAlternateId required: false @@ -202,7 +202,7 @@ components: type: string outputAlternateIdOptionInQuery: description: Boolean parameter to determine if returned value(s) will be cm - handle Ids or alternate Ids for a given query + handle ids or alternate ids for a given query in: query name: outputAlternateId required: false diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml index aa84e432e9..e7256c0836 100644 --- a/docs/api/swagger/ncmp/openapi.yaml +++ b/docs/api/swagger/ncmp/openapi.yaml @@ -1130,10 +1130,10 @@ paths: /v1/ch/id-searches: post: 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 - query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm + 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 query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible to query on any data related to the cm handle. For more on CPS Path please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS @@ -1142,7 +1142,7 @@ paths: operationId: searchCmHandleIds parameters: - description: Boolean parameter to determine if returned value(s) will be cm - handle Ids or alternate Ids for a given query + handle ids or alternate ids for a given query in: query name: outputAlternateId required: false @@ -1619,7 +1619,7 @@ components: type: string outputAlternateIdOptionInQuery: description: Boolean parameter to determine if returned value(s) will be cm - handle Ids or alternate Ids for a given query + handle ids or alternate ids for a given query in: query name: outputAlternateId required: false diff --git a/docs/ncmp-cmhandle-querying.rst b/docs/ncmp-cmhandle-querying.rst index 529297daa7..2e534d87ff 100644 --- a/docs/ncmp-cmhandle-querying.rst +++ b/docs/ncmp-cmhandle-querying.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2022-2023 Nordix Foundation +.. Copyright (C) 2022-2024 Nordix Foundation .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING .. _cmhandlequerying: @@ -19,9 +19,20 @@ For querying CM Handles we have two Post endpoints: - ncmp/v1/ch/searches Returns all CM Handles which match the query properties provided. Gives a JSON payload of the **details** of all matching CM Handles. -- ncmp/v1/ch/id-searches Returns all CM Handles IDs which match the query properties provided. Gives a JSON payload of the **ids** of all matching CM Handles. +- ncmp/v1/ch/id-searches Returns all CM Handles IDs or Alternate IDs which match the query properties provided. Gives a JSON payload of the **ids** of all matching CM Handles. -/searches returns whole CM Handle object (data) whereas /id-searches returns only CM Handle IDs. Otherwise these endpoints are intended to be functionally identical so both can be queried with the same request body. If no matching CM Handles are found an empty array is returned. +/searches returns whole CM Handle object (data) whereas /id-searches returns only CM Handle IDs or Alternate IDs. Otherwise these endpoints are intended to be functionally identical so both can be queried with the same request body. If no matching CM Handles are found an empty array is returned. + +Parameters +========== + +/id-searches can return either CM Handle IDs or Alternate IDs. This is controlled with an optional parameter outputAlternateId. + +- *outputAlternateId=true* returns Alternate IDs + +- *outputAlternateId=false* returns CM Handle IDs + +Note: Null values will default to false so /id-searches & /id-searches?outputAlternateId will both return CM Handle IDs Request Body ============ diff --git a/docs/ncmp-data-operation.rst b/docs/ncmp-data-operation.rst index 94d5ee9c0a..3352e03cf0 100644 --- a/docs/ncmp-data-operation.rst +++ b/docs/ncmp-data-operation.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2023 Nordix Foundation +.. Copyright (C) 2023-2024 Nordix Foundation .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING .. _cmHandleDataOperation: @@ -43,7 +43,7 @@ This endpoint executes data operation for given array of operations: | | | implementation. For ONAP DMI Plugin it will be RESTConf paths but it can| | | | really be anything. | +--------------------------+-------------+-------------------------------------------------------------------------+ - | targetIds | Yes | List of cm handle ids. | + | targetIds | Yes | List of cm handle references | +--------------------------+-------------+-------------------------------------------------------------------------+ The status codes used in the events resulting from these operations are defined here: |