NVIDIA Run:ai Departments API

openapi: 3.0.3
info:
  version: latest
  description: '# Introduction


    The NVIDIA Run:ai Control-Plane API reference is a guide that provides an easy-to-use programming interface for adding various tasks to your application, including workload submission, resource management, and administrative operations.


    NVIDIA Run:ai APIs are accessed using *bearer tokens*. To obtain a token, you need to create a **Service account** through the NVIDIA Run:ai user interface.

    To create a service account, in your UI, go to Access → Service Accounts (for organization-level service accounts) or User settings → Access Keys (for user access keys), and create a new one.


    After you have created a new service account, you will need to assign it access rules.

    To assign access rules to the service account, see [Create access rules](https://run-ai-docs.nvidia.com/saas/infrastructure-setup/authentication/accessrules#create-or-delete-rules).

    Make sure you assign the correct rules to your service account. Use the [Roles](https://run-ai-docs.nvidia.com/saas/infrastructure-setup/authentication/roles) to assign the correct access rules.


    To get your access token, follow the instructions in [Request a token](https://run-ai-docs.nvidia.com/saas/reference/api/rest-auth/#request-an-api-token).

    '
  title: NVIDIA Run:ai Access Keys Departments API
  x-logo:
    url: https://api.redocly.com/registry/raw/runai-xq8/saas/latest/public/runai-logo-api.png
    altText: NVIDIA Run:ai
    href: https://run.ai
  license:
    name: NVIDIA Run:ai
    url: https://www.nvidia.com/en-us/agreements/enterprise-software/nvidia-software-license-agreement/
servers:
- url: https://app.run.ai
security:
- bearerAuth: []
tags:
- name: Departments
  description: "Departments, in the hierarchy of resource allocation, are above Projects. A Department can contain multiple Projects, and has its own quotas. \nA Department's quota supersedes the total of the Project quotas in the Department, so tt is recommended \nthat a Department's quota be the total, or more than of all the Project quotas in the Department. \nFor further information see, [Working with Departments](https://run-ai-docs.nvidia.com/saas/platform-management/aiinitiatives/organization/departments).\n"
paths:
  /api/v1/org-unit/departments:
    post:
      summary: Create department
      operationId: create_department
      description: Create Department
      tags:
      - Departments
      requestBody:
        description: Department to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepartmentCreationRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Department'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '409':
          $ref: '#/components/responses/409Conflict'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
    get:
      summary: Get departments
      operationId: get_departments
      description: list departments
      tags:
      - Departments
      parameters:
      - $ref: '#/components/parameters/DepartmentsFilterBy'
      - $ref: '#/components/parameters/DepartmentsSortBy'
      - $ref: '#/components/parameters/DepartmentsVerbosity'
      - $ref: '#/components/parameters/SortOrder'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                required:
                - departments
                properties:
                  departments:
                    type: array
                    items:
                      $ref: '#/components/schemas/DepartmentForList'
                  next:
                    type: integer
                    example: 1
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
  /api/v1/org-unit/departments/{departmentId}:
    put:
      summary: Update department
      operationId: update_department
      description: Update department by Id
      tags:
      - Departments
      parameters:
      - $ref: '#/components/parameters/DepartmentId'
      requestBody:
        description: Department to update.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepartmentUpdateRequest'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Department'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
    get:
      summary: Get department
      operationId: get_department
      description: Get department by Id
      tags:
      - Departments
      parameters:
      - $ref: '#/components/parameters/DepartmentId'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Department'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
    delete:
      summary: Delete department
      operationId: delete_department
      description: Delete department by Id
      tags:
      - Departments
      parameters:
      - $ref: '#/components/parameters/DepartmentId'
      responses:
        '204':
          description: Deleted
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
  /api/v1/org-unit/departments/{departmentId}/resources:
    put:
      summary: Update department resources
      operationId: update_department_resources
      description: Update department resources by Id
      tags:
      - Departments
      parameters:
      - $ref: '#/components/parameters/DepartmentId'
      requestBody:
        description: Department resources to update.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourcesUpdateRequest'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Resources'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '500':
          $ref: '#/components/responses/500InternalServerError'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
    patch:
      summary: Patch department resources
      operationId: patch_department_resources
      description: Partial updates to specific items in the list. Should be used for update one or more attributes of an item without modifying the entire resource.
      tags:
      - Departments
      parameters:
      - $ref: '#/components/parameters/DepartmentId'
      requestBody:
        description: Department resources to update.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourcesUpdateRequest'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Resources'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '500':
          $ref: '#/components/responses/500InternalServerError'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
  /api/v1/org-unit/departments/{departmentId}/metrics:
    get:
      summary: Get department metrics data.
      operationId: get_department_metrics
      description: Retrieves department data metrics from the metrics database. Use in reporting and analysis tools.
      tags:
      - Departments
      parameters:
      - $ref: '#/components/parameters/DepartmentId'
      - $ref: '#/components/parameters/OrgUnitMetricTypes'
      - $ref: '#/components/parameters/StartRequired'
      - $ref: '#/components/parameters/EndRequired'
      - $ref: '#/components/parameters/NumberOfSamples'
      - $ref: '#/components/parameters/FilterByNodepoolName'
      responses:
        '200':
          description: Executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsResponse'
            text/csv: {}
        '207':
          description: Partial success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsResponse'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '500':
          $ref: '#/components/responses/500InternalServerError'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
  /api/v1/org-unit/departments/telemetry:
    get:
      summary: Get departments telemetry
      operationId: get_departments_telemetry
      tags:
      - Departments
      parameters:
      - $ref: '#/components/parameters/FilterByCluster'
      - $ref: '#/components/parameters/FilterByNodepoolName'
      - $ref: '#/components/parameters/FilterByDepartment'
      - $ref: '#/components/parameters/TelemetryGroupByDepartment'
      - $ref: '#/components/parameters/TelemetryType1'
      responses:
        '200':
          description: Executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TelemetryResponse'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
  /api/v1/org-unit/departments/count:
    get:
      summary: Count departments
      operationId: count_departments
      description: count departments
      tags:
      - Departments
      parameters:
      - $ref: '#/components/parameters/DepartmentsFilterBy'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountResponse'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
  /v1/k8s/clusters/{clusterUuid}/departments/metrics:
    get:
      tags:
      - Departments
      deprecated: true
      summary: Get metrics for all departments.
      operationId: getDepartmentsMetrics
      description: "Get metrics for all departments in the cluster. Use a time range to return historical data (optional). \nIf you use a `start` date, an `end` date is required.\n"
      parameters:
      - $ref: '#/components/parameters/ClusterUuid'
      - $ref: '#/components/parameters/Start'
      - $ref: '#/components/parameters/End'
      - $ref: '#/components/parameters/NumberOfSamples'
      - $ref: '#/components/parameters/NodepoolName'
      responses:
        '200':
          description: Successfully retrieved metrics for all departments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/departments'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '500':
          $ref: '#/components/responses/500InternalServerError'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
  /v1/k8s/clusters/{clusterUuid}/departments/{departmentId}/metrics:
    get:
      tags:
      - Departments
      deprecated: true
      summary: Get metrics for a specific department.
      operationId: getDepartmentMetrics
      description: "Get metrics for a specific department in the cluster. \nUse a time range to return historical data (optional). If you use a `start` date, an `end` date is required.\n"
      parameters:
      - $ref: '#/components/parameters/ClusterUuid'
      - $ref: '#/components/parameters/DepartmentId'
      - $ref: '#/components/parameters/Start'
      - $ref: '#/components/parameters/End'
      - $ref: '#/components/parameters/NumberOfSamples'
      - $ref: '#/components/parameters/NodepoolName'
      responses:
        '200':
          description: Successfully retrieved metrics for the department.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/department'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '500':
          $ref: '#/components/responses/500InternalServerError'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
  /v1/k8s/clusters/{clusterId}/departments:
    get:
      tags:
      - Departments
      deprecated: true
      summary: List all departments.
      description: List all the departments managed by the tenant on a specific cluster.
      operationId: getDepartments
      parameters:
      - in: path
        name: clusterId
        schema:
          type: string
        required: true
        description: The Universally Unique Identifier (UUID) of the cluster.
        example: 9f55255e-11ed-47c7-acef-fc4054768dbc
      - in: query
        name: excludePermissions
        schema:
          type: boolean
        required: false
        description: Backward compatibility of the `departmentAdmins` field. If `true`, the `departmentAdmins` field in the returned departments is not set. If `false`, the `departmentAdmins` is set in the returned departments.
        example: true
      - in: query
        name: memoryUnitMb
        schema:
          type: boolean
        required: false
        description: Memory returned in MB. When set to `false` (default) memory will be returned in MiB.
        example: true
      responses:
        '200':
          description: Successfully retrieved a list of Departments.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Department2'
  /v1/k8s/clusters/{clusterId}/departments/{department-id}/access-control:
    put:
      tags:
      - Departments
      summary: Set the department admins.
      description: Deprecated. Instead, use the accessrules API to add the department-admin permissions to a specific subject.
      operationId: updateDepartmentAdmins
      deprecated: true
      parameters:
      - in: path
        name: clusterId
        schema:
          type: string
        required: true
        description: The unique uuid identifying the cluster.
        example: 9f55255e-11ed-47c7-acef-fc4054768dbc
      - in: path
        name: department-id
        schema:
          type: integer
        required: true
        description: The unique id identifying the department.
        example: 2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepartmentAccessControl'
      responses:
        '201':
          description: Department admin set successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepartmentAccessControl'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Forbidden
components:
  parameters:
    DepartmentId:
      name: departmentId
      in: path
      required: true
      description: The id of the department.
      schema:
        type: string
        example: '1'
        pattern: .*
    DepartmentsVerbosity:
      name: verbosity
      in: query
      required: false
      description: Departments verbosity. If it is set to "verbose", status will be returned. If it is not defined or set to "brief" only unit specific data will be returned.
      example: verbose
      schema:
        $ref: '#/components/schemas/Verbosity'
    DepartmentsFilterBy:
      name: filterBy
      in: query
      required: false
      description: Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.
      schema:
        type: array
        items:
          type: string
          pattern: ^(name|clusterId|totalGpuQuota|gpuAllocated|createdAt|avgGpuAllocation24h|avgGpuUtilization24h|avgGpuMemoryUtilization24h|avgGpuAllocation7d|avgGpuUtilization7d|avgGpuMemoryUtilization7d|avgGpuAllocation30d|avgGpuUtilization30d|avgGpuMemoryUtilization30d)(==|!=|<=|>=|=@|!@|=\^|=\$).+$
        example:
        - name!=some-name
      explode: false
    StartRequired:
      name: start
      in: query
      description: Start date of time range to fetch data in ISO 8601 timestamp format.
      required: true
      schema:
        type: string
        format: date-time
        example: '2023-06-06T12:09:18.211Z'
    FilterByDepartment:
      name: departmentId
      in: query
      description: Filter using the department id.
      required: false
      schema:
        type: string
        example: '1'
    NumberOfSamples:
      name: numberOfSamples
      in: query
      description: The number of samples to take in the specified time range.
      required: false
      schema:
        type: integer
        example: 20
        maximum: 1000
        minimum: 0
        default: 20
    Limit:
      name: limit
      in: query
      required: false
      description: The maximum number of entries to return.
      schema:
        type: integer
        format: int32
        default: 50
        minimum: 1
        maximum: 500
    TelemetryType1:
      name: telemetryType
      in: query
      required: true
      description: specifies what data to request
      schema:
        $ref: '#/components/schemas/OrgUnitTelemetryType'
    FilterByNodepoolName:
      name: nodepoolName
      in: query
      description: Filter using the nodepool.
      required: false
      schema:
        type: string
        example: default
    EndRequired:
      name: end
      in: query
      description: End date of time range to fetch data in ISO 8601 timestamp format.
      required: true
      schema:
        type: string
        format: date-time
        example: '2023-06-07T12:09:18.211Z'
    SortOrder:
      name: sortOrder
      in: query
      required: false
      description: Sort results in descending or ascending order.
      schema:
        type: string
        enum:
        - asc
        - desc
        default: asc
    NodepoolName:
      in: query
      name: nodepoolName
      schema:
        type: string
        example: default
      required: false
      description: Filter by unique nodepool name.
    Start:
      name: start
      in: query
      description: Start of time range to fetch data from in UTC format.
      required: false
      schema:
        type: string
        format: date-time
        example: '2023-06-06 12:09:18.211'
    TelemetryGroupByDepartment:
      name: groupBy
      in: query
      description: department fields to group the data by
      explode: false
      required: false
      schema:
        type: array
        maxItems: 2
        items:
          type: string
          enum:
          - CLUSTER_ID
    DepartmentsSortBy:
      name: sortBy
      in: query
      required: false
      description: Sort results by a parameters.
      schema:
        $ref: '#/components/schemas/DepartmentFilterSortFields'
    End:
      name: end
      in: query
      description: End of time range to fetch data from in UTC format.
      required: false
      schema:
        type: string
        format: date-time
        example: '2023-06-07 12:09:18.211'
    Offset:
      name: offset
      in: query
      required: false
      description: The offset of the first item returned in the collection.
      schema:
        type: integer
        format: int32
        example: 100
    FilterByCluster:
      name: clusterId
      in: query
      description: Filter using the Universally Unique Identifier (UUID) of the cluster.
      required: false
      schema:
        type: string
        format: uuid
        example: d73a738f-fab3-430a-8fa3-5241493d7128
    OrgUnitMetricTypes:
      name: metricType
      in: query
      required: true
      description: Specify which data to request.
      explode: false
      schema:
        type: array
        items:
          $ref: '#/components/schemas/OrgUnitMetricType'
    ClusterUuid:
      name: clusterUuid
      in: path
      required: true
      description: The Universally Unique Identifier (UUID) of the cluster.
      schema:
        type: string
        format: uuid
        minLength: 1
        example: 9f55255e-11ed-47c7-acef-fc4054768dbc
  schemas:
    NodePoolsQuotaStatuses:
      type: array
      items:
        $ref: '#/components/schemas/NodePoolQuotaStatus'
      description: The current quota status for each node pool. Supported only for cluster versions 2.15+ or higher.
    Resource:
      properties:
        deserved:
          type: number
          format: double
          description: The project resource allocation that it is deserved to get in case the cluster has those resources
          nullable: true
          example: 1000
        limit:
          type: number
          format: double
          description: Maximum amount of resources the project can get
          nullable: true
          example: 0
        overQuotaWeight:
          type: number
          format: double
          description: The priority the project gets for over quota resources
          nullable: true
          example: 2
    Verbosity:
      type: string
      enum:
      - meta
      - brief
      - verbose
    Error:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          minimum: 100
          maximum: 599
        message:
          type: string
        details:
          type: string
      example:
        code: 400
        message: Bad request - Resource should have a name
    units:
      type: string
      enum:
      - Mib
      - MB
      - GB
    ProjectName1:
      type: string
      example: project-a
    DepartmentForList:
      allOf:
      - $ref: '#/components/schemas/DataDepartmentFields'
      - type: object
        required:
        - id
        - createdAt
        - updatedAt
        - totalResources
        properties:
          id:
            type: string
            example: 50
          createdAt:
            type: string
            format: date-time
          updatedAt:
            type: string
            format: date-time
          createdBy:
            type: string
          updatedBy:
            type: string
          children:
            type: array
            nullable: true
            items:
              $ref: '#/components/schemas/DepartmentProjectChild'
          status:
            type: object
            nullable: true
            properties:
              quotaStatus:
                $ref: '#/components/schemas/QuotaStatus'
          totalResources:
            $ref: '#/components/schemas/TotalResources'
            nullable: true
          resources:
            type: array
            items:
              $ref: '#/components/schemas/Resources'
            description: Resources assigned to this Organization per Node Pool
    DataUpdatableDepartmentFields:
      type: object
      description: Updatable fields
      required:
      - resources
      properties:
        description:
          type: string
          description: department's description
        schedulingRules:
          $ref: '#/components/schemas/SchedulingRules'
        defaultNodePools:
          description: default order of node pools for workloads. will be enforced if no list is defined in workload policy
          type: array
          nullable: true
          items:
            type: string
        nodeTypes:
          description: default node types configuration for workloads. will be enforced if no node type is configured in workload policy
          nullable: true
          $ref: '#/components/schemas/NodeTypesPerWorkload'
    TelemetryResponse:
      type: object
      required:
      - type
      - timestamp
      - values
      properties:
        type:
          type: string
          description: specifies what data returned
          example: ALLOCATION_RATIO
        timestamp:
          type: string
          format: date-time
          example: '2023-06-06 12:09:18.211'
        values:
          type: array
          items:
            type: object
            required:
            - value
            properties:
              value:
                type: string
                example: '85'
              groups:
                type: array
                description: columns the data is grouped by
                maxItems: 2
                items:
                  type: object
                  required:
                  - key
                  - value
                  properties:
                    key:
                      type: string
                      example: department
                    value:
                      type: string
                      example: '1'
                    name:
                      type: string
                      example: department-A
    ClusterId:
      description: The id of the cluster.
      type: string
      format: uuid
      example: 71f69d83-ba66-4822-adf5-55ce55efd210
    ResourcesDataOvertime:
      allOf:
      - $ref: '#/components/schemas/ResourcesData'
      - type: object
        required:
        - timestamp
        properties:
          timestamp:
            type: string
            format: date-time
            example: '2023-06-06T12:09:18.211Z'
    Project2:
      allOf:
      - properties:
          name:
            type: string
            description: Project name.
            example: team-a
          nodePoolsResources:
            type: array
            items:
              $ref: '#/components/schemas/NodePoolAssignedResources'
            description: Resources assigned to this Project per Node Pool.
          namespace:
            type: string
            description: The name of an existing namespace to use for the project in the cluster. Supported only for cluster versions 2.12 or higher.
            example: ns-proj1
          id:
            type: integer
            format: int32
            description: Project id.
            readOnly: true
            example: 5
          departmentId:
            type: integer
            format: int32
            description: ID of the department that owns the project.
            example: 2
          tenantId:
            type: integer
            format: int32
            description: ID of the tenant where the project is located.
            example: 2
          clusterUuid:
            type: string
            format: uuid
            description: ID of the cluster where the project is located.
            example: 71f69d83-ba66-4822-adf5-55ce55efd210
          departmentName:
            type: string
            description: Name of the department where the project is located.
            example: department-a
          interactiveNodeAffinity:
            type: string
            example: none
          trainNodeAffinity:
            type: string
            example: none
          createdAt:
            type: string
            description: Creation date of the project.
            format: date-time
            example: '2021-12-14T16:04:15.099Z'
          status:
            $ref: '#/components/schemas/ProjectStatus1'
          phase:
            type: string
            description: project's phase
            example: Ready
      - $ref: '#/components/schemas/ProjectCommonFields'
    NodePoolAssignedResourcesCreate:
      required:
      - nodePool
      properties:
        nodePool:
          allOf:
          - $ref: '#/components/schemas/NodePoolResources'
          description: The node pool which the assigned resources refer to.
        gpu:
          allOf:
          - $ref: '#/components/schemas/Resource1'
          description: Number of GPUs assigned in the node pool.
        cpu:
          allOf:
          - $ref: '#/components/schemas/Resource1'
          description: Number of CPU Millicores assigned in the node pool. Supported only if the 'CPU Resources Quota' feature flag is enabled.
        memory:
          allOf:
          - $ref: '#/components/schemas/Resource1'
          description: Amount of CPU Memory Mib assigned in the node pool. Supported only if the 'CPU Resources Quota' feature flag is enabled.
    AggregatedResources:
      type: object
      description: Sum of all resources assigned to the projects under this department per Node Pool
      required:
      - nodePool
      properties:
        nodePool:
          type: object
          description: the node pool which the resources refer to
          required:
          - id
          - name
          properties:
            id:
              type: string
              description: node pool id
              example: 22
            name:
              type: string
              description: node pool name
              example: default
        gpu:
          $ref: '#/components/schemas/DeservedResource'
        cpu:
          $ref: '#/components/schemas/DeservedResource'
        memory:
          allOf:
          - $ref: '#/components/schemas/DeservedResource'
          - type: object
            required:
            - units
            properties:
              units:
                $ref: '#/componen

# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/runai/refs/heads/main/openapi/runai-departments-api-openapi.yml