swagger-2-v0.0.1.yaml

swagger: '2.0'
info:
  description: Topological Inventory
  version: 0.0.1
  title: Topological Inventory
  contact:
    email: you@your-company.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
securityDefinitions:
  UserSecurity:
    type: basic
security:
- UserSecurity: []
paths:
  "/container_groups":
    get:
      summary: List ContainerGroups
      operationId: listContainerGroups
      description: Returns an array of ContainerGroup objects
      produces:
      - application/json
      responses:
        200:
          description: ContainerGroups array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ContainerGroup"
  "/container_groups/{id}":
    get:
      summary: Show an existing ContainerGroup
      operationId: showContainerGroup
      description: Returns a ContainerGroup object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: ContainerGroup info
          schema:
            "$ref": "#/definitions/ContainerGroup"
        404:
          description: Not found
  "/container_nodes/{id}/container_groups":
    get:
      summary: List ContainerGroups for ContainerNode
      operationId: listContainerNodeContainerGroups
      description: Returns an array of ContainerGroup objects
      produces:
      - application/json
      responses:
        200:
          description: ContainerGroups array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ContainerGroup"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/container_nodes":
    get:
      summary: List ContainerNodes
      operationId: listContainerNodes
      description: Returns an array of ContainerNode objects
      produces:
      - application/json
      responses:
        200:
          description: ContainerNodes array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ContainerNode"
  "/container_nodes/{id}":
    get:
      summary: Show an existing ContainerNode
      operationId: showContainerNode
      description: Returns a ContainerNode object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: ContainerNode info
          schema:
            "$ref": "#/definitions/ContainerNode"
        404:
          description: Not found
  "/container_projects/{id}/container_groups":
    get:
      summary: List ContainerGroups for ContainerProject
      operationId: listContainerProjectContainerGroups
      description: Returns an array of ContainerGroup objects
      produces:
      - application/json
      responses:
        200:
          description: ContainerGroups array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ContainerGroup"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/container_projects/{id}/container_templates":
    get:
      summary: List ContainerTemplates for ContainerProject
      operationId: listContainerProjectContainerTemplates
      description: Returns an array of ContainerTemplate objects
      produces:
      - application/json
      responses:
        200:
          description: ContainerTemplates array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ContainerTemplate"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/container_projects":
    get:
      summary: List ContainerProjects
      operationId: listContainerProjects
      description: Returns an array of ContainerProject objects
      produces:
      - application/json
      responses:
        200:
          description: ContainerProjects array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ContainerProject"
  "/container_projects/{id}":
    get:
      summary: Show an existing ContainerProject
      operationId: showContainerProject
      description: Returns a ContainerProject object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: ContainerProject info
          schema:
            "$ref": "#/definitions/ContainerProject"
        404:
          description: Not found
  "/container_templates":
    get:
      summary: List ContainerTemplates
      operationId: listContainerTemplates
      description: Returns an array of ContainerTemplate objects
      produces:
      - application/json
      responses:
        200:
          description: ContainerTemplates array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ContainerTemplate"
  "/container_templates/{id}":
    get:
      summary: Show an existing ContainerTemplate
      operationId: showContainerTemplate
      description: Returns a ContainerTemplate object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: ContainerTemplate info
          schema:
            "$ref": "#/definitions/ContainerTemplate"
        404:
          description: Not found
  "/endpoints":
    get:
      summary: List Endpoints
      operationId: listEndpoints
      description: Returns an array of Endpoint objects
      produces:
      - application/json
      responses:
        200:
          description: Endpoints array
          schema:
            type: array
            items:
              "$ref": "#/definitions/Endpoint"
    post:
      summary: Create a new Endpoint
      operationId: createEndpoint
      description: Creates a Endpoint object
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - name: body
        in: body
        required: true
        schema:
          "$ref": "#/definitions/Id"
      responses:
        201:
          description: Endpoint info
          schema:
            type: object
            items:
              "$ref": "#/definitions/Endpoint"
  "/endpoints/{id}":
    get:
      summary: Show an existing Endpoint
      operationId: showEndpoint
      description: Returns a Endpoint object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: Endpoint info
          schema:
            "$ref": "#/definitions/Endpoint"
        404:
          description: Not found
    patch:
      summary: Update an existing Endpoint
      operationId: updateEndpoint
      description: Updates a Endpoint object
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        204:
          description: Updated, no content
        404:
          description: Not found
    put:
      summary: Replace an existing Endpoint
      operationId: replaceEndpoint
      description: Replaces a Endpoint object
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        204:
          description: Updated, no content
        404:
          description: Not found
    delete:
      summary: Delete an existing Endpoint
      operationId: deleteEndpoint
      description: Deletes a Endpoint object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        204:
          description: Endpoint deleted
        404:
          description: Not found
  "/orchestration_stacks":
    get:
      summary: List OrchestrationStacks
      operationId: listOrchestrationStacks
      description: Returns an array of OrchestrationStack objects
      produces:
      - application/json
      responses:
        200:
          description: OrchestrationStacks array
          schema:
            type: array
            items:
              "$ref": "#/definitions/OrchestrationStack"
  "/orchestration_stacks/{id}":
    get:
      summary: Show an existing OrchestrationStack
      operationId: showOrchestrationStack
      description: Returns an OrchestrationStack object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: OrchestrationStack info
          schema:
            "$ref": "#/definitions/OrchestrationStack"
        404:
          description: Not found
  "/service_instances":
    get:
      summary: List ServiceInstances
      operationId: listServiceInstances
      description: Returns an array of ServiceInstance objects
      produces:
      - application/json
      responses:
        200:
          description: ServiceInstances array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ServiceInstance"
  "/service_instances/{id}":
    get:
      summary: Show an existing ServiceInstance
      operationId: showServiceInstance
      description: Returns a ServiceInstance object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: ServiceInstance info
          schema:
            "$ref": "#/definitions/ServiceInstance"
        404:
          description: Not found
  "/service_offerings/{id}/service_instances":
    get:
      summary: List ServiceInstances for ServiceOffering
      operationId: listServiceOfferingServiceInstances
      description: Returns an array of ServiceInstance objects
      produces:
      - application/json
      responses:
        200:
          description: ServiceInstances array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ServiceInstance"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/service_offerings/{id}/service_plans":
    get:
      summary: List ServicePlans for ServiceOffering
      operationId: listServiceOfferingServicePlans
      description: Returns an array of ServicePlan objects
      produces:
      - application/json
      responses:
        200:
          description: ServicePlans array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ServicePlan"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/service_offerings":
    get:
      summary: List ServiceOfferings
      operationId: listServiceOfferings
      description: Returns an array of ServiceOffering objects
      produces:
      - application/json
      responses:
        200:
          description: ServiceOfferings array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ServiceOffering"
  "/service_offerings/{id}":
    get:
      summary: Show an existing ServiceOffering
      operationId: showServiceOffering
      description: Returns a ServiceOffering object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: ServiceOffering info
          schema:
            "$ref": "#/definitions/ServiceOffering"
        404:
          description: Not found
  "/service_plans/{id}/service_instances":
    get:
      summary: List ServiceInstances for ServicePlan
      operationId: listServicePlanServiceInstances
      description: Returns an array of ServiceInstance objects
      produces:
      - application/json
      responses:
        200:
          description: ServiceInstances array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ServiceInstance"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/service_plans":
    get:
      summary: List ServicePlans
      operationId: listServicePlans
      description: Returns an array of ServicePlan objects
      produces:
      - application/json
      responses:
        200:
          description: ServicePlans array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ServicePlan"
  "/service_plans/{id}":
    get:
      summary: Show an existing ServicePlan
      operationId: showServicePlan
      description: Returns a ServicePlan object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: ServicePlan info
          schema:
            "$ref": "#/definitions/ServicePlan"
        404:
          description: Not found
  "/service_plans/{id}/order":
    post:
      summary: Order an existing ServicePlan
      operationId: orderServicePlan
      description: Returns a Task id
      consumes:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the ServicePlan to order
        required: true
        type: string
        pattern: '\A\d+\z'
      - name: parameters
        in: body
        description: Extra parameters defining the service and provider control
        schema:
          type: object
          properties:
            service_parameters:
              type: object
              description: JSON object with provisioning parameters
            provider_control_parameters:
              type: object
              description: >-
                The provider specific parameters needed to provision this service.
                This might include namespaces, special keys
      responses:
        200:
          description: Returns a task ID for the order
          schema:
            type: object
            properties:
              task_id:
                type: string
        400:
          description: BadRequest
  "/source_types/{id}/sources":
    get:
      summary: List Sources for SourceType
      operationId: listSourceTypeSources
      description: Returns an array of Source objects
      produces:
      - application/json
      responses:
        200:
          description: Sources array
          schema:
            type: array
            items:
              "$ref": "#/definitions/Source"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/source_types":
    get:
      summary: List SourceTypes
      operationId: listSourceTypes
      description: Returns an array of SourceType objects
      produces:
      - application/json
      responses:
        200:
          description: SourceTypes array
          schema:
            type: array
            items:
              "$ref": "#/definitions/SourceType"
    post:
      summary: Create a new SourceType
      operationId: createSourceType
      description: Creates a SourceType object
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - name: body
        in: body
        required: true
        schema:
          "$ref": "#/definitions/Id"
      responses:
        201:
          description: SourceType info
          schema:
            type: object
            items:
              "$ref": "#/definitions/SourceType"
  "/source_types/{id}":
    get:
      summary: Show an existing SourceType
      operationId: showSourceType
      description: Returns a SourceType object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: SourceType info
          schema:
            "$ref": "#/definitions/SourceType"
        404:
          description: Not found
  "/sources/{id}/container_groups":
    get:
      summary: List ContainerGroups for Source
      operationId: listSourceContainerGroups
      description: Returns an array of ContainerGroup objects
      produces:
      - application/json
      responses:
        200:
          description: ContainerGroups array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ContainerGroup"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/sources/{id}/container_nodes":
    get:
      summary: List ContainerNodes for Source
      operationId: listSourceContainerNodes
      description: Returns an array of ContainerNode objects
      produces:
      - application/json
      responses:
        200:
          description: ContainerNodes array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ContainerNode"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/sources/{id}/container_projects":
    get:
      summary: List ContainerProjects for Source
      operationId: listSourceContainerProjects
      description: Returns an array of ContainerProject objects
      produces:
      - application/json
      responses:
        200:
          description: ContainerProjects array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ContainerProject"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/sources/{id}/container_templates":
    get:
      summary: List ContainerTemplates for Source
      operationId: listSourceContainerTemplates
      description: Returns an array of ContainerTemplate objects
      produces:
      - application/json
      responses:
        200:
          description: ContainerTemplates array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ContainerTemplate"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/sources/{id}/endpoints":
    get:
      summary: List Endpoints for Source
      operationId: listSourceEndpoints
      description: Returns an array of Endpoint objects
      produces:
      - application/json
      responses:
        200:
          description: Endpoints array
          schema:
            type: array
            items:
              "$ref": "#/definitions/Endpoint"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/sources/{id}/orchestration_stacks":
    get:
      summary: List OrchestrationStacks for Source
      operationId: listSourceOrchestrationStacks
      description: Returns an array of OrchestrationStack objects
      produces:
      - application/json
      responses:
        200:
          description: OrchestrationStacks array
          schema:
            type: array
            items:
              "$ref": "#/definitions/OrchestrationStack"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/sources/{id}/service_instances":
    get:
      summary: List ServiceInstances for Source
      operationId: listSourceServiceInstances
      description: Returns an array of ServiceInstance objects
      produces:
      - application/json
      responses:
        200:
          description: ServiceInstances array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ServiceInstance"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/sources/{id}/service_offerings":
    get:
      summary: List ServiceOfferings for Source
      operationId: listSourceServiceOfferings
      description: Returns an array of ServiceOffering objects
      produces:
      - application/json
      responses:
        200:
          description: ServiceOfferings array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ServiceOffering"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/sources/{id}/service_plans":
    get:
      summary: List ServicePlans for Source
      operationId: listSourceServicePlans
      description: Returns an array of ServicePlan objects
      produces:
      - application/json
      responses:
        200:
          description: ServicePlans array
          schema:
            type: array
            items:
              "$ref": "#/definitions/ServicePlan"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/sources/{id}/vms":
    get:
      summary: List Vms for Source
      operationId: listSourceVms
      description: Returns an array of Vm objects
      produces:
      - application/json
      responses:
        200:
          description: Vms array
          schema:
            type: array
            items:
              "$ref": "#/definitions/Vm"
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
  "/sources":
    get:
      summary: List Sources
      operationId: listSources
      description: Returns an array of Source objects
      produces:
      - application/json
      responses:
        200:
          description: Sources array
          schema:
            type: array
            items:
              "$ref": "#/definitions/Source"
    post:
      summary: Create a new Source
      operationId: createSource
      description: Creates a Source object
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - name: body
        in: body
        required: true
        schema:
          "$ref": "#/definitions/Id"
      responses:
        201:
          description: Source info
          schema:
            type: object
            items:
              "$ref": "#/definitions/Source"
  "/sources/{id}":
    get:
      summary: Show an existing Source
      operationId: showSource
      description: Returns a Source object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: Source info
          schema:
            "$ref": "#/definitions/Source"
        404:
          description: Not found
    patch:
      summary: Update an existing Source
      operationId: updateSource
      description: Updates a Source object
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        204:
          description: Updated, no content
        404:
          description: Not found
    put:
      summary: Replace an existing Source
      operationId: replaceSource
      description: Replaces a Source object
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        204:
          description: Updated, no content
        404:
          description: Not found
    delete:
      summary: Delete an existing Source
      operationId: deleteSource
      description: Deletes a Source object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        204:
          description: Source deleted
        404:
          description: Not found
  "/tasks":
    get:
      summary: List Tasks
      operationId: listTasks
      description: Returns an array of Task objects
      produces:
      - application/json
      responses:
        200:
          description: Tasks array
          schema:
            type: array
            items:
              "$ref": "#/definitions/Task"
  "/tasks/{id}":
    get:
      summary: Show an existing Task
      operationId: showTask
      description: Returns a Task object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: Task info
          schema:
            "$ref": "#/definitions/Task"
        404:
          description: Not found
  "/vms":
    get:
      summary: List Vms
      operationId: listVms
      description: Returns an array of Vm objects
      produces:
      - application/json
      responses:
        200:
          description: Vms array
          schema:
            type: array
            items:
              "$ref": "#/definitions/Vm"
  "/vms/{id}":
    get:
      summary: Show an existing Vm
      operationId: showVm
      description: Returns a Vm object
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: ID of the resource to return
        required: true
        type: string
        pattern: '\A\d+\z'
      responses:
        200:
          description: Vm info
          schema:
            "$ref": "#/definitions/Vm"
        404:
          description: Not found
