openapi: 3.1.0
info:
  title: Flyte Admin DataProxy MatchableAttributes API
  description: The Flyte Admin API is the control-plane REST API exposed by the flyteadmin service. It is generated from the flyteidl protocol buffer definitions via gRPC-Gateway and provides JSON over HTTP access to the same operations exposed via gRPC. The API is used to register and manage projects, tasks, workflows, and launch plans, to create and inspect workflow, node, and task executions, to receive lifecycle events, to proxy data to and from upstream object stores, and to read and write matchable attribute overrides at the project, domain, and workflow levels. The same REST API powers the Flyte Console UI and is the primary programmatic interface for operating a Flyte cluster.
  version: v1
  contact:
    name: Flyte
    url: https://flyte.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:30080
  description: Default flyteadmin endpoint in a local sandbox cluster
tags:
- name: MatchableAttributes
  description: Matchable attribute configuration at project, domain, and workflow levels.
paths:
  /api/v1/matchable_attributes:
    get:
      tags:
      - MatchableAttributes
      summary: List matchable attributes
      operationId: ListMatchableAttributes
      responses:
        '200':
          description: A list of matchable attribute configurations.
  /api/v1/project_attributes/{project}:
    get:
      tags:
      - MatchableAttributes
      summary: Retrieve project attributes
      operationId: GetProjectAttributes
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Project attributes.
  /api/v1/project_attributes/{attributes.project}:
    put:
      tags:
      - MatchableAttributes
      summary: Update project attributes
      operationId: UpdateProjectAttributes
      parameters:
      - name: attributes.project
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Project attributes updated.
  /api/v1/project_domain_attributes/{project}/{domain}:
    get:
      tags:
      - MatchableAttributes
      summary: Retrieve project-domain attributes
      operationId: GetProjectDomainAttributes
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: domain
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Project-domain attributes.
  /api/v1/project_domain_attributes/{attributes.project}/{attributes.domain}:
    put:
      tags:
      - MatchableAttributes
      summary: Update project-domain attributes
      operationId: UpdateProjectDomainAttributes
      parameters:
      - name: attributes.project
        in: path
        required: true
        schema:
          type: string
      - name: attributes.domain
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Project-domain attributes updated.
  /api/v1/workflow_attributes/{project}/{domain}/{workflow}:
    get:
      tags:
      - MatchableAttributes
      summary: Retrieve workflow attributes
      operationId: GetWorkflowAttributes
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: domain
        in: path
        required: true
        schema:
          type: string
      - name: workflow
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Workflow attributes.
  /api/v1/workflow_attributes/{attributes.project}/{attributes.domain}/{attributes.workflow}:
    put:
      tags:
      - MatchableAttributes
      summary: Update workflow attributes
      operationId: UpdateWorkflowAttributes
      parameters:
      - name: attributes.project
        in: path
        required: true
        schema:
          type: string
      - name: attributes.domain
        in: path
        required: true
        schema:
          type: string
      - name: attributes.workflow
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Workflow attributes updated.