path: root/dispatcherAPI.yaml

swagger: '2.0'

info:
  version: "3.0.0"
  title:  Dispatcher API
  description: |
    High-level API for deploying/deploying composed services using Cloudify Manager.

# Paths
paths:
  /:
    get:
      description: |
        Get API version information, links to API operations, and location data
        
      responses:

        200:
          description: Success
          schema:
            title: DispatcherInfo
            type: object
            properties:
              apiVersion:
                type: string
                description: |
                  version of API supported by this server
              serverVersion:
                  type: string
                  description: |
                    version of software running on this server
              links:
                type: object
                description: |
                  Links to API resources
                properties:
                  info:
                    type: string
                    description: |
                      path for the server information endpoint
                  events:
                    type: string
                    description: |
                      path for the events endpoint
              locations:
                type: object
                description: |
                  Information about DCAE locations known to this dispatcher
  /events:
    post:
      description: |
        Signal an event that triggers deployment or undeployment of a DCAE service
        
      consumes:
        - application/json
      produces:
        - application/json
        
      parameters:
        - name: dcae_event
          in: body
          schema:
              $ref: "#/definitions/DCAEEvent"
          required: true
  
      responses:
    
        202:
          description: |
            Success:  The content that was posted is valid, the dispatcher has
              found the needed blueprint (for a deploy operation) or the existing deployment
              (for an undeploy operation), and is initiating the necessary orchestration steps.
          schema:
            $ref: "#/definitions/DCAEEventResponse"
            
        400:
          description: |
            Bad request: See the message in the response for details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            
        415:
          description: |
            Bad request: The Content-Type header does not indicate that the content is
            'application/json'
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            
        500:
          description: |
            Problem on the server side.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            
        502:
          description: |
            Error reported to the dispatcher by a downstream system.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            
        504:
          description: |
            Error communicating with a downstream system.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            

  /dcae-deployments:
    get:
      description: |
        List service deployments known to the orchestrator, optionally restricted to a single service type
      
      parameters:
        - name: serviceTypeId
          description: |
            Service type identifier for the type whose deployments are to be listed
          type: string
          in: query
          required: false
        
      responses:

        200:
          description: |
            Success. (Note that if no matching deployments are found, the request is still a success; the
            deployments array is empty in that case.)
          schema: 
            $ref: "#/definitions/DCAEDeploymentsListResponse"

        500:
          description: |
            Problem on the server side.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"                    
        502:
          description: |
            Error reported to the dispatcher by a downstream system.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            
        504:
          description: |
            Error communicating with a downstream system.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
      
  /dcae-deployments/{deploymentId}:
    put:
      description: |
        Request deployment of a DCAE service
        
      consumes:
        - application/json
      produces:
        - application/json
        
      parameters:
        - name: deploymentId
          description: |
            Unique deployment identifier assigned by the API client.
          in: path
          type: string
          required: true
    
        - name: body
          in: body
          schema:
              $ref: "#/definitions/DCAEDeploymentRequest"
          required: true
  
      responses:
    
        202:
          description: |
            Success:  The content that was posted is valid, the dispatcher has
              found the needed blueprint, created an instance of the topology in the orchestrator,
              and started an installation workflow.
          schema:
            $ref: "#/definitions/DCAEDeploymentResponse"
            
        400:
          description: |
            Bad request: See the message in the response for details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            
        409: 
          description: |
            A service with the specified deployment Id already exists.  Using PUT to update the service is not a supported operation.
          schema:
             $ref: "#/definitions/DCAEErrorResponse"
            
        415:
          description: |
            Bad request: The Content-Type header does not indicate that the content is
            'application/json'
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            
        500:
          description: |
            Problem on the server side.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
        
        502:
          description: |
            Error reported to the dispatcher by a downstream system.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            
        504:
          description: |
            Error communicating with a downstream system.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse" 
            
    delete:
      description: |
        Uninstall the DCAE service and remove all associated data from the orchestrator.
        
      parameters:
        - name: deploymentId
          description: |
            Deployment identifier for the service to be uninstalled.
          in: path
          type: string
          required: true
          
      responses:
    
        202:
          description: |
            Success:  The dispatcher has initiated the uninstall operation.
          schema:
            $ref: "#/definitions/DCAEDeploymentResponse"
            
        400:
          description: |
            Bad request: See the message in the response for details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            
        500:
          description: |
            Problem on the server side.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"            

        502:
          description: |
            Error reported to the dispatcher by a downstream system.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            
        504:
          description: |
            Error communicating with a downstream system.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            
  /dcae-deployments/{deploymentId}/operation/{operationId}:
    get:
      description: |
        Get status of a deployment operation
      parameters:
        - name: deploymentId
          in: path
          type: string
          required: true
        - name: operationId
          in: path
          type: string
          required: true
        
      responses:

        200:
          description: Status information retrieved successfully
          schema: 
            $ref: "#/definitions/DCAEOperationStatusResponse"
        
        404: 
          description: The operation information does not exist (possibly because the service has been uninstalled and deleted).
          schema: 
            $ref: "#/definitions/DCAEErrorResponse"
        
        500:
          description: |
            Problem on the server side.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse" 
                    
        502:
          description: |
            Error reported to the dispatcher by a downstream system.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"
            
        504:
          description: |
            Error communicating with a downstream system.  See the message
            in the response for more details.
          schema:
            $ref: "#/definitions/DCAEErrorResponse"


            
          
