1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
---
title: ForgeFed Vocabulary
---
# ForgeFed Vocabulary - DRAFT
**Editors:**
- deesix
- fr33domlover
- zPlus
- ... add other editors
**Repository:**
- [NotABug](https://notabug.org/peers/forgefed)
**Copyright:**
2019 ...
# Abstract
This document describes the ForgeFed vocabulary. It's intended to be an extension
of the [ActivityPub Vocabulary](https://www.w3.org/TR/activitystreams-vocabulary/)
and provides additional vocabulary for federation of project management and
version control system hosting and collaboration platforms.
# Table of Contents
1. [Introduction](#Introduction)
2. [Types](#Types)
3. [Properties](#Properties)
1. Introduction
The ForgeFed Vocabulary describes a set of types and properties to be used by
platforms that support the ForgeFed protocol.
2. Types
The base URI to be used as context for the new ForgeFed types and properties has
been defined to be `https://forgefed.peers.community/ns#`. Therefore any ForgeFed
activity MUST use the following `context`
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://forgefed.peers.community/ns"
]
2.1. Activity Types
2.1.1. Follow
**URI:** `https://www.w3.org/ns/activitystreams#Follow`
**Notes:** used by a user who wants to follow a repository.
This activity doesn't define a new type (the `Follow` Activity is defined in
ActivityPub) but it's here for reference.
**Example:**
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://forgefed.peers.community/ns"
],
"summary": "Alice started following ForgeFed",
"type": "Follow",
"actor": "https://localhost/alice",
"object": "https://remotehost/bob/forgefed"
}
2.1.2. Push
**URI:** `https://forgefed.peers.community/ns#Push`
**Notes:** Indicates that new content has been pushed to the repository. The
Activity's object MUST contain a list of Commits.
A Repository actor can use this Activity to notify followers of new changes.
**Example:**
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://forgefed.peers.community/ns"
],
"summary": "Alice pushed 2 new commits to Repo2."
"type": "Push",
"actor": "https://localhost/alice/repo2",
"object": [
{
"type": "Commit",
},
{
"type": "Commit",
}
]
}
2.2. Actor Types
2.2.1. Person
**URI:** `https://www.w3.org/ns/activitystreams#Person`
**Notes:** Represents forge user. For this purpose ForgeFed reuses the Person
type defined by ActivityPub.
**Example:**
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://forgefed.peers.community/ns"
],
"type": "Person",
"id": "https://localhost/alice",
"name": "Alice Smith",
"preferredUsername": "alice",
"summary": "",
"inbox": "",
"outbox": "",
"followers": "",
"following": ""
}
2.2.2. Repository
**URI:** `https://forgefed.peers.community/ns#Repository`
**Notes:** Represents a single repository.
**Example:**
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://forgefed.peers.community/ns"
],
"id": "https://localhost/alice/forgefed",
"type": "Repository",
"name": "ForgeFed",
"summary": "ForgeFed development",
"inbox": "",
"outbox": "",
"followers": "",
"following": ""
}
2.3. Object Types
2.3.1. Commit
**URI:** `https://forgefed.peers.community/ns#Commit`
**Notes:** Represents a single Commit in a Repository.
**Example:**
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://forgefed.peers.community/ns"
],
"type": "Commit",
"id": "https://localhost/alice/repo2/commit/2c7323781aec1f7",
"author": "Alice"
"message": "Fix #89"
}
#### Ticket
**URI:** `https://forgefed.peers.community/ns#Ticket`
**Notes:** Represents a single ticket (aka "issue") for a Repository. Tickets
are used to track ideas, enhancements, tasks, or bugs.
**Example:**
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://forgefed.peers.community/ns"
],
"type": "Ticket",
"id": "https://localhost/alice/repo2/issues/42",
"attributedTo": "",
"author": "",
"title": "Nothing works!",
"content": "Please fix. Everything is broken!",
"context": ""
}
3. Properties
|
