diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger/openapi.yaml | 159 |
1 files changed, 52 insertions, 107 deletions
diff --git a/docs/api/swagger/openapi.yaml b/docs/api/swagger/openapi.yaml index 750091b4..54676fe5 100644 --- a/docs/api/swagger/openapi.yaml +++ b/docs/api/swagger/openapi.yaml @@ -58,27 +58,34 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorMessage' - /v1/inventory/cmHandles: + /v1/ch/{cmHandle}/moduleResources: post: tags: - - dmi-plugin-internal - summary: register given list of cm handles (internal use only) - description: register given list of cm handles (internal use only) - operationId: registerCmHandles + - dmi-plugin + summary: Retrieve module resources + description: Retrieve module resources for one or more modules + operationId: retrieveModuleResources + parameters: + - name: cmHandle + in: path + description: The identifier for a network function, network element, subnetwork, + or any other cm object by managed Network CM Proxy + required: true + schema: + type: string requestBody: - description: list of cm handles content: application/json: schema: - $ref: '#/components/schemas/CmHandles' + $ref: '#/components/schemas/ModuleResourcesReadRequest' required: true responses: - "201": - description: Created + "200": + description: OK content: - text/plain: + application/json: schema: - type: string + $ref: '#/components/schemas/YangResources' "400": description: Bad Request content: @@ -97,35 +104,27 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorMessage' - x-api-audience: component-internal - /v1/ch/{cmHandle}/moduleResources: + /v1/inventory/cmHandles: post: tags: - - dmi-plugin - summary: Retrieve module resources - description: Retrieve module resources for one or more modules - operationId: retrieveModuleResources - parameters: - - name: cmHandle - in: path - description: The identifier for a network function, network element, subnetwork, - or any other cm object by managed Network CM Proxy - required: true - schema: - type: string + - dmi-plugin-internal + summary: register given list of cm handles (internal use only) + description: register given list of cm handles (internal use only) + operationId: registerCmHandles requestBody: + description: list of cm handles content: application/json: schema: - $ref: '#/components/schemas/ModuleResourcesReadRequest' + $ref: '#/components/schemas/CmHandles' required: true responses: - "200": - description: OK + "201": + description: Created content: - application/json: + text/plain: schema: - $ref: '#/components/schemas/YangResources' + type: string "400": description: Bad Request content: @@ -144,13 +143,15 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + x-api-audience: component-internal /v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-operational: - put: + post: tags: - dmi-plugin summary: Get resource data from passthrough-operational for cm handle - description: Get resource data from passthrough-operational for cm handle - operationId: getResourceDataOperationalForCmHandle + description: Get resource data from passthrough-operational for cm handle. Will + support read operations only. + operationId: dataAccessPassthroughOperational parameters: - name: cmHandle in: path @@ -198,7 +199,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DataAccessReadRequest' + $ref: '#/components/schemas/DataAccessRequest' responses: "200": description: OK @@ -225,12 +226,15 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' /v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-running: - put: + post: tags: - dmi-plugin - summary: Get resource data from passthrough-running for cm handle - description: Get resource data from passthrough-running for cm handle - operationId: getResourceDataPassthroughRunningForCmHandle + summary: Get, Create or Update request for data passthrough-running for a cm-handle + description: Post request to Get, Create or to Update resource data for a cm-handle. + Since all requests need to include additional information in a request body + HTTP Post is used for all use cases and the actual operation is defined in + the request body instead. + operationId: dataAccessPassthroughRunning parameters: - name: cmHandle in: path @@ -274,63 +278,10 @@ paths: value: options: (key1=10,key2=value2,key3=[val31,val32]) requestBody: - description: Operational body - content: - application/json: - schema: - $ref: '#/components/schemas/DataAccessReadRequest' - responses: - "200": - description: OK - content: - application/json: - schema: - type: object - "400": - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - "401": - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - "403": - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - post: - tags: - - dmi-plugin - summary: Write data for a cmHandle - description: Write data for a cmHandle using passthrough-running - operationId: writeDataByPassthroughRunningForCmHandle - parameters: - - name: cmHandle - in: path - description: The identifier for a network function, network element, subnetwork, - or any other cm object by managed Network CM Proxy - required: true - schema: - type: string - - name: resourceIdentifier - in: query - description: Resource identifier to get/set the resource data - required: true - allowReserved: true - schema: - type: string - requestBody: content: application/json: schema: - $ref: '#/components/schemas/DataAccessWriteRequest' - required: true + $ref: '#/components/schemas/DataAccessRequest' responses: "201": description: Created @@ -388,13 +339,6 @@ components: type: string details: type: string - CmHandles: - type: object - properties: - cmHandles: - type: array - items: - type: string ModuleResourcesReadRequest: type: object properties: @@ -417,22 +361,23 @@ components: type: string revision: $ref: '#/components/schemas/revision' - DataAccessReadRequest: + CmHandles: type: object properties: - operation: - type: string - enum: - - read - cmHandleProperties: - $ref: '#/components/schemas/cmHandleProperties' - DataAccessWriteRequest: + cmHandles: + type: array + items: + type: string + DataAccessRequest: type: object properties: operation: type: string enum: + - read - create + - update + - delete dataType: type: string data: |