Skip to content

Commit 165c5a1

Browse files
committed
pushing without any formatting
1 parent 89d22bb commit 165c5a1

File tree

1 file changed

+183
-0
lines changed

1 file changed

+183
-0
lines changed

swagger.yml

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1264,6 +1264,120 @@ paths:
12641264
default:
12651265
$ref: "#/responses/error"
12661266
# end submission
1267+
# begin service instances
1268+
/sites/{site_id}/services/{addon}/instances:
1269+
parameters:
1270+
- name: site_id
1271+
type: string
1272+
in: path
1273+
required: true
1274+
- name: addon
1275+
type: string
1276+
in: path
1277+
required: true
1278+
post:
1279+
operationId: createServiceInstance
1280+
consumes:
1281+
- application/json
1282+
parameters:
1283+
- name: config
1284+
in: body
1285+
required: true
1286+
schema:
1287+
type: object
1288+
responses:
1289+
'201':
1290+
description: Created
1291+
schema:
1292+
$ref: '#/definitions/serviceInstance'
1293+
default:
1294+
$ref: '#/responses/error'
1295+
get:
1296+
operationId: showServiceInstance
1297+
responses:
1298+
'201':
1299+
description: Created
1300+
schema:
1301+
$ref: '#/definitions/serviceInstance'
1302+
default:
1303+
$ref: '#/responses/error'
1304+
put:
1305+
operationId: updateServiceInstance
1306+
consumes:
1307+
- application/json
1308+
parameters:
1309+
- name: config
1310+
in: body
1311+
required: true
1312+
schema:
1313+
type: object
1314+
responses:
1315+
'204':
1316+
description: Created
1317+
default:
1318+
$ref: '#/responses/error'
1319+
delete:
1320+
operationId: deleteServiceInstance
1321+
responses:
1322+
'204':
1323+
description: Deleted
1324+
default:
1325+
$ref: '#/responses/error'
1326+
# end service instances
1327+
# begin services
1328+
/services/:
1329+
parameters:
1330+
- name: search
1331+
type: string
1332+
in: query
1333+
required: false
1334+
get:
1335+
operationId: getServices
1336+
responses:
1337+
'200':
1338+
description: services
1339+
schema:
1340+
type: array
1341+
items:
1342+
$ref: '#/definitions/service'
1343+
default:
1344+
$ref: '#/responses/error'
1345+
/services/{addonName}:
1346+
parameters:
1347+
- name: addonName
1348+
type: string
1349+
in: path
1350+
required: true
1351+
get:
1352+
operationId: showService
1353+
responses:
1354+
'200':
1355+
description: services
1356+
schema:
1357+
type: object
1358+
$ref: '#/definitions/serviceInstance'
1359+
default:
1360+
$ref: '#/responses/error'
1361+
1362+
# end services
1363+
# begin services manifest
1364+
/services/{addonName}/manifest:
1365+
parameters:
1366+
- name: addonName
1367+
type: string
1368+
in: path
1369+
required: true
1370+
get:
1371+
operationId: showServiceManifest
1372+
responses:
1373+
'201':
1374+
description: retrieving from provider
1375+
schema:
1376+
type: object
1377+
default:
1378+
$ref: '#/responses/error'
1379+
1380+
# end services manifest
12671381

12681382
# begin users
12691383
/user:
@@ -1280,6 +1394,75 @@ paths:
12801394
$ref: "#/responses/error"
12811395
# end users
12821396
definitions:
1397+
serviceInstance:
1398+
type: object
1399+
properties:
1400+
id:
1401+
type: string
1402+
url:
1403+
type: string
1404+
config:
1405+
type: object
1406+
external_attributes:
1407+
type: object
1408+
service_slug:
1409+
type: string
1410+
service_path:
1411+
type: string
1412+
service_name:
1413+
type: string
1414+
env:
1415+
type: object
1416+
snippets:
1417+
type: array
1418+
items:
1419+
type: object
1420+
auth_url:
1421+
type: string
1422+
created_at:
1423+
type: string
1424+
format: dateTime
1425+
updated_at:
1426+
type: string
1427+
format: dateTime
1428+
# the services definition is for the new definitions that still need to be added. currently unused
1429+
service:
1430+
type: object
1431+
properties:
1432+
id:
1433+
type: string
1434+
name:
1435+
type: string
1436+
slug:
1437+
type: string
1438+
service_path:
1439+
type: string
1440+
long_description:
1441+
type: string
1442+
description:
1443+
type: string
1444+
events:
1445+
type: array
1446+
items:
1447+
type: object
1448+
tags:
1449+
type: array
1450+
items:
1451+
type: string
1452+
icon:
1453+
type: string
1454+
manifest_url:
1455+
type: string
1456+
environments:
1457+
type: array
1458+
items:
1459+
type: string
1460+
created_at:
1461+
type: string
1462+
format: dateTime
1463+
updated_at:
1464+
type: string
1465+
format: dateTime
12831466
site:
12841467
type: object
12851468
properties:

0 commit comments

Comments
 (0)