Afero · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Afero Cloud OTA Firmware API

3 actions 3 updates update extends openapi/afero-ota-api-openapi.yml

Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-slugx-apievangelist-source-docsx-apievangelist-spec-originx-apievangelist-provider-openapix-apievangelist-artifactsx-apievangelist-reviewx-agentic-consequence

Targets 2

$.info

$.paths['/v1/ota/partners/{partnerId}/deviceTypes/{deviceTypeId}/firmwareImages/{firmwareImageId}/push'].put

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Afero Cloud OTA Firmware API
  version: 1.0.0
extends: openapi/afero-ota-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-provider: Afero
    x-apievangelist-slug: afero
    x-apievangelist-source-docs: https://afero-docs.readthedocs.io/en/latest/CloudAPIs/
    x-apievangelist-spec-origin: derived-from-documentation
    x-apievangelist-provider-openapi: none-published
    x-apievangelist-artifacts:
      authentication: authentication/afero-authentication.yml
      conventions: conventions/afero-conventions.yml
      errors: errors/afero-problem-types.yml
      lifecycle: lifecycle/afero-lifecycle.yml
      data-model: data-model/afero-data-model.yml
      conformance: conformance/afero-conformance.yml
      packages: packages/afero-packages.yml
      skills: skills/_index.yml
- target: $.info
  update:
    x-apievangelist-review:
      no_machine_readable_contract: https://api.afero.io/api-docs and https://api.afero.io/v1/openapi.json
        both return HTTP 401 (probed 2026-08-02).
      no_rate_limit_policy: true
      no_idempotency_contract: true
      no_status_page: true
      no_deprecation_policy: true
      no_event_surface: No webhooks and no AsyncAPI.
      release_notes_stale_since: '2020-01-28'
- target: $.paths['/v1/ota/partners/{partnerId}/deviceTypes/{deviceTypeId}/firmwareImages/{firmwareImageId}/push'].put
  update:
    x-agentic-consequence: safety-critical
    x-apievangelist-note: Flashes firmware onto deployed hardware; the Afero OTA service refuses downgrades
      below the installed version.