Registry

GetPackageReadme

Returns the package README as an ordered list of content nodes. Each node has a 'kind' and a 'markdown' fallback for unknown kinds. Use 'lang' and 'os' to filter language- and OS-specific content. Supports JSON or markdown via Accept. Returns 404 if the package version does not exist.

get/api/registry/packages/{source}/{publisher}/{name}/versions/{version}/readme

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/registry/packages/{source}/{publisher}/{name}/versions/{version}/readme
  • Auth: none declared

Path parameters

sourcestring required

The package source: 'pulumi', 'opentofu', or 'private'

publisherstring required

Organization that owns the package

namestring required

The package name

versionstring required

Semantic version string or 'latest'

Query parameters

lang'typescript' | 'python' | 'go' | 'csharp' | 'java' | 'yaml' | 'hcl' | 'all'

Filter language-specific content to a single language, or 'all' to keep every chooser option for a client that switches language itself. Defaults to 'go'.

os'linux' | 'macos' | 'windows'

Filter OS-specific content to a single OS.

Response

OK

languagestring

The language the content was filtered for, if a language filter was applied.

navUrlstring required

Path to the package navigation endpoint for this version.

osstring

The operating system the content was filtered for, if an OS filter was applied.

versionstring required

The resolved semantic version of the package.

Changes

No recorded changes to this operation across all 1 revision of this API.