BentoML bento repositories API

bento repositories

OpenAPI Specification

bentoml-bento-repositories-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: yatai api server admin api v1 bento repositories API
  description: This is yatai api server.
  version: 1.0.0
tags:
- name: bento repositories
  description: bento repositories
paths:
  /api/v1/bento_repositories:
    get:
      tags:
      - bento repositories
      summary: List bento repositories
      operationId: List bento repositories
      parameters:
      - 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/Schemasv1BentoRepositoryWithLatestDeploymentsListSchema'
    post:
      tags:
      - bento repositories
      summary: Create bento repository
      operationId: Create bento repository
      parameters:
      - name: X-Yatai-Organization
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Create Bento RepositoryInput'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                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
                        - deployment
                        - deployment_revision
                        - model_repository
                        - model
                        - api_token
                      transmission_strategy:
                        type: string
                        nullable: true
                      uid:
                        type: string
                      updated_at:
                        type: string
                        format: date-time
                      upload_finished_at:
                        type: string
                        format: date-time
                        nullable: true
                      upload_finished_reason:
                        type: string
                      upload_id:
                        type: string
                      upload_started_at:
                        type: string
                        format: date-time
                        nullable: true
                      upload_status:
                        type: string
                      version:
                        type: string
                  latest_bentos:
                    type: array
                    items:
                      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
                          - deployment
                          - deployment_revision
                          - model_repository
                          - model
                          - api_token
                        transmission_strategy:
                          type: string
                          nullable: true
                        uid:
                          type: string
                        updated_at:
                          type: string
                          format: date-time
                        upload_finished_at:
                          type: string
                          format: date-time
                          nullable: true
                        upload_finished_reason:
                          type: string
                        upload_id:
                          type: string
                        upload_started_at:
                          type: string
                          format: date-time
                          nullable: true
                        upload_status:
                          type: string
                        version:
                          type: string
                  n_bentos:
                    type: integer
                    format: int32
                  name:
                    type: string
                  organization:
                    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
                      disable_grafana:
                        type: boolean
                      disable_resources_graphs:
                        type: boolean
                      enable_endpoints:
                        type: boolean
                      enable_mixture_scaling:
                        type: boolean
                      enable_monitoring_endpoint:
                        type: boolean
                      expired_at:
                        type: string
                        format: date-time
                        nullable: true
                      labels:
                        type: array
                        items:
                          $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                      limit_group:
                        type: string
                        nullable: true
                      multi_tenancy:
                        type: boolean
                      name:
                        type: string
                      public:
                        type: boolean
                      resource_type:
                        type: string
                        enum:
                        - user
                        - organization
                        - cluster
                        - host_cluster
                        - bento_repository
                        - bento
                        - deployment
                        - deployment_revision
                        - model_repository
                        - model
                        - api_token
                      status:
                        type: string
                      uid:
                        type: string
                      updated_at:
                        type: string
                        format: date-time
                  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
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'
    V1SecretProjection:
      type: object
      properties:
        LocalObjectReference:
          $ref: '#/components/schemas/V1LocalObjectReference'
        items:
          type: array
          items:
            $ref: '#/components/schemas/V1KeyToPath'
        optional:
          type: boolean
          nullable: true
    V1NodeSelectorTerm:
      type: object
      properties:
        matchExpressions:
          type: array
          items:
            $ref: '#/components/schemas/V1NodeSelectorRequirement'
        matchFields:
          type: array
          items:
            $ref: '#/components/schemas/V1NodeSelectorRequirement'
    V1PodCertificateProjection:
      type: object
      properties:
        certificateChainPath:
          type: string
        credentialBundlePath:
          type: string
        keyPath:
          type: string
        keyType:
          type: string
        maxExpirationSeconds:
          type: integer
          format: int32
          nullable: true
        signerName:
          type: string
    ModelschemasRequestQueueConfig:
      type: object
      properties:
        enabled:
          type: boolean
          nullable: true
        max_consume_concurrency:
          type: integer
          format: int32
          nullable: true
    V1SecretKeySelector:
      type: object
      properties:
        LocalObjectReference:
          $ref: '#/components/schemas/V1LocalObjectReference'
        key:
          type: string
        optional:
          type: boolean
          nullable: true
    ModelschemasBentoRequestOverrides:
      type: object
      properties:
        dockerConfigJsonSecretName:
          type: string
        downloaderContainerEnvFrom:
          type: array
          items:
            $ref: '#/components/schemas/V1EnvFromSource'
        imageBuildTimeout:
          type: integer
          format: int64
          nullable: true
        imageBuilderContainerResources:
          $ref: '#/components/schemas/V1ResourceRequirements'
        imageBuilderExtraContainerEnv:
          type: array
          items:
            $ref: '#/components/schemas/V1EnvVar'
        imageBuilderExtraPodMetadata:
          $ref: '#/components/schemas/V1alpha1ExtraPodMetadata'
        imageBuilderExtraPodSpec:
          $ref: '#/components/schemas/V1alpha1ExtraPodSpec'
    V1LocalObjectReference:
      type: object
      properties:
        name:
          type: string
    V1ManagedFieldsEntry:
      type: object
      properties:
        apiVersion:
          type: string
        fieldsType:
          type: string
        fieldsV1:
          $ref: '#/components/schemas/V1FieldsV1'
        manager:
          type: string
        operation:
          type: string
        subresource:
          type: string
        time:
          $ref: '#/components/schemas/V1Time'
    V1ConfigMapKeySelector:
      type: object
      properties:
        LocalObjectReference:
          $ref: '#/components/schemas/V1LocalObjectReference'
        key:
          type: string
        optional:
          type: boolean
          nullable: true
    ModelschemasDeploymentTargetConfig:
      type: object
      properties:
        access_control:
          type: string
          nullable: true
        bento_function_overrides:
          $ref: '#/components/schemas/ModelschemasApiServerBentoFunctionOverrides'
        bento_request_overrides:
          $ref: '#/components/schemas/ModelschemasBentoRequestOverrides'
        config_overrides:
          type: object
          additionalProperties: {}
        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_image_builder_colocation:
          type: boolean
          nullable: true
        enable_ingress:
          type: boolean
          nullable: true
        enable_stealing_traffic_debug_mode:
          type: boolean
          nullable: true
        envs:
          type: array
          items:
            $ref: '#/components/schemas/ModelschemasLabelItemSchema'
        global_envs:
          type: array
          items:
            $ref: '#/components/schemas/ModelschemasLabelItemSchema'
        hpa_conf:
          $ref: '#/components/schemas/ModelschemasDeploymentTargetHPAConf'
        kubeResourceUid:
          type: string
        kubeResourceVersion:
          type: string
        resource_instance:
          type: string
          nullable: true
        resources:
          $ref: '#/components/schemas/ModelschemasDeploymentTargetResources'
        runners:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ModelschemasDeploymentTargetRunnerConfig'
        secrets:
          type: array
          items:
            type: string
        target_name:
          type: string
        traffic_control:
          $ref: '#/components/schemas/ModelschemasTrafficControlConfig'
    ModelschemasBentoRunnerSchema:
      type: object
      properties:
        models:
          type: array
          items:
            type: string
        name:
          type: string
        resource_config:
          $ref: '#/components/schemas/ModelschemasBentoRunnerResourceSchema'
        runnable_type:
          type: string
    V1ProjectedVolumeSource:
      type: object
      properties:
        defaultMode:
          type: integer
          format: int32
          nullable: true
        sources:
          type: array
          items:
            $ref: '#/components/schemas/V1VolumeProjection'
    V1DownwardAPIVolumeSource:
      type: object
      properties:
        defaultMode:
          type: integer
          format: int32
          nullable: true
        items:
          type: array
          items:
            $ref: '#/components/schemas/V1DownwardAPIVolumeFile'
    V1TypedObjectReference:
      type: object
      properties:
        apiGroup:
          type: string
          nullable: true
        kind:
          type: string
        name:
          type: string
        namespace:
          type: string
          nullable: true
    ModelschemasLabelItemSchema:
      type: object
      properties:
        key:
          type: string
        stage:
          type: string
        value:
          type: string
    V1CSIVolumeSource:
      type: object
      properties:
        driver:
          type: string
        fsType:
          type: string
          nullable: true
        no

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