diff options
| author |   Priyank Maheshwari <priyank.maheshwari@est.tech> | 2024-11-15 10:36:04 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2024-11-15 10:36:04 +0000 |
| commit | 12dd22ec92526bb2782f3c1e55b6e9a4e0e9e77c (patch) | |
| tree | b772c2918a7e640c298cb0d8b66b9bf3e41002a9 /docs/api/swagger/ncmp/openapi-inventory.yaml | |
| parent | e14acc9d0d51a47c0827401c318e549aba753dd2 (diff) | |
| parent | c37dee4816f51f750a9c92946dc9d4a558f3b812 (diff) | |
Merge "Support alternate Id interface for ncmp inventory /ch/cmhandles endpoint"
Diffstat (limited to 'docs/api/swagger/ncmp/openapi-inventory.yaml')
| -rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 28 |
1 files changed, 18 insertions, 10 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml index c72f47a428..d358719a4b 100644 --- a/docs/api/swagger/ncmp/openapi-inventory.yaml +++ b/docs/api/swagger/ncmp/openapi-inventory.yaml @@ -86,8 +86,8 @@ paths: - network-cm-proxy-inventory /v1/ch/cmHandles: get: - description: Get all cm handle IDs for a registered DMI plugin - operationId: getAllCmHandleIdsForRegisteredDmi + description: Get all cm handle references for a registered DMI plugin + operationId: getAllCmHandleReferencesForRegisteredDmi parameters: - description: dmi-plugin-identifier in: query @@ -96,6 +96,14 @@ paths: schema: 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 + in: query + name: outputAlternateId + required: false + schema: + default: false + type: boolean responses: "200": content: @@ -125,19 +133,19 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Internal Server Error - summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\ - \ data plugin, DMI model plugin)" + summary: "Get all cm handle references for a registered DMI plugin (DMI plugin,\ + \ DMI data plugin, DMI model plugin)" tags: - network-cm-proxy-inventory /v1/ch/searches: post: - description: "Query and get CMHandle references for additional properties, public\ - \ properties and registered DMI plugin (DMI plugin, DMI data plugin, DMI model\ - \ plugin)." + description: "Query and get cm handle 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 cm - handle references for a given query + handle Ids or alternate Ids for a given query in: query name: outputAlternateId required: false @@ -193,8 +201,8 @@ components: 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 + description: Boolean parameter to determine if returned value(s) will be cm + handle Ids or alternate Ids for a given query in: query name: outputAlternateId required: false |