Tessell azure-netapp-service-controller API

openapi: 3.0.3
info:
  title: Tessell APIs activity-center azure-netapp-service-controller API
  contact:
    email: support@tessell.com
    name: Tessell Inc
    url: https://www.tessell.com
  description: Tessell API Documentation
  termsOfService: https://www.tessell.com/terms
  version: '1.0'
servers:
- url: '{server}'
  variables:
    server:
      default: console.tessell.com
tags:
- name: azure-netapp-service-controller
paths:
  /storages/azure-netapp:
    get:
      tags:
      - azure-netapp-service-controller
      summary: Get Azure NetApp(s) available for Provisioning DB services
      operationId: getAzureNetAppsConsumerResponse
      parameters:
      - $ref: '#/components/parameters/subscription-query'
      - $ref: '#/components/parameters/region-query'
      - $ref: '#/components/parameters/azure-netapp-statuses'
      - $ref: '#/components/parameters/azure-netapp-skip-statuses'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/pageOffset'
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureNetAppConsumerResponse'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ApiError:
      type: object
      description: Common error response object for non 2xx responses
      properties:
        code:
          type: string
          description: Status code for the error response
        message:
          type: string
          description: Error message for API response
        resolution:
          type: string
        timestamp:
          type: string
          format: date-time
        contextId:
          type: string
          description: ContextId of API request
        sessionId:
          type: string
          description: SessionId of API request
        tessellErrorCode:
          type: string
          description: Unique error code specific to Tessell
    AzureNetAppConsumerResponse:
      allOf:
      - $ref: '#/components/schemas/apiResponse'
      type: object
      properties:
        response:
          type: array
          items:
            $ref: '#/components/schemas/AzureNetAppConsumerDTO'
    AzureNetAppCapacityPoolServiceLevel:
      type: string
      enum:
      - Standard
      - Premium
      - Ultra
      x-enum-varnames:
      - STANDARD
      - PREMIUM
      - ULTRA
    apiResponse:
      example:
        metadata:
          pagination:
            pageOffset: 0
            pageSize: 6
          records: 1
          timeZone: timeZone
        response: '{}'
      properties:
        metadata:
          $ref: '#/components/schemas/apiMetadata'
        response:
          type: object
      title: ApiResponse
      type: object
    apiPaginationInfo:
      title: apiPaginationInfo
      type: object
      properties:
        pageSize:
          type: integer
          format: int32
        pageOffset:
          type: integer
          format: int32
    cloudType:
      description: Tessell supported cloud types
      type: string
      enum:
      - AWS
      - AZURE
      - GCP
      - OCI
    AzureNetAppStatus:
      enum:
      - AVAILABLE
      - DOWN
      - DELETING
    AzureNetAppConsumerDTO:
      type: object
      description: This is a definition of Azure-NetApp(s) available for Provisioning DB services in Tessell.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          description: The name of the Azure NetApp
        subscription:
          type: string
          description: The name of the subscription
          minLength: 1
          maxLength: 128
        infrastructureInfo:
          $ref: '#/components/schemas/AzureNetAppInfrastructureInfo'
        capacityPoolInfo:
          type: array
          items:
            $ref: '#/components/schemas/AzureNetAppCapacityPoolConsumerDTO'
        status:
          $ref: '#/components/schemas/AzureNetAppStatus'
        dateCreated:
          type: string
          description: Timestamp when the entity was created
          format: date-time
    AzureNetAppInfrastructureInfo:
      type: object
      description: This is definition for Azure NetApp's infrastructure info
      properties:
        cloud:
          $ref: '#/components/schemas/cloudType'
        region:
          type: string
          description: Region of the FSx NetApp File System
        encryptionKey:
          $ref: '#/components/schemas/AzureNetAppEncryptionKeyInfo'
    apiMetadata:
      title: apiMetadata
      type: object
      properties:
        timeZone:
          type: string
        records:
          type: integer
          format: int32
        pagination:
          $ref: '#/components/schemas/apiPaginationInfo'
    AzureNetAppCapacityPoolStatus:
      enum:
      - AVAILABLE
      - DOWN
      - DELETING
    AzureNetAppEncryptionKeySource:
      enum:
      - Microsoft.NetApp
      - Microsoft.KeyVault
      x-enum-varnames:
      - MICROSOFT_NET_APP
      - MICROSOFT_KEY_VAULT
    AzureNetAppCapacityPoolConfigurationInfo:
      properties:
        availableStorage:
          type: integer
          description: Available storage in bytes
          format: int64
          minimum: 0
          default: 0
        availableThroughput:
          type: integer
          description: Available throughput in MiB per second
          format: int32
          minimum: 0
          default: 0
        maxThroughput:
          type: integer
          description: Max throughput in MiB per second
          format: int32
          minimum: 0
          default: 0
        maxStorage:
          type: integer
          description: Max storage in bytes
          format: int64
          minimum: 0
          default: 0
        usedStorage:
          type: integer
          description: Used storage in bytes
          format: int64
          minimum: 0
          default: 0
        serviceLevel:
          $ref: '#/components/schemas/AzureNetAppCapacityPoolServiceLevel'
        qosType:
          $ref: '#/components/schemas/AzureNetAppCapacityPoolQosType'
    AzureNetAppCapacityPoolQosType:
      type: string
      enum:
      - Auto
      - Manual
      x-enum-varnames:
      - AUTO
      - MANUAL
    AzureNetAppEncryptionKeyInfo:
      description: Details of encryption key
      type: object
      properties:
        id:
          type: string
          description: Id of the encryption key
          format: uuid
        name:
          type: string
          description: name of the encryption key
        keyVaultCloudResourceId:
          type: string
          description: name of the encryption key vault in cloud
        keySource:
          $ref: '#/components/schemas/AzureNetAppEncryptionKeySource'
    AzureNetAppCapacityPoolConsumerDTO:
      type: object
      description: This is a definition of Azure-NetApp Capacity Pool(s) available for Provisioning DB services in Tessell.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          minLength: 1
          maxLength: 128
          description: The name of the Azure NetApp Capacity Pool
        status:
          $ref: '#/components/schemas/AzureNetAppCapacityPoolStatus'
        configurations:
          $ref: '#/components/schemas/AzureNetAppCapacityPoolConfigurationInfo'
        dateCreated:
          type: string
          description: Timestamp when the entity was created
          format: date-time
  parameters:
    pageOffset:
      name: page-offset
      in: query
      description: Page offset for get query
      required: false
      schema:
        type: integer
        format: int32
        default: 0
    azure-netapp-statuses:
      name: statuses
      description: Statuses of Azure NetApp to be included
      in: query
      required: false
      schema:
        type: array
        uniqueItems: true
        items:
          $ref: '#/components/schemas/AzureNetAppStatus'
    subscription-query:
      name: subscription
      description: Filter the entities based on cloud-subscription
      in: query
      required: false
      schema:
        type: string
    pageSize:
      name: page-size
      in: query
      description: Page size for get query
      required: false
      schema:
        type: integer
        format: int32
        default: 10
    azure-netapp-skip-statuses:
      name: skip-statuses
      description: Statuses of Azure NetApp to be skipped
      in: query
      required: false
      schema:
        type: array
        uniqueItems: true
        items:
          $ref: '#/components/schemas/AzureNetAppStatus'
    region-query:
      name: region
      description: Filter the entities based on cloud-region
      in: query
      required: false
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer