Affectiva · OpenAPI Overlay 1.0.0

API Evangelist enhancements — Affectiva EaaS frame_sampling_jobs

4 actions 4 updates documentation extends openapi/affectiva-eaas-frame_sampling_jobs.json

Generated by API Evangelist Written by API Evangelist tooling for Affectiva's API. It is a proposal applied on top of the contract, not a document Affectiva publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

contactx-api-evangelist-notehostx-observed-base-urloperationIdresponses

Targets 3

$.info

$.paths['/frame_sampling_jobs'].post

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements — Affectiva EaaS frame_sampling_jobs
  version: 1.0.0
extends: openapi/affectiva-eaas-frame_sampling_jobs.json
x-generated: '2026-09-12'
x-method: generated
x-source: openapi/affectiva-eaas-frame_sampling_jobs.json
x-note: Non-destructive enhancements to the verbatim Affectiva contract. The published document ships no operationIds,
  no host, no contact and no 401 response even though every operation is behind HTTP Basic. These actions record
  what we observed; the original is never mutated.
actions:
- target: $.info
  description: Name the operator and the live host the contract omits.
  update:
    contact:
      name: Affectiva (Smart Eye / iMotions)
      url: https://www.affectiva.com/contact-us/
    x-api-evangelist-note: Contract harvested verbatim from https://index.affectiva.com/swagger/templates/frame_sampling_jobs.json
      on 2026-09-12.
- target: $
  description: Record the host the Swagger UI actually calls; the published document sets only basePath "/".
  update:
    host: index.affectiva.com
    x-observed-base-url: https://index.affectiva.com
- target: $.paths['/frame_sampling_jobs'].post
  description: Add the missing operationId for POST /frame_sampling_jobs.
  update:
    operationId: create_frame_sampling_jobs
- target: $.paths['/frame_sampling_jobs'].post
  description: Declare the 401 the live API actually returns; the published contract omits it on every operation.
  update:
    responses:
      '401':
        description: Unauthorized. HTTP Basic credentials required; realm "Affectiva Facial Coding API". Observed
          live 2026-09-12.