Browse code

rename proposals

devnewton authored on 12/06/2017 17:05:21
Showing 3 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,168 @@
1
+# jasoncoin
2
+
3
+JSON based simple tribune like protocol.
4
+
5
+# Norloges
6
+
7
+ONLY **Full ISO** [norloge](../ontology/norloge.md) in Paris timezone MUST be used.
8
+
9
+# Get request
10
+
11
+[Bouchots](../ontology/bouchot.md) MUST expose an HTTP endpoint for messages retrieving.
12
+
13
+This endpoint MUST accepts HTTP request using GET method.
14
+
15
+Endpoint path MUST be `/tribune/get`:
16
+
17
+## Query string parameters
18
+
19
+### since
20
+
21
+Optional last known by [coincoin](../ontology/coincoin.md) post
22
+[norloge](../ontology/norloge.md) in **Full ISO** format.
23
+
24
+### Response body
25
+
26
+[Bouchots](../ontology/bouchot.md) SHOULD produce
27
+a JSON as response body with latest posts (newer than *since* if set).
28
+
29
+```
30
+{
31
+    "posts": [
32
+        {
33
+            "msg": "plop",
34
+            "from": "dave"
35
+            "at": "2017-06-29T13:45:02.666"
36
+        }
37
+    ]
38
+}
39
+```
40
+
41
+# Post request
42
+
43
+[Bouchots](../ontology/bouchot.md) MUST expose an HTTP endpoint for posting messages.
44
+
45
+This endpoint MUST accepts HTTP request using POST method.
46
+
47
+Endpoint path MUST be `/tribune/post`:
48
+
49
+## Request body
50
+
51
+Post endpoint MUST accept following request body in JSON format:
52
+
53
+```
54
+{
55
+    "message": "plop",
56
+    "from": "dave"
57
+    "since": "2017-06-29T13:45:02.666"
58
+}
59
+```
60
+
61
+### message
62
+
63
+Mandatory message body in BML-NG format.
64
+
65
+[Bouchots](../ontology/bouchot.md) SHOULD expect error invalid BML-NG, invalid encoding
66
+ and generally shit posting from [moules](../ontology/moules.md).
67
+
68
+### from
69
+
70
+[Moule](../ontology/moules.md)'s nickname.
71
+
72
+### since
73
+
74
+Optional last known by [coincoin](../ontology/coincoin.md) post
75
+[norloge](../ontology/norloge.md) in **Full ISO** format.
76
+
77
+## Response
78
+
79
+### Response body
80
+
81
+If *since* parameters is set, [Bouchots](../ontology/bouchot.md) SHOULD produce
82
+a JSON as response body with posts newer than *since*.
83
+
84
+# BML-NG
85
+
86
+Replace [legacy BML](../legacy/legacy_bml.md) with a well defined and KISS markup
87
+language.
88
+
89
+Goals:
90
+
91
+- easy to parse.
92
+- readable as plain text.
93
+
94
+## bigorno
95
+
96
+Bigorno is way to hail someone prefix his nickname
97
+with [COMMERCIAL AT](http://www.fileformat.info/info/unicode/char/0040/index.htm):
98
+
99
+```
100
+@Dave how are you?
101
+```
102
+
103
+[Coincoins](../ontology/coincoin.md) SHOULD hail user when a [post](../ontology/post.md) is received with his bigorno.
104
+
105
+## duck
106
+
107
+User can post an ascii art left or right ducks:
108
+
109
+```
110
+\_o< \_o<   >o_/
111
+```
112
+
113
+Ducks can have the following character as head:
114
+
115
+```
116
+oO0ô°øòó@
117
+```
118
+
119
+[Coincoins](../ontology/coincoin.md) MAY use ducks in [hunt](../ontology/hunt.md).
120
+
121
+## [norloge](../ontology/norloge.md)
122
+
123
+[Coincoins](../ontology/coincoin.md) SHOULD use **Full ISO** norloges to display links or navigate between [posts](../ontology/post.md).
124
+
125
+**Only Full ISO** norloge MUST be used.
126
+
127
+**Bouchot suffix** MAY be used.
128
+
129
+**Indice suffix** MUST NOT be used.
130
+
131
+## Formatting
132
+
133
+[Markdown](https://daringfireball.net/projects/markdown/syntax) like formatting markup:
134
+
135
+```
136
+*emphasis*
137
+
138
+_underline_
139
+
140
+**strong**
141
+
142
+~~strikethrough~~
143
+
144
+`printf();`
145
+
146
+```
147
+
148
+[Coincoins](../ontology/coincoin.md) SHOULD use these to format [posts](../ontology/post.md):
149
+
150
+*emphasis*
151
+
152
+<u>underline</u>
153
+
154
+**strong**
155
+
156
+<s>strikethrough</s>
157
+
158
+`printf();`
159
+
160
+## [totoz](../ontology/totoz.md)
161
+
162
+Reference a totoz name between /[:/ and /]/:
163
+
164
+```
165
+[:good]
166
+```
167
+
168
+[Coincoins](../ontology/coincoin.md) MAY display the referenced totoz image.
0 169
\ No newline at end of file
1 170
deleted file mode 100644
... ...
@@ -1,166 +0,0 @@
1
-# Proposal01: jasoncoin
2
-
3
-# Norloges
4
-
5
-ONLY **Full ISO** [norloge](../ontology/norloge.md) in Paris timezone MUST be used.
6
-
7
-# Get request
8
-
9
-[Bouchots](../ontology/bouchot.md) MUST expose an HTTP endpoint for messages retrieving.
10
-
11
-This endpoint MUST accepts HTTP request using GET method.
12
-
13
-Endpoint path MUST be `/tribune/get`:
14
-
15
-## Query string parameters
16
-
17
-### since
18
-
19
-Optional last known by [coincoin](../ontology/coincoin.md) post
20
-[norloge](../ontology/norloge.md) in **Full ISO** format.
21
-
22
-### Response body
23
-
24
-[Bouchots](../ontology/bouchot.md) SHOULD produce
25
-a JSON as response body with latest posts (newer than *since* if set).
26
-
27
-```
28
-{
29
-    "posts": [
30
-        {
31
-            "msg": "plop",
32
-            "from": "dave"
33
-            "at": "2017-06-29T13:45:02.666"
34
-        }
35
-    ]
36
-}
37
-```
38
-
39
-# Post request
40
-
41
-[Bouchots](../ontology/bouchot.md) MUST expose an HTTP endpoint for posting messages.
42
-
43
-This endpoint MUST accepts HTTP request using POST method.
44
-
45
-Endpoint path MUST be `/tribune/post`:
46
-
47
-## Request body
48
-
49
-Post endpoint MUST accept following request body in JSON format:
50
-
51
-```
52
-{
53
-    "message": "plop",
54
-    "from": "dave"
55
-    "since": "2017-06-29T13:45:02.666"
56
-}
57
-```
58
-
59
-### message
60
-
61
-Mandatory message body in BML-NG format.
62
-
63
-[Bouchots](../ontology/bouchot.md) SHOULD expect error invalid BML-NG, invalid encoding
64
- and generally shit posting from [moules](../ontology/moules.md).
65
-
66
-### from
67
-
68
-[Moule](../ontology/moules.md)'s nickname.
69
-
70
-### since
71
-
72
-Optional last known by [coincoin](../ontology/coincoin.md) post
73
-[norloge](../ontology/norloge.md) in **Full ISO** format.
74
-
75
-## Response
76
-
77
-### Response body
78
-
79
-If *since* parameters is set, [Bouchots](../ontology/bouchot.md) SHOULD produce
80
-a JSON as response body with posts newer than *since*.
81
-
82
-# BML-NG
83
-
84
-Replace [legacy BML](../legacy/legacy_bml.md) with a well defined and KISS markup
85
-language.
86
-
87
-Goals:
88
-
89
-- easy to parse.
90
-- readable as plain text.
91
-
92
-## bigorno
93
-
94
-Bigorno is way to hail someone prefix his nickname
95
-with [COMMERCIAL AT](http://www.fileformat.info/info/unicode/char/0040/index.htm):
96
-
97
-```
98
-@Dave how are you?
99
-```
100
-
101
-[Coincoins](../ontology/coincoin.md) SHOULD hail user when a [post](../ontology/post.md) is received with his bigorno.
102
-
103
-## duck
104
-
105
-User can post an ascii art left or right ducks:
106
-
107
-```
108
-\_o< \_o<   >o_/
109
-```
110
-
111
-Ducks can have the following character as head:
112
-
113
-```
114
-oO0ô°øòó@
115
-```
116
-
117
-[Coincoins](../ontology/coincoin.md) MAY use ducks in [hunt](../ontology/hunt.md).
118
-
119
-## [norloge](../ontology/norloge.md)
120
-
121
-[Coincoins](../ontology/coincoin.md) SHOULD use **Full ISO** norloges to display links or navigate between [posts](../ontology/post.md).
122
-
123
-**Only Full ISO** norloge MUST be used.
124
-
125
-**Bouchot suffix** MAY be used.
126
-
127
-**Indice suffix** MUST NOT be used.
128
-
129
-## Formatting
130
-
131
-[Markdown](https://daringfireball.net/projects/markdown/syntax) like formatting markup:
132
-
133
-```
134
-*emphasis*
135
-
136
-_underline_
137
-
138
-**strong**
139
-
140
-~~strikethrough~~
141
-
142
-`printf();`
143
-
144
-```
145
-
146
-[Coincoins](../ontology/coincoin.md) SHOULD use tags to format [posts](../ontology/post.md):
147
-
148
-*emphasis*
149
-
150
-<u>underline</u>
151
-
152
-**strong**
153
-
154
-<s>strikethrough</s>
155
-
156
-`printf();`
157
-
158
-## [totoz](../ontology/totoz.md)
159
-
160
-Reference a totoz name between /[:/ and /]/:
161
-
162
-```
163
-[:good]
164
-```
165
-
166
-[Coincoins](../ontology/coincoin.md) MAY display the referenced totoz image.
167 0
\ No newline at end of file
168 1
new file mode 100644
... ...
@@ -0,0 +1,170 @@
1
+# restocoin
2
+
3
+RESTful tribune like protocol.
4
+
5
+# Get request
6
+
7
+[Bouchots](../ontology/bouchot.md) MUST expose an HTTP endpoint for messages retrieving.
8
+
9
+This endpoint MUST accepts HTTP request using GET method.
10
+
11
+Endpoint path MUST be `/tribune/post`:
12
+
13
+## Query string parameters
14
+
15
+### since
16
+
17
+Optional last known by [coincoin](../ontology/coincoin.md) post
18
+[norloge](../ontology/norloge.md) in **Full ISO** format.
19
+
20
+### Response body
21
+
22
+[Bouchots](../ontology/bouchot.md) SHOULD produce
23
+a JSON as response body with latest posts (newer than *since* if set).
24
+
25
+```
26
+{
27
+    "posts": [
28
+        {
29
+            "msg": "plop",
30
+            "from": "dave"
31
+            "at": "2017-06-29T13:45:02.666"
32
+            "rel": "/tribune/post/12345678"
33
+        }
34
+    ]
35
+}
36
+```
37
+
38
+# Post request
39
+
40
+[Bouchots](../ontology/bouchot.md) MUST expose an HTTP endpoint for posting messages.
41
+
42
+This endpoint MUST accepts HTTP request using POST method.
43
+
44
+Endpoint path MUST be `/tribune/post`:
45
+
46
+## Request body
47
+
48
+Post endpoint MUST accept following request body in JSON format:
49
+
50
+```
51
+{
52
+    "message": "plop",
53
+    "from": "dave"
54
+    "since": "2017-06-29T13:45:02.666"
55
+}
56
+```
57
+
58
+### message
59
+
60
+Mandatory message body in BML-ROC format.
61
+
62
+[Bouchots](../ontology/bouchot.md) SHOULD expect error invalid BML-ROC, invalid encoding
63
+ and generally shit posting from [moules](../ontology/moules.md).
64
+
65
+### from
66
+
67
+[Moule](../ontology/moules.md)'s nickname.
68
+
69
+### since
70
+
71
+Optional last known by [coincoin](../ontology/coincoin.md) post
72
+[norloge](../ontology/norloge.md) in **Full ISO** format.
73
+
74
+## Response
75
+
76
+### Response body
77
+
78
+If *since* parameters is set, [Bouchots](../ontology/bouchot.md) SHOULD produce
79
+a JSON as response body with posts newer than *since*.
80
+
81
+# BML-ROC
82
+
83
+Replace [legacy BML](../legacy/legacy_bml.md) with a well defined and RESTful markup
84
+language.
85
+
86
+Goals:
87
+
88
+- easy to parse.
89
+- readable as plain text.
90
+- RESTful
91
+
92
+## bigorno
93
+
94
+Bigorno is way to hail someone prefix his nickname
95
+with markdown like link relative to tribune base URL with 
96
+/tribune/moule/${mouleId} as path fragment:
97
+```
98
+[Dave](/tribune/moule/devnewton) how are you?
99
+```
100
+
101
+[Coincoins](../ontology/coincoin.md) SHOULD hail user when a [post](../ontology/post.md) is received with his bigorno.
102
+
103
+## duck
104
+
105
+User can post an ascii art left or right ducks with markdown like link
106
+relative to tribune base URL with 
107
+/tribune/duck/${duckId} as path fragment:
108
+
109
+```
110
+[\_o<](/tribune/duck/${duckId})
111
+```
112
+
113
+[Coincoins](../ontology/coincoin.md) MAY kill ducks in [hunt](../ontology/hunt.md)
114
+with a GET request on /tribune/duck/${duckId}/pan.
115
+
116
+## [norloge](../ontology/norloge.md)
117
+
118
+Restocoin use markdown-link-like norloge relative to tribune base URL with 
119
+/tribune/post/${postId} as path fragment:
120
+
121
+```
122
+[10:12:42](/tribune/post/123456780) plop
123
+```
124
+
125
+Absolute URL is used for cross bouchot posting:
126
+
127
+```
128
+[10:12:42](https://hadoken.free.fr/tribune/post/123456780) plop
129
+```
130
+
131
+## Formatting
132
+
133
+[Markdown](https://daringfireball.net/projects/markdown/syntax) like formatting markup:
134
+
135
+```
136
+*emphasis*
137
+
138
+_underline_
139
+
140
+**strong**
141
+
142
+~~strikethrough~~
143
+
144
+`printf();`
145
+
146
+```
147
+
148
+[Coincoins](../ontology/coincoin.md) SHOULD use these to format [posts](../ontology/post.md):
149
+
150
+*emphasis*
151
+
152
+<u>underline</u>
153
+
154
+**strong**
155
+
156
+<s>strikethrough</s>
157
+
158
+`printf();`
159
+
160
+## [totoz](../ontology/totoz.md)
161
+
162
+Reference a totoz with markdown like links
163
+relative to tribune base URL with 
164
+/tribune/totoz/${totozId} as path fragment:
165
+
166
+```
167
+[good](/tribune/totoz/good)
168
+```
169
+
170
+[Coincoins](../ontology/coincoin.md) MAY display the referenced totoz image.
0 171
\ No newline at end of file