{ "openapi": "3.1.0", "info": { "title": "Bio Radar", "version": "0.1.0", "description": "Bio Radar JSON/RSS API for bots and automation clients. See docs/BOT_INTEGRATION_API.md for usage guidance." }, "paths": { "/health": { "get": { "summary": "Health", "operationId": "health_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/v1/status": { "get": { "summary": "Status", "operationId": "status_api_v1_status_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/items": { "get": { "summary": "Items", "operationId": "items_api_v1_items_get", "parameters": [ { "name": "topic", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Topic" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" } }, { "name": "journal", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Journal" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "default": "hot", "title": "Sort" } }, { "name": "min_score", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Min Score" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/hot": { "get": { "summary": "Hot", "operationId": "hot_api_v1_hot_get", "parameters": [ { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "all", "title": "Window" } }, { "name": "topic", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Topic" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" } }, { "name": "journal", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Journal" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "default": "latest", "title": "Sort" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/items/{item_id}": { "get": { "summary": "Item Detail", "operationId": "item_detail_api_v1_items__item_id__get", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Item Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/topics": { "get": { "summary": "Topics", "operationId": "topics_api_v1_topics_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/topics/{topic}/items": { "get": { "summary": "Topic Items", "operationId": "topic_items_api_v1_topics__topic__items_get", "parameters": [ { "name": "topic", "in": "path", "required": true, "schema": { "type": "string", "title": "Topic" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/journals": { "get": { "summary": "Journals", "operationId": "journals_api_v1_journals_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/digest/daily": { "get": { "summary": "Daily Digest", "operationId": "daily_digest_api_v1_digest_daily_get", "parameters": [ { "name": "date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 20, "minimum": 1, "default": 8, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigestResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/feeds/hot.xml": { "get": { "summary": "Hot Feed", "operationId": "hot_feed_feeds_hot_xml_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 30, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/feeds/topic/{topic}.xml": { "get": { "summary": "Topic Feed", "operationId": "topic_feed_feeds_topic__topic__xml_get", "parameters": [ { "name": "topic", "in": "path", "required": true, "schema": { "type": "string", "title": "Topic" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 30, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/api/v1/search": { "get": { "summary": "Search", "operationId": "search_api_v1_search_get", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Q" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "BearerAuth": [] } ] } } }, "components": { "schemas": { "DigestResponse": { "properties": { "date": { "type": "string", "title": "Date" }, "title": { "type": "string", "title": "Title" }, "items": { "items": { "$ref": "#/components/schemas/ItemOut" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "date", "title", "items" ], "title": "DigestResponse" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ItemOut": { "properties": { "id": { "type": "string", "title": "Id" }, "title": { "type": "string", "title": "Title" }, "title_zh": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title Zh" }, "type": { "type": "string", "title": "Type" }, "url": { "type": "string", "title": "Url" }, "abstract": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Abstract" }, "summary_zh": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary Zh" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "journal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Journal" }, "published_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Published At" }, "doi": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Doi" }, "pmid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pmid" }, "arxiv_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Arxiv Id" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags", "default": [] }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "why_it_matters": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Why It Matters" }, "suggested_use": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suggested Use" } }, "type": "object", "required": [ "id", "title", "type", "url" ], "title": "ItemOut" }, "ItemsResponse": { "properties": { "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" }, "items": { "items": { "$ref": "#/components/schemas/ItemOut" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "total", "limit", "offset", "items" ], "title": "ItemsResponse" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "Bio Radar API key" } } }, "servers": [ { "url": "https://bioradar.pphd.top", "description": "Production Bio Radar API" }, { "url": "http://127.0.0.1:18888", "description": "Local development" } ] }