Quentin Dufour
87e7a9e3ce
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
107 lines
2.5 KiB
YAML
107 lines
2.5 KiB
YAML
openapi: 3.0.0
|
|
info:
|
|
version: v0.1.0
|
|
title: Guichet API
|
|
description: |
|
|
*TODO DESCRIPTION*
|
|
|
|
paths:
|
|
/website:
|
|
get:
|
|
tags:
|
|
- Website
|
|
operationId: "ListWebsites"
|
|
summary: "List all websites"
|
|
description: |
|
|
*TODO*
|
|
responses:
|
|
'500':
|
|
description: |
|
|
The server can not answer your request because it is in a bad state
|
|
|
|
/website/{vhost}:
|
|
get:
|
|
tags:
|
|
- Website
|
|
operationId: "GetWebsite"
|
|
summary: "Get Website"
|
|
description: |
|
|
*TODO*
|
|
|
|
responses:
|
|
'500':
|
|
description: |
|
|
The server can not answer your request because it is in a bad state
|
|
|
|
post:
|
|
tags:
|
|
- Website
|
|
operationId: "CreateWebsite"
|
|
summary: "Create a new website"
|
|
description: |
|
|
Instructs this Garage node to connect to other Garage nodes at specified `<node_id>@<net_address>`. `node_id` is generated automatically on node start.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
# todo
|
|
|
|
responses:
|
|
'500':
|
|
description: |
|
|
The server can not answer your request because it is in a bad state
|
|
'400':
|
|
description: |
|
|
Your request is malformed, check your JSON
|
|
|
|
patch:
|
|
tags:
|
|
- Website
|
|
operationId: "ConfigureWebsite"
|
|
summary: "Configure website"
|
|
description: |
|
|
Instructs this Garage node to connect to other Garage nodes at specified `<node_id>@<net_address>`. `node_id` is generated automatically on node start.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
# todo
|
|
|
|
responses:
|
|
'500':
|
|
description: |
|
|
The server can not answer your request because it is in a bad state
|
|
'400':
|
|
description: |
|
|
Your request is malformed, check your JSON
|
|
|
|
delete:
|
|
tags:
|
|
- Website
|
|
operationId: "DeleteWebsite"
|
|
summary: "Delete Website"
|
|
description: |
|
|
*TODO*
|
|
|
|
responses:
|
|
'500':
|
|
description: |
|
|
The server can not answer your request because it is in a bad state
|
|
|
|
|
|
components:
|
|
securitySchemes:
|
|
basicAuth:
|
|
type: http
|
|
scheme: basic
|
|
schemas:
|
|
# todo
|
|
|
|
security:
|
|
- basicAuth: []
|
|
|
|
servers:
|
|
- description: A local server
|
|
url: http://localhost:3903/v1/
|