diff options
| author | fr33domlover <fr33domlover@riseup.net> | 2019-11-05 02:18:21 +0200 |
|---|---|---|
| committer | fr33domlover <fr33domlover@riseup.net> | 2019-11-05 02:18:21 +0200 |
| commit | 00186c344c66c9bfe7a291021f9ee9a322eb8054 (patch) | |
| tree | b614d6358d8998451fc39b0b56eb9b94c930d620 | |
| parent | ae4ee6ef45cf9b4c30ba878f4c8b0413aadba673 (diff) | |
Modeling spec: Describe repo object
| -rw-r--r-- | spec/modeling.md | 38 |
1 files changed, 37 insertions, 1 deletions
diff --git a/spec/modeling.md b/spec/modeling.md index d5064ba..9a113a4 100644 --- a/spec/modeling.md +++ b/spec/modeling.md @@ -119,7 +119,41 @@ Example: # Repository -TODO +To represent a version control repository, use the ForgeFed +[Repository][type-repository] type. + +Properties: + +* [type][]: ["Repository"][type-repository] +* [name][]: The user given name of the repository, e.g. "My cool repo" +* [published][]: The time the repository was created on the server +* [summary][]: A one-line user provided description of the repository, as HTML, + e.g. "`<p>A command-line tool that does cool things</p>`" + +Example: + +```json +{ + "@context": [ + "https://www.w3.org/ns/activitystreams", + "https://w3id.org/security/v1", + "https://forgefed.peers.community/ns" + ], + "id": "https://dev.example/aviva/treesim", + "type": "Repository", + "publicKey": { + "id": "https://dev.example/aviva/treesim#main-key", + "owner": "https://dev.example/aviva/treesim", + "publicKeyPem": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhki....." + }, + "inbox": "https://dev.example/aviva/treesim/inbox", + "outbox": "https://dev.example/aviva/treesim/outbox", + "followers": "https://dev.example/aviva/treesim/followers", + "team": "https://dev.example/aviva/treesim/team", + "name": "Tree Growth 3D Simulation", + "summary": "<p>Tree growth 3D simulator for my nature exploration game</p>" +} +``` # Pushing Commits into a Repository @@ -148,4 +182,6 @@ TODO [context]: https://www.w3.org/TR/activitystreams-vocabulary/#dfn-context [mediaType]: https://www.w3.org/TR/activitystreams-vocabulary/#dfn-mediatype [name]: https://www.w3.org/TR/activitystreams-vocabulary/#dfn-name +[published]: https://www.w3.org/TR/activitystreams-vocabulary/#dfn-published +[summary]: https://www.w3.org/TR/activitystreams-vocabulary/#dfn-summary [type]: https://www.w3.org/TR/activitystreams-vocabulary/#dfn-type |