be5e057bfa
* add `security-audit` script * npm audit fix * remove nyc * nightwatch@1 this breaks the test suite, but it appears to have already regressed. leaving it for another day, TODO: open a backlog ticket * add `security-audit` script * disable mocha exclusivity * update package-lock.json * cypress@3.4.0 * `npm audit fix` * @release-it/conventional-changelog@1.1.0 * release-it@12
86 lines
2.2 KiB
YAML
86 lines
2.2 KiB
YAML
openapi: 3.0.0
|
|
info:
|
|
title: Demo API
|
|
description: First test
|
|
termsOfService: 'http://demo.io/terms-of-service/'
|
|
contact:
|
|
name: Demo Support
|
|
email: support@demo.io
|
|
version: 1.0.0
|
|
servers:
|
|
- url: '{server}/v1'
|
|
variables:
|
|
server:
|
|
default: https://api.demo.io
|
|
description: the API endpoint
|
|
|
|
paths:
|
|
/session:
|
|
put:
|
|
summary: Returns a new authentication token
|
|
tags:
|
|
- session
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
'201':
|
|
description: A session object
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- type: object
|
|
properties:
|
|
user_id:
|
|
type: string
|
|
format: uuid
|
|
readOnly: true
|
|
example: 110e8400-e29b-11d4-a716-446655440000
|
|
- $ref: '#/components/schemas/Session'
|
|
'401':
|
|
$ref: '#/components/responses/Unauthorized'
|
|
|
|
components:
|
|
securitySchemes:
|
|
basicAuth:
|
|
type: http
|
|
scheme: basic
|
|
bearerAuth:
|
|
type: http
|
|
scheme: bearer
|
|
bearerFormat: JWT
|
|
schemas:
|
|
Session:
|
|
required:
|
|
- token
|
|
properties:
|
|
token:
|
|
type: string
|
|
readOnly: true
|
|
example: >-
|
|
eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.EkN-DOsnsuRjRO6BxXemmJDm3HbxrbRzXglbN2S4sOkopdU4IsDxTI8jO19W_A4K8ZPJijNLis4EZsHeY559a4DFOd50_OqgHGuERTqYZyuhtF39yxJPAjUESwxk2J5k_4zM3O-vtd1Ghyo4IbqKKSy6J9mTniYJPenn5-HIirE
|
|
|
|
Error:
|
|
required:
|
|
- message
|
|
properties:
|
|
message:
|
|
description: a human readable message explaining the error
|
|
type: string
|
|
reason:
|
|
description: a functionnal key about the error
|
|
type: string
|
|
responses:
|
|
Unauthorized:
|
|
description: Not authenticated
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
Default:
|
|
description: unexpected error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|