{ "openapi": "3.0.1", "info": { "title": "OpenAPI Publish Readiness and Example Conformance Gate", "description": "Audit the OpenAPI or Swagger documents that you publish. The Actor reports every unresolved reference, every duplicate or absent operationId, every response without a schema, and every example that violates its own schema, with a JSON pointer and a sugges", "version": "0.1", "x-build-id": "pGwnPccjD0TzrOgfx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kingii98~openapi-publish-readiness-and-example-conformance-gate/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kingii98-openapi-publish-readiness-and-example-conformance-gate", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/kingii98~openapi-publish-readiness-and-example-conformance-gate/runs": { "post": { "operationId": "runs-sync-kingii98-openapi-publish-readiness-and-example-conformance-gate", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/kingii98~openapi-publish-readiness-and-example-conformance-gate/run-sync": { "post": { "operationId": "run-sync-kingii98-openapi-publish-readiness-and-example-conformance-gate", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "specUrls", "profile" ], "properties": { "specUrls": { "title": "OpenAPI document URLs", "minItems": 0, "maxItems": 50, "type": "array", "description": "Public URLs of 1 to 50 OpenAPI 3.x or Swagger 2.0 documents. JSON and YAML are both read. The Actor reads the documents only. It calls no protected endpoint, it sends no credential, and it uses no browser and no proxy. Leave the list empty to audit the two public example documents shown below.", "default": [ "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/e77481c73e1c703c7de2e4249047b42b8e9b56f4/examples/v3.0/petstore.json", "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/e77481c73e1c703c7de2e4249047b42b8e9b56f4/examples/v3.0/api-with-examples.json" ], "items": { "type": "string" } }, "profile": { "title": "Gate profile", "enum": [ "mock-readiness", "sdk-generation", "partner-publication" ], "type": "string", "description": "Which question the gate asks. 'mock-readiness' asks whether a mock server can answer every operation with a body. 'sdk-generation' asks whether a code generator can name every operation and every type. 'partner-publication' asks both questions, and it also asks whether a partner can find the service and knows how to authenticate. The profile changes the severity of each rule, and so it changes the gate result.", "default": "partner-publication" }, "checkServerReachability": { "title": "Check server reachability", "type": "boolean", "description": "Send one unauthenticated HEAD request to each declared server URL. A base URL that answers any status below 500 is reachable. Turn this off to keep the run inside the documents.", "default": true }, "maxOperationsPerSpec": { "title": "Maximum operations for each document", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many operations of one document are validated. A larger document reports operationsTruncated, and its operationsTotal stays complete.", "default": 1000 }, "maxDefectsPerSpec": { "title": "Maximum defects for each document", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many defect rows one document writes. The counters of the document row stay complete, and defectsDropped reports what the cap removed.", "default": 500 }, "timeoutSecs": { "title": "Request timeout (seconds)", "minimum": 2, "maximum": 120, "type": "integer", "description": "Per-request timeout for each document GET and each server HEAD. A request that exceeds it gets the TIMEOUT reason code.", "default": 30 }, "maxRedirects": { "title": "Maximum redirects", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum redirect hops followed for each request. Every hop is checked again against the private-address rules.", "default": 5 }, "maxResponseBytes": { "title": "Maximum document bytes", "minimum": 1000, "maximum": 20000000, "type": "integer", "description": "Per-document body cap. A larger document gets the DOCUMENT_TOO_LARGE reason code and is not parsed.", "default": 20000000 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }