Skip to content

Add release_asset spec #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
afragen wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −14
Open

Add release_asset spec #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 22 additions & 14 deletions specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand Down