{ "openapi": "3.1.0", "info": { "title": "UNFLD Catalog API", "summary": "Public read-only catalog for UNFLD products, news, work, and company facts.", "description": "UNFLD (UNFOLDING THE FUTURE LTDA) publishes a public catalog so agents can identify products, quote company facts, and route humans to the right URL or inbox.\n\nAuthentication: none. There is no write API, webhook, or user-account surface on unfld.com.br.\nRate limit: 60 requests per minute per client. Responses include RateLimit, RateLimit-Policy, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, and X-RateLimit-* . A 429 includes Retry-After.\n\nVersioning: URL path /api/v1. Policy and deprecation signals: https://www.unfld.com.br/api/versioning. Breaking changes ship as /api/v2. Deprecated versions send Deprecation and Sunset headers for at least 180 days.\n\nHuman docs: https://www.unfld.com.br/api\nUNFLD developer resources: https://www.unfld.com.br/developers\nAgent index: https://www.unfld.com.br/llms.txt\nWhen to use UNFLD: https://www.unfld.com.br/agents.md", "version": "1.0.0", "contact": { "name": "UNFLD", "email": "sales@unfld.com.br", "url": "https://www.unfld.com.br" }, "license": { "name": "UNFLD site terms", "url": "https://www.unfld.com.br/legal/terms-of-service" } }, "servers": [ { "url": "https://www.unfld.com.br", "description": "Production" } ], "tags": [ { "name": "Discovery", "description": "Index and machine documents." }, { "name": "Organization", "description": "Legal identity and contact." }, { "name": "Products", "description": "Products by UNFLD." }, { "name": "News", "description": "Public news posts." }, { "name": "Work", "description": "Selected work." } ], "paths": { "/api/v1": { "get": { "operationId": "getCatalogIndex", "tags": [ "Discovery" ], "summary": "Catalog index", "description": "Start here. Returns documentation links and the list of catalog collections.", "responses": { "200": { "description": "Catalog index.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogIndex" } } } }, "400": { "description": "The request was well-formed but cannot be processed.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No catalog resource matches this path or slug.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed. Catalog endpoints accept GET, HEAD, and OPTIONS.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "Accept cannot be satisfied. Request application/json.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Wait Retry-After seconds, then retry the same GET.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "examples": [ 60 ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/organization": { "get": { "operationId": "getOrganization", "tags": [ "Organization" ], "summary": "Company identity", "description": "Legal name, CNPJ, São Paulo address, phones, and emails for UNFOLDING THE FUTURE LTDA trading as UNFLD.", "responses": { "200": { "description": "Organization record.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "400": { "description": "The request was well-formed but cannot be processed.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No catalog resource matches this path or slug.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed. Catalog endpoints accept GET, HEAD, and OPTIONS.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "Accept cannot be satisfied. Request application/json.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Wait Retry-After seconds, then retry the same GET.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "examples": [ 60 ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/contact": { "get": { "operationId": "getContact", "tags": [ "Organization" ], "summary": "Public contact points", "description": "Emails and phone for sales, press, careers, privacy, and security. There is no ticket-create endpoint.", "responses": { "200": { "description": "Contact record.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "The request was well-formed but cannot be processed.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No catalog resource matches this path or slug.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed. Catalog endpoints accept GET, HEAD, and OPTIONS.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "Accept cannot be satisfied. Request application/json.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Wait Retry-After seconds, then retry the same GET.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "examples": [ 60 ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/products": { "get": { "operationId": "listProducts", "tags": [ "Products" ], "summary": "List products by UNFLD", "description": "FCR, SiteCreator, Doutor Fiscal, Queravaga, and Dialogus — with status and canonical URLs.", "responses": { "200": { "description": "Product collection.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCollection" } } } }, "400": { "description": "The request was well-formed but cannot be processed.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No catalog resource matches this path or slug.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed. Catalog endpoints accept GET, HEAD, and OPTIONS.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "Accept cannot be satisfied. Request application/json.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Wait Retry-After seconds, then retry the same GET.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "examples": [ 60 ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/products/{slug}": { "get": { "operationId": "getProduct", "tags": [ "Products" ], "summary": "Get one product", "description": "Typed product record for a published slug.", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Product slug.", "schema": { "type": "string", "enum": [ "fcr", "sitecreator", "doutor-fiscal", "queravaga", "dialogus" ] }, "examples": { "fcr": { "value": "fcr" }, "sitecreator": { "value": "sitecreator" } } } ], "responses": { "200": { "description": "Product record.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "description": "The request was well-formed but cannot be processed.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No catalog resource matches this path or slug.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed. Catalog endpoints accept GET, HEAD, and OPTIONS.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "Accept cannot be satisfied. Request application/json.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Wait Retry-After seconds, then retry the same GET.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "examples": [ 60 ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/news": { "get": { "operationId": "listNews", "tags": [ "News" ], "summary": "List news posts", "description": "Public UNFLD news, newest first.", "responses": { "200": { "description": "News collection.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewsCollection" } } } }, "400": { "description": "The request was well-formed but cannot be processed.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No catalog resource matches this path or slug.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed. Catalog endpoints accept GET, HEAD, and OPTIONS.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "Accept cannot be satisfied. Request application/json.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Wait Retry-After seconds, then retry the same GET.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "examples": [ 60 ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/news/{slug}": { "get": { "operationId": "getNewsPost", "tags": [ "News" ], "summary": "Get one news post", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "News slug.", "schema": { "type": "string", "enum": [ "queravaga", "the-unfold" ] } } ], "responses": { "200": { "description": "News post.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewsPost" } } } }, "400": { "description": "The request was well-formed but cannot be processed.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No catalog resource matches this path or slug.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed. Catalog endpoints accept GET, HEAD, and OPTIONS.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "Accept cannot be satisfied. Request application/json.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Wait Retry-After seconds, then retry the same GET.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "examples": [ 60 ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/work": { "get": { "operationId": "listWork", "tags": [ "Work" ], "summary": "List selected work", "description": "Named client work the team can discuss in public.", "responses": { "200": { "description": "Work collection.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkCollection" } } } }, "400": { "description": "The request was well-formed but cannot be processed.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No catalog resource matches this path or slug.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed. Catalog endpoints accept GET, HEAD, and OPTIONS.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "Accept cannot be satisfied. Request application/json.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Wait Retry-After seconds, then retry the same GET.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "examples": [ 60 ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/work/{slug}": { "get": { "operationId": "getWork", "tags": [ "Work" ], "summary": "Get one selected-work entry", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Work slug.", "schema": { "type": "string", "enum": [ "netflix-tudum-2020", "embraer", "o-boticario-planeta-de-plastico", "sportv-album-de-campeao", "spotify-retrospectiva", "netflix-tudum-2021", "omega-luz-livre", "pucpr-multiversidade", "sportv-doe-gols", "matchone", "neuronos" ] } } ], "responses": { "200": { "description": "Work record.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Work" } } } }, "400": { "description": "The request was well-formed but cannot be processed.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No catalog resource matches this path or slug.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed. Catalog endpoints accept GET, HEAD, and OPTIONS.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "Accept cannot be satisfied. Request application/json.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Wait Retry-After seconds, then retry the same GET.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "examples": [ 60 ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/pages": { "get": { "operationId": "listPages", "tags": [ "Discovery" ], "summary": "List canonical HTML pages", "description": "The same public pages listed in sitemap.xml and llms.txt.", "responses": { "200": { "description": "Page collection.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageCollection" } } } }, "400": { "description": "The request was well-formed but cannot be processed.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No catalog resource matches this path or slug.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed. Catalog endpoints accept GET, HEAD, and OPTIONS.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "Accept cannot be satisfied. Request application/json.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Wait Retry-After seconds, then retry the same GET.", "headers": { "RateLimit": { "description": "IETF combined quota: limit, remaining, reset (seconds).", "schema": { "type": "string", "examples": [ "limit=60, remaining=60, reset=60" ] } }, "RateLimit-Policy": { "description": "Quota policy. 60 requests per 60-second window.", "schema": { "type": "string", "examples": [ "60;w=60" ] } }, "RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Limit": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Remaining": { "schema": { "type": "integer", "examples": [ 60 ] } }, "X-RateLimit-Reset": { "schema": { "type": "integer", "examples": [ 60 ] } }, "API-Version": { "schema": { "type": "string", "examples": [ "1" ] } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "examples": [ 60 ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "hint", "status", "docs" ], "properties": { "code": { "type": "string", "examples": [ "not_found" ] }, "message": { "type": "string" }, "hint": { "type": "string", "description": "What an agent should try next." }, "status": { "type": "integer" }, "docs": { "type": "string", "format": "uri" } } } } }, "CatalogIndex": { "type": "object", "additionalProperties": false, "required": [ "name", "version", "description", "documentation", "openapi", "openapiYaml", "llms", "agentInstructions", "authentication", "rateLimit", "versioning", "links" ], "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "description": { "type": "string" }, "documentation": { "type": "string", "format": "uri" }, "openapi": { "type": "string", "format": "uri" }, "openapiYaml": { "type": "string", "format": "uri" }, "llms": { "type": "string", "format": "uri" }, "agentInstructions": { "type": "string", "format": "uri" }, "authentication": { "type": "string", "const": "none" }, "rateLimit": { "$ref": "#/components/schemas/RateLimitInfo" }, "versioning": { "$ref": "#/components/schemas/VersioningInfo" }, "links": { "$ref": "#/components/schemas/CatalogLinks" } } }, "RateLimitInfo": { "type": "object", "additionalProperties": false, "required": [ "limit", "windowSeconds", "policy", "note" ], "properties": { "limit": { "type": "integer" }, "windowSeconds": { "type": "integer" }, "policy": { "type": "string" }, "note": { "type": "string" } } }, "VersioningInfo": { "type": "object", "additionalProperties": false, "required": [ "current", "policy", "deprecation" ], "properties": { "current": { "type": "string" }, "policy": { "type": "string", "format": "uri" }, "deprecation": { "type": "string" } } }, "CatalogLinks": { "type": "object", "additionalProperties": false, "required": [ "organization", "products", "news", "work", "pages", "contact" ], "properties": { "organization": { "type": "string", "format": "uri" }, "products": { "type": "string", "format": "uri" }, "news": { "type": "string", "format": "uri" }, "work": { "type": "string", "format": "uri" }, "pages": { "type": "string", "format": "uri" }, "contact": { "type": "string", "format": "uri" } } }, "OrganizationAddress": { "type": "object", "additionalProperties": false, "required": [ "line1", "line2", "district", "city", "region", "postal", "country", "formatted" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "district": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "postal": { "type": "string" }, "country": { "type": "string" }, "formatted": { "type": "string" } } }, "OrganizationActivity": { "type": "object", "additionalProperties": false, "required": [ "code", "name", "nameEn" ], "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "nameEn": { "type": "string" } } }, "OrganizationJsonLd": { "type": "object", "additionalProperties": true, "required": [ "@type", "@id", "name", "legalName", "url" ], "properties": { "@type": { "type": "string", "const": "Organization" }, "@id": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "legalName": { "type": "string" }, "alternateName": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string", "format": "uri" }, "logo": { "type": "string", "format": "uri" }, "image": { "type": "string", "format": "uri" }, "description": { "type": "string" }, "email": { "type": "string" }, "telephone": { "type": "string" }, "taxID": { "type": "string" }, "foundingDate": { "type": "string" }, "address": { "type": "object", "additionalProperties": false, "required": [ "@type", "streetAddress", "addressLocality", "addressRegion", "postalCode", "addressCountry" ], "properties": { "@type": { "type": "string", "const": "PostalAddress" }, "streetAddress": { "type": "string" }, "addressLocality": { "type": "string" }, "addressRegion": { "type": "string" }, "postalCode": { "type": "string" }, "addressCountry": { "type": "string" } } }, "contactPoint": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "@type", "contactType", "email" ], "properties": { "@type": { "type": "string", "const": "ContactPoint" }, "contactType": { "type": "string" }, "email": { "type": "string" }, "telephone": { "type": "string" }, "availableLanguage": { "type": "array", "items": { "type": "string" } } } } }, "sameAs": { "type": "array", "items": { "type": "string", "format": "uri" } }, "knowsAbout": { "type": "array", "items": { "type": "string" } }, "identifier": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "@type", "name", "value" ], "properties": { "@type": { "type": "string", "const": "PropertyValue" }, "name": { "type": "string" }, "value": { "type": "string" } } } }, "slogan": { "type": "string" } } }, "Organization": { "type": "object", "additionalProperties": false, "required": [ "name", "legalName", "tradingName", "taxId", "url", "tagline", "email", "salesEmail", "securityEmail", "telephone", "telephoneE164", "founded", "activity", "address" ], "properties": { "name": { "type": "string" }, "legalName": { "type": "string" }, "tradingName": { "type": "string" }, "taxId": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "tagline": { "type": "string" }, "email": { "type": "string" }, "salesEmail": { "type": "string" }, "securityEmail": { "type": "string" }, "telephone": { "type": "string" }, "telephoneE164": { "type": "string" }, "founded": { "type": "string" }, "activity": { "$ref": "#/components/schemas/OrganizationActivity" }, "address": { "$ref": "#/components/schemas/OrganizationAddress" }, "jsonLd": { "$ref": "#/components/schemas/OrganizationJsonLd" } } }, "Contact": { "type": "object", "additionalProperties": false, "required": [ "sales", "hello", "security", "press", "careers", "privacy", "telephone", "telephoneE164", "address", "contactPage", "hint" ], "properties": { "sales": { "type": "string" }, "hello": { "type": "string" }, "security": { "type": "string" }, "press": { "type": "string" }, "careers": { "type": "string" }, "privacy": { "type": "string" }, "telephone": { "type": "string" }, "telephoneE164": { "type": "string" }, "address": { "type": "string" }, "contactPage": { "type": "string", "format": "uri" }, "hint": { "type": "string" } } }, "ProductFeature": { "type": "object", "additionalProperties": false, "required": [ "title", "body" ], "properties": { "title": { "type": "string" }, "body": { "type": "string" } } }, "Product": { "type": "object", "additionalProperties": false, "required": [ "slug", "name", "shortName", "status", "kicker", "line", "mission", "description", "href", "features" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "formalName": { "type": "string", "nullable": true }, "status": { "type": "string" }, "kicker": { "type": "string" }, "line": { "type": "string" }, "mission": { "type": "string" }, "description": { "type": "string" }, "href": { "type": "string", "format": "uri" }, "productUrl": { "type": "string", "nullable": true }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/ProductFeature" } } } }, "ProductCollection": { "type": "object", "additionalProperties": false, "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } }, "NewsPost": { "type": "object", "additionalProperties": false, "required": [ "slug", "date", "title", "standfirst", "body", "href" ], "properties": { "slug": { "type": "string" }, "date": { "type": "string" }, "title": { "type": "string" }, "standfirst": { "type": "string" }, "body": { "type": "array", "items": { "type": "string" } }, "href": { "type": "string", "format": "uri" } } }, "NewsCollection": { "type": "object", "additionalProperties": false, "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NewsPost" } } } }, "Work": { "type": "object", "additionalProperties": false, "required": [ "slug", "client", "title", "year", "field", "form", "line", "lede", "outcome", "href" ], "properties": { "slug": { "type": "string" }, "client": { "type": "string" }, "title": { "type": "string" }, "year": { "type": "string" }, "field": { "type": "string" }, "form": { "type": "string" }, "line": { "type": "string" }, "lede": { "type": "string" }, "outcome": { "type": "string" }, "href": { "type": "string", "format": "uri" } } }, "WorkCollection": { "type": "object", "additionalProperties": false, "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Work" } } } }, "Page": { "type": "object", "additionalProperties": false, "required": [ "path", "title", "description", "section", "href" ], "properties": { "path": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "section": { "type": "string" }, "href": { "type": "string", "format": "uri" } } }, "PageCollection": { "type": "object", "additionalProperties": false, "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Page" } } } } } }, "externalDocs": { "description": "UNFLD API documentation", "url": "https://www.unfld.com.br/api" } }