Skip to content

Add new query parameter to Teams API docs #231

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

Add new query parameter to Teams API docs #231

wants to merge 1 commit into from

Conversation

ker-an
Copy link
Contributor

@ker-an ker-an commented Dec 15, 2022 •
edited
Loading

What

This PR updates the GET organizations/:organization_name/teams API documentation to include the new q query parameter. This was added in PR: https://github.com/hashicorp/atlas/pull/14212.

Note: I also fixed a spelling mistake and formatting.

Why

Users can now query a list of teams by name.

Screenshots

Screen Shot 2022-12-15 at 2 34 40 PM

Merge Checklist

Pull Request

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

Content

  • (N/A) Redirects have been added for moved, renamed, or deleted pages. This requires a separate PR in the terraform-website repository redirects.next.js file.
  • 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.

@ker-an ker-an added documentation Improvements or additions to documentation HCP Terraform labels Dec 15, 2022
@vercel
Copy link

vercel bot commented Dec 15, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
terraform-docs-common ✅ Ready (Inspect) Visit Preview Dec 15, 2022 at 10:33PM (UTC)

@ker-an
Copy link
Contributor Author

ker-an commented Dec 15, 2022

Closing because I'm adding this change to the projects-docs branch.

@ker-an ker-an closed this Dec 15, 2022
BrianMMcClain pushed a commit that referenced this pull request Aug 2, 2024
@hashibot-web
Merge pull request #231 from hashicorp/repo-sync
434c965 
repo sync
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation HCP Terraform
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ker-an