otter-cage/docs/swagger.json
2024-12-10 15:54:22 +01:00

150 lines
4.7 KiB
JSON

{
"swagger": "2.0",
"info": {
"description": "This service handles the management of secrets",
"title": "Anthrove Otter Cage API",
"contact": {
"name": "API Support",
"url": "http://anthrove.art/support",
"email": "support@anthrove.art"
},
"version": "1.0"
},
"basePath": "/api/v1",
"paths": {
"/user/{user_id}/source/{user_source_id}/key": {
"get": {
"description": "Gets a API Key.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"API Key"
],
"summary": "Gets a API Key for a Specific user and their UserSource",
"parameters": [
{
"type": "string",
"description": "User ID",
"name": "user_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "User Source ID",
"name": "user_user_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "API Key",
"schema": {
"$ref": "#/definitions/api.Response-string"
}
}
}
},
"post": {
"description": "Saves a API Key.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"API Key"
],
"summary": "Saves a API Key for a Specific user and their UserSource",
"parameters": [
{
"type": "string",
"description": "User ID",
"name": "user_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "User Source ID",
"name": "user_user_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "API Key",
"schema": {
"$ref": "#/definitions/api.Response-string"
}
}
}
},
"delete": {
"description": "Gets a API Key.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"API Key"
],
"summary": "Gets a API Key for a Specific user and their UserSource",
"parameters": [
{
"type": "string",
"description": "User ID",
"name": "user_id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "User Source ID",
"name": "user_user_id",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
}
},
"definitions": {
"api.Meta": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"status_message": {
"type": "string"
}
}
},
"api.Response-string": {
"type": "object",
"properties": {
"data": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/api.Meta"
}
}
}
}
}