Optional
data: PartialMessage<cdx_16.ReleaseNotes>Optional alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names).
from field: repeated string aliases = 7;
Optional
descriptionA short description of the release.
from field: optional string description = 5;
Optional
featuredThe URL to an image that may be prominently displayed with the release note.
from field: optional string featuredImage = 3;
Zero or more release notes containing the locale and content. Multiple note messages may be specified to support release notes in a wide variety of languages.
from field: repeated cyclonedx.v1_6.Note notes = 10;
Specifies optional, custom, properties
from field: repeated cyclonedx.v1_6.Property properties = 11;
A collection of issues that have been resolved.
from field: repeated cyclonedx.v1_6.Issue resolves = 9;
Optional
socialThe URL to an image that may be used in messaging on social media platforms.
from field: optional string socialImage = 4;
Textual strings that aid in the discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes. Examples include "json-parser", "object-persistence", "text-to-image", "translation", and "object-detection".
from field: repeated string tags = 8;
Optional
timestampThe date and time (timestamp) when the release note was created.
from field: optional google.protobuf.Timestamp timestamp = 6;
Optional
titleThe title of the release.
from field: optional string title = 2;
The software versioning type. It is RECOMMENDED that the release type use one of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.
from field: string type = 1;
Static
Readonly
fieldsStatic
Readonly
runtimeStatic
Readonly
typeCreate a deep copy.
Compare with a message of the same type.
Parse from binary data, merging fields.
Repeated fields are appended. Map entries are added, overwriting existing keys.
If a message field is already present, it will be merged with the new data.
Optional
options: Partial<BinaryReadOptions>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.
Protected
toJSONOverride for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).
Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.
This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.
Static
equalsStatic
fromOptional
options: Partial<BinaryReadOptions>Static
fromOptional
options: Partial<JsonReadOptions>Static
fromOptional
options: Partial<JsonReadOptions>
Generated
from message cyclonedx.v1_6.ReleaseNotes