zrok/specs/zrok.yml

63 lines
1.2 KiB
YAML
Raw Normal View History

2022-07-22 16:52:36 +02:00
info:
description: zrok client access
title: zrok
2022-07-22 16:52:36 +02:00
version: 1.0.0
2022-07-22 16:52:36 +02:00
paths:
/account:
post:
tags:
- identity
operationId: createAccount
parameters:
- name: body
in: body
schema:
$ref: "#/definitions/accountRequest"
responses:
201:
description: account created
schema:
$ref: "#/definitions/accountResponse"
2022-07-25 22:23:55 +02:00
400:
description: account not created (already exists)
500:
description: internal server error
2022-07-25 17:51:23 +02:00
/version:
get:
tags:
- metadata
operationId: version
responses:
200:
description: retrieve the current server version
schema:
$ref: "#/definitions/version"
2022-07-22 16:52:36 +02:00
definitions:
version:
type: object
properties:
version:
type: string
accountRequest:
type: object
properties:
username:
type: string
password:
type: string
accountResponse:
type: object
properties:
apiToken:
type: string
2022-07-22 16:52:36 +02:00
produces:
2022-07-22 17:45:37 +02:00
- application/zrok.v1+json
2022-07-22 16:52:36 +02:00
consumes:
2022-07-22 17:45:37 +02:00
- application/zrok.v1+json
2022-07-22 16:52:36 +02:00
schemes:
- http
swagger: "2.0"