{ "openapi": "3.1.0", "info": { "title": "PTP-102 Strategic Licensing Exchange Public Content API", "version": "1.0.0", "description": "Anonymous, read-only editorial summaries. Not a clinical, licensing, medical advice or account API. No OAuth token is required. No application quota headers are currently promised. Deprecation policy: /developers#versioning.", "contact": { "name": "Byrock Technologies Limited", "url": "https://ptp-102-portal.com/contact" } }, "servers": [ { "url": "https://ptp-102-portal.base44.app" } ], "security": [], "externalDocs": { "url": "https://ptp-102-portal.com/developers" }, "components": { "schemas": { "ErrorResponse": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "hint", "documentation_url" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "documentation_url": { "type": "string", "format": "uri" } } } } }, "PublicContentItem": { "type": "object", "required": [ "id", "title", "text", "path", "url", "kind" ], "properties": { "id": { "type": "string", "enum": [ "home", "about", "contact", "privacy" ] }, "title": { "type": "string" }, "text": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "kind": { "const": "public_editorial_summary", "type": "string" } } }, "PublicContentResponse": { "type": "object", "required": [ "api_version", "data" ], "properties": { "api_version": { "type": "string", "const": "1" }, "data": { "type": "array", "maxItems": 4, "items": { "type": "object", "required": [ "id", "title", "text", "path", "url", "kind" ], "properties": { "id": { "type": "string", "enum": [ "home", "about", "contact", "privacy" ] }, "title": { "type": "string" }, "text": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "kind": { "const": "public_editorial_summary", "type": "string" } } } } } } } }, "x-versioning": { "strategy": "header", "header": "API-Version", "default": "1", "policy": "https://ptp-102-portal.com/developers#versioning", "plannedNoticeDays": 90 }, "paths": { "/functions/publicContentV1": { "get": { "operationId": "listPublicContentV1", "summary": "List four public website summaries", "description": "Use for public company, programme, contact and privacy context. Anonymous and read-only; never returns private records.", "parameters": [ { "name": "API-Version", "in": "header", "required": false, "description": "Major API version. Omit for v1; unsupported versions return 400 unsupported_api_version. Additive changes stay within v1; breaking changes require a new version. Planned retirement is announced at least 90 days ahead with Deprecation, Sunset and migration links.", "schema": { "type": "string", "enum": [ "1" ], "default": "1" } } ], "responses": { "200": { "description": "Bounded public editorial summaries. No private data.", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "api_version", "data" ], "properties": { "api_version": { "type": "string", "const": "1" }, "data": { "type": "array", "maxItems": 4, "items": { "type": "object", "required": [ "id", "title", "text", "path", "url", "kind" ], "properties": { "id": { "type": "string", "enum": [ "home", "about", "contact", "privacy" ] }, "title": { "type": "string" }, "text": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "kind": { "const": "public_editorial_summary", "type": "string" } } } } } } }, "text/markdown": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid request", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown public resource", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } }, "405": { "description": "Unsupported method", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } }, "413": { "description": "Request exceeds 1024 bytes", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } }, "415": { "description": "JSON content type required", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } }, "500": { "description": "Public content unavailable", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } }, "default": { "description": "Unexpected application error. Hosting-level errors may use a different format.", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } } } }, "head": { "operationId": "headPublicContentV1", "summary": "Read catalogue response headers", "description": "Transport operation with no body on any response, including errors. Use GET to read content.", "parameters": [ { "name": "API-Version", "in": "header", "required": false, "description": "Major API version. Omit for v1; unsupported versions return 400 unsupported_api_version. Additive changes stay within v1; breaking changes require a new version. Planned retirement is announced at least 90 days ahead with Deprecation, Sunset and migration links.", "schema": { "type": "string", "enum": [ "1" ], "default": "1" } } ], "responses": { "200": { "description": "No response body", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } } }, "400": { "description": "Unsupported API version; no response body", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } } }, "500": { "description": "Public content unavailable; no response body", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } } } } }, "options": { "operationId": "optionsPublicContentV1", "summary": "Check allowed methods and request headers", "description": "CORS preflight only, not a content lookup. The successful response has no body.", "responses": { "204": { "description": "Public CORS preflight; GET, HEAD, POST, OPTIONS allowed", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } } } } }, "post": { "operationId": "readPublicContentV1", "summary": "Read a selected public summary; never writes data", "description": "Use resource home, about, contact or privacy to return one editorial summary. This POST performs no writes and needs no key, registration or payment.", "parameters": [ { "name": "API-Version", "in": "header", "required": false, "description": "Major API version. Omit for v1; unsupported versions return 400 unsupported_api_version. Additive changes stay within v1; breaking changes require a new version. Planned retirement is announced at least 90 days ahead with Deprecation, Sunset and migration links.", "schema": { "type": "string", "enum": [ "1" ], "default": "1" } } ], "requestBody": { "required": false, "description": "A read-only lookup, never a mutation. An empty JSON object returns the catalogue.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "resource": { "type": "string", "enum": [ "home", "about", "contact", "privacy" ] } } }, "example": { "resource": "about" } } } }, "responses": { "200": { "description": "Bounded public editorial summaries. No private data.", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "api_version", "data" ], "properties": { "api_version": { "type": "string", "const": "1" }, "data": { "type": "array", "maxItems": 4, "items": { "type": "object", "required": [ "id", "title", "text", "path", "url", "kind" ], "properties": { "id": { "type": "string", "enum": [ "home", "about", "contact", "privacy" ] }, "title": { "type": "string" }, "text": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "kind": { "const": "public_editorial_summary", "type": "string" } } } } } } }, "text/markdown": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid request", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown public resource", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } }, "405": { "description": "Unsupported method", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } }, "413": { "description": "Request exceeds 1024 bytes", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } }, "415": { "description": "JSON content type required", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } }, "500": { "description": "Public content unavailable", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } }, "default": { "description": "Unexpected application error. Hosting-level errors may use a different format.", "headers": { "Vary": { "description": "Includes Accept and API-Version for representation-specific caching.", "schema": { "type": "string" } }, "API-Version": { "description": "The supported API major version.", "schema": { "type": "string", "enum": [ "1" ] } }, "Link": { "description": "Links to the service description and developer documentation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/markdown": { "schema": { "type": "string" } } } } } } } } }