org.tangled.ci.subscribePipelineLogs

tangled.org

Documentation

Pipeline logs stream

main subscription

Pipeline logs stream

Parameters

pipeline string Required

Pipeline ID

repo stringdid Required

Repository DID

workflows array Optional

filter logs by specific workflows

Message Types

Open union

#control #data

Errors

PipelineNotFound Pipeline not found

WorkflowNotFound Workflow not found

InvalidRequest Invalid request parameters

View raw schema

{
  "description": "Pipeline logs stream",
  "errors": [
    {
      "description": "Pipeline not found",
      "name": "PipelineNotFound"
    },
    {
      "description": "Workflow not found",
      "name": "WorkflowNotFound"
    },
    {
      "description": "Invalid request parameters",
      "name": "InvalidRequest"
    }
  ],
  "message": {
    "schema": {
      "refs": [
        "#control",
        "#data"
      ],
      "type": "union"
    }
  },
  "parameters": {
    "properties": {
      "pipeline": {
        "description": "Pipeline ID",
        "type": "string"
      },
      "repo": {
        "description": "Repository DID",
        "format": "did",
        "type": "string"
      },
      "workflows": {
        "description": "filter logs by specific workflows",
        "items": {
          "description": "Workflow name",
          "type": "string"
        },
        "type": "array"
      }
    },
    "required": [
      "repo",
      "pipeline"
    ],
    "type": "params"
  },
  "type": "subscription"
}

control object

No description available.

Properties

command string Optional

Step command

content string Required

No description available.

kind string Optional

Step kind

outcome string Optional

How the step ended, only set on end frames for steps that can fail

status string Optional

Step status

step integer Required

Step ID

time string datetime Required

An RFC 3339 formatted timestamp.

workflow string Required

workflow name

View raw schema

{
  "properties": {
    "command": {
      "description": "Step command",
      "type": "string"
    },
    "content": {
      "type": "string"
    },
    "kind": {
      "description": "Step kind",
      "enum": [
        "system",
        "user"
      ],
      "type": "string"
    },
    "outcome": {
      "description": "How the step ended, only set on end frames for steps that can fail",
      "enum": [
        "success",
        "failed"
      ],
      "type": "string"
    },
    "status": {
      "description": "Step status",
      "enum": [
        "start",
        "end"
      ],
      "type": "string"
    },
    "step": {
      "description": "Step ID",
      "type": "integer"
    },
    "time": {
      "format": "datetime",
      "type": "string"
    },
    "workflow": {
      "description": "workflow name",
      "type": "string"
    }
  },
  "required": [
    "time",
    "workflow",
    "step",
    "content"
  ],
  "type": "object"
}

data object

No description available.

Properties

content string Required

No description available.

step integer Required

Step ID

stream string Required

No description available.

time string datetime Required

An RFC 3339 formatted timestamp.

workflow string Required

workflow name

View raw schema

{
  "properties": {
    "content": {
      "type": "string"
    },
    "step": {
      "description": "Step ID",
      "type": "integer"
    },
    "stream": {
      "enum": [
        "stdout",
        "stderr"
      ],
      "type": "string"
    },
    "time": {
      "format": "datetime",
      "type": "string"
    },
    "workflow": {
      "description": "workflow name",
      "type": "string"
    }
  },
  "required": [
    "time",
    "workflow",
    "step",
    "content",
    "stream"
  ],
  "type": "object"
}