mirror of
https://github.com/ditkrg/rswag.git
synced 2026-01-23 06:16:42 +00:00
b8dcc8fe30
Can add externalValue or it will work and produce valid swagger spec. The Symbol name matching the let parameter is always required
517 lines
12 KiB
JSON
517 lines
12 KiB
JSON
{
|
|
"openapi": "3.0.0",
|
|
"info": {
|
|
"title": "API V1",
|
|
"version": "v1"
|
|
},
|
|
"paths": {
|
|
"/auth-tests/basic": {
|
|
"post": {
|
|
"summary": "Authenticates with basic auth",
|
|
"tags": [
|
|
"Auth Tests"
|
|
],
|
|
"operationId": "testBasicAuth",
|
|
"security": [
|
|
{
|
|
"basic_auth": [
|
|
|
|
]
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Valid credentials"
|
|
},
|
|
"401": {
|
|
"description": "Invalid credentials"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth-tests/api-key": {
|
|
"post": {
|
|
"summary": "Authenticates with an api key",
|
|
"tags": [
|
|
"Auth Tests"
|
|
],
|
|
"operationId": "testApiKey",
|
|
"security": [
|
|
{
|
|
"api_key": [
|
|
|
|
]
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Valid credentials"
|
|
},
|
|
"401": {
|
|
"description": "Invalid credentials"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth-tests/basic-and-api-key": {
|
|
"post": {
|
|
"summary": "Authenticates with basic auth and api key",
|
|
"tags": [
|
|
"Auth Tests"
|
|
],
|
|
"operationId": "testBasicAndApiKey",
|
|
"security": [
|
|
{
|
|
"basic_auth": [
|
|
|
|
],
|
|
"api_key": [
|
|
|
|
]
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Valid credentials"
|
|
},
|
|
"401": {
|
|
"description": "Invalid credentials"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blogs": {
|
|
"post": {
|
|
"summary": "Creates a blog",
|
|
"tags": [
|
|
"Blogs"
|
|
],
|
|
"description": "Creates a new blog from provided data",
|
|
"operationId": "createBlog",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"examples": {
|
|
"blog": {
|
|
"value": {
|
|
"blog": {
|
|
"title": "foo",
|
|
"content": "bar"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/blog"
|
|
}
|
|
},
|
|
"test/plain": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/blog"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "blog created",
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"id": 1,
|
|
"title": "foo",
|
|
"content": "bar",
|
|
"thumbnail": null
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/blog"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "invalid request",
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"errors": {
|
|
"content": [
|
|
"can't be blank"
|
|
]
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/errors_object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"summary": "Searches blogs",
|
|
"tags": [
|
|
"Blogs"
|
|
],
|
|
"description": "Searches blogs by keywords",
|
|
"operationId": "searchBlogs",
|
|
"parameters": [
|
|
{
|
|
"name": "keywords",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "success",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/blog"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"406": {
|
|
"description": "unsupported accept header"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blogs/flexible": {
|
|
"post": {
|
|
"summary": "Creates a blog flexible body",
|
|
"tags": [
|
|
"Blogs"
|
|
],
|
|
"description": "Creates a flexible blog from provided data",
|
|
"operationId": "createFlexibleBlog",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"examples": {
|
|
"flexible_blog": {
|
|
"value": {
|
|
"blog": {
|
|
"headline": "my headline",
|
|
"text": "my text"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/blog"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/flexible_blog"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "flexible blog created",
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"id": 1,
|
|
"title": "my headline",
|
|
"content": "my text",
|
|
"thumbnail": null
|
|
},
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/blog"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/flexible_blog"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blogs/alternate": {
|
|
"post": {
|
|
"summary": "Creates a blog - different :examples in requestBody",
|
|
"tags": [
|
|
"Blogs"
|
|
],
|
|
"description": "Creates a new blog from provided data",
|
|
"operationId": "createAlternateBlog",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"examples": {
|
|
"blog": {
|
|
"value": {
|
|
"blog": {
|
|
"title": "alt title",
|
|
"content": "alt bar"
|
|
}
|
|
}
|
|
},
|
|
"external_blog": {
|
|
"externalValue": "http://api.sample.org/myjson_example"
|
|
},
|
|
"another_example": {
|
|
"$ref": "#/components/examples/flexible_blog_example"
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/blog"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "blog created",
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"id": 1,
|
|
"title": "alt title",
|
|
"content": "alt bar",
|
|
"thumbnail": null
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/blog"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blogs/{id}": {
|
|
"get": {
|
|
"summary": "Retrieves a blog",
|
|
"tags": [
|
|
"Blogs"
|
|
],
|
|
"description": "Retrieves a specific blog by id",
|
|
"operationId": "getBlog",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "blog found",
|
|
"headers": {
|
|
"ETag": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"Last-Modified": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"Cache-Control": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"id": 1,
|
|
"title": "Hello world!",
|
|
"content": "Hello world and hello universe. Thank you all very much!!!",
|
|
"thumbnail": "thumbnail.png"
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/blog"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "blog not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blogs/{id}/upload": {
|
|
"put": {
|
|
"summary": "Uploads a blog thumbnail",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"Blogs"
|
|
],
|
|
"description": "Upload a thumbnail for specific blog by id",
|
|
"operationId": "uploadThumbnailBlog",
|
|
"requestBody": {
|
|
"content": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"properties": {
|
|
"orderId": {
|
|
"type": "integer"
|
|
},
|
|
"file": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "blog updated"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "https://{defaultHost}",
|
|
"variables": {
|
|
"defaultHost": {
|
|
"default": "www.example.com"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"components": {
|
|
"schemas": {
|
|
"errors_object": {
|
|
"type": "object",
|
|
"properties": {
|
|
"errors": {
|
|
"$ref": "#/components/schemas/errors_map"
|
|
}
|
|
}
|
|
},
|
|
"errors_map": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"blog": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"thumbnail": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"title"
|
|
]
|
|
},
|
|
"flexible_blog": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"headline": {
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"thumbnail": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"headline"
|
|
]
|
|
}
|
|
},
|
|
"examples": {
|
|
"flexible_blog_example": {
|
|
"summary": "Sample example of a flexible blog",
|
|
"value": {
|
|
"id": 1,
|
|
"headline": "This is a headline",
|
|
"text": "Some sample text"
|
|
}
|
|
}
|
|
},
|
|
"securitySchemes": {
|
|
"basic_auth": {
|
|
"type": "http",
|
|
"scheme": "basic"
|
|
},
|
|
"api_key": {
|
|
"type": "apiKey",
|
|
"name": "api_key",
|
|
"in": "query"
|
|
}
|
|
}
|
|
}
|
|
} |