Modifies parameters and body request/responses to output 3.0 syntax for basic operations.

SwaggerEditor passes basic output
This commit is contained in:
Jay Danielian
2019-07-14 17:28:11 -04:00
parent 23349b2678
commit c820bb75e0
7 changed files with 226 additions and 85 deletions

View File

@@ -13,12 +13,6 @@
],
"description": "Creates a new blog from provided data",
"operationId": "createBlog",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"requestBody": {
"required": true,
"content": {
@@ -32,6 +26,9 @@
}
}
}
},
"schema": {
"$ref": "#/components/schemas/blog"
}
}
}
@@ -49,15 +46,15 @@
"title": "foo",
"content": "bar",
"thumbnail": null
},
"schema": {
"$ref": "#/components/schemas/blog"
}
}
}
},
"422": {
"description": "invalid request",
"schema": {
"$ref": "#/components/schemas/errors_object"
},
"content": {
"application/json": {
"example": {
@@ -66,6 +63,9 @@
"can't be blank"
]
}
},
"schema": {
"$ref": "#/components/schemas/errors_object"
}
}
}
@@ -79,22 +79,125 @@
],
"description": "Searches blogs by keywords",
"operationId": "searchBlogs",
"produces": [
"application/json"
],
"parameters": [
{
"name": "keywords",
"in": "query",
"type": "string"
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/blog"
}
}
}
}
},
"406": {
"description": "unsupported accept header"
}
}
}
},
"/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"
}
},
{
"name": "file",
"in": "formData",
"required": true,
"schema": {
"type": "file"
}
}
],
"tags": [
"Blogs"
],
"description": "Upload a thumbnail for specific blog by id",
"operationId": "uploadThumbnailBlog",
"responses": {
"200": {
"description": "blog updated"
}
}
}
}
},
"servers": [