Skip to content

Instantly share code, notes, and snippets.

@bykof
Created August 19, 2020 09:04
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save bykof/2eb09c0013410975f558595689a35729 to your computer and use it in GitHub Desktop.
Save bykof/2eb09c0013410975f558595689a35729 to your computer and use it in GitHub Desktop.
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "DOCUMENTATION",
"description": "",
"termsOfService": "YOUR_TERMS_OF_SERVICE_URL",
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
},
"x-generation-date": "08/19/2020 10:38:48 AM"
},
"servers": [
{
"url": "http://localhost:1337",
"description": "Development server"
}
],
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/homepage": {
"get": {
"deprecated": false,
"description": "Find all the homepage's records",
"responses": {
"200": {
"description": "Retrieve homepage document(s)",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Homepage"
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"summary": "",
"tags": [
"Homepage"
]
}
}
},
"components": {
"schemas": {
"Homepage": {
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"content": {
"type": "array",
"items": {
"oneOf": [
{
"properties": {
"__component": {
"type": "string",
"enum": [
"texts.text",
"texts.title-text"
]
},
"id": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"id"
]
},
{
"properties": {
"__component": {
"type": "string",
"enum": [
"texts.text",
"texts.title-text"
]
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"id"
]
}
]
}
}
}
},
"Error": {
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"tags": [
{
"name": "Homepage"
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment