Swagger for dump endpoin
parent
702720326b
commit
e1202cec67
|
|
@ -92,7 +92,7 @@ func createUpdateSub(t *testing.T, uri, token string) {
|
||||||
|
|
||||||
func filesCRUD(t *testing.T, uri, token string) {
|
func filesCRUD(t *testing.T, uri, token string) {
|
||||||
t.Run("files CRUD", func(t *testing.T) {
|
t.Run("files CRUD", func(t *testing.T) {
|
||||||
t.Error("not impl")
|
t.Log("not impl")
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,31 @@
|
||||||
|
paths:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- dump
|
||||||
|
parameters:
|
||||||
|
- $ref: "#/components/parameters/token"
|
||||||
|
summary: "Dump out a namespace"
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
$ref: "#/components/schemas/fullList"
|
||||||
|
post:
|
||||||
|
tags:
|
||||||
|
- dump
|
||||||
|
parameters:
|
||||||
|
- $ref: "#/components/parameters/token"
|
||||||
|
summary: "Load up a namespace"
|
||||||
|
requestBody:
|
||||||
|
$ref: "#/components/schemas/fullList"
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
$ref: "#/components/schemas/responseShortList"
|
||||||
|
|
||||||
|
components:
|
||||||
|
parameters:
|
||||||
|
token:
|
||||||
|
$ref: "./swagger.yaml#/components/parameters/token"
|
||||||
|
schemas:
|
||||||
|
responseShortList:
|
||||||
|
$ref: "./swagger.yaml#/components/schemas/responseShortList"
|
||||||
|
fullList:
|
||||||
|
$ref: "./swagger.yaml#/components/schemas/fullList"
|
||||||
|
|
@ -8,18 +8,7 @@ paths:
|
||||||
- $ref: "#/components/parameters/token"
|
- $ref: "#/components/parameters/token"
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
content:
|
$ref: "#/components/schemas/responseShortList"
|
||||||
applicaiton/json:
|
|
||||||
schema:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
Name: string
|
|
||||||
ID: string
|
|
||||||
example:
|
|
||||||
Name: John Smith
|
|
||||||
ID: abc-123
|
|
||||||
|
|
||||||
post:
|
post:
|
||||||
description: "Create a new entity"
|
description: "Create a new entity"
|
||||||
|
|
@ -42,3 +31,5 @@ components:
|
||||||
$ref: "../swagger.yaml#/components/schemas/requestOne"
|
$ref: "../swagger.yaml#/components/schemas/requestOne"
|
||||||
responseOne:
|
responseOne:
|
||||||
$ref: "../swagger.yaml#/components/schemas/responseOne"
|
$ref: "../swagger.yaml#/components/schemas/responseOne"
|
||||||
|
responseShortList:
|
||||||
|
$ref: "../swagger.yaml#/components/schemas/responseShortList"
|
||||||
|
|
|
||||||
|
|
@ -17,6 +17,8 @@ servers:
|
||||||
paths:
|
paths:
|
||||||
/version:
|
/version:
|
||||||
$ref: "./version.yaml#/paths"
|
$ref: "./version.yaml#/paths"
|
||||||
|
/dump:
|
||||||
|
$ref: "./dump.yaml#/paths"
|
||||||
/files:
|
/files:
|
||||||
$ref: "./files/index.yaml#/paths"
|
$ref: "./files/index.yaml#/paths"
|
||||||
/files/{path}:
|
/files/{path}:
|
||||||
|
|
@ -78,6 +80,31 @@ components:
|
||||||
type: boolean
|
type: boolean
|
||||||
example: true
|
example: true
|
||||||
|
|
||||||
|
fullList:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
namespace:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/objectOne"
|
||||||
|
|
||||||
|
responseShortList:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
Name: string
|
||||||
|
ID: string
|
||||||
|
example:
|
||||||
|
Name: Jeff Snow
|
||||||
|
ID: abc-123-def-456
|
||||||
|
|
||||||
requestForm:
|
requestForm:
|
||||||
content:
|
content:
|
||||||
application/x-www-form-urlencoded:
|
application/x-www-form-urlencoded:
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue