X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi%2Fswagger%2Fncmp%2Fopenapi-inventory.yaml;h=ff9f4ba6839263117b4c36543d7f2209bdb357d3;hb=4a978d3c66da16bc96b54cba807138fc9b0c79fa;hp=9e84f3a194fac786e6a6b9dc7a44f45c2601568c;hpb=8f55ef0b08bfde2878b286c7f2d3029a470db3fc;p=cps.git diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml index 9e84f3a19..ff9f4ba68 100644 --- a/docs/api/swagger/ncmp/openapi-inventory.yaml +++ b/docs/api/swagger/ncmp/openapi-inventory.yaml @@ -1,16 +1,15 @@ -openapi: 3.0.1 +openapi: 3.0.3 info: - title: NCMP Inventory API description: NCMP Inventory API + title: NCMP Inventory API version: "1.0" servers: - url: /ncmpInventory +security: +- basicAuth: [] paths: /v1/ch: post: - tags: - - network-cm-proxy-inventory - summary: DMI notifies NCMP of new CM Handles description: "Register a DMI Plugin with any new, updated or removed CM Handles." operationId: updateDmiPluginRegistration requestBody: @@ -21,46 +20,31 @@ paths: required: true responses: "200": - description: No Content content: {} + description: No Content "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details - "401": - description: Unauthorized - content: - application/json: schema: $ref: '#/components/schemas/ErrorMessage' - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details + description: Bad Request "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "500": - description: Partial or Complete failure. The error details are provided - in the response body and all supported error codes are documented in the - example. content: application/json: - schema: - $ref: '#/components/schemas/DmiPluginRegistrationErrorResponse' example: failedCreatedCmHandles: - cmHandle: my-cm-handle-01 @@ -92,118 +76,296 @@ paths: - cmHandle: my-cm-handle-03 errorCode: "03" errorText: cm-handle has an invalid character(s) in id - /v1/ch/cmHandles: - get: + schema: + $ref: '#/components/schemas/DmiPluginRegistrationErrorResponse' + description: Partial or Complete failure. The error details are provided + in the response body and all supported error codes are documented in the + example. + summary: DMI notifies NCMP of new CM Handles tags: - network-cm-proxy-inventory - summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\ - \ data plugin, DMI model plugin)" + /v1/ch/cmHandles: + get: description: Get all cm handle IDs for a registered DMI plugin operationId: getAllCmHandleIdsForRegisteredDmi parameters: - - name: dmi-plugin-identifier + - description: dmi-plugin-identifier in: query - description: dmi-plugin-identifier + name: dmi-plugin-identifier required: true schema: - type: string example: my-dmi-plugin + type: string responses: "200": - description: OK content: application/json: schema: - type: array items: type: string - "401": - description: Unauthorized + type: array + description: OK + "403": content: application/json: + example: + status: 403 + message: Forbidden error message + details: Forbidden error details schema: $ref: '#/components/schemas/ErrorMessage' - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - "403": description: Forbidden + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred 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)" + tags: + - 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)." + operationId: searchCmHandleIds + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CmHandleQueryParameters' + required: true + responses: + "200": + content: + application/json: + schema: + items: + type: string + type: array + description: OK + "403": + content: + application/json: example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "500": - description: Internal Server Error content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 500 message: Internal Server Error details: Internal Server Error occurred + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Query for CM Handle IDs + tags: + - network-cm-proxy-inventory components: - securitySchemes: - basicAuth: - type: http - scheme: basic + parameters: + dmiPluginIdentifierInQuery: + description: dmi-plugin-identifier + in: query + name: dmi-plugin-identifier + required: true + schema: + example: my-dmi-plugin + type: string + responses: + NoContent: + content: {} + description: No Content + BadRequest: + content: + application/json: + example: + status: 400 BAD_REQUEST + message: Bad request error message + details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request + Forbidden: + content: + application/json: + example: + status: 403 + message: Forbidden error message + details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + InternalServerError: + content: + application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error schemas: RestDmiPluginRegistration: - type: object + example: + updatedCmHandles: + - cmHandle: my-cm-handle + alternateId: my-alternate-id + publicCmHandleProperties: + key: my-property + cmHandleProperties: + key: my-property + moduleSetTag: my-module-set-tag + trustLevel: COMPLETE + - cmHandle: my-cm-handle + alternateId: my-alternate-id + publicCmHandleProperties: + key: my-property + cmHandleProperties: + key: my-property + moduleSetTag: my-module-set-tag + trustLevel: COMPLETE + createdCmHandles: + - cmHandle: my-cm-handle + alternateId: my-alternate-id + publicCmHandleProperties: + key: my-property + cmHandleProperties: + key: my-property + moduleSetTag: my-module-set-tag + trustLevel: COMPLETE + - cmHandle: my-cm-handle + alternateId: my-alternate-id + publicCmHandleProperties: + key: my-property + cmHandleProperties: + key: my-property + moduleSetTag: my-module-set-tag + trustLevel: COMPLETE + dmiPlugin: my-dmi-plugin + dmiModelPlugin: my-dmi-model-plugin + upgradedCmHandles: + cmHandles: + - my-cm-handle1 + - my-cm-handle2 + - my-cm-handle3 + moduleSetTag: my-module-set-tag + dmiDataPlugin: my-dmi-data-plugin + removedCmHandles: + - my-cm-handle1 + - my-cm-handle2 + - my-cm-handle3 properties: dmiPlugin: - type: string - example: my-dmi-plugin default: "" - dmiDataPlugin: + example: my-dmi-plugin type: string - example: my-dmi-data-plugin + dmiDataPlugin: default: "" - dmiModelPlugin: + example: my-dmi-data-plugin type: string - example: my-dmi-model-plugin + dmiModelPlugin: default: "" + example: my-dmi-model-plugin + type: string createdCmHandles: - type: array items: $ref: '#/components/schemas/RestInputCmHandle' - updatedCmHandles: type: array + updatedCmHandles: items: $ref: '#/components/schemas/RestInputCmHandle' - removedCmHandles: type: array + removedCmHandles: example: - my-cm-handle1 - my-cm-handle2 - my-cm-handle3 items: type: string - RestInputCmHandle: - required: - - cmHandle + type: array + upgradedCmHandles: + $ref: '#/components/schemas/UpgradedCmHandles' type: object + RestInputCmHandle: + example: + cmHandle: my-cm-handle + alternateId: my-alternate-id + publicCmHandleProperties: + key: my-property + cmHandleProperties: + key: my-property + moduleSetTag: my-module-set-tag + trustLevel: COMPLETE properties: cmHandle: - type: string example: my-cm-handle + type: string cmHandleProperties: - $ref: '#/components/schemas/RestCmHandleProperties' + additionalProperties: + example: my-property + type: string + type: object publicCmHandleProperties: - $ref: '#/components/schemas/RestCmHandleProperties' - RestCmHandleProperties: + additionalProperties: + example: my-property + type: string + type: object + moduleSetTag: + example: my-module-set-tag + type: string + trustLevel: + enum: + - COMPLETE + - NONE + example: COMPLETE + type: string + alternateId: + example: my-alternate-id + type: string + required: + - cmHandle type: object + RestCmHandleProperties: additionalProperties: - type: string example: my-property - ErrorMessage: - title: Error + type: string + type: object + UpgradedCmHandles: + example: + cmHandles: + - my-cm-handle1 + - my-cm-handle2 + - my-cm-handle3 + moduleSetTag: my-module-set-tag + properties: + cmHandles: + example: + - my-cm-handle1 + - my-cm-handle2 + - my-cm-handle3 + items: + type: string + type: array + moduleSetTag: + default: "" + example: my-module-set-tag + type: string + required: + - cmHandles type: object + ErrorMessage: properties: status: type: string @@ -211,33 +373,109 @@ components: type: string details: type: string - DmiPluginRegistrationErrorResponse: + title: Error type: object + DmiPluginRegistrationErrorResponse: properties: failedCreatedCmHandles: - type: array items: $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' - failedUpdatedCmHandles: type: array + failedUpdatedCmHandles: items: $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' + type: array failedRemovedCmHandles: + items: + $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' type: array + failedUpgradeCmHandles: items: $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' - CmHandlerRegistrationErrorResponse: + type: array type: object + CmHandlerRegistrationErrorResponse: properties: cmHandle: - type: string example: my-cm-handle - errorCode: type: string + errorCode: example: "00" - errorText: type: string + errorText: example: Unknown error. - -security: - - basicAuth: [] \ No newline at end of file + type: string + type: object + CmHandleQueryParameters: + example: + cmHandleQueryParameters: + - conditionParameters: + - key: conditionParameters + - key: conditionParameters + conditionName: conditionName + - conditionParameters: + - key: conditionParameters + - key: conditionParameters + conditionName: conditionName + conditions: + - name: name + conditionParameters: + - moduleName: my-module + - moduleName: my-module + - name: name + conditionParameters: + - moduleName: my-module + - moduleName: my-module + properties: + cmHandleQueryParameters: + items: + $ref: '#/components/schemas/ConditionProperties' + type: array + conditions: + deprecated: true + description: "not necessary, it is just for backward compatibility" + items: + $ref: '#/components/schemas/OldConditionProperties' + type: array + title: Cm Handle query parameters for executing cm handle search + type: object + ConditionProperties: + example: + conditionParameters: + - key: conditionParameters + - key: conditionParameters + conditionName: conditionName + properties: + conditionName: + type: string + conditionParameters: + items: + additionalProperties: + type: string + type: object + type: array + OldConditionProperties: + deprecated: true + example: + name: name + conditionParameters: + - moduleName: my-module + - moduleName: my-module + properties: + name: + type: string + conditionParameters: + items: + $ref: '#/components/schemas/ModuleNameAsJsonObject' + type: array + ModuleNameAsJsonObject: + example: + moduleName: my-module + properties: + moduleName: + example: my-module + type: string + securitySchemes: + basicAuth: + scheme: basic + type: http