{ "openapi": "3.0.3", "info": { "title": "News", "version": "18.1.0", "description": "An RSS/Atom feed reader", "license": { "name": "agpl" } }, "servers": [ { "url": "https://{hostname}:{port}/apps/news", "variables": { "hostname": { "default": "localhost" }, "port": { "default": "8080" } } } ], "security": [ { "basic_auth": [] } ], "components": { "securitySchemes": { "basic_auth": { "type": "http", "scheme": "basic" } } }, "paths": { "/folders": { "get": { "operationId": "folder-index-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "post": { "operationId": "folder-create-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/folders/{folderId}": { "parameters": [ { "name": "folderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "delete": { "operationId": "folder-delete-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/folders/{folderId}/restore": { "parameters": [ { "name": "folderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "folder-restore-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/folders/{folderId}/rename": { "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of the folder", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "folder-rename-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/folders/{folderId}/read": { "parameters": [ { "name": "folderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "folder-read-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/folders/{folderId}/open": { "parameters": [ { "name": "folderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "folder-open-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/feeds": { "get": { "operationId": "feed-index-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "post": { "operationId": "feed-create-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/feeds/{feedId}": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "delete": { "operationId": "feed-delete-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "patch": { "operationId": "feed-patch-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/feeds/{feedId}/restore": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "feed-restore-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/feeds/{feedId}/read": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "feed-read-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/feeds/{feedId}/update": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "feed-update-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/feeds/active": { "get": { "operationId": "feed-active-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/feeds/import/articles": { "post": { "operationId": "feed-import-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/items": { "get": { "operationId": "item-index-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/items/new": { "get": { "operationId": "item-new_items-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/items/read": { "post": { "operationId": "item-readall-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/items/{itemId}/read": { "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "item-read-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/items/read/multiple": { "post": { "operationId": "item-read_multiple-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/items/{feedId}/{guidHash}/star": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "guidHash", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "item-star-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/items/{itemId}/share/{shareRecipientId}": { "parameters": [ { "name": "itemId", "in": "path", "description": "Item to share", "required": true, "schema": { "type": "integer" } }, { "name": "shareRecipientId", "in": "path", "description": "User to share the item with", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "item-share-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/export/opml": { "get": { "operationId": "export-opml-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/export/articles": { "get": { "operationId": "export-articles-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api": { "get": { "operationId": "api-index-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/folders": { "post": { "operationId": "folder_api_v2-create-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v2/folders/{folderId}": { "parameters": [ { "name": "folderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "delete": { "operationId": "folder_api_v2-delete-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "patch": { "operationId": "folder_api_v2-update-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/version": { "get": { "operationId": "utility_api-version-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/status": { "get": { "operationId": "utility_api-status-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/cleanup/before-update": { "get": { "operationId": "utility_api-before_update-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/cleanup/after-update": { "get": { "operationId": "utility_api-after_update-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/folders": { "get": { "operationId": "folder_api-index-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "post": { "operationId": "folder_api-create-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/folders/{folderId}": { "parameters": [ { "name": "folderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "put": { "operationId": "folder_api-update-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "delete": { "operationId": "folder_api-delete-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/folders/{folderId}/read": { "parameters": [ { "name": "folderId", "in": "path", "description": "ID of the folder", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "folder_api-read-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/feeds": { "get": { "operationId": "feed_api-index-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "post": { "operationId": "feed_api-create-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/feeds/{feedId}": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "put": { "operationId": "feed_api-update-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "delete": { "operationId": "feed_api-delete-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/feeds/all": { "get": { "operationId": "feed_api-from_all_users-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/feeds/{feedId}/move": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "feed_api-move-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/feeds/{feedId}/rename": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "feed_api-rename-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/feeds/{feedId}/read": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "feed_api-read-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/feeds/update": { "get": { "operationId": "feed_api-update-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/items": { "get": { "operationId": "item_api-index-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/items/updated": { "get": { "operationId": "item_api-updated-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/items/{itemId}/read": { "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "item_api-read-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/items/{itemId}/unread": { "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "item_api-unread-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/items/read": { "post": { "operationId": "item_api-read_all-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/items/read/multiple": { "post": { "operationId": "item_api-read_multiple_by_ids-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/items/unread/multiple": { "post": { "operationId": "item_api-unread_multiple_by_ids-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/items/{itemId}/star": { "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "item_api-star_by_item_id-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/items/{itemId}/unstar": { "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "operationId": "item_api-unstar_by_item_id-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/items/star/multiple": { "post": { "operationId": "item_api-star_multiple_by_item_ids-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-3/items/unstar/multiple": { "post": { "operationId": "item_api-unstar_multiple_by_item_ids-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/version": { "get": { "operationId": "utility_api-version-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/status": { "get": { "operationId": "utility_api-status-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/cleanup/before-update": { "get": { "operationId": "utility_api-before_update-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/cleanup/after-update": { "get": { "operationId": "utility_api-after_update-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/folders": { "get": { "operationId": "folder_api-index-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "post": { "operationId": "folder_api-create-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/folders/{folderId}": { "parameters": [ { "name": "folderId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "put": { "operationId": "folder_api-update-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "delete": { "operationId": "folder_api-delete-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/folders/{folderId}/read": { "parameters": [ { "name": "folderId", "in": "path", "description": "ID of the folder", "required": true, "schema": { "type": "integer" } } ], "put": { "operationId": "folder_api-read-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/feeds": { "get": { "operationId": "feed_api-index-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "post": { "operationId": "feed_api-create-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/feeds/{feedId}": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "put": { "operationId": "feed_api-update-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "delete": { "operationId": "feed_api-delete-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/feeds/all": { "get": { "operationId": "feed_api-from_all_users-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/feeds/{feedId}/move": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "put": { "operationId": "feed_api-move-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/feeds/{feedId}/rename": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "put": { "operationId": "feed_api-rename-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/feeds/{feedId}/read": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "put": { "operationId": "feed_api-read-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/feeds/update": { "get": { "operationId": "feed_api-update-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/items": { "get": { "operationId": "item_api-index-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/items/updated": { "get": { "operationId": "item_api-updated-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/items/{itemId}/read": { "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "put": { "operationId": "item_api-read-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/items/{itemId}/unread": { "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "put": { "operationId": "item_api-unread-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/items/read": { "put": { "operationId": "item_api-read_all-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/items/read/multiple": { "put": { "operationId": "item_api-read_multiple-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/items/unread/multiple": { "put": { "operationId": "item_api-unread_multiple-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/items/{feedId}/{guidHash}/star": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "guidHash", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "operationId": "item_api-star-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/items/{feedId}/{guidHash}/unstar": { "parameters": [ { "name": "feedId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "guidHash", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "operationId": "item_api-unstar-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/items/star/multiple": { "put": { "operationId": "item_api-star_multiple-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/v1-2/items/unstar/multiple": { "put": { "operationId": "item_api-unstar_multiple-TODO", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } } } }