- type: string
- responses:
- default:
- description: successful operation
-definitions:
- Allocate3gppService:
- description: This describes the request body for 3gpp service allocation
- type: object
- properties:
- name:
- description: Name of the service to allocate
- type: string
- modelInvariantUuid:
- description: >-
- Model Invariant UUID corresponding to the service. For E.g : NSST
- Model invariant uuid in case of NSSI creation
- type: string
- modelUuid:
- description: >-
- Model UUID corresponding to the service. For E.g : NSST Model uuid in
- case of NSSI creation
- type: string
- globalSubscriberId:
- type: string
- subscriptionServiceType:
- description: 'Service type for the subscription. For E.G :5G'
- type: string
- networkType:
- description: 'Network type. For E.G :AN/CN/TN'
- type: string
- additionalProperties:
- description: Map of additional properties required for service allocation
- type: object
- DeAllocate3gppService:
- description: This describes the request body for 3gpp service Termination/Deallocation
- type: object
- properties:
- serviceInstanceID:
- description: ID of the service to terminate
- type: string
- globalSubscriberId:
- type: string
- subscriptionServiceType:
- description: 'Service type for the subscription. For E.G :5G'
- type: string
- networkType:
- description: 'Network type. For E.G :AN/CN/TN'
- type: string
- additionalProperties:
- description: Map of additional properties required for service deallocation
- type: object
- Modify3gppService:
- description: This describes the request body for 3gpp service modification
- type: object
- properties:
- name:
- description: Name of the service to modify
- type: string
- serviceInstanceID:
- description: ID of the service to modify
- type: string
- globalSubscriberId:
- type: string
- subscriptionServiceType:
- description: 'Service type for the subscription. For E.G :5G'
- type: string
- networkType:
- description: 'Network type. For E.G :AN/CN/TN'
- type: string
- additionalProperties:
- description: Map of additional properties required for service modification
- type: object
- 3gppServiceActivation:
- description: This describes the request body for 3gpp service activation/deactivation
- type: object
- properties:
- serviceInstanceID:
- description: ID of the service to be activated/deactivated
- type: string
- globalSubscriberId:
- type: string
- subscriptionServiceType:
- description: 'Service type for the subscription. For E.G :5G'
- type: string
- networkType:
- description: 'Network type. For E.G :AN/CN/TN'
- type: string
- additionalProperties:
- description: >-
- Map of additional properties required for service
- activation/deactivation
- type: object
- QuerySubnetCapability:
- description: This describes the subnet capabilities that can be queried
- type: object
- properties:
- subnetTypes:
- type: array
- items:
- $ref: '#/definitions/SubnetTypes'
- SubnetTypes:
- description: This describes allowed subnet types
- type: string
- enum:
- - AN
- - AN_NF
- - CN
- - TN_FH
- - TN_MH
- - TN_BH
- 3gppServiceResponse:
- description: This describes the response for 3gpp services
- type: object
- properties:
- jobId:
- description: Job ID to be used to identify the status of the job
- type: string
- status:
- description: status of the job
- type: string
- statusDescription:
- description: Description on status in case of erroneous response
- type: object
- RetrievingWorkflowResponse:
- description: Response body of fetching workflows using resource target
- type: object
- properties:
- workflowSpecificationList:
- description: List of Workflow specification data
- type: array
- items:
- $ref: '#/definitions/WorkflowSpecification'
- WorkflowSpecification:
- description: This describes workflow specification object
- type: object
- properties:
- artifactInfo:
- description: 'Attributes related to artifact information '
- type: object
- properties:
- artifactType:
- description: Type of the artifact to be queried
- type: string
- artifactUuid:
- description: UUID of the artifact
- type: string
- artifactName:
- description: Name of the artifact
- type: string
- artifactVersion:
- description: Artifact's Version
- type: string
- artifactDescription:
- description: ''
- type: string
- workflowName:
- description: Name of the workflow fetched for the resource type
- type: string
- operationName:
- description: Mapped operation name of the corresponding workflow
- type: string
- workflowSource:
- description: ''
- type: string
- workflowResourceTarget:
- description: Type of Resource mapped against the workflow
- type: string
- ServiceLevelWorkflowExecution:
- description: This describes the request body of service level custom workflow execution
- type: object
- properties:
- requestInfo:
- description: Request object contains source information
- type: object
- properties:
- source:
- description: Name of the sender
- type: string
- suppressRollback:
- description: Enable/disable rollback suppression
- type: boolean
- requestorId:
- description: Id of the sender
- type: string
- modelInfo:
- description: Parameters related to the service model
- type: object
- properties:
- modelType:
- description: Type of the model to be executed
- type: string
- modelInvariantUuid:
- description: Model invariant id corresponding to the service
- type: string
- modelUuid:
- description: Model uuid corresponding to the service
- type: string
- modelVersionId:
- description: Model version of the service instance
- type: string
- modelName:
- description: Name of the service
- type: string
- modelVersion:
- description: Version of the service instance
- type: string
- requestParameters:
- description: User parameter object
- type: object
- properties:
- subscriptionServiceType:
- description: Type of service subscription
- type: string
- subscriberInfo:
- description: Subscriber id information
- type: object
- properties:
- globalSubscriberId:
- description: Id of the subscriber sending the request
- type: string
- project:
- description: Information about the target project name
- type: object
- properties:
- projectName:
- description: Name of the target project
- type: string
- owningEntity:
- description: Object describes the entity details
- type: object
- properties:
- owningEntityId:
- description: Id of the owning Entity
- type: string
- owningEntityName:
- description: Name of the owning Entity
- type: string
- PNFCustomWorkflowExecution:
- description: This describes the request body of PNF custom workflow execution
- type: object
- properties:
- requestInfo:
- description: Request object contains source information
- type: object
- properties:
- source:
- description: Name of the sender
- type: string
- suppressRollback:
- description: Enable/disable rollback suppression
- type: boolean
- requestorId:
- description: Id of the sender
- type: string
- modelInfo:
- description: Parameters related to the service model
- type: object
- properties:
- modelType:
- description: Type of the model to be executed
- type: string
- modelInvariantUuid:
- description: Model invariant id corresponding to the service
- type: string
- modelUuid:
- description: Model uuid corresponding to the service
- type: string
- modelVersionId:
- description: Model version of the service instance
- type: string
- modelName:
- description: Name of the service
- type: string
- modelVersion:
- description: Version of the service instance
- type: string
- requestParameters:
- description: User parameter object
- type: object
- properties:
- subscriptionServiceType:
- description: Type of service subscription
- type: string
- subscriberInfo:
- description: Subscriber id information
- type: object
- properties:
- globalSubscriberId:
- description: Id of the subscriber sending the request
- type: string
- project:
- description: Information about the target project name
- type: object
- properties:
- projectName:
- description: Name of the target project
- type: string
- owningEntity:
- description: Object describes the entity details
- type: object
- properties:
- owningEntityId:
- description: Id of the owning Entity
- type: string
- owningEntityName:
- description: Name of the owning Entity
- type: string
\ No newline at end of file
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PNFCustomWorkflowExecution'
+ required: false
+ responses:
+ default:
+ description: successful operation
+ content: {}
+ x-codegen-request-body-name: body
+components:
+ schemas:
+ Allocate3gppService:
+ type: object
+ properties:
+ name:
+ type: string
+ description: Name of the service to allocate
+ modelInvariantUuid:
+ type: string
+ description: >-
+ Model Invariant UUID corresponding to the service. For E.g : NSST
+ Model invariant uuid in case of NSSI creation
+ modelUuid:
+ type: string
+ description: >-
+ Model UUID corresponding to the service. For E.g : NSST Model uuid
+ in case of NSSI creation
+ globalSubscriberId:
+ type: string
+ subscriptionServiceType:
+ type: string
+ description: Service type for the subscription. For E.G :5G
+ networkType:
+ type: string
+ description: Network type. For E.G :AN/CN/TN
+ additionalProperties:
+ type: object
+ properties: {}
+ description: Map of additional properties required for service allocation
+ description: This describes the request body for 3gpp service allocation
+ DeAllocate3gppService:
+ type: object
+ properties:
+ serviceInstanceID:
+ type: string
+ description: ID of the service to terminate
+ globalSubscriberId:
+ type: string
+ subscriptionServiceType:
+ type: string
+ description: Service type for the subscription. For E.G :5G
+ networkType:
+ type: string
+ description: Network type. For E.G :AN/CN/TN
+ additionalProperties:
+ type: object
+ properties: {}
+ description: Map of additional properties required for service deallocation
+ description: >-
+ This describes the request body for 3gpp service
+ Termination/Deallocation
+ Modify3gppService:
+ type: object
+ properties:
+ name:
+ type: string
+ description: Name of the service to modify
+ serviceInstanceID:
+ type: string
+ description: ID of the service to modify
+ globalSubscriberId:
+ type: string
+ subscriptionServiceType:
+ type: string
+ description: Service type for the subscription. For E.G :5G
+ networkType:
+ type: string
+ description: Network type. For E.G :AN/CN/TN
+ additionalProperties:
+ type: object
+ properties: {}
+ description: Map of additional properties required for service modification
+ description: This describes the request body for 3gpp service modification
+ 3gppServiceActivation:
+ type: object
+ properties:
+ serviceInstanceID:
+ type: string
+ description: ID of the service to be activated/deactivated
+ globalSubscriberId:
+ type: string
+ subscriptionServiceType:
+ type: string
+ description: Service type for the subscription. For E.G :5G
+ networkType:
+ type: string
+ description: Network type. For E.G :AN/CN/TN
+ additionalProperties:
+ type: object
+ properties: {}
+ description: >-
+ Map of additional properties required for service
+ activation/deactivation
+ description: This describes the request body for 3gpp service activation/deactivation
+ QuerySubnetCapability:
+ type: object
+ properties:
+ subnetTypes:
+ type: array
+ items:
+ $ref: '#/components/schemas/SubnetTypes'
+ description: This describes the subnet capabilities that can be queried
+ SubnetTypes:
+ type: string
+ description: This describes allowed subnet types
+ enum:
+ - AN
+ - AN_NF
+ - CN
+ - TN_FH
+ - TN_MH
+ - TN_BH
+ 3gppServiceResponse:
+ type: object
+ properties:
+ jobId:
+ type: string
+ description: Job ID to be used to identify the status of the job
+ status:
+ type: string
+ description: status of the job
+ statusDescription:
+ type: object
+ properties: {}
+ description: Description on status in case of erroneous response
+ description: This describes the response for 3gpp services
+ RetrievingWorkflowResponse:
+ type: object
+ properties:
+ workflowSpecificationList:
+ type: array
+ description: List of Workflow specification data
+ items:
+ $ref: '#/components/schemas/WorkflowSpecification'
+ description: Response body of fetching workflows using resource target
+ WorkflowSpecification:
+ type: object
+ properties:
+ artifactInfo:
+ type: object
+ properties:
+ artifactType:
+ type: string
+ description: Type of the artifact to be queried
+ artifactUuid:
+ type: string
+ description: UUID of the artifact
+ artifactName:
+ type: string
+ description: Name of the artifact
+ artifactVersion:
+ type: string
+ description: Artifact's Version
+ artifactDescription:
+ type: string
+ description: ''
+ workflowName:
+ type: string
+ description: Name of the workflow fetched for the resource type
+ operationName:
+ type: string
+ description: Mapped operation name of the corresponding workflow
+ workflowSource:
+ type: string
+ description: ''
+ workflowResourceTarget:
+ type: string
+ description: Type of Resource mapped against the workflow
+ description: 'Attributes related to artifact information '
+ description: This describes workflow specification object
+ ServiceLevelWorkflowExecution:
+ type: object
+ properties:
+ requestInfo:
+ type: object
+ properties:
+ source:
+ type: string
+ description: Name of the sender
+ suppressRollback:
+ type: boolean
+ description: Enable/disable rollback suppression
+ requestorId:
+ type: string
+ description: Id of the sender
+ description: Request object contains source information
+ modelInfo:
+ type: object
+ properties:
+ modelType:
+ type: string
+ description: Type of the model to be executed
+ modelInvariantUuid:
+ type: string
+ description: Model invariant id corresponding to the service
+ modelUuid:
+ type: string
+ description: Model uuid corresponding to the service
+ modelVersionId:
+ type: string
+ description: Model version of the service instance
+ modelName:
+ type: string
+ description: Name of the service
+ modelVersion:
+ type: string
+ description: Version of the service instance
+ description: Parameters related to the service model
+ requestParameters:
+ type: object
+ properties:
+ subscriptionServiceType:
+ type: string
+ description: Type of service subscription
+ description: User parameter object
+ subscriberInfo:
+ type: object
+ properties:
+ globalSubscriberId:
+ type: string
+ description: Id of the subscriber sending the request
+ description: Subscriber id information
+ project:
+ type: object
+ properties:
+ projectName:
+ type: string
+ description: Name of the target project
+ description: Information about the target project name
+ owningEntity:
+ type: object
+ properties:
+ owningEntityId:
+ type: string
+ description: Id of the owning Entity
+ owningEntityName:
+ type: string
+ description: Name of the owning Entity
+ description: Object describes the entity details
+ description: >-
+ This describes the request body of service level custom workflow
+ execution
+ PNFCustomWorkflowExecution:
+ type: object
+ properties:
+ requestInfo:
+ type: object
+ properties:
+ source:
+ type: string
+ description: Name of the sender
+ suppressRollback:
+ type: boolean
+ description: Enable/disable rollback suppression
+ requestorId:
+ type: string
+ description: Id of the sender
+ description: Request object contains source information
+ modelInfo:
+ type: object
+ properties:
+ modelType:
+ type: string
+ description: Type of the model to be executed
+ modelInvariantUuid:
+ type: string
+ description: Model invariant id corresponding to the service
+ modelUuid:
+ type: string
+ description: Model uuid corresponding to the service
+ modelVersionId:
+ type: string
+ description: Model version of the service instance
+ modelName:
+ type: string
+ description: Name of the service
+ modelVersion:
+ type: string
+ description: Version of the service instance
+ description: Parameters related to the service model
+ requestParameters:
+ type: object
+ properties:
+ subscriptionServiceType:
+ type: string
+ description: Type of service subscription
+ description: User parameter object
+ subscriberInfo:
+ type: object
+ properties:
+ globalSubscriberId:
+ type: string
+ description: Id of the subscriber sending the request
+ description: Subscriber id information
+ project:
+ type: object
+ properties:
+ projectName:
+ type: string
+ description: Name of the target project
+ description: Information about the target project name
+ owningEntity:
+ type: object
+ properties:
+ owningEntityId:
+ type: string
+ description: Id of the owning Entity
+ owningEntityName:
+ type: string
+ description: Name of the owning Entity
+ description: Object describes the entity details
+ description: This describes the request body of PNF custom workflow execution
+ CreateServiceInstanceParamaters:
+ type: object
+ properties:
+ requestDetails:
+ type: object
+ description: Contains data associated with a request
+ properties:
+ requestParameters:
+ type: object
+ description: Contains all the parameters, associated with this request
+ properties:
+ subscriptionServiceType:
+ type: string
+ description: Type of service subscriptions of customer resource
+ userParams:
+ type: array
+ description: Array of data that contains information about Service
+ items:
+ oneOf:
+ - $ref: >-
+ #/components/schemas/CreateServiceInstParamsUserParamsHoming
+ - $ref: >-
+ #/components/schemas/CreateServiceInstParamsUserParamsService
+ aLaCarte:
+ type: boolean
+ description: >-
+ Enable “A La Carte” mode. In this mode, the user creates and
+ submits operations for each object to be created.
+ usePreload:
+ type: boolean
+ description: Special value required to use additional Policy settings
+ modelInfo:
+ type: object
+ description: Contains information about the currently used Service Model model
+ properties:
+ modelInvariantId:
+ type: string
+ description: >-
+ Unique identifier corresponding to the main definition of a
+ model in SDC
+ modelType:
+ type: string
+ description: Type of service model, created in SDC
+ modelName:
+ type: string
+ description: Name of the model, which can change from version to version.
+ modelVersion:
+ type: string
+ description: >-
+ Unique identifier corresponding to one version of a model in
+ SDC
+ modelVersionId:
+ type: string
+ description: The SDC model version for this resource or service model.
+ modelUuid:
+ type: string
+ description: >-
+ Unique identifier corresponding to the main definition of a
+ model in SDC
+ modelInvariantUuid:
+ type: string
+ description: >-
+ Unique identifier corresponding to the main definition of a
+ model in SDC
+ requestInfo:
+ type: object
+ description: Represents some information for the request
+ properties:
+ productFamilyId:
+ type: string
+ description: SDC catalog service type
+ source:
+ type: string
+ description: Determines only the source from whom the request came
+ instanceName:
+ type: string
+ description: Defines the name of the instance to be created
+ suppressRollback:
+ type: boolean
+ description: >-
+ If false – the rollback process will not start if something
+ goes wrong in execution BB. If true - QueryRainyDayTable
+ task will start and make querying policy in table
+ rainy_day_handler_macro
+ requestorId:
+ type: string
+ description: User Id or Application Id, initiating the Assessment
+ subscriberInfo:
+ type: object
+ description: >-
+ Represents the object that groups service instances used by a
+ customer
+ properties:
+ globalSubscriberId:
+ type: string
+ description: >-
+ Global Subscriber Id used across ONAP to uniquely identify
+ subscriber.
+ project:
+ type: object
+ description: Represents the project, which will own the service instance
+ properties:
+ projectName:
+ type: string
+ description: Name of the project deploying a service
+ owningEntity:
+ type: object
+ description: Represents the entity, which will own the service instance
+ properties:
+ owningEntityId:
+ type: string
+ description: UUID of an owning entity
+ owningEntityName:
+ type: string
+ description: Owning entity name
+ CreateServiceInstParamsUserParamsHoming:
+ allOf:
+ - type: object
+ properties:
+ Homing_Solution:
+ type: string
+ description: >-
+ Switches on an optimization service to deploy services
+ automatically across multiple sites and multiple clouds
+ CreateServiceInstParamsUserParamsService:
+ allOf:
+ - type: object
+ properties:
+ service:
+ type: object
+ description: Includes information about all created instances
+ properties:
+ instanceParams:
+ type: array
+ description: Includes a set of specific parameters
+ items:
+ type: object
+ properties: {}
+ instanceName:
+ type: string
+ description: Defines the name of the instance to be created
+ resources:
+ type: object
+ properties:
+ vnfs:
+ type: array
+ description: Contains information about VNF parameters
+ items:
+ type: object
+ properties:
+ modelInfo:
+ type: object
+ description: Contains information about the currently used Service Model model
+ properties:
+ modelInvariantId:
+ type: string
+ description: >-
+ Unique identifier corresponding to the main
+ definition of a model in SDC
+ modelType:
+ type: string
+ description: Type of Service Model, created in SDC
+ modelName:
+ type: string
+ description: >-
+ Name of the model, which can change from
+ version to version.
+ modelVersion:
+ type: string
+ description: >-
+ Unique identifier corresponding to one version
+ of a model in SDC
+ modelVersionId:
+ type: string
+ description: >-
+ The SDC model version for this resource or
+ service model.
+ modelUuid:
+ type: string
+ description: >-
+ Unique identifier corresponding to the main
+ definition of a model in SDC
+ modelInvariantUuid:
+ type: string
+ description: >-
+ Unique identifier corresponding to the main
+ definition of a model in SDC
+ cloudConfiguration:
+ type: object
+ properties:
+ cloudOwner:
+ type: string
+ description: >-
+ Identifies the vendor and cloud name. First
+ part of composite key should be formatted as
+ vendor-cloudname
+ lcpCloudRegionId:
+ type: string
+ description: >-
+ Cloud-owner defined type indicator (Openstack
+ region)
+ tenantId:
+ type: string
+ description: Unique id relative to the cloud-region.
+ platform:
+ type: object
+ description: >-
+ Represents the platform, on which the VNFs/CNFs
+ will run
+ properties:
+ platformName:
+ type: string
+ description: Name of the platform
+ lineOfBusiness:
+ type: object
+ description: >-
+ Represents the business line, owns the VNFs/CNFs
+ instances
+ properties:
+ lineOfBusinessName:
+ type: string
+ description: Name of the line-of-business (product)
+ productFamilyId:
+ type: string
+ description: Define SDC catalog service type
+ instanceName:
+ type: string
+ description: Defines the name of the instance to be created
+ instanceParams:
+ type: array
+ description: Includes a set of specific parameters of instance
+ items:
+ type: object
+ properties: {}
+ vfModules:
+ type: array
+ description: Сontains a set of parameters of VF Modules
+ items:
+ type: object
+ properties:
+ modelInfo:
+ type: object
+ description: Contains information about the currently used Service Model model
+ properties:
+ modelInvariantId:
+ type: string
+ description: >-
+ Unique identifier corresponding to the
+ main definition of a model in SDC
+ modelType:
+ type: string
+ description: Type of service model, created in SDC
+ modelName:
+ type: string
+ description: >-
+ Name of the model, which can change from
+ version to version.
+ modelVersion:
+ type: string
+ description: >-
+ Unique identifier corresponding to one
+ version of a model in SDC
+ modelVersionId:
+ type: string
+ description: >-
+ The SDC model version for this resource
+ or service model.
+ modelUuid:
+ type: string
+ description: >-
+ Unique identifier corresponding to the
+ main definition of a model in SDC
+ modelInvariantUuid:
+ type: string
+ description: >-
+ Unique identifier corresponding to the
+ main definition of a model in SDC
+ instanceName:
+ type: string
+ description: >-
+ Defines the name of the instance to be
+ created
+ instanceParams:
+ type: array
+ description: Includes a set of specific parameters
+ items:
+ type: object
+ properties: {}
+ modelInfo:
+ type: object
+ description: Contains information about the currently used Service Model model
+ properties:
+ modelName:
+ type: string
+ description: >-
+ Name of the model, which can change from
+ version to version.
+ modelVersionId:
+ type: string
+ description: >-
+ Unique identifier corresponding to one
+ version of a model in SDC
+ modelInvariantUuid:
+ type: string
+ description: >-
+ Unique identifier corresponding to the
+ main definition of a model in SDC
+ modelVersion:
+ type: string
+ description: >-
+ The SDC model version for this resource
+ or service model.
+ modelCustomizationId:
+ type: string
+ description: >-
+ Unique generated identifier of a model in SDC