BentoML endpoint resource API

endpoint resource

OpenAPI Specification

bentoml-endpoint-resource-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: yatai api server admin api v1 endpoint resource API
  description: This is yatai api server.
  version: 1.0.0
tags:
- name: endpoint resource
  description: endpoint resource
paths:
  /api/v1/endpoints/{endpointUID}:
    get:
      tags:
      - endpoint resource
      summary: Get an endpoint
      operationId: Get an endpoint
      parameters:
      - name: endpointUID
        in: path
        required: true
        schema:
          type: string
      - name: X-Yatai-Organization
        in: header
        schema:
          type: string
      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
                  deployments:
                    type: array
                    items:
                      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'
                        latest_revision:
                          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:
                               

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