Gong · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Gong Auditing Audit Logs Permission Profiles API

2 actions 2 updates update extends gong-permission-profiles-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Gong's API. It is a proposal applied on top of the contract, not a document Gong publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-artifactsx-rate-limitx-idempotencyx-paginationx-error-envelopex-forward-compatibilityx-per-customer-base-url

Targets 2

$.info
$.servers

OpenAPI Overlay

Raw ↑
# 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
# Generated by the API Evangelist enrichment pipeline.
# Captures API Evangelist enhancements for gong-permission-profiles-api-openapi.yml WITHOUT mutating the harvested spec.
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Gong Auditing Audit Logs Permission Profiles API
  version: 1.0.0
extends: gong-permission-profiles-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: openapi/gong-permission-profiles-api-openapi.yml, conventions/gong-conventions.yml, errors/gong-problem-types.yml, rate-limits/gong-rate-limits.yml, scopes/gong-scopes.yml
actions:
  - target: $.info
    update:
      x-apievangelist-provider: gong
      x-apievangelist-artifacts:
        conventions: conventions/gong-conventions.yml
        errors: errors/gong-problem-types.yml
        authentication: authentication/gong-authentication.yml
        scopes: scopes/gong-scopes.yml
        rate-limits: rate-limits/gong-rate-limits.yml
        lifecycle: lifecycle/gong-lifecycle.yml
        data-model: data-model/gong-data-model.yml
        webhooks: asyncapi/gong-webhooks.yml
        mcp: mcp/gong-mcp.yml
      x-rate-limit:
        requests_per_second: 3
        requests_per_day: 10000
        scope: company
        exhaustion_status: 429
        retry_header: Retry-After
        budget_headers_published: false
        source: https://help.gong.io/apidocs/introduction-2
      x-idempotency:
        supported: false
        note: Gong documents no idempotency key or dedupe window; write retries are not safe.
      x-pagination:
        style: opaque-cursor
        request_param: cursor
        response_object: records
        response_fields: [totalRecords, currentPageSize, currentPageNumber, cursor]
      x-error-envelope:
        media_type: application/json
        fields: [requestId, errors]
        rfc9457: false
      x-forward-compatibility: >-
        Gong may add fields to JSON output without prior warning; clients must
        ignore unknown fields.
  - target: $.servers
    update:
      x-per-customer-base-url:
        note: >-
          OAuth clients must call the host returned as api_base_url_for_customer
          in the token response (e.g. https://company-17.api.gong.io) rather than
          the generic api.gong.io host.
        source: https://help.gong.io/docs/create-an-app-for-gong