definitions:

  DCAEEvent:
    description: |
      Data describing an event that should trigger a deploy or undeploy operation for one 
      or more DCAE services.
   
    type: object
    required: [dcae_target_name, dcae_target_type, dcae_service_action, dcae_service_location, event]
    
    properties:
      
      dcae_target_name:
        description: |
          The name of the entity that's the target for monitoring by a DCAE service.  This uniquely identifies the monitoring target.   For 'undeploy' operations, this value will be used to select the specific DCAE service instance to be undeployed.
        type: string

      dcae_target_type:
        description: |
          The type of the entity that's the target for monitoring by a DCAE service.  In 1607, this field will have one of eight distinct values, based on which mobility VM is to
            be monitored.  For 'deploy' operations, this value will be used to select the
            service blueprint to deploy.
        type: string

      dcae_service_action:
        description: |
          Indicates whether the event requires a  DCAE service to be deployed or undeployed.
          Valid values are 'deploy' and 'undeploy'.
        type: string

      dcae_service_location:
        description: |
          The location at which the DCAE service is to be deployed or from which it is to be
          undeployed.
        type: string
      
      dcae_service_type:
        description: |
          Identifier for the service of which the target entity is a part.
        type: string
        
      dcae_service-instance_persona-model-id:
        description: |
          ASDC identifier for the service.
        type: string

      dcae_service-instance_persona-model-version:
        description: |
          ASDC version for the service. (Currently ignored by the dispatcher.)
        type: string
        
      dcae_generic-vnf_persona-model-id:
        description: |
          ASDC identifier for the resource.
        type: string
 
      dcae_generic-vnf_persona-model-version:
        description: |
          ASDC version for the resource. (Currently ignored by the dispatcher.)
        type: string
               
      event:
        description: |
          The original A&AI event object.  
          The data included here is available for populating deployment-specific values in the
          service blueprint.
        type: object

      aai_additional_info:
        description: |
          Additional information, not carried in the event, obtained from an A&AI query or set of queries.  Data in this object is available for populating deployment-specific values in the blueprint.
        type: object
  
  DCAEEventResponse:
    description: |
      Response body for a POST to /events.
      
    type: object
    required: [requestId, deploymentIds]
    
    properties:
      
      requestId:
        description: |
          A unique identifier assigned to the request.  Useful for tracing a request through
          logs.
        type: string
        
      deploymentIds:
        description: |
          An array of deploymentIds, one for each service being deployed in response to this
          event.  A deploymentId uniquely identifies an attempt to deploy a service.
        type: array
        items: 
          type: string
          
  DCAEDeploymentRequest:
    description: |
      Request for deploying a DCAE service.
    type:
      object
    required: [serviceTypeId]
    
    properties:
    
      serviceTypeId:
        description: |
          The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed.
        type: string
        
      inputs:
        description: |
          Object containing inputs needed by the service blueprint to create an instance of the service.
          Content of the object depends on the service being deployed.
        type: object
 
  DCAEDeploymentResponse:
    description: |
      Response body for a PUT or DELETE to /dcae-deployments/{deploymentId}
    type: object
    
    required: [requestId, links]
    
    properties:
      requestId: 
        type: string
        description: |
          Unique identifier for the request
      links:
        description: |
          Links that the API client can access.
        type: object
        properties:
          self:
            type: string
            description: |
              Link used to retrieve information about the service being deployed
          status:
            type: string
            description:
              Link used to retrieve information about the status of the installation workflow
  
  DCAEOperationStatusResponse:
    description: |
      Response body for a request for status of an installation or uninstallation operation.
    type: object
    
    required: [requestId, operationType, status]
    
    properties:
      requestId:
        type: string
        description: |
          A unique identifier assigned to the request.  Useful for tracing a request through logs.  
      operationType:
        description: |
          Type of operation being reported on. ("install" or "uninstall")
        type: string
      status:
        description: |
          Status of the installation or uninstallation operation.  Possible values are "processing",
          "succeeded", and "failed"
        type: string
      error:
        description: |
          If status is "failed", this field will be present and contain additional information about the reason the operation failed.
        type: string
      links: 
        description: |
         If the operation succeeded, links that the client can follow to take further action.  Note that a successful "uninstall" operation removes the DCAE service instance completely, so there are no possible further actions, and no links.
        type: object
        properties:
          self:
            type: string
            description: |
              Link used to retrieve information about the service.  
          uninstall:
            type: string
            description:
              Link used to trigger an "uninstall" operation for the service.  (Use the DELETE method.)        
        
  DCAEErrorResponse:
    description: |
      Object reporting an error.
    type:
      object
    required: [status]
    
    properties:
      status:
        description: HTTP status code for the response
        type: integer
        
      message:
        description: Human-readable description of the reason for the error
        type: string

  DCAEDeploymentsListResponse: 
    description: |
      Object providing a list of deployments
    type: object
    required: [requestId, deployments]
    
    properties:
      requestId:
        type: string
        description: |
          Unique identifier for the request
      deployments:
        type: array
        items:
          type: object
          properties:
            href: 
              type: string
              description: |
                  URL for the service deployment