Add initial Stacks API documentation #826
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
aaabdelgany
changed the title
aaabdelgany
changed the title
| | `POST` | `/stack-plans/:stack_plan_id/replan` | Call this endpoint to [replan stack plan](#replan-stack-plan).| | ||
| | `PATCH` | `/stacks/:stack_id` | Call this endpoint to [update a stack](#update-a-stack).| | ||
|
|
||
| ## List stacks |
There was a problem hiding this comment.
I wonder if it would be helpful to have a "Requirements" section above this where we can talk about specific permissions/tokens are user requires to interact with this endpoints? We did something similar on the Projects API page, see https://developer.hashicorp.com/terraform/cloud-docs/api-docs/projects#requirements.
|
|
||
| | Parameter | Description | | ||
| | -------------------- | ------------------------------------------------------- | | ||
| | `:organization_name` | The name of the organization to list the stacks of. | |
There was a problem hiding this comment.
Something I've done before is list the query parameters section. We could list the valid include data and any search/filter/pagination. An example of the policy sets query parameter section: https://developer.hashicorp.com/terraform/cloud-docs/api-docs/policy-sets#query-parameters
What
This PR adds the basic api documentation for Stacks.
Why
Stacks has hit open beta so it's time we documented the api. This will likely be the first PR among many since the API surface area is pretty expansive but hopefully we can get the most useful/frequently hit endpoints.
Screenshots
Merge Checklist
If items do not apply to your changes, add (N/A) and mark them as complete.
Pull Request
Content
Reviews