Bureau of Consular Affairs · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Bureau of Consular Affairs write-api

3 actions 3 updates update extends openapi/bureau-of-consular-affairs-write-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Bureau of Consular Affairs's API. It is a proposal applied on top of the contract, not a document Bureau of Consular Affairs publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-reversibilityx-apievangelist-providerx-apievangelist-surfacex-apievangelist-artifactsx-apievangelist-warningx-apievangelist-idempotencyx-apievangelist-host-access

Targets 3

$.info
$.paths['/action/package_delete'].post
$.paths['/action/package_update'].post

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Bureau of Consular Affairs write-api
  version: 1.0.0
extends: openapi/bureau-of-consular-affairs-write-api-openapi.yml
x-provenance:
  generated: '2026-09-05'
  method: generated
  source: openapi/bureau-of-consular-affairs-write-api-openapi.yml
actions:
  - target: $.info
    update:
      x-apievangelist-provider: bureau-of-consular-affairs
      x-apievangelist-surface: CKAN Action API on the CA Data Catalog
      x-apievangelist-artifacts:
        authentication: authentication/bureau-of-consular-affairs-authentication.yml
        conventions: conventions/bureau-of-consular-affairs-conventions.yml
        errors: errors/bureau-of-consular-affairs-problem-types.yml
        data_model: data-model/bureau-of-consular-affairs-data-model.yml
        conformance: conformance/bureau-of-consular-affairs-conformance.yml
        lifecycle: lifecycle/bureau-of-consular-affairs-lifecycle.yml
      x-apievangelist-warning: >-
        This API returns HTTP 200 on failure. Read the "success" boolean in the response body; the
        status code is not the signal. See the error catalog artifact.
      x-apievangelist-idempotency: none
      x-apievangelist-host-access: >-
        cadatacatalog.state.gov is fronted by a Cloudflare WAF that returned 403 to every automated
        request from this pipeline on 2026-09-05. The operations described here are documented, not
        observed against the live host.
  - target: $.paths['/action/package_delete'].post
    update:
      x-apievangelist-reversibility:
        grade: documented
        reversal: packageUpdate
        detail: >-
          CKAN package_delete is a soft delete that sets state to "deleted"; a sysadmin can restore
          the dataset by setting state back to "active". No retention window is published.
        window: null
  - target: $.paths['/action/package_update'].post
    update:
      x-apievangelist-reversibility:
        grade: none
        detail: No undo. The previous dataset document is not returned and no revision-restore action is exposed.