source: ProjectBuilder/devel/pb-server/api.json@ 2293

Last change on this file since 2293 was 2293, checked in by Bruno Cornec, 7 years ago

Add pb-server packaging support (preliminary work for RPM)

File size: 3.3 KB
Line 
1{
2 "swagger": "2.0",
3 "info": { "title": "Project-Builder.org", "description": "PBSUMMARY", "version": "PBVER" },
4 "consumes": [ "application/json" ],
5 "produces": [ "application/json" ],
6 "host": "localhost",
7 "schemes": [ "http" ],
8 "basePath": "/v1",
9 "paths": {
10 "/prj": {
11 "get": {
12 "operationId": "listPrj",
13 "parameters": [],
14 "responses": {
15 "200": {
16 "description": "Success",
17 "schema": {
18 "type": "array",
19 "items": { "$ref": "#/definitions/Entry" }
20 }
21 },
22 "default": {
23 "description": "Error.",
24 "schema": { "$ref": "http://git.io/vcKD4#" }
25 }
26 }
27 }
28 },
29 "/conf": {
30 "get": {
31 "operationId": "listConf",
32 "parameters": [],
33 "responses": {
34 "200": {
35 "description": "Success",
36 "schema": {
37 "type": "array",
38 "items": { "$ref": "#/definitions/Entry" }
39 }
40 },
41 "default": {
42 "description": "Error.",
43 "schema": { "$ref": "http://git.io/vcKD4#" }
44 }
45 }
46 }
47 },
48 "/confs/{id}": {
49 "get": {
50 "operationId": "showConf",
51 "parameters": [
52 { "$ref": "#/parameters/entry_id" }
53 ],
54 "responses": {
55 "200": {
56 "description": "Success",
57 "schema": { "$ref": "#/definitions/Entry" }
58 },
59 "default": {
60 "description": "Error.",
61 "schema": { "$ref": "https://raw.githubusercontent.com/jhthorsen/swagger2/master/lib/Swagger2/error.json" }
62 }
63 }
64 },
65 "put": {
66 "operationId": "updateConf",
67 "parameters": [
68 { "$ref": "#/parameters/entry_id" },
69 { "$ref": "#/parameters/entry" }
70 ],
71 "responses": {
72 "200": {
73 "description": "Success",
74 "schema": { "$ref": "#/definitions/Void" }
75 },
76 "default": {
77 "description": "Error.",
78 "schema": { "$ref": "https://raw.githubusercontent.com/jhthorsen/swagger2/master/lib/Swagger2/error.json" }
79 }
80 }
81 },
82 "delete": {
83 "operationId": "removeConf",
84 "parameters": [
85 { "$ref": "#/parameters/entry_id" }
86 ],
87 "responses": {
88 "200": {
89 "description": "Success",
90 "schema": { "$ref": "#/definitions/Void" }
91 },
92 "default": {
93 "description": "Error.",
94 "schema": { "$ref": "https://raw.githubusercontent.com/jhthorsen/swagger2/master/lib/Swagger2/error.json" }
95 }
96 }
97 }
98 }
99 },
100 "parameters": {
101 "entry": {
102 "name": "entry",
103 "in": "body",
104 "required": true,
105 "schema": {
106 "$ref": "#/definitions/Entry"
107 },
108 "description": "A conf item"
109 },
110 "entry_id": {
111 "name": "id",
112 "in": "path",
113 "required": true,
114 "type": "integer",
115 "description": "A conf id"
116 }
117 },
118 "definitions": {
119 "Entry": {
120 "required": [ "body", "title" ],
121 "properties": {
122 "id": { "type": "integer" },
123 "body": { "type": "string" },
124 "title": { "type": "string" }
125 }
126 },
127 "Void": {
128 "properties": {}
129 }
130 }
131}
Note: See TracBrowser for help on using the repository browser.