Argo Workflows ArtifactService API

The ArtifactService API from Argo Workflows — 5 operation(s) for artifactservice.

OpenAPI Specification

argo-workflows-artifactservice-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  description: Argo Workflows is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. For more information, please see https://argo-workflows.readthedocs.io/en/latest/
  title: Argo Workflows ArchivedWorkflowService ArtifactService API
  version: 3.6.0
host: localhost:2746
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
security:
- BearerToken: []
tags:
- name: ArtifactService
paths:
  /artifact-files/{namespace}/{idDiscriminator}/{id}/{nodeId}/{artifactDiscriminator}/{artifactName}:
    get:
      tags:
      - ArtifactService
      summary: Argo Workflows Get an Artifact.
      operationId: ArtifactService_GetArtifactFile
      parameters:
      - type: string
        name: namespace
        in: path
        required: true
      - enum:
        - workflow
        - archived-workflows
        type: string
        name: idDiscriminator
        in: path
        required: true
      - type: string
        name: id
        in: path
        required: true
      - type: string
        name: nodeId
        in: path
        required: true
      - type: string
        name: artifactName
        in: path
        required: true
      - enum:
        - outputs
        type: string
        name: artifactDiscriminator
        in: path
        required: true
      responses:
        '200':
          description: An artifact file.
          schema:
            type: string
            format: binary
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /artifacts-by-uid/{uid}/{nodeId}/{artifactName}:
    get:
      tags:
      - ArtifactService
      summary: Argo Workflows Get an Output Artifact by UID.
      operationId: ArtifactService_GetOutputArtifactByUID
      parameters:
      - type: string
        name: uid
        in: path
        required: true
      - type: string
        name: nodeId
        in: path
        required: true
      - type: string
        name: artifactName
        in: path
        required: true
      responses:
        '200':
          description: An artifact file.
          schema:
            type: string
            format: binary
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /artifacts/{namespace}/{name}/{nodeId}/{artifactName}:
    get:
      tags:
      - ArtifactService
      summary: Argo Workflows Get an Output Artifact.
      operationId: ArtifactService_GetOutputArtifact
      parameters:
      - type: string
        name: namespace
        in: path
        required: true
      - type: string
        name: name
        in: path
        required: true
      - type: string
        name: nodeId
        in: path
        required: true
      - type: string
        name: artifactName
        in: path
        required: true
      responses:
        '200':
          description: An artifact file.
          schema:
            type: string
            format: binary
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /input-artifacts-by-uid/{uid}/{nodeId}/{artifactName}:
    get:
      tags:
      - ArtifactService
      summary: Argo Workflows Get an Input Artifact by UID.
      operationId: ArtifactService_GetInputArtifactByUID
      parameters:
      - type: string
        name: uid
        in: path
        required: true
      - type: string
        name: nodeId
        in: path
        required: true
      - type: string
        name: artifactName
        in: path
        required: true
      responses:
        '200':
          description: An artifact file.
          schema:
            type: string
            format: binary
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /input-artifacts/{namespace}/{name}/{nodeId}/{artifactName}:
    get:
      tags:
      - ArtifactService
      summary: Argo Workflows Get an Input Artifact.
      operationId: ArtifactService_GetInputArtifact
      parameters:
      - type: string
        name: namespace
        in: path
        required: true
      - type: string
        name: name
        in: path
        required: true
      - type: string
        name: nodeId
        in: path
        required: true
      - type: string
        name: artifactName
        in: path
        required: true
      responses:
        '200':
          description: An artifact file.
          schema:
            type: string
            format: binary
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/grpc.gateway.runtime.Error'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
definitions:
  grpc.gateway.runtime.Error:
    type: object
    properties:
      code:
        type: integer
      details:
        type: array
        items:
          $ref: '#/definitions/google.protobuf.Any'
      error:
        type: string
      message:
        type: string
  google.protobuf.Any:
    type: object
    properties:
      type_url:
        type: string
      value:
        type: string
        format: byte
securityDefinitions:
  BearerToken:
    type: apiKey
    in: header
    name: Authorization
    description: JWT Bearer token