Type: ReleaseNotes
Release notes for a software release. Note, this closely follows the Release Notes specification in CycloneDX. This is a work in progress and may change.
Related Filters
Properties
| Name | Type | Description |
|---|---|---|
| _notesMeta | _QueryMeta | Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages. |
| _resolvesMeta | _QueryMeta | A collection of issues that have been resolved by this release |
| aliases | [String] | One or more alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams(e.g. code names) |
| description | String | A short description of the release |
| featuredImage | String | The URL to an image that may be prominently displayed with the release notes |
| notes | [ReleaseNote] | Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages. |
| releaseType | ReleaseType | The type of software release the release notes describe |
| resolves | [ResolvedIssueInfo] | A collection of issues that have been resolved by this release |
| socialImage | String | The URL to an image that may be used in messaging on social media platforms |
| tags | [String] | One or more tags that may aid in search or retrieval of the release notes |
| timestamp | DateTime | The timestamp when the release notes were originally created |
| title | String | The title of the release |
This page was generated: 2024-05-17