Skip to content

Fix Universal Connector JSON schema reference (sourceType, ContinuationToken fields, progressWindowParams) - #6954

Open
diabler-ie wants to merge 2 commits into
SumoLogic:mainfrom
diabler-ie:fix/universal-connector-json-schema
Open

Fix Universal Connector JSON schema reference (sourceType, ContinuationToken fields, progressWindowParams)#6954
diabler-ie wants to merge 2 commits into
SumoLogic:mainfrom
diabler-ie:fix/universal-connector-json-schema

Conversation

@diabler-ie

@diabler-ie diabler-ie commented Jul 23, 2026

Copy link
Copy Markdown

Purpose of this pull request

This pull request corrects the JSON schema section of the Universal Connector page, which did not match what the Collector Management API actually accepts. Every change was verified against the live API (POST /v1/collectors/{id}/sources, us1, 2026-07-22/23):

  1. sourceType corrected to "Universal". The documented "Universal Connector" fails before schema validation with 400 collectors.validation.fields.missing: Missing required field: 'properties'. "Universal" (the value all C2C sources use, and what GET returns for existing Universal Connector sources) is accepted. This also matches the repo's own C2C template (docs/contributing/templates/c2c-source.md) and sibling C2C pages.

  2. ContinuationToken added to the paginationType enum row, with a note that LinkHeaders/ContinuationToken require their companion ...Type field. When it is missing, the validator reports misleading errors — observed verbatim with all companion fields absent: error=#/paginationType: ContinuationToken is not a valid enum value (repeated) plus error=#: required key [paginationContinuationTokenType] not found — rather than plainly naming the missing field. (PageBased was deliberately not added: probing the validator shows it is not an accepted enum value, even though the UI offers Page Based pagination.)

  3. The four ContinuationToken companion fields documented (previously absent from the table): paginationContinuationTokenType (required; "headers"/"body"), paginationContinuationTokenJsonPath, paginationContinuationTokenKey, paginationContinuationTokenLocation (all optional — verified by omitting each individually, which produces no validation error).

  4. progressWindowParams documented (previously absent). When omitted, the stored config gains default start/end query parameters built from the collection window; an API that rejects unknown query parameters then fails with Error / THIRD-PARTY-CONFIG (400: Unknown query parameter: 'end') on the first poll. Documented the explicit empty-array opt-out ("progressWindowParams": []).

  5. Example-column fixes: progressType/progressWindowSize/progressWindowInitLookback/progressWindowMaxLookback examples showed key names that don't exist (progressionType, windowSize, windowInitialLookback, windowMaxLookback); the paginationOffsetLimitValue example was a copy-pasted "$.link.next". Also fixed a pre-existing "no affect" → "no effect" typo in a row already being edited.

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

N/A — issues found while integrating against the API; no tracking ticket.

🤖 Generated with Claude Code

…inuationToken fields, progressWindowParams, example keys
@cla-bot

cla-bot Bot commented Jul 23, 2026

Copy link
Copy Markdown

Thank you for your contribution! As this is an open source project, we require contributors to sign our Contributor License Agreement and do not have yours on file. To proceed with your PR, please sign your name here and we will add you to our approved list of contributors.

…requiredness, scope progressWindowParams claim, fix typo
@cla-bot

cla-bot Bot commented Jul 23, 2026

Copy link
Copy Markdown

Thank you for your contribution! As this is an open source project, we require contributors to sign our Contributor License Agreement and do not have yours on file. To proceed with your PR, please sign your name here and we will add you to our approved list of contributors.

@kimsauce

Copy link
Copy Markdown
Collaborator

Hi @diabler-ie , many thanks for your help with the docs! Can you please sign our CLA so that we can move forward with the merge?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants