Skip to main content
  1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. GetPackageReadmeResponse

GetPackageReadmeResponse

    README content for a registry package, structured as an ordered list of content nodes. When a language or OS filter is applied, language- and OS-specific content is collapsed to the requested value.

    Properties

    • version string required
      The resolved semantic version of the package.
    • language string optional
      The language the content was filtered for, if a language filter was applied.
    • os string optional
      The operating system the content was filtered for, if an OS filter was applied.
    • navUrl string required
      Path to the package navigation endpoint for this version.
    • content array[RegistryContentNode] required
      Ordered list of content nodes composing the README document.
    • ↳ 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'.