public/atlantis
1
0
Fork 0
mirror of https://git.vectorsigma.ru/public/atlantis.git synced 2026-07-28 23:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: updating api-endpoints.md doc to include PR parameter (#3255)

Browse Source 
documents the optional PR parameter for the plan/apply endpoints
This commit is contained in:
Isaac Gaskin
2023-03-21 12:26:07 -07:00
committed by GitHub
parent 16746632b1
commit 6e3a9eba65
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
runatlantis.io/docs/api-endpoints.md
View File

@@ -27,6 +27,7 @@ Execute [atlantis plan](using-atlantis.html#atlantis-plan) on the specified repo
| Ref | string | Yes | Git reference, like a branch name |
| Type | string | Yes | Type of the VCS provider (Github/Gitlab) |
| Paths | [ [Path](api-endpoints.html#path) ] | Yes | Paths to the projects to run the plan |
| PR | int | No | Pull Request number |
##### Path
@@ -52,7 +53,8 @@ curl --request POST 'https://<ATLANTIS_HOST_NAME>/api/plan' \
"Paths": [{
"Directory": ".",
"Workspace": "default"
}]
}],
"PR": 2
}'
```
@@ -100,6 +102,7 @@ Execute [atlantis apply](using-atlantis.html#atlantis-apply) on the specified re
| Ref | string | Yes | Git reference, like a branch name |
| Type | string | Yes | Type of the VCS provider (Github/Gitlab) |
| Paths | [ [Path](api-endpoints.html#path-1) ] | Yes | Paths to the projects to run the apply |
| PR | int | No | Pull Request number |
##### Path
@@ -125,7 +128,8 @@ curl --request POST 'https://<ATLANTIS_HOST_NAME>/api/apply' \
"Paths": [{
"Directory": ".",
"Workspace": "default"
}]
}],
"PR": 2
}'
```