Skip to content

[Do Not Merge] Add API Documentation for Multi-Team Tokens #875

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
Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[Do Not Merge] Add API Documentation for Multi-Team Tokens #875

wants to merge 6 commits into from

Conversation

juliannatetreault
Copy link
Contributor

@juliannatetreault juliannatetreault commented Mar 27, 2025 •
edited
Loading

What

Update the Team Token API documentation to reflect the changes to team tokens, which include allowing multiple team tokens to be generated for a team and flagging the existing Team Token API as "legacy."

Why

These updates are relevant to the work being done for the allowance of multiple team tokens. The work being done adds a new API endpoint for creating multiple team tokens and now requires that Team Tokens (using the new API) set a description for the token, similar to the user experience when creating User Tokens. The existing Team Token API that only allows a single team token to be created will still exist so that users leveraging that API do not have to worry about data loss, however, this API is considered to be "legacy" now. Additionally, the work being done includes changes to the regenerate token button in the UI--this button will cease to exist once the changes are rolled out. The API documentation does not mention this button much, so very small wording tweaks were made to reflect this. Here's a link to the RFC for more information regarding the updates, and the Jira ticket for the work.

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

  • Redirects have been added to website/redirects.js for moved, renamed, or deleted pages.
  • API documentation and the API Changelog have been updated.
  • Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
  • 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.
  • 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.

@vercel Vercel
Copy link

vercel bot commented Mar 27, 2025 •
edited
Loading

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

Name Status Preview Comments Updated (UTC)
terraform-docs-common ✅ Ready (Inspect) Visit Preview ✅ 1 resolved Apr 24, 2025 4:25pm

@juliannatetreault juliannatetreault force-pushed the juliannatetreault/TF-24516-multiple-team-token-docs branch from 101ca21 to a89b19a Compare March 27, 2025 19:02
@juliannatetreault juliannatetreault added HCP Terraform documentation Improvements or additions to documentation labels Mar 27, 2025
@juliannatetreault juliannatetreault requested review from a team March 27, 2025 19:18
@juliannatetreault juliannatetreault force-pushed the juliannatetreault/TF-24516-multiple-team-token-docs branch 2 times, most recently from 1dcb277 to 04b3595 Compare April 1, 2025 16:10
@juliannatetreault juliannatetreault force-pushed the juliannatetreault/TF-24516-multiple-team-token-docs branch from 04b3595 to 3aa2f3b Compare April 1, 2025 18:36
robin-norwood
robin-norwood requested changes Apr 11, 2025
View reviewed changes
Copy link
Contributor

@robin-norwood robin-norwood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few suggestions.

@juliannatetreault juliannatetreault force-pushed the juliannatetreault/TF-24516-multiple-team-token-docs branch 2 times, most recently from 18dbeba to 190eb3e Compare April 14, 2025 17:41
@juliannatetreault juliannatetreault force-pushed the juliannatetreault/TF-24516-multiple-team-token-docs branch from 190eb3e to 919ae1a Compare April 16, 2025 19:35
@juliannatetreault juliannatetreault force-pushed the juliannatetreault/TF-24516-multiple-team-token-docs branch from 919ae1a to 2b46fe6 Compare April 18, 2025 14:15
@juliannatetreault
Copy link
Contributor Author

Hi, @robin-norwood! I'm seeing a "Vercel Preview Comments" failure on this PR, but I cannot see the actual failure due to a lack of access to Vercel -- do you have any pointers on how should I go about resolving the issue?

@rkoron007
Copy link
Contributor

Hi, @robin-norwood! I'm seeing a "Vercel Preview Comments" failure on this PR, but I cannot see the actual failure due to a lack of access to Vercel -- do you have any pointers on how should I go about resolving the issue?

I resolved the comment! It was about a header, and I checked and your already fixed it!

@juliannatetreault
Copy link
Contributor Author

Hi, @robin-norwood! I'm seeing a "Vercel Preview Comments" failure on this PR, but I cannot see the actual failure due to a lack of access to Vercel -- do you have any pointers on how should I go about resolving the issue?

I resolved the comment! It was about a header, and I checked and your already fixed it!

Thank you so much for doing that, @rkoron007! I appreciate your help 🙌

@juliannatetreault juliannatetreault marked this pull request as ready for review April 21, 2025 21:55
@juliannatetreault juliannatetreault changed the title Add API Documentation for Multi-Team Tokens [Do Not Merge] Add API Documentation for Multi-Team Tokens Apr 21, 2025
@juliannatetreault juliannatetreault force-pushed the juliannatetreault/TF-24516-multiple-team-token-docs branch from 69f51e9 to 0aeb1c7 Compare April 23, 2025 16:17
juliannatetreault
juliannatetreault commented Apr 23, 2025
View reviewed changes
website/docs/cloud-docs/api-docs/team-tokens.mdx

| Key path | Type | Default | Description |
| ----------------------------- | ------ | ------- | --------------------------------------------------------------------------------------------------------------- |
| `data.type` | string | | Must be `"authentication-tokens"`. |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated this to be the plural authentication-tokens per this Slack comment!

juliannatetreault
juliannatetreault commented Apr 23, 2025
View reviewed changes
website/docs/cloud-docs/api-docs/team-tokens.mdx
```json
{
"data": {
"type": "authentication-tokens",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated this to be the plural authentication-tokens per this Slack comment!

@juliannatetreault juliannatetreault force-pushed the juliannatetreault/TF-24516-multiple-team-token-docs branch from ff3537e to 17eb6d4 Compare April 23, 2025 18:38
@juliannatetreault juliannatetreault force-pushed the juliannatetreault/TF-24516-multiple-team-token-docs branch from 17eb6d4 to f3a6bf9 Compare April 23, 2025 19:11
@juliannatetreault
Copy link
Contributor Author

Hi, @robin-norwood 👋 This PR is ready for re-review whenever you have a moment, please and thank you so much!

robin-norwood
robin-norwood approved these changes Apr 24, 2025
View reviewed changes
Copy link
Contributor

@robin-norwood robin-norwood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@robin-norwood robin-norwood robin-norwood approved these changes

@mkam mkam mkam approved these changes

@netramali netramali Awaiting requested review from netramali

@drewmullen drewmullen Awaiting requested review from drewmullen

@tylerwolf tylerwolf Awaiting requested review from tylerwolf

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.
7 participants
@juliannatetreault @rkoron007 @robin-norwood @tylerwolf @mkam @drewmullen @netramali