diff options
author | fr33domlover <fr33domlover@riseup.net> | 2019-12-05 12:29:13 +0200 |
---|---|---|
committer | fr33domlover <fr33domlover@riseup.net> | 2019-12-05 12:29:13 +0200 |
commit | 5272138af328f5a4a72e97e09fb01060653734f1 (patch) | |
tree | b4ea0dffcbedc9a78509d60ed82db13bdfbf139c | |
parent | db5cb2f504aa67967ba87545b8b3ed6d63851c24 (diff) |
Vocab spec: Tweak links and make sure all types have a parent type
-rw-r--r-- | spec/vocabulary.md | 43 |
1 files changed, 27 insertions, 16 deletions
diff --git a/spec/vocabulary.md b/spec/vocabulary.md index d21b093..ebfad49 100644 --- a/spec/vocabulary.md +++ b/spec/vocabulary.md @@ -45,6 +45,8 @@ A typical `@context` of a ForgeFed object may look like this: **Notes:** Indicates that new content has been pushed to the [Repository](#type-repository). +**Extends:** [Activity][] + **Example:** ```json @@ -91,6 +93,8 @@ A typical `@context` of a ForgeFed object may look like this: **Notes:** Represents a version control system repository. +**Extends:** [Object][] + **Example:** ```json @@ -127,6 +131,8 @@ A typical `@context` of a ForgeFed object may look like this: parallel to other development, and usually eventually merging the changes into the main history line. +**Extends:** [Object][] + **Example:** ```json @@ -154,6 +160,8 @@ is a set of changes that already exists in a repo's history, while a [Patch](#type-patch) is a separate proposed change set, that *could* be applied and pushed to a repo, resulting with a `Commit`. +**Extends:** [Object][] + **Example:** ```json @@ -187,7 +195,7 @@ which the resolution of one ticket requires the other ticket to be resolved too. It MUST specify the [subject], [object] and [relationship] properties, and the `relationship` property MUST be [dependsOn](#prop-dependson). -**Extends:** [Relationship] +**Extends:** [Relationship][] **Example:** @@ -216,6 +224,8 @@ the `relationship` property MUST be [dependsOn](#prop-dependson). the context of a project (which may or may not be a version-control repository), and are used to track ideas, proposals, tasks, bugs and more. +**Extends:** [Object][] + **Example:** ```json @@ -246,12 +256,12 @@ repository), and are used to track ideas, proposals, tasks, bugs and more. **URI:** `https://forgefed.peers.community/ns#assignedTo` -**Notes:** Identifies the [Person] assigned to work on this +**Notes:** Identifies the [Person][] assigned to work on this [Ticket](#type-ticket). **Domain:** [Ticket](#type-ticket) -**Range:** [Person] +**Range:** [Person][] **Functional:** Yes @@ -317,12 +327,12 @@ resolved too. **Notes:** Identifies a [Collection] of [TicketDependency](#type-ticketdependency) which specify tickets that this -[Ticket](#type-ticket) depends on, i.e. this ticket is the [subject] of the +[Ticket](#type-ticket) depends on, i.e. this ticket is the [subject][] of the [dependsOn](#prop-dependson) relationship. **Domain:** [Ticket](#type-ticket) -**Range:** [Collection] of items of type +**Range:** [Collection][] of items of type [TicketDependency](#type-ticketdependency) **Functional:** Yes @@ -337,12 +347,12 @@ resolved too. **Notes:** Identifies a [Collection] of [TicketDependency](#type-ticketdependency) which specify tickets that depends -on this [Ticket](#type-ticket), i.e. this ticket is the [object] of the +on this [Ticket](#type-ticket), i.e. this ticket is the [object][] of the [dependsOn](#prop-dependson) relationship. Often called "reverse dependencies". **Domain:** [Ticket](#type-ticket) -**Range:** [Collection] of items of type +**Range:** [Collection][] of items of type [TicketDependency](#type-ticketdependency) **Functional:** Yes @@ -372,14 +382,14 @@ the standard ActivityPub `context` property instead. **URI:** `https://forgefed.peers.community/ns#description` -**Notes:** Specifies the description text of a [Commit](#type-commit), which is an optional -possibly multi-line text provided in addition to the one-line commit title. The -range of the `description` property works the same way the range of the -ActivityPub [source] property works. +**Notes:** Specifies the description text of a [Commit](#type-commit), which is +an optional possibly multi-line text provided in addition to the one-line +commit title. The range of the `description` property works the same way the +range of the ActivityPub [source][] property works. **Domain:** [Commit](#type-commit) -**Range:** [Object] that specifies a [content] and a [mediaType]. The +**Range:** Object that specifies a [content][] and a [mediaType][]. The `mediaType` SHOULD be `"text/plain"`. **Functional:** Yes @@ -425,7 +435,7 @@ repository. **Domain:** [Commit](#type-commit) -**Range:** [Object] +**Range:** [Object][] **Functional:** Yes @@ -569,14 +579,14 @@ Git, "refs/heads/master" would be the `ref` of the master branch. **URI:** `https://forgefed.peers.community/ns#team` -**Notes:**: Specifies a [Collection] of actors who are working on the object, +**Notes:**: Specifies a [Collection][] of actors who are working on the object, or responsible for it, or managing or administrating it, or having edit access to it. For example, for a [Repository](#type-repository), it could be the people who have push/edit access, the "collaborators" of the repository. -**Domain:** [Object] +**Domain:** [Object][] -**Range:** [Collection] of actors +**Range:** [Collection][] of actors **Functional:** Yes @@ -626,6 +636,7 @@ The repository's team *https://dev.example/aviva/treesim/team*: } ``` +[Activity]: https://www.w3.org/TR/activitystreams-vocabulary/#dfn-activity [Collection]: https://www.w3.org/TR/activitystreams-vocabulary/#dfn-collection [Object]: https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object [Person]: https://www.w3.org/TR/activitystreams-vocabulary/#dfn-person |