feat(discovery): Add comprehensive data contracts documentation and validation framework

This commit adds JSON/YAML schemas, Python stubs, fixture examples, and comprehensive test coverage for data contracts across all modules (auth, AI models, contexts, plans, orgs, etc.). Implements automated validation through Behave and
This commit is contained in:
2025-11-01 23:33:12 -04:00
parent f48c1e8829
commit a6f3bd3841
155 changed files with 18679 additions and 20 deletions
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,7 @@
{
"publishers": {
"key": "<map[ModelPublisher]bool>"
},
"config": "<ModelProviderConfigSchema>",
"priority": 42
}
@@ -0,0 +1,4 @@
{
"name": "example_string",
"description": "example_string"
}
@@ -0,0 +1,12 @@
{
"$schema": "<SchemaUrl>",
"models": [
"<*CustomModel>"
],
"providers": [
"<*CustomProvider>"
],
"modelPacks": [
"<*ClientModelPackSchema>"
]
}
@@ -0,0 +1,9 @@
{
"id": "example_string",
"modelId": "<ModelId>",
"publisher": "<ModelPublisher>",
"description": "example_string",
"providers": [
"<BaseModelUsesProvider>"
]
}
@@ -0,0 +1,11 @@
{
"id": "example_string",
"name": "example_string",
"baseUrl": "example_string",
"hasAWSAuth": true,
"skipAuth": true,
"apiKeyEnvVar": "example_string",
"extraAuthVars": [
"<ModelProviderExtraAuthVars>"
]
}
@@ -0,0 +1,11 @@
{
"models": [
"<*CustomModel>"
],
"providers": [
"<*CustomProvider>"
],
"modelPacks": [
"<*ModelPackSchema>"
]
}
@@ -0,0 +1,7 @@
{
"id": "example_string",
"description": "example_string",
"defaultMaxConvoTokens": 42,
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,6 @@
{
"modelTag": "<ModelTag>",
"modelId": "<ModelId>",
"publisher": "<ModelPublisher>",
"basemodelshared": "<BaseModelProviderConfig>"
}
@@ -0,0 +1,15 @@
{
"modelTag": "<ModelTag>",
"modelId": "<ModelId>",
"publisher": "<ModelPublisher>",
"description": "example_string",
"requiresVariantOverrides": [
"example_string"
],
"variants": [
"<BaseModelConfigVariant>"
],
"providers": [
"<BaseModelUsesProvider>"
]
}
@@ -0,0 +1,13 @@
{
"isBaseVariant": true,
"variantTag": "<VariantTag>",
"description": "example_string",
"overrides": "<BaseModelShared>",
"variants": [
"<BaseModelConfigVariant>"
],
"requiresVariantOverrides": [
"example_string"
],
"isDefaultVariant": true
}
@@ -0,0 +1,3 @@
{
"modelName": "<ModelName>"
}
@@ -0,0 +1,19 @@
{
"defaultMaxConvoTokens": 42,
"maxTokens": 42,
"maxOutputTokens": 42,
"reservedOutputTokens": 42,
"preferredOutputFormat": "<ModelOutputFormat>",
"systemPromptDisabled": true,
"roleParamsDisabled": true,
"stopDisabled": true,
"predictedOutputEnabled": true,
"reasoningEffortEnabled": true,
"reasoningEffort": "<ReasoningEffort>",
"includeReasoning": true,
"hideReasoning": true,
"reasoningBudget": 42,
"supportsCacheControl": true,
"singleMessageNoSystemPrompt": true,
"tokenEstimatePaddingPct": 3.14159
}
@@ -0,0 +1,4 @@
{
"provider": "<ModelProvider>",
"modelName": "<ModelName>"
}
@@ -0,0 +1,13 @@
{
"$schema": "<SchemaUrl>",
"localProvider": "<ModelProvider>",
"planner": "<RoleJSON>",
"architect": "<RoleJSON>",
"coder": "<RoleJSON>",
"summarizer": "<RoleJSON>",
"builder": "<RoleJSON>",
"wholeFileBuilder": "<RoleJSON>",
"names": "<RoleJSON>",
"commitMessages": "<RoleJSON>",
"autoContinue": "<RoleJSON>"
}
@@ -0,0 +1,3 @@
{
"hasImageSupport": true
}
@@ -0,0 +1,15 @@
{
"id": "example_string",
"name": "example_string",
"localProvider": "<ModelProvider>",
"description": "example_string",
"planner": "<PlannerRoleConfig>",
"coder": "<ModelRoleConfig>",
"planSummary": "<ModelRoleConfig>",
"builder": "<ModelRoleConfig>",
"wholeFileBuilder": "<ModelRoleConfig>",
"namer": "<ModelRoleConfig>",
"commitMsg": "<ModelRoleConfig>",
"execStatus": "<ModelRoleConfig>",
"contextLoader": "<ModelRoleConfig>"
}
@@ -0,0 +1,4 @@
{
"name": "example_string",
"description": "example_string"
}
@@ -0,0 +1,9 @@
{
"localProvider": "<ModelProvider>",
"planner": "<ModelRoleConfigSchema>",
"planSummary": "<ModelRoleConfigSchema>",
"builder": "<ModelRoleConfigSchema>",
"namer": "<ModelRoleConfigSchema>",
"commitMsg": "<ModelRoleConfigSchema>",
"execStatus": "<ModelRoleConfigSchema>"
}
@@ -0,0 +1,12 @@
{
"role": "<ModelRole>",
"modelId": "<ModelId>",
"temperature": 3.14,
"topP": 3.14,
"reservedOutputTokens": 42,
"largeContextFallback": "<ModelRoleConfig>",
"largeOutputFallback": "<ModelRoleConfig>",
"errorFallback": "<ModelRoleConfig>",
"strongModel": "<ModelRoleConfig>",
"localProvider": "<ModelProvider>"
}
@@ -0,0 +1,3 @@
{
"modelId": "<ModelId>"
}
@@ -0,0 +1,4 @@
{
"provider": "<ModelProvider>",
"modelTag": "<ModelTag>"
}
@@ -0,0 +1,3 @@
{
"maxConvoTokens": 42
}
@@ -0,0 +1,3 @@
{
"modelroleconfig": "<PlannerModelConfig>"
}
@@ -0,0 +1,6 @@
{
"modelroleconfig": "<ModelRoleConfig>",
"isfallback": true,
"fallbacktype": "<FallbackType>",
"basemodelconfig": "<BaseModelConfig>"
}
@@ -0,0 +1,5 @@
{
"kind": "<ModelErrKind>",
"retriable": true,
"retryafterseconds": 42
}
@@ -0,0 +1,12 @@
{
"provider": "<ModelProvider>",
"baseUrl": "example_string",
"hasAWSAuth": true,
"hasClaudeMaxAuth": true,
"skipAuth": true,
"localOnly": true,
"apiKeyEnvVar": "example_string",
"extraAuthVars": [
"<ModelProviderExtraAuthVars>"
]
}
@@ -0,0 +1,6 @@
{
"var": "example_string",
"maybeJSONFilePath": true,
"required": true,
"default": "example_string"
}
@@ -0,0 +1,5 @@
{
"type": "<ApiErrorType>",
"status": 42,
"msg": "example_string"
}
@@ -0,0 +1,5 @@
{
"token": "example_string",
"orgId": "example_string",
"hash": "example_string"
}
@@ -0,0 +1,4 @@
{
"hasBillingPermission": true,
"isTrial": true
}
@@ -0,0 +1,10 @@
{
"isCloud": true,
"host": "example_string",
"email": "example_string",
"userName": "example_string",
"userId": "example_string",
"token": "example_string",
"isLocalMode": true,
"isTrial": true
}
@@ -0,0 +1,6 @@
{
"orgId": "example_string",
"orgName": "example_string",
"orgIsTrial": true,
"integratedModelsMode": true
}
@@ -0,0 +1,3 @@
{
"maxMessages": 42
}
@@ -0,0 +1,3 @@
{
"maxPlans": 42
}
@@ -0,0 +1,16 @@
{
"updatedcontexts": [
"<*Context>"
],
"tokendiffsbyid": {
"key": "<map[string]int>"
},
"tokensdiff": 42,
"totaltokens": 42,
"numfiles": 42,
"numurls": 42,
"numimages": 42,
"numtrees": 42,
"nummaps": 42,
"maxtokens": 42
}
@@ -0,0 +1,8 @@
{
"numfiles": 42,
"numtrees": 42,
"numurls": 42,
"nummaps": 42,
"tokensdiff": 42,
"totaltokens": 42
}
@@ -0,0 +1,12 @@
{
"id": "example_string",
"planId": "example_string",
"ownerId": "example_string",
"parentBranchId": "example_string",
"name": "example_string",
"status": "<PlanStatus>",
"contextTokens": 42,
"convoTokens": 42,
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,18 @@
{
"creditsBalance": "<decimal.Decimal>",
"monthlyGrant": "<decimal.Decimal>",
"autoRebuyEnabled": true,
"autoRebuyMinThreshold": "<decimal.Decimal>",
"autoRebuyToBalance": "<decimal.Decimal>",
"notifyThreshold": "<decimal.Decimal>",
"maxThresholdPerMonth": "<decimal.Decimal>",
"billingCycleStartedAt": "2024-01-01T00:00:00Z",
"changedBillingMode": true,
"trialPaid": true,
"stripeSubscriptionId": "example_string",
"subscriptionStatus": "example_string",
"subscriptionPausedAt": "2024-01-01T00:00:00Z",
"stripePaymentMethod": "example_string",
"subscriptionActionRequired": true,
"subscriptionActionRequiredInvoiceUrl": "example_string"
}
@@ -0,0 +1,27 @@
{
"id": "example_string",
"ownerId": "example_string",
"contextType": "<ContextType>",
"name": "example_string",
"url": "example_string",
"file_path": "example_string",
"sha": "example_string",
"numTokens": 42,
"body": "example_string",
"bodySize": 42,
"forceSkipIgnore": true,
"imageDetail": "<openai.ImageURLDetail>",
"mapParts": "<FileMapBodies>",
"mapShas": {
"key": "<map[string]string>"
},
"mapTokens": {
"key": "<map[string]int>"
},
"mapSizes": {
"key": "<map[string]int64>"
},
"autoLoaded": true,
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,20 @@
{
"id": "example_string",
"userId": "example_string",
"role": "example_string",
"tokens": 42,
"num": 42,
"message": "example_string",
"stopped": true,
"flags": "<ConvoMessageFlags>",
"addedSubtasks": [
"<*Subtask>"
],
"removedSubtasks": [
"example_string"
],
"activeContextIds": [
"example_string"
],
"createdAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,17 @@
{
"id": "example_string",
"convoMessageId": "example_string",
"summarizedToMessageId": "example_string",
"wroteFiles": true,
"commitMsg": "example_string",
"operations": [
"<*Operation>"
],
"didBuild": true,
"buildPathsInvalidated": {
"key": "<map[string]bool>"
},
"error": "example_string",
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,15 @@
{
"didMakePlan": true,
"didRemoveTasks": true,
"didMakeDebuggingPlan": true,
"didLoadContext": true,
"currentstage": "<CurrentStage>",
"isChat": true,
"didWriteCode": true,
"didCompleteTask": true,
"didCompletePlan": true,
"hasUnfinishedSubtasks": true,
"isApplyDebug": true,
"isUserDebug": true,
"hasError": true
}
@@ -0,0 +1,9 @@
{
"id": "example_string",
"latestConvoMessageCreatedAt": "2024-01-01T00:00:00Z",
"lastestConvoMessageId": "example_string",
"summary": "example_string",
"tokens": 42,
"numMessages": 42,
"createdAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,14 @@
{
"id": "example_string",
"orgId": "example_string",
"orgName": "example_string",
"userId": "example_string",
"userEmail": "example_string",
"userName": "example_string",
"transactionType": "<CreditsTransactionType>",
"amount": "<decimal.Decimal>",
"startBalance": "<decimal.Decimal>",
"endBalance": "<decimal.Decimal>",
"creditIsAutoRebuy": true,
"createdAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,11 @@
{
"files": {
"key": "<map[string]string>"
},
"removedByPath": {
"key": "<map[string]bool>"
},
"updatedAtByPath": {
"key": "<map[string]time.Time>"
}
}
@@ -0,0 +1,13 @@
{
"planResult": "<PlanResult>",
"currentPlanFiles": "<CurrentPlanFiles>",
"convoMessageDescriptions": [
"<*ConvoMessageDescription>"
],
"planApplies": [
"<*PlanApply>"
],
"contextsByPath": {
"key": "<map[string]*Context>"
}
}
@@ -0,0 +1,4 @@
{
"tellstage": "<TellStage>",
"planningphase": "<PlanningPhase>"
}
@@ -0,0 +1,11 @@
{
"id": "example_string",
"orgId": "example_string",
"email": "example_string",
"name": "example_string",
"orgRoleId": "example_string",
"inviterId": "example_string",
"inviteeId": "example_string",
"acceptedAt": "2024-01-01T00:00:00Z",
"createdAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,9 @@
{
"type": "<OperationType>",
"path": "example_string",
"destination": "example_string",
"content": "example_string",
"description": "example_string",
"replybefore": "example_string",
"numtokens": 42
}
@@ -0,0 +1,7 @@
{
"id": "example_string",
"name": "example_string",
"isTrial": true,
"autoAddDomainUsers": true,
"integratedModelsMode": true
}
@@ -0,0 +1,6 @@
{
"id": "example_string",
"isDefault": true,
"label": "example_string",
"description": "example_string"
}
@@ -0,0 +1,5 @@
{
"orgId": "example_string",
"userId": "example_string",
"orgRoleId": "example_string"
}
@@ -0,0 +1,10 @@
{
"id": "example_string",
"ownerId": "example_string",
"projectId": "example_string",
"name": "example_string",
"totalReplies": 42,
"activeBranches": 42,
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,15 @@
{
"id": "example_string",
"userId": "example_string",
"convoMessageIds": [
"example_string"
],
"convoMessageDescriptionIds": [
"example_string"
],
"planFileResultIds": [
"example_string"
],
"commitMsg": "example_string",
"createdAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,8 @@
{
"id": "example_string",
"convoMessageId": "example_string",
"filePath": "example_string",
"error": "example_string",
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,16 @@
{
"id": "example_string",
"typeVersion": 42,
"replaceWithLineNums": true,
"convoMessageId": "example_string",
"planBuildId": "example_string",
"path": "example_string",
"content": "example_string",
"anyFailed": true,
"replacements": [
"<*Replacement>"
],
"removedFile": true,
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,12 @@
{
"sortedPaths": [
"example_string"
],
"fileResultsByPath": "<PlanFileResultsByPath>",
"results": [
"<*PlanFileResult>"
],
"replacementsByPath": {
"key": "<map[string][]*Replacement>"
}
}
@@ -0,0 +1,4 @@
{
"id": "example_string",
"name": "example_string"
}
@@ -0,0 +1,9 @@
{
"id": "example_string",
"old": "example_string",
"summary": "example_string",
"entireFile": true,
"new": "example_string",
"failed": true,
"streamedChange": "<StreamedChangeWithLineNums>"
}
@@ -0,0 +1,8 @@
{
"title": "example_string",
"description": "example_string",
"usesFiles": [
"example_string"
],
"isFinished": true
}
@@ -0,0 +1,7 @@
{
"id": "example_string",
"name": "example_string",
"email": "example_string",
"isTrial": true,
"numNonDraftPlans": 42
}
@@ -0,0 +1,5 @@
{
"promptedClaudeMax": true,
"useClaudeSubscription": true,
"claudeSubscriptionCooldownStartedAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,9 @@
{
"name": "example_string",
"desc": "example_string",
"choices": [
"example_string"
],
"hascustomchoice": true,
"sortkey": "example_string"
}
@@ -0,0 +1,23 @@
{
"autoMode": "<AutoModeType>",
"editor": "example_string",
"editorCommand": "example_string",
"editorArgs": [
"example_string"
],
"editorOpenManually": true,
"autoContinue": true,
"autoBuild": true,
"autoUpdateContext": true,
"autoContext": true,
"smartContext": true,
"autoApply": true,
"autoCommit": true,
"skipCommit": true,
"canExec": true,
"autoExec": true,
"autoDebug": true,
"autoDebugTries": 42,
"autoRevertOnRewind": true,
"skipChangesMenu": true
}
@@ -0,0 +1,22 @@
{
"modelPackName": "example_string",
"modelPack": "<ModelPack>",
"customModelPacks": [
"<*ModelPack>"
],
"customModels": [
"<*CustomModel>"
],
"customModelsById": {
"key": "<map[ModelId]*CustomModel>"
},
"customProviders": [
"<*CustomProvider>"
],
"usesCustomProviderByModelId": {
"key": "<map[ModelId][]BaseModelUsesProvider>"
},
"isCloud": true,
"configured": true,
"updatedAt": "2024-01-01T00:00:00Z"
}
@@ -0,0 +1,11 @@
{
"apiKeys": {
"key": "<map[string]string>"
},
"openAIBase": "example_string",
"openAIOrgId": "example_string",
"authVars": {
"key": "<map[string]string>"
},
"sessionId": "example_string"
}
@@ -0,0 +1,14 @@
{
"connectStream": true,
"apiKeys": {
"key": "<map[string]string>"
},
"openAIOrgId": "example_string",
"authVars": {
"key": "<map[string]string>"
},
"projectPaths": {
"key": "<map[string]bool>"
},
"sessionId": "example_string"
}
@@ -0,0 +1,7 @@
{
"email": "example_string",
"pin": "example_string",
"userName": "example_string",
"orgName": "example_string",
"orgAutoAddDomainUsers": true
}
@@ -0,0 +1,5 @@
{
"email": "example_string",
"pin": "example_string",
"userName": "example_string"
}
@@ -0,0 +1,3 @@
{
"name": "example_string"
}
@@ -0,0 +1,6 @@
{
"email": "example_string",
"userId": "example_string",
"requireUser": true,
"requireNoUser": true
}
@@ -0,0 +1,4 @@
{
"hasAccount": true,
"isLocalMode": true
}
@@ -0,0 +1,4 @@
{
"name": "example_string",
"autoAddDomainUsers": true
}
@@ -0,0 +1,3 @@
{
"id": "example_string"
}
@@ -0,0 +1,3 @@
{
"name": "example_string"
}
@@ -0,0 +1,4 @@
{
"id": "example_string",
"name": "example_string"
}
@@ -0,0 +1,3 @@
{
"name": "example_string"
}
@@ -0,0 +1,3 @@
{
"id": "example_string"
}
@@ -0,0 +1,7 @@
{
"transactionType": "<CreditsTransactionType>",
"planId": "example_string",
"sessionId": "example_string",
"dayStart": "2024-01-01T00:00:00Z",
"month": true
}
@@ -0,0 +1,11 @@
{
"transactions": [
"<*CreditsTransaction>"
],
"numPages": 42,
"numPagesMax": true,
"monthStart": "2024-01-01T00:00:00Z",
"planNamesById": {
"key": "<map[string]string>"
}
}
@@ -0,0 +1,18 @@
{
"balance": "<decimal.Decimal>",
"totalSpend": "<decimal.Decimal>",
"monthStart": "2024-01-01T00:00:00Z",
"byPlanId": {
"key": "<map[string]decimal.Decimal>"
},
"planNamesById": {
"key": "<map[string]string>"
},
"byModelName": {
"key": "<map[string]decimal.Decimal>"
},
"byPurpose": {
"key": "<map[string]decimal.Decimal>"
},
"cacheSavings": "<decimal.Decimal>"
}
@@ -0,0 +1,5 @@
{
"ids": {
"key": "<map[string]bool>"
}
}
@@ -0,0 +1,5 @@
{
"tokensRemoved": 42,
"totalTokens": 42,
"msg": "example_string"
}
@@ -0,0 +1,3 @@
{
"balance": "<decimal.Decimal>"
}
@@ -0,0 +1,8 @@
{
"builtFiles": {
"key": "<map[string]bool>"
},
"isBuildingByPath": {
"key": "<map[string]bool>"
}
}
@@ -0,0 +1,3 @@
{
"contextId": "example_string"
}
@@ -0,0 +1,3 @@
{
"body": "example_string"
}
@@ -0,0 +1,5 @@
{
"currentBranchByPlanId": {
"key": "<map[string]string>"
}
}
@@ -0,0 +1,3 @@
{
"config": "<PlanConfig>"
}
@@ -0,0 +1,3 @@
{
"mapInputs": "<FileMapInputs>"
}
@@ -0,0 +1,3 @@
{
"mapBodies": "<FileMapBodies>"
}
@@ -0,0 +1,3 @@
{
"config": "<PlanConfig>"
}
@@ -0,0 +1,5 @@
{
"email": "example_string",
"name": "example_string",
"orgRoleId": "example_string"
}
@@ -0,0 +1,17 @@
{
"branches": [
"<*Branch>"
],
"streamStartedAtByBranchId": {
"key": "<map[string]time.Time>"
},
"streamFinishedAtByBranchId": {
"key": "<map[string]time.Time>"
},
"streamIdByBranchId": {
"key": "<map[string]string>"
},
"plansById": {
"key": "<map[string]*Plan>"
}
}
@@ -0,0 +1,8 @@
{
"users": [
"<*User>"
],
"orgUsersByUserId": {
"key": "<map[string]*OrgUser>"
}
}
@@ -0,0 +1,5 @@
{
"filePaths": [
"example_string"
]
}
@@ -0,0 +1,6 @@
{
"loadRes": "<LoadContextResponse>",
"cachedByPath": {
"key": "<map[string]bool>"
}
}
@@ -0,0 +1,29 @@
{
"contextType": "<ContextType>",
"name": "example_string",
"url": "example_string",
"file_path": "example_string",
"body": "example_string",
"forceSkipIgnore": true,
"imageDetail": "<openai.ImageURLDetail>",
"autoLoaded": true,
"inputShas": {
"key": "<map[string]string>"
},
"inputTokens": {
"key": "<map[string]int>"
},
"inputSizes": {
"key": "<map[string]int64>"
},
"mapBodies": "<FileMapBodies>",
"apiKeys": {
"key": "<map[string]string>"
},
"openAIBase": "example_string",
"openAIOrgId": "example_string",
"authVars": {
"key": "<map[string]string>"
},
"sessionId": "example_string"
}

Some files were not shown because too many files have changed in this diff Show More