diff options
| author |   seanbeirne <sean.beirne@est.tech> | 2024-11-05 10:21:30 +0000 |
|---|---|---|
| committer | seanbeirne <sean.beirne@est.tech> | 2024-11-13 10:52:19 +0000 |
| commit | c37dee4816f51f750a9c92946dc9d4a558f3b812 (patch) | |
| tree | d54dba7ce7c024c6be1a347190b14c8a2aecb092 /cps-ncmp-rest/docs | |
| parent | 38cea5882ab71f23eddd3ffc9fd56c5d6540f28e (diff) | |
Support alternate Id interface for ncmp inventory /ch/cmhandles endpoint
Issue-ID: CPS-2481
Change-Id: I8a200495be1afb9a4f256127f886bed78c77f653
Signed-off-by: seanbeirne <sean.beirne@est.tech>
Diffstat (limited to 'cps-ncmp-rest/docs')
| -rw-r--r-- | cps-ncmp-rest/docs/openapi/components.yaml | 4 | ||||
| -rwxr-xr-x | cps-ncmp-rest/docs/openapi/ncmp-inventory.yml | 11 | ||||
| -rwxr-xr-x | cps-ncmp-rest/docs/openapi/openapi-inventory.yml | 2 |
3 files changed, 9 insertions, 8 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml index a8da6937a3..e564c6b0cf 100644 --- a/cps-ncmp-rest/docs/openapi/components.yaml +++ b/cps-ncmp-rest/docs/openapi/components.yaml @@ -366,7 +366,7 @@ components: type: array items: type: string - description: targeted cm handle references, maximum of 200 supported. If this limit is exceeded the request wil be refused. + description: targeted cm handle references, maximum of 200 supported. If this limit is exceeded the request will be refused. example: [ "da310eecdb8d44c2acc0ddaae01174b1","c748c58f8e0b438f9fd1f28370b17d47" ] examples: @@ -516,7 +516,7 @@ components: outputAlternateIdOptionInQuery: name: outputAlternateId in: query - description: Boolean parameter to determine if returned value(s) will be cm handle references 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 required: false schema: type: boolean diff --git a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml index 24b83cf368..7b1c8d403e 100755 --- a/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml +++ b/cps-ncmp-rest/docs/openapi/ncmp-inventory.yml @@ -96,15 +96,16 @@ updateDmiRegistration: } ] -getAllCmHandleIdsForRegisteredDmi: +getAllCmHandleReferencesForRegisteredDmi: get: - description: Get all cm handle IDs for a registered DMI plugin + description: Get all cm handle references for a registered DMI plugin tags: - network-cm-proxy-inventory - summary: Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin) - operationId: getAllCmHandleIdsForRegisteredDmi + summary: Get all cm handle references for a registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin) + operationId: getAllCmHandleReferencesForRegisteredDmi parameters: - $ref: 'components.yaml#/components/parameters/dmiPluginIdentifierInQuery' + - $ref: 'components.yaml#/components/parameters/outputAlternateIdOptionInQuery' responses: 200: description: OK @@ -121,7 +122,7 @@ getAllCmHandleIdsForRegisteredDmi: searchCmHandleIds: 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). tags: - network-cm-proxy-inventory summary: Query for CM Handle IDs diff --git a/cps-ncmp-rest/docs/openapi/openapi-inventory.yml b/cps-ncmp-rest/docs/openapi/openapi-inventory.yml index d374dcc9db..6c207ee2af 100755 --- a/cps-ncmp-rest/docs/openapi/openapi-inventory.yml +++ b/cps-ncmp-rest/docs/openapi/openapi-inventory.yml @@ -34,7 +34,7 @@ paths: $ref: 'ncmp-inventory.yml#/updateDmiRegistration' /v1/ch/cmHandles: - $ref: 'ncmp-inventory.yml#/getAllCmHandleIdsForRegisteredDmi' + $ref: 'ncmp-inventory.yml#/getAllCmHandleReferencesForRegisteredDmi' /v1/ch/searches: $ref: 'ncmp-inventory.yml#/searchCmHandleIds' |