X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FSOL005.git;a=blobdiff_plain;f=osm-openapi.yaml;h=594becb991b0705eedf85fbcdaf86adcf662bbfb;hp=5b5eef9c731b5341cc7bba62a6e2b4ac6390ff19;hb=HEAD;hpb=a6f638b36ac2417881d28789cd30c57b0ea64a77 diff --git a/osm-openapi.yaml b/osm-openapi.yaml index 5b5eef9..e9eaad4 100644 --- a/osm-openapi.yaml +++ b/osm-openapi.yaml @@ -1661,6 +1661,62 @@ paths: $ref: '#/components/responses/UnexpectedError' default: $ref: '#/components/responses/UnexpectedError' + '/nslcm/v1/ns_instances/{nsInstanceId}/migrate': + parameters: + - name: nsInstanceId + in: path + required: true + description: NS Instance ID + schema: + type: string + post: + tags: + - "NS instances" + summary: Migrate VNFs in a NS instance + description: | + Migrate the VNFs and VDUs in a NS instance. The precondition is + that the NS instance must have been created and must be in + INSTANTIATED state. As a result of the success of this operation, + the NFVO creates a "NS Lifecycle Operation Occurrence" resource + for the request, and the NS instance state remains INSTANTIATED. + operationId: migrateNSinstance + requestBody: + $ref: '#/components/requestBodies/NSinstanceMigrateRequest' + responses: + '202': + description: Accepted + headers: + Location: + description: | + It must point to the new "NS Lifecycle Operation Occurrence" + resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}" + schema: + type: string + format: uri + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' '/nslcm/v1/ns_instances/{nsInstanceId}/terminate': parameters: - name: nsInstanceId @@ -1791,6 +1847,115 @@ paths: $ref: '#/components/responses/UnexpectedError' default: $ref: '#/components/responses/UnexpectedError' + '/nslcm/v1/ns_instances/{nsInstanceId}/update': + parameters: + - name: nsInstanceId + in: path + required: true + description: NS Instance ID + schema: + type: string + post: + tags: + - "NS instances" + summary: Update a NS instance + description: | + Update a NS instance. The precondition is that the NS instance must have + been created and must be in INSTANTIATED state. As a result of the + success of this operation, the NFVO creates a "NS Lifecycle Operation + Occurrence" resource for the request, and the NS instance state remains + INSTANTIATED. + operationId: updateNSinstance + requestBody: + $ref: '#/components/requestBodies/UpdateNsRequest' + responses: + '202': + description: Accepted + headers: + Location: + description: | + It must point to the new "NS Lifecycle Operation Occurrence" + resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}" + schema: + type: string + format: uri + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' + '/nslcm/v1/ns_instances/{nsInstanceId}/verticalscale': + parameters: + - name: nsInstanceId + in: path + required: true + description: NS Instance ID + schema: + type: string + post: + tags: + - "NS instances" + summary: Vertical scale a NS instance + description: + Execute an verticalscale on a NS instance. + The NS instance must have been created and must be in INSTANTIATED state. + operationId: verticalscaleNSinstance + requestBody: + $ref: '#/components/requestBodies/VerticalscaleNsRequest' + responses: + '202': + description: Accepted + headers: + Location: + description: | + It must point to the new "NS Lifecycle Operation Occurrence" + resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}" + schema: + type: string + format: uri + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' '/nslcm/v1/ns_instances_content': get: tags: @@ -2058,6 +2223,49 @@ paths: $ref: '#/components/responses/UnexpectedError' default: $ref: '#/components/responses/UnexpectedError' + '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel': + parameters: + - name: nsLcmOpOccId + in: path + required: true + description: NS LCM Operation Occurrence ID + schema: + type: string + post: + tags: + - "NS instances" + summary: Cancel an ongoing NS lifecycle management operation + description: Cancel an ongoing NS lifecycle management operation while it is being executed or rolled back + operationId: cancelNSLCMOpOcc + requestBody: + $ref: '#/components/requestBodies/CancelNSLCMOpOccRequest' + responses: + '202': + description: Accepted + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' '/nslcm/v1/vnf_instances': get: tags: @@ -6990,6 +7198,28 @@ components: Flag to indicate whether or not to run day1 primitives for the VDU (default: false). type: boolean default: false + NSinstanceMigrateRequest: + description: > + This type represents request parameters for the "Migrate" operation. This operation supports the migration of an NS + instance by migrating one or more of the VDUs that are part of this NS. + type: object + properties: + vnfInstanceId: + type: string + migrateToHost: + type: string + vdu: + type: object + properties: + vduId: + type: string + vduCountIndex: + type: integer + required: + - vduId + required: + - vnfInstanceId + additionalProperties: false TerminateNsRequest: type: object properties: @@ -7036,6 +7266,103 @@ components: - primitive - primitive_params additionalProperties: false + UpdateNsRequest: + description: > + This type represents request parameters for the "Update NS" operation. This operation supports the update of an NS + instance by updating one or more of the VNFs that are part of this NS. + type: object + properties: + updateType: + type: string + enum: + - CHANGE_VNFPKG + - REMOVE_VNF + - MODIFY_VNF_INFORMATION + - OPERATE_VNF + changeVnfPackageData: + type: object + properties: + vnfInstanceId: + type: string + vnfdId: + type: string + required: + - vnfInstanceId + - vnfdId + removeVnfInstanceId: + type: string + modifyVnfInfoData: + type: object + properties: + vnfInstanceId: + type: string + vnfdId: + type: string + required: + - vnfInstanceId + - vnfdId + operateVnfData: + type: object + properties: + vnfInstanceId: + type: string + changeStateTo: + type: string + additionalParam: + type: object + properties: + run-day1: + type: boolean + vdu_id: + type: string + count-index: + type: number + required: + - vdu_id + - count-index + required: + - vnfInstanceId + - changeStateTo + additionalProperties: false + required: + - updateType + additionalProperties: false + VerticalscaleNsRequest: + description: > + This type represents request parameters for the "Vertical Scale NS" operation. + This operation supports the vertical scale of an NS instance by verticalscaling + one or more of the VNFs that are part of this NS. + type: object + properties: + verticalScale: + type: string + changeVnfFlavorData: + type: object + properties: + vnfInstanceId: + type: string + format: uuid + additionalParams: + type: object + properties: + vduid: + type: string + format: uuid + vduCountIndex: + type: integer + virtualMemory: + type: integer + sizeOfStorage: + type: integer + numVirtualCpu: + type: integer + required: + - vnfInstanceId + - additionalParams + additionalProperties: false + required: + - verticalScale + additionalProperties: false # CreateNSinstanceContentRequest: # Substituted by InstantiateNsRequest CreateNSinstanceContentResponse: @@ -7649,6 +7976,8 @@ components: type: string admin: type: boolean + admin_show: + type: boolean project_id: type: string format: uuid @@ -7662,6 +7991,13 @@ components: issued_at: type: number format: float + user_show: + type: boolean + last_login: + type: number + format: float + login_count: + type: number expires: type: number format: float @@ -7799,6 +8135,15 @@ components: type: string password: type: string + old_password: + type: string + system_admin_id: + type: string + format: uuid + unlock: + type: boolean + renew: + type: boolean projects: oneOf: - $ref: '#/components/schemas/ShortNameList' @@ -8090,6 +8435,9 @@ components: config: type: object additionalProperties: true + prometheus-config: + type: object + additionalProperties: true resources: type: object required: @@ -8125,6 +8473,9 @@ components: vca: type: string format: uuid + prometheus-config: + type: object + additionalProperties: true config: type: object additionalProperties: true @@ -8432,7 +8783,16 @@ components: type: array items: type: object - additionalProperties: true + additionalProperties: false + K8sClusterDeploymentMethods: + type: object + properties: + juju-bundle: + type: boolean + helm-chart-v3: + type: boolean + additionalProperties: false + minProperties: 3 K8sClusterInfo: type: object properties: @@ -8458,6 +8818,8 @@ components: type: string nets: $ref: '#/components/schemas/K8sClusterNetList' + deployment_methods: + $ref: '#/components/schemas/K8sClusterDeploymentMethods' namespace: type: string cni: @@ -8672,6 +9034,16 @@ components: key-file: type: string description: identify HTTPS client using this SSL key file + oci: + type: boolean + default: false + description: > + Flag to indicate whether or not it is an OCI-enabled repo (default: false) + required: + - name + - type + - url + additionalProperties: false ArrayOfK8sRepoInfo: type: array items: @@ -8859,6 +9231,14 @@ components: $ref: '#/components/schemas/Authenticationschema' required: - CallbackUri + CancelNSLCMOpOccRequest: + type: object + properties: + cancelMode: + type: string + enum: + - GRACEFUL + - FORCEFUL # END SCHEMAS requestBodies: @@ -8940,6 +9320,14 @@ components: application/yaml: schema: $ref: '#/components/schemas/HealNsRequest' + NSinstanceMigrateRequest: + content: + application/json: + schema: + $ref: '#/components/schemas/NSinstanceMigrateRequest' + application/yaml: + schema: + $ref: '#/components/schemas/NSinstanceMigrateRequest' ScaleNsRequest: content: application/json: @@ -8956,6 +9344,22 @@ components: application/yaml: schema: $ref: '#/components/schemas/TerminateNsRequest' + UpdateNsRequest: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateNsRequest' + application/yaml: + schema: + $ref: '#/components/schemas/UpdateNsRequest' + VerticalscaleNsRequest: + content: + application/json: + schema: + $ref: '#/components/schemas/VerticalscaleNsRequest' + application/yaml: + schema: + $ref: '#/components/schemas/VerticalscaleNsRequest' # CreateNSinstanceContentRequest: # Substituted by InstantiateNsRequest CreateNstInfoRequest: @@ -9180,6 +9584,14 @@ components: application/yaml: schema: $ref: '#/components/schemas/NslcmSubscriptionRequest' + CancelNSLCMOpOccRequest: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelNSLCMOpOccRequest' + application/yaml: + schema: + $ref: '#/components/schemas/CancelNSLCMOpOccRequest' # END REQUEST BODIES securitySchemes: