API Evangelist enhancements — TrustRadius API — Traffic Data

# authorship: generated by API Evangelist tooling. Stamped 2026-08-18
# on the file's own generator header (roadmap#64). An unmarked file is
# NOT assumed to be ours -- absence of evidence was never stamped.
x-method: generated
overlay: 1.0.0
info:
  title: API Evangelist enhancements — TrustRadius API — Traffic Data
  version: 1.0.0
extends: ../openapi/trustradius-traffic-data-api-openapi.yml
x-generated: '2026-08-14'
x-method: generated
x-source: openapi/_original/trustradius-api-openapi.yml (provider-published, exported from https://stoplight.io/api/v1/projects/trustradius/public-api/nodes/reference/api.oas3.yml), plus https://apidocs.trustradius.com/docs/public-api/ZG9jOjQ1Mg-trust-radius-api and https://apidocs.trustradius.com/docs/public-api/ZG9jOjMzODE1NA-faq
x-note: These are API Evangelist additions, not TrustRadius statements, except where an action quotes the provider docs. The original spec in openapi/ is never mutated.
actions:
- target: $.info
  description: Attach the support contact TrustRadius publishes in its API overview article, which the exported spec omits.
  update:
    contact:
      name: TrustRadius Product Team
      email: product@trustradius.com
      url: https://apidocs.trustradius.com/
    termsOfService: https://www.trustradius.com/legal/terms-of-use
- target: $
  description: 'Declare the API key requirement once at the document root. The published spec repeats `x-api-key: []` on every operation and declares no root-level security, so a generator that reads only the root sees an unauthenticated API.'
  update:
    security:
    - x-api-key: []
    externalDocs:
      description: TrustRadius API documentation
      url: https://apidocs.trustradius.com/
    x-rate-limits:
      limit: 10
      unit: second
      equivalent: 600 requests per minute
      source: https://apidocs.trustradius.com/docs/public-api/ZG9jOjMzODE1NA-faq
      response_headers: null
      note: Published in the provider FAQ. The API returns no RateLimit-* headers and names no exhaustion status code.
    x-conventions:
      format_selection: query parameter ?format=json|csv — the Accept header is ignored
      pagination: offset via skip/limit; no cursor, no total count, no Link header
      sorting: sort=field1,-field2 (leading hyphen = descending)
      sparse_fields: fields=a,b,c
      identifier_bootstrap: resolve ids with GET /product-ids before calling any other operation
      source: overlays generated by API Evangelist from apidocs.trustradius.com
- target: $.paths['/reports/traffic/pages'].get.responses['400']
  description: Give the undescribed 400 on get_traffic_page_types a human-readable meaning.
  update:
    description: Bad Request — a query parameter failed validation (date filters must be ISO 8601; limit >= 1; skip >= 0; format must be csv or json). The published spec declares no response body for this status.
- target: $.paths['/reports/traffic/pages'].get.responses['404']
  description: Give the undescribed 404 on get_traffic_page_types a human-readable meaning.
  update:
    description: Not Found — the requested identifier is unknown or is not published under the calling vendor profile. Resolve ids with GET /product-ids first. The published spec declares no response body for this status.
- target: $.paths['/reports/traffic/pages'].get.responses
  description: Record the observed AWS API Gateway 403 deny for get_traffic_page_types; the published spec declares no 403.
  update:
    '403':
      description: Forbidden — the x-api-key header is missing, invalid, or the vendor account is not entitled to this path. Observed live at the API edge on 2026-08-14 with body {"message":"Forbidden"}.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
- target: $.paths['/reports/traffic/products'].get.responses['400']
  description: Give the undescribed 400 on get_traffic_products a human-readable meaning.
  update:
    description: Bad Request — a query parameter failed validation (date filters must be ISO 8601; limit >= 1; skip >= 0; format must be csv or json). The published spec declares no response body for this status.
- target: $.paths['/reports/traffic/products'].get.responses['404']
  description: Give the undescribed 404 on get_traffic_products a human-readable meaning.
  update:
    description: Not Found — the requested identifier is unknown or is not published under the calling vendor profile. Resolve ids with GET /product-ids first. The published spec declares no response body for this status.
- target: $.paths['/reports/traffic/products'].get.responses
  description: Record the observed AWS API Gateway 403 deny for get_traffic_products; the published spec declares no 403.
  update:
    '403':
      description: Forbidden — the x-api-key header is missing, invalid, or the vendor account is not entitled to this path. Observed live at the API edge on 2026-08-14 with body {"message":"Forbidden"}.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string