Apidoc (#302)

* Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file * api documentation improvement
author: Dimitri Gilbert <dimitri.gilbert@gmail.com> 2018-02-17 19:24:56 +0100
committer: Chocobozzz <me@florianbigard.com> 2018-02-17 19:24:56 +0100
commit: 44cb3b85f8299b6300a23fea9e04b7f6e20a8023 (patch)
tree: 69088ee9d439683d5cf0205d5728a317fb5bd73f /support/doc
parent: 702785a54cb4d60f082ed15fb7f97f534a7ae8ed (diff)
download: PeerTube-44cb3b85f8299b6300a23fea9e04b7f6e20a8023.tar.gz
PeerTube-44cb3b85f8299b6300a23fea9e04b7f6e20a8023.tar.zst
PeerTube-44cb3b85f8299b6300a23fea9e04b7f6e20a8023.zip
1 files changed, 195 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index f00e40737..bcb0c511e 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -18,6 +18,21 @@ paths:
          required: true
          type: string
          description: 'The id of the account'
+        - name: start
+          in: query
+          required: false
+          type: number
+          description: 'starting page'
+        - name: stop
+          in: query
+          required: false
+          type: number
+          description: 'stoping page'
+        - name: sort
+          in: query
+          required: false
+          type: number
+          description: 'sorting'
      responses:
        '200':
          description: successful operation
@@ -59,6 +74,27 @@ paths:
        - application/json
      produces:
        - application/json
+      parameters:
+        - name: state
+          in: path
+          required: true
+          type: string
+          description: 'The id of the account'
+        - name: start
+          in: query
+          required: false
+          type: number
+          description: 'starting page'
+        - name: count
+          in: query
+          required: false
+          type: number
+          description: ''
+        - name: sort
+          in: query
+          required: false
+          type: number
+          description: 'sorting'
      responses:
        '200':
          description: successful operation
@@ -91,6 +127,22 @@ paths:
        - application/json
      produces:
        - application/json
+      parameters:
+        - name: start
+          in: query
+          required: false
+          type: number
+          description: 'starting page'
+        - name: stop
+          in: query
+          required: false
+          type: number
+          description: 'stoping page'
+        - name: sort
+          in: query
+          required: false
+          type: number
+          description: 'sorting'
      responses:
        '200':
          description: successful operation
@@ -106,6 +158,22 @@ paths:
        - application/json
      produces:
        - application/json
+      parameters:
+        - name: start
+          in: query
+          required: false
+          type: number
+          description: 'starting page'
+        - name: stop
+          in: query
+          required: false
+          type: number
+          description: 'stoping page'
+        - name: sort
+          in: query
+          required: false
+          type: number
+          description: 'sorting'
      responses:
        '200':
          description: successful operation
@@ -154,6 +222,22 @@ paths:
        - application/json
      produces:
        - application/json
+      parameters:
+        - name: start
+          in: query
+          required: false
+          type: number
+          description: 'starting page'
+        - name: stop
+          in: query
+          required: false
+          type: number
+          description: 'stoping page'
+        - name: sort
+          in: query
+          required: false
+          type: number
+          description: 'sorting'
      responses:
        '200':
          description: successful operation
@@ -289,6 +373,22 @@ paths:
        - application/json
      produces:
        - application/json
+      parameters:
+        - name: start
+          in: query
+          required: false
+          type: number
+          description: 'starting page'
+        - name: stop
+          in: query
+          required: false
+          type: number
+          description: 'stoping page'
+        - name: sort
+          in: query
+          required: false
+          type: number
+          description: 'sorting'
      responses:
        '200':
          description: successful operation
@@ -339,6 +439,22 @@ paths:
        - application/json
      produces:
        - application/json
+      parameters:
+        - name: start
+          in: query
+          required: false
+          type: number
+          description: 'starting page'
+        - name: stop
+          in: query
+          required: false
+          type: number
+          description: 'stoping page'
+        - name: sort
+          in: query
+          required: false
+          type: number
+          description: 'sorting'
      responses:
        '200':
          description: successful operation
@@ -414,6 +530,22 @@ paths:
        - application/json
      produces:
        - application/json
+      parameters:
+        - name: start
+          in: query
+          required: false
+          type: number
+          description: 'starting page'
+        - name: stop
+          in: query
+          required: false
+          type: number
+          description: 'stoping page'
+        - name: sort
+          in: query
+          required: false
+          type: number
+          description: 'sorting'
      responses:
        '200':
          description: successful operation
@@ -536,6 +668,22 @@ paths:
        - application/json
      produces:
        - application/json
+      parameters:
+        - name: start
+          in: query
+          required: false
+          type: number
+          description: 'starting page'
+        - name: stop
+          in: query
+          required: false
+          type: number
+          description: 'stoping page'
+        - name: sort
+          in: query
+          required: false
+          type: number
+          description: 'sorting'
      responses:
        '200':
          description: successful operation
@@ -601,6 +749,22 @@ paths:
        - application/json
      produces:
        - application/json
+      parameters:
+        - name: start
+          in: query
+          required: false
+          type: number
+          description: 'starting page'
+        - name: stop
+          in: query
+          required: false
+          type: number
+          description: 'stoping page'
+        - name: sort
+          in: query
+          required: false
+          type: number
+          description: 'sorting'
      responses:
        '200':
          description: successful operation
@@ -616,6 +780,22 @@ paths:
        - application/json
      produces:
        - application/json
+      parameters:
+        - name: start
+          in: query
+          required: false
+          type: number
+          description: 'starting page'
+        - name: stop
+          in: query
+          required: false
+          type: number
+          description: 'stoping page'
+        - name: sort
+          in: query
+          required: false
+          type: number
+          description: 'sorting'
      responses:
        '200':
          description: successful operation
@@ -728,6 +908,21 @@ paths:
          required: true
          type: string
          description: 'The video id '
+        - name: start
+          in: query
+          required: false
+          type: number
+          description: 'starting page'
+        - name: stop
+          in: query
+          required: false
+          type: number
+          description: 'stoping page'
+        - name: sort
+          in: query
+          required: false
+          type: number
+          description: 'sorting'
      responses:
        '200':
          description: successful operation
author	Dimitri Gilbert <dimitri.gilbert@gmail.com>	2018-02-17 19:24:56 +0100
committer	Chocobozzz <me@florianbigard.com>	2018-02-17 19:24:56 +0100
commit	44cb3b85f8299b6300a23fea9e04b7f6e20a8023 (patch)
tree	69088ee9d439683d5cf0205d5728a317fb5bd73f /support/doc
parent	702785a54cb4d60f082ed15fb7f97f534a7ae8ed (diff)
download	PeerTube-44cb3b85f8299b6300a23fea9e04b7f6e20a8023.tar.gz PeerTube-44cb3b85f8299b6300a23fea9e04b7f6e20a8023.tar.zst PeerTube-44cb3b85f8299b6300a23fea9e04b7f6e20a8023.zip

diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index f00e40737..bcb0c511e 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml
@@ -18,6 +18,21 @@ paths:
18	required: true	18	required: true
19	type: string	19	type: string
20	description: 'The id of the account'	20	description: 'The id of the account'
		21	- name: start
		22	in: query
		23	required: false
		24	type: number
		25	description: 'starting page'
		26	- name: stop
		27	in: query
		28	required: false
		29	type: number
		30	description: 'stoping page'
		31	- name: sort
		32	in: query
		33	required: false
		34	type: number
		35	description: 'sorting'
21	responses:	36	responses:
22	'200':	37	'200':
23	description: successful operation	38	description: successful operation
@@ -59,6 +74,27 @@ paths:
59	- application/json	74	- application/json
60	produces:	75	produces:
61	- application/json	76	- application/json
		77	parameters:
		78	- name: state
		79	in: path
		80	required: true
		81	type: string
		82	description: 'The id of the account'
		83	- name: start
		84	in: query
		85	required: false
		86	type: number
		87	description: 'starting page'
		88	- name: count
		89	in: query
		90	required: false
		91	type: number
		92	description: ''
		93	- name: sort
		94	in: query
		95	required: false
		96	type: number
		97	description: 'sorting'
62	responses:	98	responses:
63	'200':	99	'200':
64	description: successful operation	100	description: successful operation
@@ -91,6 +127,22 @@ paths:
91	- application/json	127	- application/json
92	produces:	128	produces:
93	- application/json	129	- application/json
		130	parameters:
		131	- name: start
		132	in: query
		133	required: false
		134	type: number
		135	description: 'starting page'
		136	- name: stop
		137	in: query
		138	required: false
		139	type: number
		140	description: 'stoping page'
		141	- name: sort
		142	in: query
		143	required: false
		144	type: number
		145	description: 'sorting'
94	responses:	146	responses:
95	'200':	147	'200':
96	description: successful operation	148	description: successful operation
@@ -106,6 +158,22 @@ paths:
106	- application/json	158	- application/json
107	produces:	159	produces:
108	- application/json	160	- application/json
		161	parameters:
		162	- name: start
		163	in: query
		164	required: false
		165	type: number
		166	description: 'starting page'
		167	- name: stop
		168	in: query
		169	required: false
		170	type: number
		171	description: 'stoping page'
		172	- name: sort
		173	in: query
		174	required: false
		175	type: number
		176	description: 'sorting'
109	responses:	177	responses:
110	'200':	178	'200':
111	description: successful operation	179	description: successful operation
@@ -154,6 +222,22 @@ paths:
154	- application/json	222	- application/json
155	produces:	223	produces:
156	- application/json	224	- application/json
		225	parameters:
		226	- name: start
		227	in: query
		228	required: false
		229	type: number
		230	description: 'starting page'
		231	- name: stop
		232	in: query
		233	required: false
		234	type: number
		235	description: 'stoping page'
		236	- name: sort
		237	in: query
		238	required: false
		239	type: number
		240	description: 'sorting'
157	responses:	241	responses:
158	'200':	242	'200':
159	description: successful operation	243	description: successful operation
@@ -289,6 +373,22 @@ paths:
289	- application/json	373	- application/json
290	produces:	374	produces:
291	- application/json	375	- application/json
		376	parameters:
		377	- name: start
		378	in: query
		379	required: false
		380	type: number
		381	description: 'starting page'
		382	- name: stop
		383	in: query
		384	required: false
		385	type: number
		386	description: 'stoping page'
		387	- name: sort
		388	in: query
		389	required: false
		390	type: number
		391	description: 'sorting'
292	responses:	392	responses:
293	'200':	393	'200':
294	description: successful operation	394	description: successful operation
@@ -339,6 +439,22 @@ paths:
339	- application/json	439	- application/json
340	produces:	440	produces:
341	- application/json	441	- application/json
		442	parameters:
		443	- name: start
		444	in: query
		445	required: false
		446	type: number
		447	description: 'starting page'
		448	- name: stop
		449	in: query
		450	required: false
		451	type: number
		452	description: 'stoping page'
		453	- name: sort
		454	in: query
		455	required: false
		456	type: number
		457	description: 'sorting'
342	responses:	458	responses:
343	'200':	459	'200':
344	description: successful operation	460	description: successful operation
@@ -414,6 +530,22 @@ paths:
414	- application/json	530	- application/json
415	produces:	531	produces:
416	- application/json	532	- application/json
		533	parameters:
		534	- name: start
		535	in: query
		536	required: false
		537	type: number
		538	description: 'starting page'
		539	- name: stop
		540	in: query
		541	required: false
		542	type: number
		543	description: 'stoping page'
		544	- name: sort
		545	in: query
		546	required: false
		547	type: number
		548	description: 'sorting'
417	responses:	549	responses:
418	'200':	550	'200':
419	description: successful operation	551	description: successful operation
@@ -536,6 +668,22 @@ paths:
536	- application/json	668	- application/json
537	produces:	669	produces:
538	- application/json	670	- application/json
		671	parameters:
		672	- name: start
		673	in: query
		674	required: false
		675	type: number
		676	description: 'starting page'
		677	- name: stop
		678	in: query
		679	required: false
		680	type: number
		681	description: 'stoping page'
		682	- name: sort
		683	in: query
		684	required: false
		685	type: number
		686	description: 'sorting'
539	responses:	687	responses:
540	'200':	688	'200':
541	description: successful operation	689	description: successful operation
@@ -601,6 +749,22 @@ paths:
601	- application/json	749	- application/json
602	produces:	750	produces:
603	- application/json	751	- application/json
		752	parameters:
		753	- name: start
		754	in: query
		755	required: false
		756	type: number
		757	description: 'starting page'
		758	- name: stop
		759	in: query
		760	required: false
		761	type: number
		762	description: 'stoping page'
		763	- name: sort
		764	in: query
		765	required: false
		766	type: number
		767	description: 'sorting'
604	responses:	768	responses:
605	'200':	769	'200':
606	description: successful operation	770	description: successful operation
@@ -616,6 +780,22 @@ paths:
616	- application/json	780	- application/json
617	produces:	781	produces:
618	- application/json	782	- application/json
		783	parameters:
		784	- name: start
		785	in: query
		786	required: false
		787	type: number
		788	description: 'starting page'
		789	- name: stop
		790	in: query
		791	required: false
		792	type: number
		793	description: 'stoping page'
		794	- name: sort
		795	in: query
		796	required: false
		797	type: number
		798	description: 'sorting'
619	responses:	799	responses:
620	'200':	800	'200':
621	description: successful operation	801	description: successful operation
@@ -728,6 +908,21 @@ paths:
728	required: true	908	required: true
729	type: string	909	type: string
730	description: 'The video id '	910	description: 'The video id '
		911	- name: start
		912	in: query
		913	required: false
		914	type: number
		915	description: 'starting page'
		916	- name: stop
		917	in: query
		918	required: false
		919	type: number
		920	description: 'stoping page'
		921	- name: sort
		922	in: query
		923	required: false
		924	type: number
		925	description: 'sorting'
731	responses:	926	responses:
732	'200':	927	'200':
733	description: successful operation	928	description: successful operation