registry icon indicating copy to clipboard operation
registry copied to clipboard

Include package published in api docs URLs

Open iwahbe opened this issue 1 year ago • 0 comments

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 https://github.com/pulumi/registry/issues/5846, which we know we want to tackle in the future.

Affected area/feature

iwahbe avatar Nov 11 '24 12:11 iwahbe