@itentialopensource/adapter-openstack_glance/report/adapter-openapi.yaml

This adapter integrates with system described as: Openstack Image (Glance) Service

openapi: 3.0.0
info:
  title: Openstack Glance API
  contact: {}
  version: '1.0'
servers:
- url: http://{host}:{port}
  description: Image service (glance) administrative endpoint
  variables:
    host:
      default: localhost
    port:
      default: '9292'
paths:
  /v2/images:
    post:
      tags:
      - Images
      summary: createImage
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#create-image
      operationId: createImage
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ImagesRequest'
        required: false
      responses:
        '201':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - Images
      summary: listImages
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#list-images
      operationId: listImages
      parameters:
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: marker
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: owner
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: protected
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: boolean
      - name: status
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: tag
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: visibility
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: os_hidden
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: boolean
      - name: member_status
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: size_max
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: size_min
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: created_at
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: updated_at
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: sort_dir
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: sort_key
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/images/{image_id}:
    get:
      tags:
      - Images
      summary: showImage
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-image
      operationId: showImage
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - Images
      summary: updateImage
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#update-image
      operationId: updateImage
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/openstack-images-v2.1-json-patch:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/V2ImagesRequest1'
              description: ''
        required: false
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Images
      summary: deleteImage
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#delete-image
      operationId: deleteImage
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/images/{image_id}/tasks:
    get:
      tags:
      - Images
      summary: showTasksAssociatedWithImage
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-tasks-associated-with-image
      operationId: showTasksAssociatedWithImage
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/images/{image_id}/actions/deactivate:
    post:
      tags:
      - Images
      summary: deactivateImage
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#deactivate-image
      operationId: deactivateImage
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/images/{image_id}/actions/reactivate:
    post:
      tags:
      - Images
      summary: reactivateImage
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#reactivate-image
      operationId: reactivateImage
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/images/{image_id}/members:
    post:
      tags:
      - Sharing
      summary: createImageMember
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#create-image-member
      operationId: createImageMember
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ImagesMembersRequest'
        required: false
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - Sharing
      summary: listImageMembers
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#list-image-members
      operationId: listImageMembers
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/images/{image_id}/members/{member_id}:
    get:
      tags:
      - Sharing
      summary: showImageMemberDetails
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-image-member-details
      operationId: showImageMemberDetails
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: member_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Sharing
      summary: updateImageMember
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#update-image-member
      operationId: updateImageMember
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: member_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ImagesMembersRequest1'
        required: false
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Sharing
      summary: deleteImageMember
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#delete-image-member
      operationId: deleteImageMember
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: member_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/images/{image_id}/tags/{tag}:
    put:
      tags:
      - Image tags
      summary: addImageTag
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#add-image-tag
      operationId: addImageTag
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: tag
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Image tags
      summary: deleteImageTag
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#delete-image-tag
      operationId: deleteImageTag
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: tag
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/schemas/images:
    get:
      tags:
      - Image Schemas
      summary: showImagesSchema
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-images-schema
      operationId: showImagesSchema
      parameters: []
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/schemas/image:
    get:
      tags:
      - Image Schemas
      summary: showImageSchema
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-image-schema
      operationId: showImageSchema
      parameters: []
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/schemas/members:
    get:
      tags:
      - Image Schemas
      summary: showImageMembersSchema
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-image-members-schema
      operationId: showImageMembersSchema
      parameters: []
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/schemas/member:
    get:
      tags:
      - Image Schemas
      summary: showImageMemberSchema
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-image-member-schema
      operationId: showImageMemberSchema
      parameters: []
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/images/{image_id}/file:
    put:
      tags:
      - Image data
      summary: uploadBinaryImageData
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#upload-binary-image-data
      operationId: uploadBinaryImageData
      parameters:
      - name: X-Image-Meta-Store
        in: header
        description: ''
        style: simple
        schema:
          type: string
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          enum:
          - application/octet-stream
          type: string
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                body:
                  type: string
                  format: binary
        required: false
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - Image data
      summary: downloadBinaryImageData
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#download-binary-image-data
      operationId: downloadBinaryImageData
      parameters:
      - name: Range
        in: header
        description: ''
        style: simple
        schema:
          type: string
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/images/{image_id}/stage:
    put:
      tags:
      - Interoperable image import
      summary: stageBinaryImageData
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#stage-binary-image-data
      operationId: stageBinaryImageData
      parameters:
      - name: Content-type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/images/{image_id}/import:
    post:
      tags:
      - Interoperable image import
      summary: importAnImage
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#import-an-image
      operationId: importAnImage
      parameters:
      - name: X-Image-Meta-Store
        in: header
        description: ''
        style: simple
        schema:
          type: string
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ImagesImportRequest'
        required: false
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/stores/{store_id}/{image_id}:
    delete:
      tags:
      - Stores
      summary: deleteImageFromStore
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#delete-image-from-store
      operationId: deleteImageFromStore
      parameters:
      - name: store_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/info/import:
    get:
      tags:
      - Image Service Info (Discovery)
      summary: importMethodsAndValuesDiscovery
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#import-methods-and-values-discovery
      operationId: importMethodsAndValuesDiscovery
      parameters: []
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/info/stores:
    get:
      tags:
      - Image Service Info (Discovery)
      summary: listStores
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#list-stores
      operationId: listStores
      parameters: []
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/info/usage:
    get:
      tags:
      - Image Service Info (Discovery)
      summary: quotaUsage
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#quota-usage
      operationId: quotaUsage
      parameters: []
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/info/stores/detail:
    get:
      tags:
      - Image Service Info (Discovery)
      summary: listStoresDetail
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#list-stores-detail
      operationId: listStoresDetail
      parameters: []
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/tasks:
    post:
      tags:
      - Tasks
      summary: createTask
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#create-task
      operationId: createTask
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2TasksRequest'
        required: false
      responses:
        '201':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - Tasks
      summary: listTasks
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#list-tasks
      operationId: listTasks
      parameters:
      - name: limit
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: marker
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: sort_dir
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: sort_key
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: status
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/tasks/{task_id}:
    get:
      tags:
      - Tasks
      summary: showTaskDetails
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-task-details
      operationId: showTaskDetails
      parameters:
      - name: task_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/schemas/tasks:
    get:
      tags:
      - Task Schemas
      summary: showTasksSchema
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-tasks-schema
      operationId: showTasksSchema
      parameters: []
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/schemas/task:
    get:
      tags:
      - Task Schemas
      summary: showTaskSchema
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-task-schema
      operationId: showTaskSchema
      parameters: []
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/cache:
    get:
      tags:
      - Cache Manage
      summary: queryCacheStatus
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#query-cache-status
      operationId: queryCacheStatus
      parameters: []
      responses:
        '200':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Cache Manage
      summary: clearImagesFromCache
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#clear-images-from-cache
      operationId: clearImagesFromCache
      parameters:
      - name: x-image-cache-clear-target
        in: header
        description: ''
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
  /v2/cache/{image_id}:
    put:
      tags:
      - Cache Manage
      summary: queueImage
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#queue-image
      operationId: queueImage
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Cache Manage
      summary: deleteImageFromCache
      description: ''
      externalDocs:
        url: https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#delete-image-from-cache
      operationId: deleteImageFromCache
      parameters:
      - name: image_id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: Request was successful.
          headers: {}
          content: {}
      deprecated: false
