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

API documentation for a single resource or function.

Properties

• version string required
  The resolved semantic version of the package.
• navUrl string required
  Path to the package navigation endpoint for this version.
• typeToken string required
  The Pulumi type token identifying this resource or function (e.g. ‘random:index/randomPassword:RandomPassword’).
• kind string required
  Whether this is a ‘resource’ or ‘function’.
• language string required
  Rendering target for code snippets and resolved names. Individual content may fall back to another available language when the target is missing. Never null.
• name map[string]string required
  Display name keyed by language.
• description array[RegistryContentNode] required
  Description as an array of content nodes. Chooser nodes are resolved.
• ↳ kind string required
  Node kind. Known kinds: ’text’, ’language-chooser’, ‘os-chooser’. Render ‘markdown’ for unrecognized kinds.
• ↳ markdown string required
  Markdown content. For ’text’ nodes, the content itself. For chooser nodes, a concatenation of options for fallback rendering.
• ↳ options array[RegistryContentNodeOption] optional
  Options for chooser nodes; absent for ’text'.
• inputs array[RegistryDocsProperty] optional
  Input properties.
• ↳ name map[string]string required
  Property name, keyed by language.
• ↳ type map[string]string required
  Display type, keyed by language.
• ↳ required boolean required
  Whether the property is required.
• ↳ replaceOnChanges boolean required
  Whether changing this property forces replacement.
• ↳ deprecated boolean optional
  Whether this property is deprecated.
• ↳ description map[string]string required
  Markdown description, keyed by language.
• ↳ typeRef RegistryDocsTypeRef optional
  Reference to a local supporting type or a remote type. Null for primitive types.
• outputs array[RegistryDocsProperty] optional
  Output properties.
• ↳ name map[string]string required
  Property name, keyed by language.
• ↳ type map[string]string required
  Display type, keyed by language.
• ↳ required boolean required
  Whether the property is required.
• ↳ replaceOnChanges boolean required
  Whether changing this property forces replacement.
• ↳ deprecated boolean optional
  Whether this property is deprecated.
• ↳ description map[string]string required
  Markdown description, keyed by language.
• ↳ typeRef RegistryDocsTypeRef optional
  Reference to a local supporting type or a remote type. Null for primitive types.
• supportingTypes array[RegistryDocsSupportingType] optional
  Supporting types referenced by inputs and outputs (inlined, not referenced by index).
• ↳ typeToken string required
  Pulumi type token of this type.
• ↳ name map[string]string required
  Display name keyed by language.
• ↳ kind string required
  ‘object’ or ’enum’.
• ↳ properties array[RegistryDocsProperty] optional
  Properties (when kind is ‘object’).
• ↳ values array[RegistryDocsEnumValue] optional
  Enum values (when kind is ’enum’).