From 6e3a9eba655c24a9154db5fd3974142b3aa8d49a Mon Sep 17 00:00:00 2001 From: Isaac Gaskin Date: Tue, 21 Mar 2023 12:26:07 -0700 Subject: [PATCH] docs: updating api-endpoints.md doc to include PR parameter (#3255) documents the optional PR parameter for the plan/apply endpoints --- runatlantis.io/docs/api-endpoints.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/runatlantis.io/docs/api-endpoints.md b/runatlantis.io/docs/api-endpoints.md index 58b22b0a9..96dd6d0b5 100644 --- a/runatlantis.io/docs/api-endpoints.md +++ b/runatlantis.io/docs/api-endpoints.md @@ -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:///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:///api/apply' \ "Paths": [{ "Directory": ".", "Workspace": "default" - }] + }], + "PR": 2 }' ```