1. Docs
2. Reference
3. REST API Docs
4. Schema
5. GetPackageNavResponse

Package navigation: a flat list of modules, each with resources and functions.

Properties

• source string required
  Package source (e.g. ‘pulumi’).
• publisher string required
  Package publisher (e.g. ‘pulumi’).
• name string required
  Package name (e.g. ‘aws’).
• version string required
  Resolved semantic version.
• title string required
  Display title.
• description string optional
  Short description of the package.
• language string optional
  Rendering target for resolved names. Individual content may fall back to another available language when the target is missing.
• packageVersionUrl string required
  Path to the package version metadata endpoint.
• readmeUrl string required
  Path to the README endpoint.
• installationUrl string optional
  Path to the installation configuration endpoint, if present.
• docsUrlTemplate string required
  URL template for the docs endpoint. Substitute ‘{token}’ with a URL-encoded Pulumi token from a navigation item.
• modules array[GetPackageNavModule] required
  Modules in this package.
• ↳ name string required
  Module display name, resolved for the requested language. May contain ‘/’ (e.g. ‘s3/bucket’).
• ↳ resources array[GetPackageNavItem] optional
  Resources in this module. Returned only when ‘depth=full’ is set.
• ↳ functions array[GetPackageNavItem] optional
  Functions in this module. Returned only when ‘depth=full’ is set.
• ↳ resourcesTotal integer required
  Total resources in this module, independent of ‘q’.
• ↳ functionsTotal integer required
  Total functions in this module, independent of ‘q’.
• modulesTotal integer required
  Total number of modules in the package, independent of ‘q’.