Zededa VolumeInstanceConfiguration API

swagger: '2.0'
info:
  title: ZEDEDA App Profiles Service AppProfileService VolumeInstanceConfiguration API
  description: The ZEDEDA App Profiles Service is part of ZEDEDA Edge Orchestration Platform. This service enables customers to define their app profiles on ZEDEDA platform and to manage them remotely.
  termsOfService: https://www.zededa.com/terms
  version: '1.0'
  contact:
    name: ZEDEDA API Support
    url: https://www.zededa.com/support
    email: support@zededa.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
basePath: /api
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- BearerToken: []
tags:
- name: VolumeInstanceConfiguration
paths:
  /v1/volumes/instances:
    get:
      summary: Query edge volume instances
      description: Query the edge volume instance records.
      operationId: VolumeInstanceConfiguration_QueryVolumeInstances
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/VolInstList'
        '400':
          description: Bad Request. The API gateway did not process the request because of invalid value of filter parameters.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: summary
        in: query
        required: false
        type: boolean
      - name: deviceName
        in: query
        required: false
        type: string
      - name: projectName
        in: query
        required: false
        type: string
      - name: namePattern
        in: query
        required: false
        type: string
      - name: labelName
        in: query
        required: false
        type: string
      - name: appInstName
        in: query
        required: false
        type: string
      - name: deviceNamePattern
        in: query
        required: false
        type: string
      - name: projectNamePattern
        in: query
        required: false
        type: string
      - name: next.pageToken
        description: Page Token
        in: query
        required: false
        type: string
      - name: next.orderBy
        description: OrderBy helps in sorting the list response
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: next.pageNum
        description: Page Number
        in: query
        required: false
        type: number
        format: int64
      - name: next.pageSize
        description: Defines the page size
        in: query
        required: false
        type: number
        format: int64
      - name: next.totalPages
        description: Total number of pages to be fetched.
        in: query
        required: false
        type: number
        format: int64
      - name: fields
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - VolumeInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
    post:
      summary: Create edge volume instance
      description: Create an edge volume instance record.
      operationId: VolumeInstanceConfiguration_CreateVolumeInstance
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '400':
          description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '409':
          description: Conflict. The API gateway did not process the request because this edge volume instance record will conflict with an already existing edge volume instance record.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/VolInstConfig'
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - VolumeInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
  /v1/volumes/instances/id/{id}:
    get:
      summary: Get edge volume instance
      description: Get the configuration (without security details) of an edge volume instance record.
      operationId: VolumeInstanceConfiguration_GetVolumeInstance
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/VolInstConfig'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: id
        in: path
        required: true
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - VolumeInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
    delete:
      summary: Delete volume instance
      description: Delete a volume instance record.
      operationId: VolumeInstanceConfiguration_DeleteVolumeInstance
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: id
        in: path
        required: true
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - VolumeInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
    put:
      summary: Update edge volume instance
      description: Update an edge volume instance. The usual pattern to update an edge volume instance record is to retrieve the record and update with the modified values in a new body to update the edge volume instance record.
      operationId: VolumeInstanceConfiguration_UpdateVolumeInstance
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '409':
          description: Conflict. The API gateway did not process the request because this operation will conflict with an already existing edge volume instance record.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: id
        in: path
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/VolInstConfigUpdate_HttpRequest'
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - VolumeInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
  /v1/volumes/instances/name/{name}:
    get:
      summary: Get edge volume instance
      description: Get the configuration (without security details) of an edge volume instance record.
      operationId: VolumeInstanceConfiguration_GetVolumeInstanceByName
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/VolInstConfig'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: name
        in: path
        required: true
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - VolumeInstanceConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
definitions:
  ZcOpsType:
    type: string
    enum:
    - OPS_TYPE_UNSPECIFIED
    - OPS_TYPE_READ
    - OPS_TYPE_DELETE
    - OPS_TYPE_CREATE
    - OPS_TYPE_UPDATE
    - OPS_TYPE_LIST
    default: OPS_TYPE_UNSPECIFIED
    title: ZedCloud internal operation type
  ObjectType:
    type: string
    enum:
    - OBJECT_TYPE_UNSPECIFIED
    - OBJECT_TYPE_USER
    - OBJECT_TYPE_EDGE_NODE
    - OBJECT_TYPE_EDGE_APP
    - OBJECT_TYPE_IMAGE
    - OBJECT_TYPE_EDGE_APP_INSTANCE
    - OBJECT_TYPE_PROJECT
    - OBJECT_TYPE_NETWORK
    - OBJECT_TYPE_DATASTORE
    - OBJECT_TYPE_SERVICE
    - OBJECT_TYPE_SERVICE_INSTANCE
    - OBJECT_TYPE_ENTERPRISE
    - OBJECT_TYPE_ROLE
    - OBJECT_TYPE_CREDENTIAL
    - OBJECT_TYPE_NETWORK_INSTANCE
    - OBJECT_TYPE_VOLUME_INSTANCE
    - OBJECT_TYPE_REALM
    - OBJECT_TYPE_AUTHPROFILE
    - OBJECT_TYPE_POLICY
    - OBJECT_TYPE_APP_POLICY
    - OBJECT_TYPE_CLUSTER_INSTANCE
    - OBJECT_TYPE_PLUGIN
    - OBJECT_TYPE_DOC_POLICY
    - OBJECT_TYPE_ORCHESTRATOR_CLUSTER
    - OBJECT_TYPE_TAGS
    - OBJECT_TYPE_EDGE_NODE_INTERFACE
    - OBJECT_TYPE_DEPLOYMENT
    - OBJECT_TYPE_ENTITLEMENTS
    - OBJECT_TYPE_DATA_STREAM
    - OBJECT_TYPE_API_USAGE
    - OBJECT_TYPE_APP_INSTANCE_SNAPSHOT
    - OBJECT_TYPE_PATCH_ENVELOPE
    - OBJECT_TYPE_RESOURCE_USAGE_TRACK
    - OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE
    - OBJECT_TYPE_DEV_PASSTHROUGH
    - OBJECT_TYPE_EDGE_NODE_CLUSTER
    - OBJECT_TYPE_ASSET_GROUP
    - OBJECT_TYPE_APP_PROFILE
    - OBJECT_TYPE_PROFILE_DEPLOYMENT
    - OBJECT_TYPE_ZKS_INSTANCE
    - OBJECT_TYPE_CLUSTER_GROUP
    default: OBJECT_TYPE_UNSPECIFIED
  Summary:
    type: object
    properties:
      description:
        type: string
        description: Summary description
      total:
        type: number
        format: int64
        description: Total
      values:
        type: object
        additionalProperties:
          type: integer
          format: int64
        description: 'Values: Map for storing <string, uint32>'
    description: Summary is used to store the Summary details
    title: Summary is used to store the Summary details
  protobufAny:
    type: object
    properties:
      typeUrl:
        type: string
      value:
        type: string
        format: byte
  Cursor:
    type: object
    properties:
      pageToken:
        type: string
        description: Page Token
      orderBy:
        type: array
        items:
          type: string
        description: OrderBy helps in sorting the list response
      pageNum:
        type: number
        format: int64
        description: Page Number
      pageSize:
        type: number
        format: int64
        description: Defines the page size
      totalPages:
        type: number
        format: int64
        description: Total number of pages to be fetched.
    description: 'Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc. '
    title: Cursor is used as filter in list operation.
  VolumeInstanceType:
    type: string
    enum:
    - VOLUME_INSTANCE_TYPE_UNSPECIFIED
    - VOLUME_INSTANCE_TYPE_EMPTYDIR
    - VOLUME_INSTANCE_TYPE_BLOCKSTORAGE
    - VOLUME_INSTANCE_TYPE_HOSTFS
    - VOLUME_INSTANCE_TYPE_TMPFS
    - VOLUME_INSTANCE_TYPE_SECRET
    - VOLUME_INSTANCE_TYPE_NFS
    - VOLUME_INSTANCE_TYPE_AWS_BLOCK_STORAGE
    - VOLUME_INSTANCE_TYPE_CONTENT_TREE
    default: VOLUME_INSTANCE_TYPE_UNSPECIFIED
    title: VolumeInstanceType - On update, please update VolumeInstanceType_HttpRequest as well
  ObjectRevision:
    type: object
    properties:
      prev:
        type: string
        description: Previous
      curr:
        type: string
        description: Current Database version of the record
      createdAt:
        type: object
        format: date-time
        description: The time, in milliseconds since the epoch, when the record was created.
      createdBy:
        type: string
        description: 'User data: Created By'
      updatedAt:
        type: object
        format: date-time
        description: The time, in milliseconds since the epoch, when the record was last updated.
      updatedBy:
        type: string
        description: 'User data: Updated By'
    description: ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
    title: ObjectRevision is used to store the user information.
    required:
    - curr
    - createdAt
    - createdBy
    - updatedAt
    - updatedBy
  VolumeInstanceAccessMode:
    type: string
    enum:
    - VOLUME_INSTANCE_ACCESS_MODE_INVALID
    - VOLUME_INSTANCE_ACCESS_MODE_READWRITE
    - VOLUME_INSTANCE_ACCESS_MODE_READONLY
    - VOLUME_INSTANCE_ACCESS_MODE_MULTIREAD_SINGLEWRITE
    default: VOLUME_INSTANCE_ACCESS_MODE_INVALID
  ZcOpsStatus:
    type: string
    enum:
    - OPS_STATUS_UNSPECIFIED
    - OPS_STATUS_PENDING
    - OPS_STATUS_ONGOING
    - OPS_STATUS_COMPLETE
    default: OPS_STATUS_UNSPECIFIED
    description: "- OPS_STATUS_PENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING\n - OPS_STATUS_ONGOING: system will start the operation, but at the time response was generated, operation is still ONGOING.\n - OPS_STATUS_COMPLETE: Even if the result of the operations may result in failure, but the OpsStatus will marked COMPLETE for almost all cases."
    title: ZedCloud internal operation status
  ZedCloudOpsCmd:
    type: object
    properties:
      counter:
        type: number
        format: int64
        description: counter
      opsTime:
        type: object
        format: date-time
        description: 'Timestamp: Operational time'
    description: Zed cloud Operation command
    title: Zed cloud Operation command
  VolInstConfig:
    type: object
    properties:
      id:
        type: string
        description: System defined universally unique Id of the volume instance.
        readOnly: true
        pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}'
        uniqueItems: true
      name:
        type: string
        description: User defined name of the volume instance, unique across the enterprise. Once object is created, name can’t be changed.
        maxLength: 256
        minLength: 3
        pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+'
        uniqueItems: true
      title:
        type: string
        description: User defined title of the volume instance. Title can be changed at any time.
        maxLength: 256
        minLength: 3
        pattern: '[a-zA-Z0-9]+[a-zA-Z0-9!-~ ]+'
      description:
        type: string
        description: Detailed description of the volume instance.
        maxLength: 256
      revision:
        $ref: '#/definitions/ObjectRevision'
        description: system defined Revision info of the object
        readOnly: true
      projectId:
        type: string
        description: id of the project in which the volume instance is created
      type:
        type: string
        $ref: '#/definitions/VolumeInstanceType'
        description: type of Volume Instance
      deviceId:
        type: string
        description: id of the device on which volume instance is created
      multiattach:
        type: boolean
        description: flag to enable the volume to be attached to multiple app instances
      cleartext:
        type: boolean
        description: flag to keep the contents of the volume unencrypted (in clear text)
      accessmode:
        type: string
        $ref: '#/definitions/VolumeInstanceAccessMode'
        description: Access mode
      sizeBytes:
        type: integer
        format: uint64
        description: size of volume
      image:
        type: string
        description: name of the image
      implicit:
        type: boolean
        description: flag to create implicit volumes
      contentTreeId:
        type: string
        description: content tree ID
      label:
        type: string
        description: label
      purge:
        $ref: '#/definitions/ZedCloudOpsCmd'
        description: Purge Counter information
      tags:
        type: object
        additionalProperties:
          type: string
        description: Tags are name/value pairs that enable you to categorize resources. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3.
        maxLength: 32
        pattern: ^[^<%&?/\>]+$
      patchartifactvolume:
        type: string
        description: flag to indicate whether volume instance is created for patch envelope external artifact
      edgeNodeCluster:
        type: string
        $ref: '#/definitions/VolInstEdgeNodeCluster'
        description: edge node cluster associated with the volume instance
    title: VolInstConfig - On update, please update VolInstConfigUpdate_HttpRequest as well
  VolInstShortConfig:
    type: object
    properties:
      id:
        type: string
      name:
        type: string
      type:
        $ref: '#/definitions/VolumeInstanceType'
      deviceId:
        type: string
      projectId:
        type: string
  VolInstConfigUpdate_HttpRequest:
    type: object
    properties:
      id:
        type: string
        description: System defined universally unique Id of the volume instance.
        pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}'
        uniqueItems: true
      name:
        type: string
        description: User defined name of the volume instance, unique across the enterprise. Once object is created, name can’t be changed.
        maxLength: 256
        minLength: 3
        pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+'
        uniqueItems: true
      title:
        type: string
        description: User defined title of the volume instance. Title can be changed at any time.
        maxLength: 256
        minLength: 3
        pattern: '[a-zA-Z0-9]+[a-zA-Z0-9!-~ ]+'
      description:
        type: string
        description: Detailed description of the volume instance.
        maxLength: 256
      revision:
        $ref: '#/definitions/ObjectRevision'
        description: system defined Revision info of the object
        readOnly: true
      projectId:
        type: string
        description: id of the project in which the volume instance is created
      type:
        type: string
        $ref: '#/definitions/VolumeInstanceType'
        description: type of Volume Instance
      deviceId:
        type: string
        description: id of the device on which volume instance is created
      multiattach:
        type: boolean
        description: flag to enable the volume to be attached to multiple app instances
      cleartext:
        type: boolean
        description: flag to keep the contents of the volume unencrypted (in clear text)
      accessmode:
        type: string
        $ref: '#/definitions/VolumeInstanceAccessMode'
        description: Access mode
      sizeBytes:
        type: integer
        format: uint64
        description: size of volume
      image:
        type: string
        description: name of the image
      implicit:
        type: boolean
        description: flag to create implicit volumes
      contentTreeId:
        type: string
        description: content tree ID
      label:
        type: string
        description: label
      purge:
        $ref: '#/definitions/ZedCloudOpsCmd'
        description: Purge Counter information
      tags:
        type: object
        additionalProperties:
          type: string
        description: Tags are name/value pairs that enable you to categorize resources. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3.
        maxLength: 32
        pattern: ^[^<%&?/\>]+$
      patchartifactvolume:
        type: string
        description: flag to indicate whether volume instance is created for patch envelope external artifact
      edgeNodeCluster:
        type: string
        $ref: '#/definitions/VolInstEdgeNodeCluster'
        description: edge node cluster associated with the volume instance
    title: VolInstConfigUpdate_HttpRequest - Only for swagger documentation
  ZsrvError:
    type: object
    properties:
      ec:
        $ref: '#/definitions/ZsrvErrorCode'
        title: 'Enumrated error code, describes more granular numerical

          value than just httpStatus'
      location:
        type: string
        title: 'Ignore: Internal field only'
      details:
        type: string
        title: Field captures string description of details
  googlerpcStatus:
    type: object
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/protobufAny'
  VolInstList:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/VolInstShortConfig'
      cfgList:
        type: array
        items:
          $ref: '#/definitions/VolInstConfig'
      summaryByType:
        $ref: '#/definitions/Summary'
      next:
        $ref: '#/definitions/Cursor'
  VolInstEdgeNodeCluster:
    type: object
    properties:
      id:
        type: string
        description: edge node cluster ID
      designatedNodeID:
        type: string
        description: designated node ID
  ZsrvResponse:
    type: object
    properties:
      operationType:
        $ref: '#/definitions/ZcOpsType'
        title: "Describes one of the operations type : possible values\n                        Read/Delete/Create/Update/List"
      operationStatus:
        $ref: '#/definitions/ZcOpsStatus'
        title: if this is log running job
      objectKind:
        type: string
        title: zedcloud object kind on which the operation was performed
      objectId:
        type: string
        title: Unique value identifies the object that was operated on
      objectName:
        type: string
        title: name of the object
      objectRevision:
        type: string
        title: 'object revision post the operation, note Read operation

          doesn''t change the revision'
      objectType:
        $ref: '#/definitions/ObjectType'
      operationTime:
        type: string
        title: time of operation
      startTime:
        type: string
        title: total time taken by operations
      endTime:
        type: string
      user:
        type: string
        title: the operation is performed on behalf of this user
      httpStatusCode:
        type: integer
        format: int32
        title: http response
      httpStatusMsg:
        type: string
        title: summary of the error in text format
      jobId:
        type: string
        title: for tracking asynchronous tasks
      error:
        type: array
        items:
          $ref: '#/definitions/ZsrvError'
        title: 'one or more errors will be set if the operation failed

          i.e. httpStatusCode != 2xx'
  ZsrvErrorCode:
    type: string
    enum:
    - zMsgErrorNone
    - zMsgSucess
    - NotFound
    - AlreadyExists
    - VersionMismatch
    - RangeError
    - LargeResult
    - IncompleteData
    - InvalidData
    - FunctionUnsupported
    - NoMemory
    - SendFailure
    - Timeout
    - BadReqBody
    - BadReqParam
    - InvalidFieldFormat
    - UrlNotFound
    - ApiVersionNotSupported
    - Unauthorized
    - Forbidden
    - Conflict
    - NotModified
    - DependencyConflict
    - JsonFmtError
    - ProtoFmtError
    - CertError
    - DataBaseConnection
    - DBError
    - zMsgAccepted
    - zMsgCreated
    - PreConditionFailed
    - InternalServerError
    default: zMsgErrorNone
    description: "- zMsgErrorNone: common validation errors\n - IncompleteData: message had fields that weren't filled in\n - InvalidData: message contained the field that wasn't expected\n - FunctionUnsupported: this feature un

# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zededa/refs/heads/main/openapi/zededa-volumeinstanceconfiguration-api-openapi.yml