Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
packages/spec/spec-changes.json merge=os-regen
packages/spec/authorable-surface/** merge=os-regen
packages/spec/authorable-surface.base.json merge=os-regen
packages/spec/authorable-defaults/** merge=os-regen
packages/spec/json-schema.manifest/** merge=os-regen
packages/spec/api-surface/** merge=os-regen
packages/spec/api-surface-signatures.json merge=os-regen
Expand Down
66 changes: 66 additions & 0 deletions packages/spec/authorable-defaults/ai.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
{
"description": "Ratchet of the DEFAULT VALUE of every authorable key in one category that has one (#4666) — what a metadata author gets when they omit the key, which for AI-authored metadata is most of the time. Sharded by category like authorable-surface/; the gate reads the whole authorable-defaults/ directory as ONE set. Each line is \"<def>:<key> = <canonical JSON>\". Additions (a NEW key that ships with a default) are auto-recorded — commit the change. CHANGING, ADDING or REMOVING the default of a key that already existed is NOT auto-recorded: it silently alters the behaviour of already-deployed metadata, so it fails check:authorable-surface until it is declared in DEFAULT_CHANGES_BY_MAJOR (scripts/lib/default-changes.ts). Constraints are deliberately NOT recorded here — a tightened bound REJECTS a document loudly, which is a different and self-announcing class (maintainer ruling on #4666, direction B). See #4666, #4661.",
"category": "ai",
"defaults": [
"ai/AIModelConfig:provider = \"openai\"",
"ai/AIModelConfig:temperature = 0.7",
"ai/Agent:active = true",
"ai/Agent:surface = \"ask\"",
"ai/BlueprintNavItem:type = \"object\"",
"ai/BlueprintView:type = \"list\"",
"ai/CodeContent:language = \"text\"",
"ai/ConversationAnalytics:pruningEvents = 0",
"ai/ConversationAnalytics:summarizationEvents = 0",
"ai/ConversationAnalytics:tokensSavedByPruning = 0",
"ai/ConversationAnalytics:tokensSavedBySummarization = 0",
"ai/ConversationMessage:pinned = false",
"ai/ConversationSession:messages = []",
"ai/ConversationSession:status = \"active\"",
"ai/FileKnowledgeSource:mimeTypes = []",
"ai/ImageContent:detail = \"auto\"",
"ai/KnowledgeDocument:metadata = {}",
"ai/KnowledgeHit:metadata = {}",
"ai/KnowledgeRefreshPolicy:onRecordChange = true",
"ai/KnowledgeSource:adapterConfig = {}",
"ai/KnowledgeSource:aiExposed = true",
"ai/KnowledgeSource:refresh = {}",
"ai/MCPServerRef:active = true",
"ai/MCPToolBinding:approval = \"never\"",
"ai/ModelCapability:codeGeneration = false",
"ai/ModelCapability:functionCalling = false",
"ai/ModelCapability:imageGeneration = false",
"ai/ModelCapability:imageUnderstanding = false",
"ai/ModelCapability:reasoning = false",
"ai/ModelCapability:textEmbedding = false",
"ai/ModelCapability:textGeneration = true",
"ai/ModelConfig:deprecated = false",
"ai/ModelPricing:currency = \"USD\"",
"ai/ModelRegistry:enableAutoFallback = true",
"ai/ModelRegistryEntry:priority = 0",
"ai/ModelRegistryEntry:status = \"active\"",
"ai/ModelSelectionCriteria:excludeDeprecated = true",
"ai/ObjectKnowledgeSource:metadataFields = []",
"ai/PromptTemplate:version = \"1.0.0\"",
"ai/PromptVariable:required = false",
"ai/PromptVariable:type = \"string\"",
"ai/Skill:active = true",
"ai/Skill:surface = \"ask\"",
"ai/SolutionBlueprint:assumptions = []",
"ai/StructuredOutputConfig:maxRetries = 3",
"ai/StructuredOutputConfig:retryOnValidationFailure = true",
"ai/StructuredOutputConfig:strict = false",
"ai/TokenBudgetConfig:bufferPercentage = 0.1",
"ai/TokenBudgetConfig:enableSummarization = false",
"ai/TokenBudgetConfig:reserveTokens = 500",
"ai/TokenBudgetConfig:strategy = \"sliding_window\"",
"ai/TokenBudgetConfig:warnThreshold = 0.8",
"ai/TokenUsageStats:budgetUsed = 0",
"ai/TokenUsageStats:completionTokens = 0",
"ai/TokenUsageStats:messageCount = 0",
"ai/TokenUsageStats:promptTokens = 0",
"ai/TokenUsageStats:prunedMessageCount = 0",
"ai/TokenUsageStats:summarizedMessageCount = 0",
"ai/TokenUsageStats:totalTokens = 0",
"ai/ToolCall:type = \"function\""
]
}
207 changes: 207 additions & 0 deletions packages/spec/authorable-defaults/api.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
{
"description": "Ratchet of the DEFAULT VALUE of every authorable key in one category that has one (#4666) — what a metadata author gets when they omit the key, which for AI-authored metadata is most of the time. Sharded by category like authorable-surface/; the gate reads the whole authorable-defaults/ directory as ONE set. Each line is \"<def>:<key> = <canonical JSON>\". Additions (a NEW key that ships with a default) are auto-recorded — commit the change. CHANGING, ADDING or REMOVING the default of a key that already existed is NOT auto-recorded: it silently alters the behaviour of already-deployed metadata, so it fails check:authorable-surface until it is declared in DEFAULT_CHANGES_BY_MAJOR (scripts/lib/default-changes.ts). Constraints are deliberately NOT recorded here — a tightened bound REJECTS a document loudly, which is a different and self-announcing class (maintainer ruling on #4666, direction B). See #4666, #4661.",
"category": "api",
"defaults": [
"api/ApiDocumentationConfig:changelog = []",
"api/ApiDocumentationConfig:codeTemplates = []",
"api/ApiDocumentationConfig:enabled = true",
"api/ApiDocumentationConfig:generateOpenApi = true",
"api/ApiDocumentationConfig:generateTestCollections = true",
"api/ApiDocumentationConfig:servers = []",
"api/ApiDocumentationConfig:testCollections = []",
"api/ApiDocumentationConfig:title = \"API Documentation\"",
"api/ApiEndpoint:authRequired = true",
"api/ApiTestCollection:variables = {}",
"api/ApiTestRequest:headers = {}",
"api/ApiTestRequest:queryParams = {}",
"api/ApiTestRequest:variables = {}",
"api/ApiTestingUiConfig:defaultModelsExpandDepth = 1",
"api/ApiTestingUiConfig:displayRequestDuration = true",
"api/ApiTestingUiConfig:enableCors = true",
"api/ApiTestingUiConfig:enableFilter = true",
"api/ApiTestingUiConfig:enableTryItOut = true",
"api/ApiTestingUiConfig:path = \"/api-docs\"",
"api/ApiTestingUiConfig:syntaxHighlighting = true",
"api/ApiTestingUiConfig:theme = \"light\"",
"api/AuthFeaturesConfig:magicLink = false",
"api/AuthFeaturesConfig:organization = false",
"api/AuthFeaturesConfig:passkeys = false",
"api/AuthFeaturesConfig:twoFactor = false",
"api/AuthProviderInfo:type = \"social\"",
"api/BatchConfig:enabled = true",
"api/BatchConfig:maxRecordsPerBatch = 200",
"api/BatchEndpointsConfig:defaultAtomic = true",
"api/BatchEndpointsConfig:enableBatchEndpoint = true",
"api/BatchEndpointsConfig:maxBatchSize = 200",
"api/BatchLoadingStrategy:associationLoading = \"batch\"",
"api/BatchOptions:atomic = false",
"api/BatchOptions:continueOnError = false",
"api/BatchOptions:returnRecords = false",
"api/BulkRequest:allOrNone = true",
"api/CacheInvalidationRequest:cascade = false",
"api/CreateExportJobRequest:encoding = \"utf-8\"",
"api/CreateExportJobRequest:format = \"csv\"",
"api/CreateExportJobRequest:includeHeaders = true",
"api/CreateFlowRequest:runAs = \"user\"",
"api/CreateFlowRequest:status = \"draft\"",
"api/CreateFlowRequest:version = 1",
"api/CreateImportJobRequest:createMissingOptions = false",
"api/CreateImportJobRequest:dryRun = false",
"api/CreateImportJobRequest:runAutomations = false",
"api/CreateImportJobRequest:skipBlankMatchKey = false",
"api/CreateImportJobRequest:treatAsHistorical = false",
"api/CreateImportJobRequest:trimWhitespace = true",
"api/CreateImportJobRequest:writeMode = \"insert\"",
"api/CrossObjectBatchOperation:action = \"create\"",
"api/CrossObjectBatchRequest:atomic = true",
"api/CrudEndpointsConfig:dataPrefix = \"/data\"",
"api/CrudEndpointsConfig:objectParamStyle = \"path\"",
"api/DataLoaderConfig:batchScheduleFn = \"microtask\"",
"api/DataLoaderConfig:cacheEnabled = true",
"api/DataLoaderConfig:coalesceRequests = true",
"api/DataLoaderConfig:maxBatchSize = 100",
"api/DeviceRequestResponse:interval = 2",
"api/DispatcherConfig:fallback = \"404\"",
"api/DispatcherRoute:authRequired = true",
"api/DispatcherRoute:criticality = \"optional\"",
"api/ETag:weak = false",
"api/EnhancedApiError:retryable = false",
"api/ErrorHandlingConfig:enabled = true",
"api/ErrorHandlingConfig:exposeInternalErrors = false",
"api/ErrorHandlingConfig:includeDocumentation = true",
"api/ErrorHandlingConfig:includeRequestId = true",
"api/ErrorHandlingConfig:includeStackTrace = false",
"api/ErrorHandlingConfig:includeTimestamp = true",
"api/ErrorHandlingConfig:logErrors = true",
"api/FieldMappingEntry:required = false",
"api/FieldMappingEntry:transform = \"none\"",
"api/GetMetaItemCachedResponse:notModified = false",
"api/GetPresignedUrlRequest:scope = \"user\"",
"api/ImportRequest:createMissingOptions = false",
"api/ImportRequest:dryRun = false",
"api/ImportRequest:runAutomations = false",
"api/ImportRequest:skipBlankMatchKey = false",
"api/ImportRequest:treatAsHistorical = false",
"api/ImportRequest:trimWhitespace = true",
"api/ImportRequest:writeMode = \"insert\"",
"api/ImportValidationConfig:maxErrors = 100",
"api/ImportValidationConfig:mode = \"strict\"",
"api/ImportValidationConfig:trimWhitespace = true",
"api/InitiateChunkedUploadRequest:chunkSize = 5242880",
"api/InitiateChunkedUploadRequest:scope = \"user\"",
"api/InstallPackageRequest:enableOnInstall = true",
"api/ListExportJobsRequest:limit = 20",
"api/ListFlowsRequest:limit = 50",
"api/ListImportJobsRequest:limit = 50",
"api/ListImportJobsRequest:offset = 0",
"api/ListInstalledPackagesRequest:limit = 50",
"api/ListNotificationsRequest:limit = 20",
"api/ListRunsRequest:limit = 20",
"api/LoginRequest:type = \"email\"",
"api/MetadataBulkRegisterRequest:continueOnError = false",
"api/MetadataBulkRegisterRequest:validate = true",
"api/MetadataCacheResponse:notModified = false",
"api/MetadataEndpointsConfig:cacheTtl = 3600",
"api/MetadataEndpointsConfig:enableCache = true",
"api/MetadataEndpointsConfig:prefix = \"/meta\"",
"api/MetadataExportRequest:format = \"json\"",
"api/MetadataImportRequest:conflictResolution = \"skip\"",
"api/MetadataImportRequest:dryRun = false",
"api/MetadataImportRequest:validate = true",
"api/MetadataOverlaySaveRequest:active = true",
"api/MetadataOverlaySaveRequest:scope = \"platform\"",
"api/MetadataQueryRequest:page = 1",
"api/MetadataQueryRequest:pageSize = 50",
"api/MetadataQueryRequest:sortBy = \"name\"",
"api/MetadataQueryRequest:sortOrder = \"asc\"",
"api/Notification:read = false",
"api/NotificationPreferences:digest = \"none\"",
"api/NotificationPreferences:email = true",
"api/NotificationPreferences:inApp = true",
"api/NotificationPreferences:push = true",
"api/ODataConfig:enabled = true",
"api/ODataConfig:path = \"/odata\"",
"api/ODataQueryAdapter:usePrefix = true",
"api/ODataQueryAdapter:version = \"v4\"",
"api/OpenApiGenerationConfig:apiVersion = \"1.0.0\"",
"api/OpenApiGenerationConfig:enabled = true",
"api/OpenApiGenerationConfig:generateSchemas = true",
"api/OpenApiGenerationConfig:includeExamples = true",
"api/OpenApiGenerationConfig:includeInternal = false",
"api/OpenApiGenerationConfig:outputPath = \"/api/docs/openapi.json\"",
"api/OpenApiGenerationConfig:title = \"ObjectStack API\"",
"api/OpenApiGenerationConfig:uiFramework = \"swagger-ui\"",
"api/OpenApiGenerationConfig:uiPath = \"/api/docs\"",
"api/OpenApiGenerationConfig:version = \"3.0.3\"",
"api/OpenApiSpec:openapi = \"3.0.0\"",
"api/OpenApiSpec:servers = []",
"api/PackageInstallRequest:enableOnInstall = true",
"api/PackageRollbackRequest:rollbackCustomizations = true",
"api/PackageUpgradeRequest:createSnapshot = true",
"api/PackageUpgradeRequest:dryRun = false",
"api/PackageUpgradeRequest:mergeStrategy = \"three-way-merge\"",
"api/PackageUpgradeRequest:skipValidation = false",
"api/QueryOptimizationConfig:enableQueryPlan = false",
"api/RealtimeConfig:enabled = true",
"api/RealtimeConfig:transport = \"websocket\"",
"api/RequestValidationConfig:enabled = true",
"api/RequestValidationConfig:includeFieldErrors = true",
"api/RequestValidationConfig:mode = \"strict\"",
"api/RequestValidationConfig:validateBody = true",
"api/RequestValidationConfig:validateHeaders = false",
"api/RequestValidationConfig:validateParams = true",
"api/RequestValidationConfig:validateQuery = true",
"api/ResponseEnvelopeConfig:enabled = true",
"api/ResponseEnvelopeConfig:includeDuration = false",
"api/ResponseEnvelopeConfig:includeMetadata = true",
"api/ResponseEnvelopeConfig:includeRequestId = true",
"api/ResponseEnvelopeConfig:includeTimestamp = true",
"api/ResponseEnvelopeConfig:includeTraceId = false",
"api/ResponseEnvelopeConfig:skipIfWrapped = true",
"api/RestApiConfig:basePath = \"/api\"",
"api/RestApiConfig:enableBatch = true",
"api/RestApiConfig:enableCrud = true",
"api/RestApiConfig:enableDiscovery = true",
"api/RestApiConfig:enableMetadata = true",
"api/RestApiConfig:enableOpenApi = true",
"api/RestApiConfig:enableProjectScoping = false",
"api/RestApiConfig:enableUi = true",
"api/RestApiConfig:projectResolution = \"auto\"",
"api/RestApiConfig:version = \"v1\"",
"api/RestApiEndpoint:cacheable = false",
"api/RestApiEndpoint:public = false",
"api/RestApiPluginConfig:basePath = \"/api\"",
"api/RestApiPluginConfig:enabled = true",
"api/RestApiPluginConfig:version = \"v1\"",
"api/RestApiRouteRegistration:authRequired = true",
"api/RestQueryAdapter:fieldsParam = \"fields\"",
"api/RestQueryAdapter:filterStyle = \"bracket\"",
"api/RouteDefinition:category = \"api\"",
"api/RouteDefinition:public = false",
"api/RouteGenerationConfig:nameTransform = \"none\"",
"api/RouterConfig:basePath = \"/api\"",
"api/RouterConfig:mounts = {\"ai\":\"/ai\",\"analytics\":\"/analytics\",\"auth\":\"/auth\",\"automation\":\"/automation\",\"data\":\"/data\",\"i18n\":\"/i18n\",\"metadata\":\"/meta\",\"notifications\":\"/notifications\",\"packages\":\"/packages\",\"realtime\":\"/realtime\",\"storage\":\"/storage\",\"ui\":\"/ui\"}",
"api/ScheduleExportRequest:format = \"csv\"",
"api/ScheduledExport:enabled = true",
"api/ScheduledExport:format = \"csv\"",
"api/SessionUser:emailVerified = false",
"api/SessionUser:language = \"en\"",
"api/SessionUser:roles = []",
"api/VersioningConfig:headerName = \"ObjectStack-Version\"",
"api/VersioningConfig:includeInDiscovery = true",
"api/VersioningConfig:queryParamName = \"version\"",
"api/VersioningConfig:strategy = \"urlPath\"",
"api/VersioningConfig:urlPrefix = \"/api\"",
"api/WebSocketConfig:maxReconnectAttempts = 5",
"api/WebSocketConfig:pingInterval = 30000",
"api/WebSocketConfig:reconnect = true",
"api/WebSocketConfig:reconnectInterval = 1000",
"api/WebSocketConfig:timeout = 5000",
"api/WebSocketServerConfig:cursorSharing = false",
"api/WebSocketServerConfig:enabled = false",
"api/WebSocketServerConfig:heartbeatInterval = 30000",
"api/WebSocketServerConfig:path = \"/ws\"",
"api/WebSocketServerConfig:presence = false",
"api/WebSocketServerConfig:reconnectAttempts = 5"
]
}
Loading
Loading