Updated swagger docs to OAS3

This commit is contained in:
Alejandro Celaya
2018-02-03 09:53:40 +01:00
parent c3d555ef3c
commit ee1e1d5688
7 changed files with 500 additions and 272 deletions

View File

@@ -1,23 +1,41 @@
{
"swagger": "2.0",
"openapi": "3.0.0",
"info": {
"title": "Shlink",
"description": "Shlink, the self-hosted URL shortener",
"version": "1.0"
},
"schemes": [
"http",
"https"
],
"basePath": "/rest",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded",
"application/json"
"servers": [
{
"url": "{schema}://{host}.com",
"variables": {
"schema": {
"type": "string",
"default": "https",
"enum": [
"https",
"http"
]
},
"host": {
"type": "string"
}
}
}
],
"components": {
"securitySchemes": {
"Bearer": {
"description": "The JWT identifying a previously logged API key",
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"paths": {
"/v1/authenticate": {
"$ref": "paths/v1_authenticate.json"