otter-cage/docs/swagger.yaml

101 lines
2.3 KiB
YAML
Raw Normal View History

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