From 879f0f26836ca8461f232188ad078a28e39912e1 Mon Sep 17 00:00:00 2001 From: Andy Fragen Date: Thu, 10 Jul 2025 13:48:02 -0700 Subject: [PATCH] Add release_asset spec Signed-off-by: Andy Fragen --- specification.md | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/specification.md b/specification.md index 1147e70..f7e1671 100644 --- a/specification.md +++ b/specification.md @@ -202,20 +202,21 @@ Valid metadata documents MUST conform to the JSON-LD specification. When present The following properties are defined for the metadata document: -| Property | Required? | Constraints | -| ----------- | --------- | ------------------------------------------------------------------- | -| id | yes | A valid DID. | -| type | yes | A string that conforms to the rules of [type](#property-type). | -| license | yes | A string that conforms to the rules of [license](#property-license) | -| authors | yes | A list that conforms to the rules of [authors](#property-authors) | -| security | yes | A list that conforms to the rules of [security](#property-security) | -| releases | yes | A list of [Releases](#release-document) | -| slug | no | A string that conforms to the rules of [slug](#property-slug) | -| name | no | A string. | -| description | no | A string. | -| keywords | no | A list of strings. | -| sections | no | A map that conforms to the rules of [sections](#property-sections) | -| _links | no | [HAL links][hal], with [defined relationships](#links-metadata) | +| Property | Required? | Constraints | +| ------------- | --------- | ------------------------------------------------------------------- | +| id | yes | A valid DID. | +| type | yes | A string that conforms to the rules of [type](#property-type). | +| license | yes | A string that conforms to the rules of [license](#property-license) | +| authors | yes | A list that conforms to the rules of [authors](#property-authors) | +| security | yes | A list that conforms to the rules of [security](#property-security) | +| releases | yes | A list of [Releases](#release-document) | +| slug | no | A string that conforms to the rules of [slug](#property-slug) | +| name | no | A string. | +| release_asset | no | A boolean indicating the package binary is a release asset. | +| description | no | A string. | +| keywords | no | A list of strings. | +| sections | no | A map that conforms to the rules of [sections](#property-sections) | +| _links | no | [HAL links][hal], with [defined relationships](#links-metadata) | The properties of the metadata document have the following semantic meanings and constraints. @@ -331,6 +332,13 @@ The `name` property specifies a human-readable name for the package, which the c The name MUST be a string. +### release_asset + +The `release_asset` property is a boolean that specifies whether the package binary is a release asset. + +The release_asset MUST be a boolean. + + ### description The `description` property specifies a short description of the package, which the client may display in index or list pages.