Skip to content
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

update sample responses for subscriptions API #777

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

kevin-loehfelm
Copy link

@kevin-loehfelm kevin-loehfelm commented Nov 8, 2024

What

Updated sample requests and responses for the subscription API documentation. Impacted documentation page:

https://developer.hashicorp.com/terraform/cloud-docs/api-docs/subscriptions

Submitted issue #778 to request this update

Why

The current sample responses appear to be from 2021 and are missing some of the attributes in current subscriptions API.

Screenshots

N/A


Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

  • One or more labels describe the type of change (e.g. clarification) and associated product (e.g. HCP Terraform ).
  • Description links to related pull requests or issues, if any.

Content

  • N/A Redirects have been added to website/redirects.js for moved, renamed, or deleted pages.
  • N/A API documentation and the API Changelog have been updated.
  • N/A Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
  • N/A Pages with related content are updated and link to this content when appropriate.
  • N/A Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
  • N/A New pages have metadata (page name and description) at the top.
  • N/A New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
  • N/A New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
  • N/A UI elements (button names, page names, etc.) are bolded.
  • The Vercel website preview successfully deployed.

Reviews

  • I or someone else reviewed the content for technical accuracy.
  • I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

Copy link

vercel bot commented Nov 8, 2024

@kevin-loehfelm is attempting to deploy a commit to the HashiCorp Team on Vercel.

A member of the Team first needs to authorize it.

@kevin-loehfelm kevin-loehfelm added documentation Improvements or additions to documentation HCP Terraform labels Nov 8, 2024
@kevin-loehfelm kevin-loehfelm linked an issue Nov 8, 2024 that may be closed by this pull request
Copy link

vercel bot commented Nov 8, 2024

You must have Developer access to commit code to HashiCorp on Vercel. If you contact an administrator and receive Developer access, commit again to see your changes.

Learn more: https://vercel.com/docs/accounts/team-members-and-roles/access-roles#team-level-roles

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation HCP Terraform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

update sample responses for subscriptions API
1 participant