Fix Universal Connector JSON schema reference (sourceType, ContinuationToken fields, progressWindowParams) - #6954
Open
diabler-ie wants to merge 2 commits into
Open
Conversation
…inuationToken fields, progressWindowParams, example keys
diabler-ie
requested review from
JV0812,
amee-sumo,
kimsauce and
mafsumo
as code owners
July 23, 2026 12:30
|
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
|
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. |
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? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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):sourceTypecorrected to"Universal". The documented"Universal Connector"fails before schema validation with400 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.ContinuationTokenadded to thepaginationTypeenum row, with a note thatLinkHeaders/ContinuationTokenrequire their companion...Typefield. 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) pluserror=#: required key [paginationContinuationTokenType] not found— rather than plainly naming the missing field. (PageBasedwas deliberately not added: probing the validator shows it is not an accepted enum value, even though the UI offers Page Based pagination.)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).progressWindowParamsdocumented (previously absent). When omitted, the stored config gains defaultstart/endquery parameters built from the collection window; an API that rejects unknown query parameters then fails withError / THIRD-PARTY-CONFIG(400: Unknown query parameter: 'end') on the first poll. Documented the explicit empty-array opt-out ("progressWindowParams": []).Example-column fixes:
progressType/progressWindowSize/progressWindowInitLookback/progressWindowMaxLookbackexamples showed key names that don't exist (progressionType,windowSize,windowInitialLookback,windowMaxLookback); thepaginationOffsetLimitValueexample 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
Ticket (if applicable)
N/A — issues found while integrating against the API; no tracking ticket.
🤖 Generated with Claude Code