docs: /api/plan and /api/apply endpoints

[lilincmu]

what

• Add API doc for /api/* endpoints as a page under https://www.runatlantis.io/docs/using-atlantis.html

why

The feature has become stable and was lacking an API doc.

references

• related to Add the /plan and /apply endpoints #997
• partially implements Document all API endpoints #2640
• https://deploy-preview-3013--runatlantis.netlify.app/docs/api-endpoints.html

[lilincmu]

I couldn't find out how to serve OpenAPI spec on vuepress, so I resorted to plain markdown file for the API doc. 😞

[nitrocode]

Thank you!

[jamengual]

I'm using : ./atlantis server --config=atlantis-server-config.yaml and on that yaml I have `api-secret`

…

On Tue, Jan 24, 2023 at 3:59 PM Li Lin ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In runatlantis.io/docs/server-side-repo-config.md <#3013 (comment)> : > @@ -78,10 +78,6 @@ repos: post_workflow_hooks: - run: my-post-workflow-hook-command arg1 - # api-secret defines the secret used to pass to the /api/plan and /api/apply endpoints - # if not present the api endpoints will not be accesible. - api-secret: "myapisecret" @jamengual <https://github.com/jamengual> Hmm... is it possible that you have passed ATLANTIS_API_SECRET environment variable when you tested it? If api-secret is not defined as part of the Repo <https://github.com/runatlantis/atlantis/blob/main/server/core/config/raw/global_cfg.go#L22> struct, Atlantis cannot parse the value, right? 🤔 — Reply to this email directly, view it on GitHub <#3013 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAQ3ERBV4SVVSS6WEOPOCT3WUBUGHANCNFSM6AAAAAAT72QW3E> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[lilincmu]

I'm using : ./atlantis server --config=atlantis-server-config.yaml and on that yaml I have api-secret

@jamengual The error "ignoring request since API is disabled" is returned when using below server side config and --config=atlantis-server-config.yaml param. Where did you add the api-secret? Was it under repos as well?

repos:
  # id can either be an exact repo ID or a regex.
  # If using a regex, it must start and end with a slash.
  # Repo ID's are of the form {VCS hostname}/{org}/{repo name}, ex.
  # github.com/runatlantis/atlantis.
- id: /.*/
  # branch is an regex matching pull requests by base branch
  # (the branch the pull request is getting merged into).
  # By default, all branches are matched
  branch: /.*/

  api-secret: "<redacted>"

[jamengual]

so -config= is for server flag configs mine looks like:

gh-user: jamengual
gh-token: "GHTOKEN"
repo-allowlist: "*"
gh-webhook-secret: "webhooksecret"
repo-config: atlantis-repo-config.yaml
enable-diff-markdown-format: true
silence-vcs-status-no-plans: true
hide-prev-plan-comments: true 
log-level: debug
atlantis-url: "http://localhost:4141"
api-secret: "apisecret"

[jamengual]

so it is not part of the Repo config that was my mistake, it is a server flag.