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 REST API docs: add get team endpoint and minor fixes #13758

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

Conversation

caseyyh
Copy link

@caseyyh caseyyh commented Jan 6, 2025

Proposed changes

Fixes https://github.com/pulumi/pulumi-service/issues/21535

  1. Adds GetTeam REST API endpoint
  2. Corrects typo in List OIDC API
  3. Adds default response for List Updates API

@caseyyh caseyyh added the impact/no-changelog-required This issue doesn't require a CHANGELOG update label Jan 6, 2025
@caseyyh caseyyh self-assigned this Jan 6, 2025
@caseyyh caseyyh requested a review from a team as a code owner January 6, 2025 23:08
@meagancojocar
Copy link
Collaborator

Any chance we can combine Deployments REST API docs with our Pulumi Cloud REST API docs as part of this work?

@pulumi-bot
Copy link
Collaborator

@caseyyh
Copy link
Author

caseyyh commented Jan 7, 2025

Any chance we can combine Deployments REST API docs with our Pulumi Cloud REST API docs as part of this work?

like move the link to here?

Screenshot 2025-01-07 at 3 06 25 PM

@meagancojocar
Copy link
Collaborator

Any chance we can combine Deployments REST API docs with our Pulumi Cloud REST API docs as part of this work?

like move the link to here?

Screenshot 2025-01-07 at 3 06 25 PM

No, like combine them into one API doc! We have schedules and TTL in the non-deploy docs now, its a mess. @komalali let me know if you disagree

@komalali
Copy link
Member

komalali commented Jan 8, 2025

@meagancojocar yeah, I agree with you. We'll need redirects / aliases to make sure existing links don't break.

@caseyyh
Copy link
Author

caseyyh commented Jan 8, 2025

The URL wouldn't change, it's just moving where the tab is in the navbar.

If it's migrating the deploy docs in its entirety, feels like it should be its own issue + PR. I like small PRs.

@caseyyh
Copy link
Author

caseyyh commented Jan 8, 2025

But my opinion is that the REST API doc page is already huge, rather than lean in on a single uber-huge page, we should split it out by product maybe?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact/no-changelog-required This issue doesn't require a CHANGELOG update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants