docs: Update API Endpoints params#6092
Merged
jamengual merged 1 commit intorunatlantis:mainfrom Jan 20, 2026
Merged
Conversation
Signed-off-by: Alberto Rojas <albertorojasm95@gmail.com>
jamengual
approved these changes
Jan 20, 2026
albertorm95
added a commit
to albertorm95/atlantis
that referenced
this pull request
Jan 21, 2026
Signed-off-by: Alberto Rojas <albertorojasm95@gmail.com>
carmennavarreteh
pushed a commit
to carmennavarreteh/atlantis-fork
that referenced
this pull request
Jan 21, 2026
Signed-off-by: Alberto Rojas <albertorojasm95@gmail.com> Signed-off-by: Carmen Navarrete Hernandez <carmennavarreteh@gmail.com>
This file contains hidden or 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
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
This pull request updates the API documentation to clarify and improve the parameter definitions for the
/api/planand/api/applyendpoints. The main changes are the introduction of theProjectsparameter, clarification of thePathsparameter, and a note about their usage requirements.API parameter improvements:
Projectsparameter ([]string) as an optional way to specify project names for both the/api/planand/api/applyendpoints.Pathsparameter to be optional and accept multiple values ([]Path) instead of a single required value.ProjectsorPathsmust be specified for these endpoints.why
Docs were out-of-date
tests
n/a
references
atlantis/server/controllers/api_controller.go
Lines 47 to 57 in 8fd24e7