BentoML deployment revisions API

deployment revisions

OpenAPI Specification

bentoml-deployment-revisions-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: yatai api server admin api v1 deployment revisions API
  description: This is yatai api server.
  version: 1.0.0
tags:
- name: deployment revisions
  description: deployment revisions
paths:
  /api/v1/clusters/{clusterName}/namespaces/{kubeNamespace}/deployments/{deploymentName}/revisions:
    get:
      tags:
      - deployment revisions
      summary: List deployment revisions
      operationId: List deployment revisions
      parameters:
      - name: clusterName
        in: path
        required: true
        schema:
          type: string
      - name: deploymentName
        in: path
        required: true
        schema:
          type: string
      - name: kubeNamespace
        in: path
        required: true
        schema:
          type: string
      - name: count
        in: query
        schema:
          type: integer
          format: int32
      - name: q
        in: query
        schema:
          type: string
      - name: search
        in: query
        schema:
          type: string
          nullable: true
      - name: start
        in: query
        schema:
          type: integer
          format: int32
      - name: X-Yatai-Organization
        in: header
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schemasv1DeploymentRevisionListSchema'
components:
  schemas:
    V1SecretEnvSource:
      type: object
      properties:
        LocalObjectReference:
          $ref: '#/components/schemas/V1LocalObjectReference'
        optional:
          type: boolean
          nullable: true
    ModelschemasDeploymentRoutingSchema:
      type: object
      properties:
        route_by:
          type: string
          nullable: true
        route_type:
          type: string
          nullable: true
        weights:
          type: object
          additionalProperties:
            type: integer
            format: int32
    V1GitRepoVolumeSource:
      type: object
      properties:
        directory:
          type: string
        repository:
          type: string
        revision:
          type: string
    V1LabelSelector:
      type: object
      properties:
        matchExpressions:
          type: array
          items:
            $ref: '#/components/schemas/V1LabelSelectorRequirement'
        matchLabels:
          type: object
          additionalProperties:
            type: string
    V1FlexVolumeSource:
      type: object
      properties:
        driver:
          type: string
        fsType:
          type: string
        options:
          type: object
          additionalProperties:
            type: string
        readOnly:
          type: boolean
        secretRef:
          $ref: '#/components/schemas/V1LocalObjectReference'
    ModelschemasDeploymentTargetResourceItem:
      type: object
      properties:
        cpu:
          type: string
        custom:
          type: object
          additionalProperties:
            type: string
        gpu:
          type: string
        memory:
          type: string
    V1ServiceAccountTokenProjection:
      type: object
      properties:
        audience:
          type: string
        expirationSeconds:
          type: integer
          format: int64
          nullable: true
        path:
          type: string
    V1Affinity:
      type: object
      properties:
        nodeAffinity:
          $ref: '#/components/schemas/V1NodeAffinity'
        podAffinity:
          $ref: '#/components/schemas/V1PodAffinity'
        podAntiAffinity:
          $ref: '#/components/schemas/V1PodAntiAffinity'
    ModelschemasEnvItemSchema:
      type: object
      properties:
        name:
          type: string
        stage:
          type: string
        value:
          type: string
    ModelschemasDeploymentManifest:
      type: object
      properties:
        dev:
          type: boolean
        replicas:
          type: object
          additionalProperties:
            type: integer
            format: int32
        routing:
          $ref: '#/components/schemas/ModelschemasDeploymentRoutingSchema'
        super_admin:
          type: boolean
    V1KeyToPath:
      type: object
      properties:
        key:
          type: string
        mode:
          type: integer
          format: int32
          nullable: true
        path:
          type: string
    V1EmptyDirVolumeSource:
      type: object
      properties:
        medium:
          type: string
        sizeLimit:
          $ref: '#/components/schemas/ResourceQuantity'
    V1PhotonPersistentDiskVolumeSource:
      type: object
      properties:
        fsType:
          type: string
        pdID:
          type: string
    ModelschemasDeploymentTargetHPAConf:
      type: object
      properties:
        max_replicas:
          type: integer
          format: int32
          nullable: true
        min_replicas:
          type: integer
          format: int32
          nullable: true
        policy:
          $ref: '#/components/schemas/ModelschemasHPAPolicy'
    V1ClusterTrustBundleProjection:
      type: object
      properties:
        labelSelector:
          $ref: '#/components/schemas/V1LabelSelector'
        name:
          type: string
          nullable: true
        optional:
          type: boolean
          nullable: true
        path:
          type: string
        signerName:
          type: string
          nullable: true
    ModelschemasHPAPolicy:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/ModelschemasHPAMetric'
        scale_down_behavior:
          type: string
          nullable: true
        scale_down_stabilization_window:
          type: integer
          format: int32
          nullable: true
        scale_up_behavior:
          type: string
          nullable: true
        scale_up_stabilization_window:
          type: integer
          format: int32
          nullable: true
        scaling_strategy:
          type: string
          nullable: true
    V1DownwardAPIProjection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/V1DownwardAPIVolumeFile'
    V1DownwardAPIVolumeFile:
      type: object
      properties:
        fieldRef:
          $ref: '#/components/schemas/V1ObjectFieldSelector'
        mode:
          type: integer
          format: int32
          nullable: true
        path:
          type: string
        resourceFieldRef:
          $ref: '#/components/schemas/V1ResourceFieldSelector'
    V1LabelSelectorRequirement:
      type: object
      properties:
        key:
          type: string
        operator:
          type: string
        values:
          type: array
          items:
            type: string
    ModelschemasDeploymentTargetRunnerConfig:
      type: object
      properties:
        bento_function_overrides:
          $ref: '#/components/schemas/ModelschemasRunnerBentoFunctionOverrides'
        deployment_cold_start_wait_timeout:
          type: integer
          format: int64
          nullable: true
        deployment_strategy:
          type: string
          nullable: true
        enable_debug_mode:
          type: boolean
          nullable: true
        enable_debug_pod_receive_production_traffic:
          type: boolean
          nullable: true
        enable_stealing_traffic_debug_mode:
          type: boolean
          nullable: true
        envs:
          type: array
          items:
            $ref: '#/components/schemas/ModelschemasLabelItemSchema'
        hpa_conf:
          $ref: '#/components/schemas/ModelschemasDeploymentTargetHPAConf'
        resource_instance:
          type: string
          nullable: true
        resources:
          $ref: '#/components/schemas/ModelschemasDeploymentTargetResources'
        secrets:
          type: array
          items:
            type: string
        traffic_control:
          $ref: '#/components/schemas/ModelschemasTrafficControlConfig'
    Schemasv1DeploymentRevisionListSchema:
      type: object
      properties:
        count:
          type: integer
          format: int32
        items:
          type: array
          items:
            type: object
            properties:
              created_at:
                type: string
                format: date-time
              creator:
                type: object
                properties:
                  application_status:
                    type: string
                  avatar_url:
                    type: string
                  created_at:
                    type: string
                    format: date-time
                  deleted_at:
                    type: string
                    format: date-time
                    nullable: true
                  email:
                    type: string
                  first_name:
                    type: string
                  from_sso:
                    type: boolean
                  is_super_admin:
                    type: boolean
                  labels:
                    type: array
                    items:
                      $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                  last_name:
                    type: string
                  name:
                    type: string
                  perm:
                    type: string
                  register_stage:
                    type: string
                  resource_type:
                    type: string
                    enum:
                    - user
                    - organization
                    - cluster
                    - host_cluster
                    - bento_repository
                    - bento
                    - deployment
                    - deployment_revision
                    - model_repository
                    - model
                    - api_token
                  uid:
                    type: string
                  updated_at:
                    type: string
                    format: date-time
              deleted_at:
                type: string
                format: date-time
                nullable: true
              deployment:
                type: object
                properties:
                  cluster:
                    type: object
                    properties:
                      created_at:
                        type: string
                        format: date-time
                      creator:
                        type: object
                        properties:
                          application_status:
                            type: string
                          avatar_url:
                            type: string
                          created_at:
                            type: string
                            format: date-time
                          deleted_at:
                            type: string
                            format: date-time
                            nullable: true
                          email:
                            type: string
                          first_name:
                            type: string
                          from_sso:
                            type: boolean
                          is_super_admin:
                            type: boolean
                          labels:
                            type: array
                            items:
                              $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                          last_name:
                            type: string
                          name:
                            type: string
                          perm:
                            type: string
                          register_stage:
                            type: string
                          resource_type:
                            type: string
                            enum:
                            - user
                            - organization
                            - cluster
                            - host_cluster
                            - bento_repository
                            - bento
                            - deployment
                            - deployment_revision
                            - model_repository
                            - model
                            - api_token
                          uid:
                            type: string
                          updated_at:
                            type: string
                            format: date-time
                      default_deployment_kube_namespace:
                        type: string
                      deleted_at:
                        type: string
                        format: date-time
                        nullable: true
                      description:
                        type: string
                      grafana_root_path:
                        type: string
                      host_cluster_display_name:
                        type: string
                      host_cluster_name:
                        type: string
                      is_first:
                        type: boolean
                      labels:
                        type: array
                        items:
                          $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                      multi_tenancy:
                        type: boolean
                      name:
                        type: string
                      organization_name:
                        type: string
                      provider:
                        type: string
                      resource_type:
                        type: string
                        enum:
                        - user
                        - organization
                        - cluster
                        - host_cluster
                        - bento_repository
                        - bento
                        - deployment
                        - deployment_revision
                        - model_repository
                        - model
                        - api_token
                      uid:
                        type: string
                      updated_at:
                        type: string
                        format: date-time
                  created_at:
                    type: string
                    format: date-time
                  creator:
                    type: object
                    properties:
                      application_status:
                        type: string
                      avatar_url:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      deleted_at:
                        type: string
                        format: date-time
                        nullable: true
                      email:
                        type: string
                      first_name:
                        type: string
                      from_sso:
                        type: boolean
                      is_super_admin:
                        type: boolean
                      labels:
                        type: array
                        items:
                          $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                      last_name:
                        type: string
                      name:
                        type: string
                      perm:
                        type: string
                      register_stage:
                        type: string
                      resource_type:
                        type: string
                        enum:
                        - user
                        - organization
                        - cluster
                        - host_cluster
                        - bento_repository
                        - bento
                        - deployment
                        - deployment_revision
                        - model_repository
                        - model
                        - api_token
                      uid:
                        type: string
                      updated_at:
                        type: string
                        format: date-time
                  deleted_at:
                    type: string
                    format: date-time
                    nullable: true
                  description:
                    type: string
                  distributed:
                    type: boolean
                  kube_namespace:
                    type: string
                  labels:
                    type: array
                    items:
                      $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                  manifest:
                    $ref: '#/components/schemas/ModelschemasDeploymentManifest'
                  mode:
                    type: string
                    nullable: true
                  name:
                    type: string
                  resource_type:
                    type: string
                    enum:
                    - user
                    - organization
                    - cluster
                    - host_cluster
                    - bento_repository
                    - bento
                    - deployment
                    - deployment_revision
                    - model_repository
                    - model
                    - api_token
                  status:
                    type: string
                    enum:
                    - unknown
                    - non-deployed
                    - running
                    - unhealthy
                    - failed
                    - deploying
                  uid:
                    type: string
                  updated_at:
                    type: string
                    format: date-time
                  updater:
                    type: object
                    properties:
                      application_status:
                        type: string
                      avatar_url:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      deleted_at:
                        type: string
                        format: date-time
                        nullable: true
                      email:
                        type: string
                      first_name:
                        type: string
                      from_sso:
                        type: boolean
                      is_super_admin:
                        type: boolean
                      labels:
                        type: array
                        items:
                          $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                      last_name:
                        type: string
                      name:
                        type: string
                      perm:
                        type: string
                      register_stage:
                        type: string
                      resource_type:
                        type: string
                        enum:
                        - user
                        - organization
                        - cluster
                        - host_cluster
                        - bento_repository
                        - bento
                        - deployment
                        - deployment_revision
                        - model_repository
                        - model
                        - api_token
                      uid:
                        type: string
                      updated_at:
                        type: string
                        format: date-time
              labels:
                type: array
                items:
                  $ref: '#/components/schemas/ModelschemasLabelItemSchema'
              name:
                type: string
              resource_type:
                type: string
                enum:
                - user
                - organization
                - cluster
                - host_cluster
                - bento_repository
                - bento
                - deployment
                - deployment_revision
                - model_repository
                - model
                - api_token
              status:
                type: string
                enum:
                - active
                - inactive
              targets:
                type: array
                items:
                  type: object
                  properties:
                    bento:
                      type: object
                      properties:
                        bento_repository_uid:
                          type: string
                        build_at:
                          type: string
                          format: date-time
                        created_at:
                          type: string
                          format: date-time
                        creator:
                          type: object
                          properties:
                            application_status:
                              type: string
                            avatar_url:
                              type: string
                            created_at:
                              type: string
                              format: date-time
                            deleted_at:
                              type: string
                              format: date-time
                              nullable: true
                            email:
                              type: string
                            first_name:
                              type: string
                            from_sso:
                              type: boolean
                            is_super_admin:
                              type: boolean
                            labels:
                              type: array
                              items:
                                $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                            last_name:
                              type: string
                            name:
                              type: string
                            perm:
                              type: string
                            register_stage:
                              type: string
                            resource_type:
                              type: string
                              enum:
                              - user
                              - organization
                              - cluster
                              - host_cluster
                              - bento_repository
                              - bento
                              - deployment
                              - deployment_revision
                              - model_repository
                              - model
                              - api_token
                            uid:
                              type: string
                            updated_at:
                              type: string
                              format: date-time
                        deleted_at:
                          type: string
                          format: date-time
                          nullable: true
                        description:
                          type: string
                        image_build_status:
                          type: string
                        labels:
                          type: array
                          items:
                            $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                        manifest:
                          $ref: '#/components/schemas/ModelschemasBentoManifestSchema'
                        n_deployments:
                          type: integer
                          format: int32
                        name:
                          type: string
                        presigned_download_url:
                          type: string
                        presigned_upload_url:
                          type: string
                        presigned_urls_deprecated:
                          type: boolean
                        repository:
                          type: object
                          properties:
                            created_at:
                              type: string
                              format: date-time
                            creator:
                              type: object
                              properties:
                                application_status:
                                  type: string
                                avatar_url:
                                  type: string
                                created_at:
                                  type: string
                                  format: date-time
                                deleted_at:
                                  type: string
                                  format: date-time
                                  nullable: true
                                email:
                                  type: string
                                first_name:
                                  type: string
                                from_sso:
                                  type: boolean
                                is_super_admin:
                                  type: boolean
                                labels:
                                  type: array
                                  items:
                                    $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                                last_name:
                                  type: string
                                name:
                                  type: string
                                perm:
                                  type: string
                                register_stage:
                                  type: string
                                resource_type:
                                  type: string
                                  enum:
                                  - user
                                  - organization
                                  - cluster
                                  - host_cluster
                                  - bento_repository
                                  - bento
                                  - deployment
                                  - deployment_revision
                                  - model_repository
                                  - model
                                  - api_token
                                uid:
                                  type: string
                                updated_at:
                                  type: string
                                  format: date-time
                            deleted_at:
                              type: string
                              format: date-time
                              nullable: true
                            description:
                              type: string
                            labels:
                              type: array
                              items:
                                $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                            latest_bento:
                              type: object
                              properties:
                                bento_repository_uid:
                                  type: string
                                build_at:
                                  type: string
                                  format: date-time
                                created_at:
                                  type: string
                                  format: date-time
                                creator:
                                  type: object
                                  properties:
                                    application_status:
                                      type: string
                                    avatar_url:
                                      type: string
                                    created_at:
                                      type: string
                                      format: date-time
                                    deleted_at:
                                      type: string
                                      format: date-time
                                      nullable: true
                                    email:
                                      type: string
                                    first_name:
                                      type: string
                                    from_sso:
                                      type: boolean
                                    is_super_admin:
                                      type: boolean
                                    labels:
                                      type: array
                                      items:
                                        $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                                    last_name:
                                      type: string
                                    name:
                                      type: string
                                    perm:
                                      type: string
                                    register_stage:
                                      type: string
                                    resource_type:
                                      type: string
                                      enum:
                                      - user
                                      - organization
                                      - cluster
                                      - host_cluster
                                      - bento_repository
                                      - bento
                                      - deployment
                                      - deployment_revision
                                      - model_repository
                                      - model
                                      - api_token
                                    uid:
                                      type: string
                                    updated_at:
                                      type: string
                                      format: date-time
                                deleted_at:
                                  type: string
                                  format: date-time
                                  nullable: true
                                description:
                                  type: string
                                image_build_status:
                                  type: string
                                labels:
                                  type: array
                                  items:
                                    $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                                manifest:
                                  $ref: '#/components/schemas/ModelschemasBentoManifestSchema'
                                name:
                                  type: string
                                presigned_download_url:
                                  type: string
                                presigned_upload_url:
                                  type: string
                                presigned_urls_deprecated:
                                  type: boolean
                                resource_type:
                                  type: string
                                  enum:
                                  - user
                                  - organization
                                  - cluster
                                  - host_cluster
                                  - bento_repository
                                  - bento
                         

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