components:
  schemas:
    V2ImagesRequest:
      title: V2ImagesRequest
      type: object
      properties:
        container_format:
          type: string
        disk_format:
          type: string
        name:
          type: string
        id:
          type: string
    V2ImagesRequest1:
      title: V2ImagesRequest1
      type: object
      properties:
        op:
          $ref: '#/components/schemas/Op'
        path:
          type: string
        value:
          type: array
          items:
            type: string
          description: ''
    Op:
      title: Op
      enum:
      - replace
      type: string
    V2ImagesMembersRequest:
      title: V2ImagesMembersRequest
      type: object
      properties:
        member:
          type: string
    V2ImagesMembersRequest1:
      title: V2ImagesMembersRequest1
      type: object
      properties:
        status:
          type: string
    V2ImagesImportRequest:
      title: V2ImagesImportRequest
      type: object
      properties:
        method:
          $ref: '#/components/schemas/Method'
        stores:
          type: array
          items:
            type: string
          description: ''
        all_stores_must_succeed:
          type: boolean
        all_stores:
          type: boolean
    Method:
      title: Method
      type: object
      properties:
        name:
          type: string
    V2TasksRequest:
      title: V2TasksRequest
      type: object
      properties:
        type:
          type: string
        input:
          $ref: '#/components/schemas/Input'
    Input:
      title: Input
      type: object
      properties:
        import_from:
          type: string
        import_from_format:
          type: string
        image_properties:
          $ref: '#/components/schemas/ImageProperties'
    ImageProperties:
      title: ImageProperties
      type: object
      properties:
        disk_format:
          type: string
        container_format:
          type: string
  securitySchemes:
    token:
      type: apiKey
      description: Token authentication
      name: X-Auth-Token
      in: header
security:
- token: []
tags:
- name: Images
  description: ''
- name: Sharing
  description: ''
- name: Image tags
  description: ''
- name: Image Schemas
  description: ''
- name: Image data
  description: ''
- name: Interoperable image import
  description: ''
- name: Stores
  description: ''
- name: Image Service Info (Discovery)
  description: ''
- name: Tasks
  description: ''
- name: Task Schemas
  description: ''
- name: Cache Manage
  description: ''
externalDocs:
  description: Openstack Image Service API v2
  url: https://docs.openstack.org/api-ref/image/v2/index.html