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

Code examples aggregated across a package’s resources and functions. Each example carries its own ’token’ and ‘kind’, filtered by ‘q’ and capped by ’limit’.

Properties

• version string required
  Resolved semantic version.
• navUrl string required
  Path to the package navigation endpoint.
• language string required
  Resolved snippet language.
• examples array[RegistryExample] required
  Examples sorted by token, then by position within each token. Capped at ’limit'.
• ↳ id string required
  Stable identifier within the package version. Format: ‘#’, where slug is the kebab-case title (e.g. ‘aws:ec2/instance:Instance#account-analyzer’), falling back to ’example-’ when there is no heading. Duplicates within the same token are suffixed ‘-2’, ‘-3’, etc.
• ↳ title string required
  Title derived from the surrounding heading or caption. Capped at 120 chars. Empty when none was available; rely on ‘id’ for addressability.
• ↳ code string required
  Example source code in the resolved language.
• ↳ token string required
  Pulumi token this example belongs to.
• ↳ kind string required
  Whether ’token’ is a ‘resource’ or ‘function’.
• totalCount integer required
  Total examples matching the query before ’limit’ was applied.