101 lines
2.4 KiB
JSON
101 lines
2.4 KiB
JSON
{
|
|
"openapi": "3.0.0",
|
|
"info": {
|
|
"title": "DictionaryPlugin",
|
|
"version": "1.0.0",
|
|
"description": "A plugin that provides dictionary functions for common words and their definitions."
|
|
},
|
|
"paths": {
|
|
"/GetRandomEntry": {
|
|
"get": {
|
|
"summary": "Gets a random word from a dictionary of common words and their definitions.",
|
|
"operationId": "GetRandomEntry",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DictionaryEntry"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/GetWord": {
|
|
"get": {
|
|
"summary": "Gets the word for a given dictionary entry.",
|
|
"operationId": "GetWord",
|
|
"parameters": [
|
|
{
|
|
"name": "entry",
|
|
"in": "query",
|
|
"description": "Word to get definition for.",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DictionaryEntry"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response",
|
|
"content": {
|
|
"text/plain": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/GetDefinition": {
|
|
"get": {
|
|
"summary": "Gets the definition for a given word.",
|
|
"operationId": "GetDefinition",
|
|
"parameters": [
|
|
{
|
|
"name": "word",
|
|
"in": "query",
|
|
"description": "Word to get definition for.",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response",
|
|
"content": {
|
|
"text/plain": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"DictionaryEntry": {
|
|
"type": "object",
|
|
"properties": {
|
|
"Word": {
|
|
"type": "string"
|
|
},
|
|
"Definition": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |