# org.tangled.ci.getWorkflowDefinition

> Published by [tangled.org](https://lexicon.garden/identity/did:plc:wshs7t2adsemcrrd4snkeqli)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.ci.getWorkflowDefinition)
- [Documentation](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.ci.getWorkflowDefinition/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.ci.getWorkflowDefinition/examples)

## Definitions

### `org.tangled.ci.getWorkflowDefinition`

**Type**: `query`

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `repo` | `string` (did) | Yes |  |
| `workflow` | `string` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `workflow` | `ref` → `org.tangled.ci.defs#workflow` | Yes |  |

#### Errors

- **InvalidRequest**: Invalid request parameters
- **RepoNotFound**: Repository not found
- **WorkflowNotFound**: Workflow not found

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "errors": [
        {
          "description": "Invalid request parameters",
          "name": "InvalidRequest"
        },
        {
          "description": "Repository not found",
          "name": "RepoNotFound"
        },
        {
          "description": "Workflow not found",
          "name": "WorkflowNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "workflow": {
              "ref": "org.tangled.ci.defs#workflow",
              "type": "ref"
            }
          },
          "required": [
            "workflow"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "repo": {
            "format": "did",
            "type": "string"
          },
          "workflow": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [
          "repo",
          "workflow"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "org.tangled.ci.getWorkflowDefinition",
  "lexicon": 1
}
```