diff options
| author |   seanbeirne <sean.beirne@est.tech> | 2024-11-04 16:36:10 +0000 |
|---|---|---|
| committer | seanbeirne <sean.beirne@est.tech> | 2024-11-18 10:43:36 +0000 |
| commit | 7e6fee9321e4f13cc4a0d81f83fc3693309cb5d7 (patch) | |
| tree | f1a87adf60644eb4eb991274a6f6d44df3457e12 /docs/api | |
| parent | 37962e3faca4f2306546c4f70d480b0c323d2c68 (diff) | |
Update error response for ncmp endpoints
Issue-ID: CPS-2386
Change-Id: Ib4f37858f5f107e350a13e4bf7ed93493864ce60
Signed-off-by: seanbeirne <sean.beirne@est.tech>
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 6 | ||||
| -rw-r--r-- | docs/api/swagger/ncmp/openapi.yaml | 12 |
2 files changed, 9 insertions, 9 deletions
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 |