definitions:
  ContainerGroup:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      name:
        type: string
        example: Sample Group
        title: Name
        readOnly: true
      ipaddress:
        type: string
        example: 192.0.2.1
        title: IP Address
        readOnly: true
      source_created_at:
        type: string
        format: date-time
        readOnly: true
      source_deleted_at:
        type: string
        format: date-time
        readOnly: true
      container_node_id:
        type: string
        readOnly: true
        format: uuid
      container_project_id:
        type: string
        readOnly: true
        format: uuid
      source_id:
        type: string
        readOnly: true
        format: uuid
      source_ref:
        type: string
        readOnly: true
        format: uuid
      tenant_id:
        type: string
        readOnly: true
        format: uuid
  ContainerNode:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      name:
        type: string
        example: Sample Group
        title: Name
        readOnly: true
      cpus:
        type: integer
        example: 4
        readOnly: true
      memory:
        type: integer
        example: 4294967296
        readOnly: true
      source_created_at:
        type: string
        format: date-time
        readOnly: true
      source_deleted_at:
        type: string
        format: date-time
        readOnly: true
      source_id:
        type: string
        readOnly: true
        format: uuid
      source_ref:
        type: string
        readOnly: true
        format: uuid
      tenant_id:
        type: string
        readOnly: true
        format: uuid
  ContainerProject:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      name:
        type: string
        example: Sample Project
        title: Name
      display_name:
        type: string
        example: This is a sample display name for a project
        title: Display Name
      source_id:
        type: string
        readOnly: true
        format: uuid
      source_ref:
        type: string
        readOnly: true
        format: uuid
      tenant_id:
        type: string
        readOnly: true
        format: uuid
  ContainerTemplate:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      name:
        type: string
        example: Sample Project
        title: Name
      source_created_at:
        type: string
        format: date-time
        readOnly: true
      source_deleted_at:
        type: string
        format: date-time
        readOnly: true
      source_id:
        type: string
        readOnly: true
        format: uuid
      source_ref:
        type: string
        readOnly: true
        format: uuid
      tenant_id:
        type: string
        readOnly: true
        format: uuid
      container_project_id:
        type: string
        readOnly: true
        format: uuid
  Endpoint:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      default:
        type: boolean
      host:
        type: string
        example: www.example.com
        description: URI host component
      path:
        type: string
        example: "/api/v1"
        description: URI path component
      port:
        type: integer
        minimum: 0
        maximum: 65534
        example: 80
        description: URI port component
      role:
        type: string
        example: default
      scheme:
        type: string
        example: https
        description: URI scheme component
      source_id:
        type: string
        example: '1234567890'
        readOnly: true
        format: uuid
      tenant_id:
        type: string
        readOnly: true
        format: uuid
  Id:
    type: string
    format: uuid
  OrchestrationStack:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      name:
        type: string
        example: Sample OrchestrationStack
        title: Name
        readOnly: true
      description:
        type: string
        description: Description of the OrchestrationStack
        readOnly: true
      source_created_at:
        type: string
        format: date-time
        readOnly: true
      source_deleted_at:
        type: string
        format: date-time
        readOnly: true
      source_id:
        type: string
        readOnly: true
        format: uuid
      source_ref:
        type: string
        readOnly: true
        format: uuid
      tenant_id:
        type: string
        readOnly: true
        format: uuid
  ServiceInstance:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      name:
        type: string
        example: Sample ServiceInstance
        title: Name
      extra:
        type: string
        description: Extra information about this object in JSON format
        readOnly: true
      source_created_at:
        type: string
        format: date-time
        readOnly: true
      source_deleted_at:
        type: string
        format: date-time
        readOnly: true
      service_offering_id:
        type: string
        readOnly: true
        format: uuid
      source_id:
        type: string
        readOnly: true
        format: uuid
      source_ref:
        type: string
        readOnly: true
        format: uuid
      tenant_id:
        type: string
        readOnly: true
        format: uuid
  ServiceOffering:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      name:
        type: string
        example: Sample Provider
        title: Name
      description:
        type: string
        example: This is a sample description for a provider
        title: Description
      source_ref:
        type: string
        example: object-12345_67890
        title: Source reference
        description: The native reference used by the Source to refer to this object
      extra:
        type: string
        description: Extra information about this object in JSON format
        readOnly: true
      source_created_at:
        type: string
        format: date-time
        readOnly: true
      source_deleted_at:
        type: string
        format: date-time
        readOnly: true
      source_id:
        type: string
        readOnly: true
        format: uuid
      tenant_id:
        type: string
        readOnly: true
        format: uuid
  ServicePlan:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      name:
        type: string
        example: Sample Provider
        title: Name
      description:
        type: string
        example: This is a sample description for a provider
        title: Description
      extra:
        type: string
        description: Extra information about this object in JSON format
        readOnly: true
      source_created_at:
        type: string
        format: date-time
        readOnly: true
      source_deleted_at:
        type: string
        format: date-time
        readOnly: true
      source_id:
        type: string
        readOnly: true
        format: uuid
      source_ref:
        type: string
        readOnly: true
        format: uuid
      tenant_id:
        type: string
        readOnly: true
        format: uuid
      service_offering_id:
        type: string
        readOnly: true
        format: uuid
      create_json_schema:
        type: object
        readOnly: true
      update_json_schema:
        type: object
        readOnly: true
  Source:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      source_type_id:
        type: string
        readOnly: true
        format: uuid
      name:
        type: string
        example: Sample Provider
        title: Name
      uid:
        type: string
        readOnly: true
        title: Unique ID of the inventory source installation
      tenant_id:
        type: string
        readOnly: true
        format: uuid
  SourceType:
    type: object
    required:
    - name
    - product_name
    - vendor
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      name:
        type: string
        example: openshift
      product_name:
        type: string
        example: OpenShift
      vendor:
        type: string
        example: Red Hat
  Task:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      name:
        type: string
        example: Order Service Plan
        title: Name
      status:
        type: string
        example: Error
        title: Status
      state:
        type: string
        example: Running
        title: State
      context:
        type: object
        example: Extra information about this task, e.g. new inventory items created by this task
        title: Context
      completed_at:
        type: string
        format: date-time
      tenant_id:
        type: string
        readOnly: true
        format: uuid
  Vm:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        format: uuid
      name:
        type: string
        example: Sample Vm
        title: Name
        readOnly: true
      description:
        type: string
        description: Description of the Vm
        readOnly: true
      source_created_at:
        type: string
        format: date-time
        readOnly: true
      source_deleted_at:
        type: string
        format: date-time
        readOnly: true
      source_id:
        type: string
        readOnly: true
        format: uuid
      source_ref:
        type: string
        readOnly: true
        format: uuid
      tenant_id:
        type: string
        readOnly: true
        format: uuid
host: virtserver.swaggerhub.com
schemes:
- https
- http
basePath: "/api/v0.0"