Talkwalker · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Talkwalker Documents API

6 actions 6 updates documentation extends openapi/talkwalker-documents-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

operationIdx-apievangelist-slugx-apievangelist-sourcex-apievangelist-harvestedx-apievangelist-error-catalogx-apievangelist-conventionsx-apievangelist-rate-limitsx-apievangelist-sandbox-token

Targets 6

$.info

$.components.securitySchemes.apikeyAuth

$.paths['/api/v2/docs/p/{project_id}'].post

$.paths['/api/v2/docs/p/{project_id}/{action}'].post

$.paths['/api/v2/docs/p/{project_id}/d/{dataset_id}/{action}'].post

$.paths['/api/v2/docs/p/{project_id}/d/{dataset_id}'].post

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Talkwalker Documents API
  version: 1.0.0
extends: openapi/talkwalker-documents-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-note: Talkwalker's published OpenAPI carries NO operationId on any operation, so no tool, SDK generator, Arazzo workflow
  or MCP binding can address its operations by name. These actions add a deterministic operationId derived from method +
  path, plus provenance and auth-semantics annotations. Applying this overlay does not change any request or response contract.
actions:
- target: $.info
  update:
    x-apievangelist-slug: talkwalker
    x-apievangelist-source: https://developer.talkwalker.com/talkwalker-api.yaml
    x-apievangelist-harvested: '2026-08-13'
    x-apievangelist-error-catalog: errors/talkwalker-problem-types.yml
    x-apievangelist-conventions: conventions/talkwalker-conventions.yml
    x-apievangelist-rate-limits: rate-limits/talkwalker-rate-limits.yml
    x-apievangelist-sandbox-token: access_token=demo (search + histogram + streaming only; queries limited to cats, dogs,
      cats AND dogs)
- target: $.components.securitySchemes.apikeyAuth
  update:
    description: 'Talkwalker access token, passed as the access_token QUERY parameter (not a header). Two rights levels
      exist: read_only (search) and read_write (search plus document, stream, panel and rule writes). Because the credential
      travels in the URL it is recorded in intermediary access logs.'
    x-apievangelist-rights-levels:
    - read_only
    - read_write
- target: $.paths['/api/v2/docs/p/{project_id}'].post
  update:
    operationId: post_v2_docs_p_project_id
- target: $.paths['/api/v2/docs/p/{project_id}/{action}'].post
  update:
    operationId: post_v2_docs_p_project_id_action
- target: $.paths['/api/v2/docs/p/{project_id}/d/{dataset_id}/{action}'].post
  update:
    operationId: post_v2_docs_p_project_id_d_dataset_id_action
- target: $.paths['/api/v2/docs/p/{project_id}/d/{dataset_id}'].post
  update:
    operationId: post_v2_docs_p_project_id_d_dataset_id