Files

86 lines
2.0 KiB
JSON

{
"components": {
"schemas": {
"AddParams": {
"description": "Parameters for a new note.",
"properties": {
"text": {
"description": "The complete note text, including any newlines.",
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
},
"Added": {
"description": "The result after a note enters the list.",
"properties": {
"count": {
"description": "The number of notes, including the new note.",
"format": "uint",
"minimum": 0,
"type": "integer"
}
},
"required": [
"count"
],
"type": "object"
}
}
},
"info": {
"title": "notes",
"version": "0.1.0"
},
"methods": [
{
"description": "Add a note and return the new count.",
"name": "add",
"paramStructure": "by-name",
"params": [
{
"description": "The complete note text, including any newlines.",
"name": "text",
"required": true,
"schema": {
"description": "The complete note text, including any newlines.",
"type": "string"
}
}
],
"result": {
"name": "result",
"schema": {
"$ref": "#/components/schemas/Added"
}
},
"summary": "Add a note and return the new count.",
"x-sausage-params": {
"$ref": "#/components/schemas/AddParams"
}
},
{
"description": "List all notes, oldest first.",
"name": "list",
"paramStructure": "by-name",
"params": [],
"result": {
"name": "result",
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
},
"summary": "List all notes, oldest first."
}
],
"openrpc": "1.2.6",
"x-sausage-endpoints": {},
"x-sausage-imports": {}
}