docs: updating api-endpoints.md doc to include PR parameter #3255
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
documents the optional PR parameter for the plan/apply endpoints
jamengual
reviewed
Mar 21, 2023
| @@ -52,7 +53,8 @@ curl --request POST 'https://<ATLANTIS_HOST_NAME>/api/plan' \ | |||
| "Paths": [{ | |||
| "Directory": ".", | |||
| "Workspace": "default" | |||
| }] | |||
| }], | |||
| "PR": 2 | |||
There was a problem hiding this comment.
I believe this is a respond not part of the POST request.
There was a problem hiding this comment.
I'm seeing it hear as part of the POST request: https://github.com/runatlantis/atlantis/blob/main/server/controllers/api_controller.go#L39
Looks like it was added in a subsequent commit: 71233ef
I've tested this parameter locally, and it works as expected. If PR is not specified it defaults to 0, which in my environment will cause an error.
There was a problem hiding this comment.
you are correct, I was looking at the old commit
jamengual
approved these changes
Mar 21, 2023
|
thanks for the contribution @igaskin |
nitrocode
pushed a commit
that referenced
this pull request
May 5, 2023
documents the optional PR parameter for the plan/apply endpoints
ijames-gc
pushed a commit
to gocardless/atlantis
that referenced
this pull request
Feb 13, 2024
…tis#3255) documents the optional PR parameter for the plan/apply endpoints
ijames-gc
pushed a commit
to gocardless/atlantis
that referenced
this pull request
Feb 13, 2024
…tis#3255) documents the optional PR parameter for the plan/apply endpoints
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
what
documents the optional PR parameter for the plan/apply endpoints
why
This parameter is currently undocumented, but helpful
tests
rendering the markdown locally
references