diff options
author | fr33domlover <fr33domlover@riseup.net> | 2020-01-22 12:31:07 +0200 |
---|---|---|
committer | fr33domlover <fr33domlover@riseup.net> | 2020-01-22 12:31:07 +0200 |
commit | e2345a8fe8bf5e11f8cdae7a0d03b25fbe5a0209 (patch) | |
tree | 5b819d80c768b0733700a4d5f590c95a0049b113 | |
parent | 84e9d1e77608486427c822c6a1d44965ef1f4d3f (diff) |
Use 'summary' for ticket and commit titles, instead of 'name'
-rw-r--r-- | spec/behavior.md | 8 | ||||
-rw-r--r-- | spec/modeling.md | 16 | ||||
-rw-r--r-- | spec/vocabulary.md | 6 |
3 files changed, 15 insertions, 15 deletions
diff --git a/spec/behavior.md b/spec/behavior.md index 0a0c528..f80e1aa 100644 --- a/spec/behavior.md +++ b/spec/behavior.md @@ -234,7 +234,7 @@ It is recommended to use the *creation* flow as a default, and resort to the The *creation* flow begins with the ticket being published using a [Create][] activity, in which [object][] is a [Ticket][type-ticket] with fields as described [in the modeling specification][model-ticket]. The ticket -MUST specify at least [id][], [attributedTo][], [name][], [content][] and +MUST specify at least [id][], [attributedTo][], [summary][], [content][] and [context][]. The [context][] property specifies the ticket tracker to which the actor is reporting the Ticket (e.g. a repository or project etc. under which the ticket will be listed if accepted). [context][] MUST be either an actor or @@ -274,7 +274,7 @@ Life simulation app: "id": "https://forge.example/luke/issues/k49fn", "type": "Ticket", "attributedTo": "https://forge.example/luke", - "name": "Test test test", + "summary": "Test test test", "content": "<p>Just testing</p>", "mediaType": "text/html", "source": { @@ -333,7 +333,7 @@ an [Offer][] activity, in which: - [object][] is the ticket to be opened, it's a [Ticket][type-ticket] object with fields as described [in the modeling specification][model-ticket]. It - MUST specify at least [attributedTo][], [name][] and [content][], and MUST + MUST specify at least [attributedTo][], [summary][] and [content][], and MUST NOT specify [id][]. If it specifies a [context][], then it MUST be identical the Offer's [target][] described below. - [target][] is the ticket tracker to which the actor is offering the Ticket @@ -373,7 +373,7 @@ Life simulation app: "object": { "type": "Ticket", "attributedTo": "https://forge.example/luke", - "name": "Test test test", + "summary": "Test test test", "content": "<p>Just testing</p>", "mediaType": "text/html", "source": { diff --git a/spec/modeling.md b/spec/modeling.md index f283456..5cf71ee 100644 --- a/spec/modeling.md +++ b/spec/modeling.md @@ -51,9 +51,9 @@ Properties: committer * [hash][prop-hash]: The hash identifying the commit, e.g. the commit SHA1 hash in Git; the patch info SHA1 hash in Darcs -* [name][]: The commit's one-line title as plain text; if the commit title and - description are a single commit message string, then the title is the 1st - line of the commit message +* [summary][]: The commit's one-line title as HTML-escaped plain text; if the + commit title and description are a single commit message string, then the + title is the 1st line of the commit message * [description][prop-description]: A JSON object with a [mediaType][] field and a [content][] field, where `mediaType` SHOULD be "text/plain" and `content` is the commit's possibly-multi-line description; if the commit title and @@ -77,7 +77,7 @@ Example: "committedBy": "https://example.dev/alice", "committed": "2019-07-26T23:45:01Z", "hash": "109ec9a09c7df7fec775d2ba0b9d466e5643ec8c", - "name": "Add an installation script, fixes issue #89", + "summary": "Add an installation script, fixes issue #89", "description": { "mediaType": "text/plain", "content": "It's about time people can install it on their computers!" @@ -227,7 +227,7 @@ Example: "context": "https://dev.example/aviva/game-of-life", "hash": "be9f48a341c4bb5cd79ae7ab85fbf0c05d2837bb", "created": "2019-12-02T16:07:32Z", - "name": "Add widget to alter simulation speed" + "summary": "Add widget to alter simulation speed" }, { "id": "https://dev.example/aviva/game-of-life/commits/fa37fe100a8b1e69933889c5bf3caf95cd3ae1e6", @@ -236,7 +236,7 @@ Example: "context": "https://dev.example/aviva/game-of-life", "hash": "fa37fe100a8b1e69933889c5bf3caf95cd3ae1e6", "created": "2019-12-02T15:51:52Z", - "name": "Set window title correctly, fixes issue #7" + "summary": "Set window title correctly, fixes issue #7" } ] } @@ -260,7 +260,7 @@ Properties: - [context][]: The project to which this ticket belongs (a repository, an issue tracker, etc.) - [attributedTo][]: The actor (person, bot, etc.) who submitted the ticket -- [name][]: The ticket's plain-text one-line title +- [summary][]: The ticket's one-line title, as HTML-escaped plain text - [content][], [mediaType][]: The ticket's (possibly multi-line) detailed description text, in rendered form - [source][]: Source form of the ticket's description @@ -290,7 +290,7 @@ Example: "type": "Ticket", "context": "https://dev.example/aviva/game-of-life", "attributedTo": "https://forge.example/luke", - "name": "Window title is empty", + "summary": "Window title is empty", "content": "<p>When I start the simulation, window title disappears suddenly</p>", "mediaType": "text/html", "source": { diff --git a/spec/vocabulary.md b/spec/vocabulary.md index 1413ad0..64ad147 100644 --- a/spec/vocabulary.md +++ b/spec/vocabulary.md @@ -76,7 +76,7 @@ A typical `@context` of a ForgeFed object may look like this: "context": "https://example.dev/aviva/myproject", "hash": "d96596230322716bd6f87a232a648ca9822a1c20", "created": "2019-11-03T13:43:59Z", - "name": "Provide hints in sign-up form fields", + "summary": "Provide hints in sign-up form fields", } ] }, @@ -176,7 +176,7 @@ and pushed to a repo, resulting with a `Commit`. "attributedTo": "https://example.dev/bob", "committedBy": "https://example.dev/alice", "hash": "109ec9a09c7df7fec775d2ba0b9d466e5643ec8c", - "name": "Add an installation script, fixes issue #89", + "summary": "Add an installation script, fixes issue #89", "description": { "mediaType": "text/plain", "content": "It's about time people can install on their computers!" @@ -455,7 +455,7 @@ range of the ActivityPub [source][] property works. "attributedTo": "https://example.dev/bob", "hash": "109ec9a09c7df7fec775d2ba0b9d466e5643ec8c", "created": "2019-07-11T12:34:56Z", - "name": "Add an installation script, fixes issue #89", + "summary": "Add an installation script, fixes issue #89", "description": { "mediaType": "text/plain", |