Update swagger for json login, api prefix, direct upload, markdown read
parent
cf3a289a54
commit
3a3ee3912d
|
|
@ -18,6 +18,7 @@ paths:
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/token"
|
- $ref: "#/components/parameters/token"
|
||||||
- $ref: "#/components/parameters/id"
|
- $ref: "#/components/parameters/id"
|
||||||
|
- $ref: "#/components/parameters/md"
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
$ref: "#/components/schemas/responseOneResolved"
|
$ref: "#/components/schemas/responseOneResolved"
|
||||||
|
|
@ -54,6 +55,13 @@ components:
|
||||||
$ref: "../swagger.yaml#/components/parameters/token"
|
$ref: "../swagger.yaml#/components/parameters/token"
|
||||||
id:
|
id:
|
||||||
$ref: "../swagger.yaml#/components/parameters/id"
|
$ref: "../swagger.yaml#/components/parameters/id"
|
||||||
|
md:
|
||||||
|
name: md
|
||||||
|
description: "render the text section as markdown"
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: bool
|
||||||
|
|
||||||
schemas:
|
schemas:
|
||||||
requestOne:
|
requestOne:
|
||||||
|
|
|
||||||
|
|
@ -5,6 +5,7 @@ paths:
|
||||||
- files
|
- files
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/token"
|
- $ref: "#/components/parameters/token"
|
||||||
|
- $ref: "#/components/parameters/direct"
|
||||||
requestBody:
|
requestBody:
|
||||||
$ref: "#/components/schemas/requestForm"
|
$ref: "#/components/schemas/requestForm"
|
||||||
|
|
||||||
|
|
@ -12,6 +13,13 @@ components:
|
||||||
parameters:
|
parameters:
|
||||||
token:
|
token:
|
||||||
$ref: "../swagger.yaml#/components/parameters/token"
|
$ref: "../swagger.yaml#/components/parameters/token"
|
||||||
|
direct:
|
||||||
|
name: direct
|
||||||
|
description: "interpret content as a direct link to actual content"
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: bool
|
||||||
schemas:
|
schemas:
|
||||||
requestForm:
|
requestForm:
|
||||||
$ref: "../swagger.yaml#/components/schemas/requestForm"
|
$ref: "../swagger.yaml#/components/schemas/requestForm"
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,6 @@
|
||||||
|
paths:
|
||||||
|
get:
|
||||||
|
tags: []
|
||||||
|
summary: "Access a static read-only file server"
|
||||||
|
responses:
|
||||||
|
200: {}
|
||||||
|
|
@ -15,24 +15,26 @@ servers:
|
||||||
- url: http://api1.dndex.lan:8080/
|
- url: http://api1.dndex.lan:8080/
|
||||||
|
|
||||||
paths:
|
paths:
|
||||||
/version:
|
/api/version:
|
||||||
$ref: "./version.yaml#/paths"
|
$ref: "./version.yaml#/paths"
|
||||||
/dump:
|
/api/dump:
|
||||||
$ref: "./dump.yaml#/paths"
|
$ref: "./dump.yaml#/paths"
|
||||||
/files:
|
/api/files:
|
||||||
$ref: "./files/index.yaml#/paths"
|
$ref: "./files/index.yaml#/paths"
|
||||||
/files/{path}:
|
/api/files/{path}:
|
||||||
$ref: "./files/one.yaml#/paths"
|
$ref: "./files/one.yaml#/paths"
|
||||||
/users/register:
|
/api/users/register:
|
||||||
$ref: "./users/register.yaml#/paths"
|
$ref: "./users/register.yaml#/paths"
|
||||||
/users/login:
|
/api/users/login:
|
||||||
$ref: "./users/login.yaml#/paths"
|
$ref: "./users/login.yaml#/paths"
|
||||||
/entities:
|
/api/entities:
|
||||||
$ref: "./entities/index.yaml#/paths"
|
$ref: "./entities/index.yaml#/paths"
|
||||||
/entities/{id}:
|
/api/entities/{id}:
|
||||||
$ref: "./entities/id.yaml#/paths"
|
$ref: "./entities/id.yaml#/paths"
|
||||||
/entities/{id}/{path}:
|
/api/entities/{id}/{path}:
|
||||||
$ref: "./entities/idsub.yaml#/paths"
|
$ref: "./entities/idsub.yaml#/paths"
|
||||||
|
/:
|
||||||
|
$ref: "./index.yaml#/paths"
|
||||||
|
|
||||||
components:
|
components:
|
||||||
parameters:
|
parameters:
|
||||||
|
|
|
||||||
|
|
@ -6,13 +6,10 @@ paths:
|
||||||
- users
|
- users
|
||||||
requestBody:
|
requestBody:
|
||||||
content:
|
content:
|
||||||
|
application/json:
|
||||||
|
$ref: "#/components/schemas/requestLogin"
|
||||||
application/x-www-form-urlencoded:
|
application/x-www-form-urlencoded:
|
||||||
schema:
|
$ref: "#/components/schemas/requestLogin"
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
DnDex-User:
|
|
||||||
type: string
|
|
||||||
example: "namespace"
|
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
content:
|
content:
|
||||||
|
|
@ -26,3 +23,13 @@ paths:
|
||||||
salt:
|
salt:
|
||||||
type: string
|
type: string
|
||||||
example: def-456
|
example: def-456
|
||||||
|
|
||||||
|
components:
|
||||||
|
schemas:
|
||||||
|
requestLogin:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
DnDex-User:
|
||||||
|
type: string
|
||||||
|
example: "namespace"
|
||||||
|
|
|
||||||
|
|
@ -5,16 +5,10 @@ paths:
|
||||||
- users
|
- users
|
||||||
requestBody:
|
requestBody:
|
||||||
content:
|
content:
|
||||||
|
application/json:
|
||||||
|
$ref: "#/components/schemas/requestRegister"
|
||||||
application/x-www-form-urlencoded:
|
application/x-www-form-urlencoded:
|
||||||
schema:
|
$ref: "#/components/schemas/requestRegister"
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
DnDex-User:
|
|
||||||
type: string
|
|
||||||
example: "namespace"
|
|
||||||
DnDex-Auth:
|
|
||||||
type: string
|
|
||||||
example: "password"
|
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
$ref: "#/components/schemas/responseOK"
|
$ref: "#/components/schemas/responseOK"
|
||||||
|
|
@ -23,3 +17,13 @@ components:
|
||||||
schemas:
|
schemas:
|
||||||
responseOK:
|
responseOK:
|
||||||
$ref: "../swagger.yaml#/components/schemas/responseOK"
|
$ref: "../swagger.yaml#/components/schemas/responseOK"
|
||||||
|
requestRegister:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
DnDex-User:
|
||||||
|
type: string
|
||||||
|
example: "namespace"
|
||||||
|
DnDex-Auth:
|
||||||
|
type: string
|
||||||
|
example: "password"
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue