Skip to content

Commit

Permalink
chore(api/deploy): specify how parameters are passed into body (#377)
Browse files Browse the repository at this point in the history
  • Loading branch information
ecrupper committed Sep 7, 2023
1 parent cdc3d96 commit 32cb5b0
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions content/reference/api/deployment/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,49 @@ curl \
"description": "Deployment request from Vela"
}
```

#### File with Parameters

If you would like to pass parameters, which can be referenced in the pipeline as `$DEPLOYMENT_PARAMETER_<KEY>`, include them as a map inside the `payload` tag.

```json
{
"ref": "main",
"target": "production",
"payload": {
"FIRST_EXAMPLE": "hello",
"SECOND_EXAMPLE": "goodbye"
}
}
```

#### Request with Parameters

```sh
curl \
-X POST \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "@data.json" \
"http://127.0.0.1:8080/api/v1/deployments/github/octocat"
```

#### Response with Parameters

```json
{
"id": 1,
"repo_id": 1,
"url": "https://api.github.com/repos/github/octocat/deployments/1",
"user": "octocat",
"commit": "48afb5bdc41ad69bf22588491333f7cf71135163",
"ref": "main",
"task": "deploy:vela",
"target": "production",
"description": "Deployment request from Vela",
"payload": {
"EXAMPLE": "hello",
"SECOND_EXAMPLE": "goodbye"
}
}
```

0 comments on commit 32cb5b0

Please sign in to comment.