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

Include package published in api docs URLs #5948

Open
iwahbe opened this issue Nov 11, 2024 · 0 comments
Open

Include package published in api docs URLs #5948

iwahbe opened this issue Nov 11, 2024 · 0 comments
Labels
kind/enhancement Improvements or new features

Comments

@iwahbe
Copy link
Member

iwahbe commented Nov 11, 2024

Hello!

  • Vote on this issue by adding a 👍 reaction
  • If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

API doc URLs look like this:

https://www.pulumi.com/registry/packages/{package-name}/api-docs/{module}/{lowercase-resource-or-function-name}/

For example:

https://www.pulumi.com/registry/packages/aws/api-docs/s3/bucketv2/

This URL scheme limits future improvements like name-spaced packages or versioned packages. We should transition the new URL structure to a more flexible setup:

https://www.pulumi.com/registry/packages/{source}/{owner}/{pacakge}/{version=latest}/api-docs/{kind=r|d}/{module}/{resource}

AWS S3 BucketV2 would now be:

https://www.pulumi.com/registry/packages/pulumi/pulumi/aws/latest/api-docs/r/s3/bucketv2/

This will allow us to deconflict packages from different sources (like OpenTofu or CDK constructs) and native Pulumi packages, as well as deconflict packages from different publishers but with the same name. This makes space for #5846, which we know we want to tackle in the future.

Affected area/feature

@iwahbe iwahbe added the kind/enhancement Improvements or new features label Nov 11, 2024
@pulumi-bot pulumi-bot added the needs-triage Needs attention from the triage team label Nov 11, 2024
@iwahbe iwahbe removed the needs-triage Needs attention from the triage team label Nov 11, 2024
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Nov 11, 2024
iwahbe added a commit that referenced this issue Nov 14, 2024
This is a very simple API, just allowing other repositories to get the latest version of a
provider. The API is listed as v0, marking it as experimental and without backwards
comparability guarantees. I don't expect this API to survive the
[IA transition](#5948) the registry will undergo.
iwahbe added a commit that referenced this issue Nov 15, 2024
This is a very simple API, just allowing other repositories to get the latest version of a
provider. The API is listed as v0, marking it as experimental and without backwards
comparability guarantees. I don't expect this API to survive the
[IA transition](#5948) the registry will undergo.
@thoward thoward removed this from Docs 📚 Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement Improvements or new features
Projects
None yet
Development

No branches or pull requests

2 participants