Skip to content

docs: Update API Endpoints params#6092

Merged
jamengual merged 1 commit intorunatlantis:mainfrom
albertorm95:main
Jan 20, 2026
Merged

docs: Update API Endpoints params#6092
jamengual merged 1 commit intorunatlantis:mainfrom
albertorm95:main

Conversation

@albertorm95
Copy link
Contributor

what

This pull request updates the API documentation to clarify and improve the parameter definitions for the /api/plan and /api/apply endpoints. The main changes are the introduction of the Projects parameter, clarification of the Paths parameter, and a note about their usage requirements.

API parameter improvements:

  • Added a Projects parameter ([]string) as an optional way to specify project names for both the /api/plan and /api/apply endpoints.
  • Changed the Paths parameter to be optional and accept multiple values ([]Path) instead of a single required value.
  • Added a documentation note stating that at least one of Projects or Paths must be specified for these endpoints.

why

Docs were out-of-date

tests

n/a

references

  • type APIRequest struct {
    Repository string `validate:"required"`
    Ref string `validate:"required"`
    Type string `validate:"required"`
    PR int
    Projects []string
    Paths []struct {
    Directory string
    Workspace string
    }
    }

@dosubot dosubot bot added the docs Documentation label Jan 20, 2026
Signed-off-by: Alberto Rojas <albertorojasm95@gmail.com>
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 20, 2026
@jamengual jamengual merged commit 08476cd into runatlantis:main Jan 20, 2026
33 of 34 checks passed
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants