116 lines
2.5 KiB
JSON
116 lines
2.5 KiB
JSON
{
|
|
"openapi": "3.0.3",
|
|
"info": {
|
|
"title": "Test API",
|
|
"version": "1.33.7",
|
|
"description": "An amazing, fully-ish 😉 generated API spec",
|
|
"termsOfService": "https://example.com",
|
|
"contact": {
|
|
"name": "Homer Simpson",
|
|
"url": "https://gph.is/1NPUDiM",
|
|
"email": "chunkylover53@aol.com"
|
|
},
|
|
"license": {
|
|
"name": "MIT",
|
|
"url": "https://github.com/bkbnio/kompendium/blob/main/LICENSE"
|
|
}
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "https://myawesomeapi.com",
|
|
"description": "Production instance of my API"
|
|
},
|
|
{
|
|
"url": "https://staging.myawesomeapi.com",
|
|
"description": "Where the fun stuff happens"
|
|
}
|
|
],
|
|
"paths": {
|
|
"/test": {
|
|
"patch": {
|
|
"tags": [],
|
|
"summary": "Test patch endpoint",
|
|
"description": "patch your tests here!",
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"description": "A Test request",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "A Successful Endeavor",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TestResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"deprecated": false
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"TestRequest": {
|
|
"properties": {
|
|
"aaa": {
|
|
"items": {
|
|
"format": "int64",
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"b": {
|
|
"format": "double",
|
|
"type": "number"
|
|
},
|
|
"field_name": {
|
|
"$ref": "#/components/schemas/TestNested"
|
|
}
|
|
},
|
|
"required": [
|
|
"field_name",
|
|
"b",
|
|
"aaa"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"TestNested": {
|
|
"properties": {
|
|
"nesty": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"nesty"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"TestResponse": {
|
|
"properties": {
|
|
"c": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"c"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"securitySchemes": {}
|
|
},
|
|
"security": [],
|
|
"tags": []
|
|
}
|