OpenAPI JSON Change & Declared Consumer Impact Checker
Pricing
$0.05 / complete validation report
Compare supported OpenAPI JSON changes against explicitly declared consumers. Selected local checks; no exhaustive compatibility certification.
You can access the OpenAPI JSON Change & Declared Consumer Impact Checker programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in API & Integrations in Apify Console.
# Set API token$API_TOKEN=<YOUR_API_TOKEN>
# Prepare Actor input$cat > input.json << 'EOF'<{< "baseline_json": "{\n \"openapi\": \"3.1.0\",\n \"info\": {\"title\": \"Orders API\", \"version\": \"1.0.0\"},\n \"paths\": {\n \"/orders/{id}\": {\n \"get\": {\n \"parameters\": [{\"name\": \"id\", \"in\": \"path\", \"required\": true, \"schema\": {\"type\": \"string\"}}],\n \"responses\": {\"200\": {\"content\": {\"application/json\": {\"schema\": {\"type\": \"object\", \"properties\": {\"id\": {\"type\": \"string\"}, \"total\": {\"type\": \"number\"}}}}}}}\n }\n }\n }\n}\n",< "candidate_json": "{\n \"openapi\": \"3.1.0\",\n \"info\": {\"title\": \"Orders API\", \"version\": \"1.1.0\"},\n \"paths\": {\n \"/orders/{id}\": {\n \"get\": {\n \"parameters\": [\n {\"name\": \"id\", \"in\": \"path\", \"required\": true, \"schema\": {\"type\": \"string\"}},\n {\"name\": \"tenant\", \"in\": \"header\", \"required\": true, \"schema\": {\"type\": \"string\"}}\n ],\n \"responses\": {\"200\": {\"content\": {\"application/json\": {\"schema\": {\"type\": \"object\", \"properties\": {\"id\": {\"type\": \"string\"}}}}}}}\n }\n }\n }\n}\n",< "consumers_json": "{\n \"schema_version\": \"openapi-consumer-registry@1\",\n \"consumers\": [\n {\"consumer_id\": \"checkout\", \"criticality\": \"critical\", \"operations\": [\"GET /orders/{id}\"]},\n {\"consumer_id\": \"reporting\", \"criticality\": \"medium\", \"operations\": [\"GET /orders/{id}\"]}\n ]\n}\n"<}<EOF
# Run the Actor using an HTTP API# See the full API reference at https://docs.apify.com/api/v2$curl "https://api.apify.com/v2/actors/biztoolsus~openapi-consumer-impact/runs?token=$API_TOKEN" \< -X POST \< -d @input.json \< -H 'Content-Type: application/json'Below, you can find a list of relevant HTTP API endpoints for calling the OpenAPI JSON Change & Declared Consumer Impact Checker Actor. For this, you’ll need an Apify account. Replace <YOUR_API_TOKEN> in the URLs with your Apify API token, which you can find under API & Integrations in Apify Console. For details, see the API reference.
https://api.apify.com/v2/actors/biztoolsus~openapi-consumer-impact/runs?token=<YOUR_API_TOKEN>Note: By adding the method=POST query parameter, this API endpoint can be called using a GET request and thus used in third-party webhooks. Please refer to our Run Actor API documentation.
https://api.apify.com/v2/actors/biztoolsus~openapi-consumer-impact/run-sync-get-dataset-items?token=<YOUR_API_TOKEN>Note: This endpoint supports both POST and GET request methods. However, only the POST method allows you to pass input data. For more information, please refer to our Run Actor synchronously and get dataset items API documentation.
https://api.apify.com/v2/actors/biztoolsus~openapi-consumer-impact?token=<YOUR_API_TOKEN>For more information, please refer to our Get Actor API documentation.
Actors can be used to scrape web pages, extract data, or automate browser tasks. Use the OpenAPI JSON Change & Declared Consumer Impact Checker API programmatically via the Apify API.
You can choose from:
You can start OpenAPI JSON Change & Declared Consumer Impact Checker with the Apify API by sending an HTTP POST request to the Run Actorendpoint. An Actor’s input and its content type can be passed as a payload of the POST request, and additional options can be specified using URL query parameters. The OpenAPI JSON Change & Declared Consumer Impact Checker is identified within the API by its ID, which is the creator’s username and the name of the Actor.
When the OpenAPI JSON Change & Declared Consumer Impact Checker run finishes you can list the data from its default dataset(storage) via the API or you can preview the data directly on Apify Console.