-
Notifications
You must be signed in to change notification settings - Fork 139
2 - Add api docs for stack configuration apis #904
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
511b1d9
to
e8e3608
Compare
e8e3608
to
4aad20e
Compare
a57f365
to
9b99b90
Compare
4aad20e
to
34779bb
Compare
9b99b90
to
f7d9810
Compare
34779bb
to
b3a9448
Compare
Howdy @mrinalirao! I posted this on your other PRs, but as a reminder to myself:
|
f7d9810
to
dd63c9d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks good, please feel free to ping me or let me know when it's ready for a final review
| `POST` | `/stacks/:stack_id/fetch-latest-from-vcs` | Call this endpoint to [fetch the latest stack configuration](#fetch-the-latest-stack-configuration). | | ||
| `GET` | `/stack-configurations/:stack_configuration_id/stack-diagnostics` | Call this endpoint to [list stack configuration diagnostics](#list-stack-configuration-diagnostics). | | ||
| `GET` | `/stack-configurations/:stack_configuration_id/upload-url` | Call this endpoint to [fetch stack configuration upload url](#fetch-stack-configuration-upload-url). | | ||
| `GET` | `/stack-configurations/:stack_configuration_id/source-bundle` | Call this endpoint to [fetch stack configuration source bundle](#fetch-stack-configuration-source-bundle). | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we supposed to observe any particular order with regards to API actions? It may be nice to group everything together for readability - but I'm not sure if that's an official requirement or suggestion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’m happy to follow your suggestion on how these APIs should be ordered, as I don’t have a strong preference. :) They’re currently grouped based on the corresponding JIRA tickets, but we can absolutely revisit the ordering once all the PRs are merged into a single one (into the first PR branch)
b3a9448
to
f6046d1
Compare
Hello @mrinalirao! The UDR migration has occurred, and the HCP Terraform documentation version now lives in the unified documentation repository. I'm going to close this PR since we are no longer serving this content from this repo, but please feel free to recreate your PR in the UDR repository within the HCP Terraform documentation and tag me if you need a review: |
What
Note: Stacks CRUD APIs need to be approved first: #898
This PR adds API docs for basic stacks configuration APIs.
https://hashicorp.atlassian.net/browse/TF-26184
NOTE: This PR will remain in draft as this cannot be merged before stacks goes GA.
The API documentation has been divided into multiple PRs to simplify the review process. As each of these PRs is approved, it will be merged into
mr/stacks-api-ga
branch.Subsequent PRs will address other Stacks API's (for ease of review). The CHANGELOG will be updated once all the APIs have been added
Why
In preparation for stacks going GA, we need to document all the public facing API's for stacks
Merge Checklist
If items do not apply to your changes, add (N/A) and mark them as complete.
Pull Request
Content
website/redirects.js
for moved, renamed, or deleted pages.Reviews