openapi: 3.0.1
info:
  title: yatai api server admin api v1 api token resource API
  description: This is yatai api server.
  version: 1.0.0
tags:
- name: api token resource
  description: api token resource
paths:
  /api/v1/api_tokens/{apiTokenUid}:
    get:
      tags:
      - api token resource
      summary: Get a api token
      operationId: Get a api token
      parameters:
      - name: apiTokenUid
        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
                  deleted_at:
                    type: string
                    format: date-time
                    nullable: true
                  deployment_names:
                    type: array
                    items:
                      type: string
                  deployment_uids:
                    type: array
                    items:
                      type: string
                  description:
                    type: string
                  expired_at:
                    type: string
                    format: date-time
                    nullable: true
                  is_access_token:
                    type: boolean
                  is_api_token:
                    type: boolean
                  is_expired:
                    type: boolean
                  is_global_access:
                    type: boolean
                  is_global_router_access:
                    type: boolean
                  is_monitoring_token:
                    type: boolean
                  is_organization_token:
                    type: boolean
                  labels:
                    type: array
                    items:
                      $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                  last_used_at:
                    type: string
                    format: date-time
                    nullable: true
                  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
                  scopes:
                    type: array
                    items:
                      type: string
                  token:
                    type: string
                  uid:
                    type: string
                  updated_at:
                    type: string
                    format: date-time
                  user:
                    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
    delete:
      tags:
      - api token resource
      summary: Delete a api token
      operationId: Delete a api token
      parameters:
      - name: apiTokenUid
        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
                  deleted_at:
                    type: string
                    format: date-time
                    nullable: true
                  deployment_names:
                    type: array
                    items:
                      type: string
                  deployment_uids:
                    type: array
                    items:
                      type: string
                  description:
                    type: string
                  expired_at:
                    type: string
                    format: date-time
                    nullable: true
                  is_access_token:
                    type: boolean
                  is_api_token:
                    type: boolean
                  is_expired:
                    type: boolean
                  is_global_access:
                    type: boolean
                  is_global_router_access:
                    type: boolean
                  is_monitoring_token:
                    type: boolean
                  is_organization_token:
                    type: boolean
                  labels:
                    type: array
                    items:
                      $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                  last_used_at:
                    type: string
                    format: date-time
                    nullable: true
                  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
                  scopes:
                    type: array
                    items:
                      type: string
                  token:
                    type: string
                  uid:
                    type: string
                  updated_at:
                    type: string
                    format: date-time
                  user:
                    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
    patch:
      tags:
      - api token resource
      summary: Update a api token
      operationId: Update a api token
      parameters:
      - name: apiTokenUid
        in: path
        required: true
        schema:
          type: string
      - name: X-Yatai-Organization
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Update A Api TokenInput'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  created_at:
                    type: string
                    format: date-time
                  deleted_at:
                    type: string
                    format: date-time
                    nullable: true
                  deployment_names:
                    type: array
                    items:
                      type: string
                  deployment_uids:
                    type: array
                    items:
                      type: string
                  description:
                    type: string
                  expired_at:
                    type: string
                    format: date-time
                    nullable: true
                  is_access_token:
                    type: boolean
                  is_api_token:
                    type: boolean
                  is_expired:
                    type: boolean
                  is_global_access:
                    type: boolean
                  is_global_router_access:
                    type: boolean
                  is_monitoring_token:
                    type: boolean
                  is_organization_token:
                    type: boolean
                  labels:
                    type: array
                    items:
                      $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                  last_used_at:
                    type: string
                    format: date-time
                    nullable: true
                  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
                  scopes:
                    type: array
                    items:
                      type: string
                  token:
                    type: string
                  uid:
                    type: string
                  updated_at:
                    type: string
                    format: date-time
                  user:
                    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
components:
  schemas:
    ModelschemasLabelItemSchema:
      type: object
      properties:
        key:
          type: string
        stage:
          type: string
        value:
          type: string
    Update A Api TokenInput:
      type: object
      properties:
        description:
          type: string
          nullable: true
        expired_at:
          type: string
          format: date-time
          nullable: true
        last_used_at:
          type: string
          format: date-time
          nullable: true
        scopes:
          type: array
          items:
            type: string
  securitySchemes:
    apiToken:
      type: apiKey
      in: header
      name: X-YATAI-API-TOKEN