openxiangda-contracts 2.0.0-alpha.94 → 2.0.0

package/dist/schemas.js

@@ -1,4 +1,4 @@
-import { CONFIGURATION_COMPATIBILITY_CAPABILITY, OPENXIANGDA_COMPILER_CONTRACT_VERSION, DEPLOYMENT_ENVIRONMENTS, LOCAL_RUNTIME_MODE, OPENXIANGDA_CONTRACT_VERSION, PLATFORM_CAPABILITY_CONTRACT_VERSIONS, SCHEMA_VERSIONS, DATA_FIELD_TYPES, } from "./types.js";
+import { CONFIGURATION_COMPATIBILITY_CAPABILITY, OPENXIANGDA_COMPILER_CONTRACT_VERSION, DEPLOYMENT_ENVIRONMENTS, LOCAL_RUNTIME_MODE, OPENXIANGDA_CONTRACT_VERSION, PLATFORM_CAPABILITY_CONTRACT_VERSIONS, SCHEMA_VERSIONS, RUNTIME_CAPACITY_PREFLIGHT_SCHEMA, DATA_FIELD_TYPES, } from "./types.js";
 import { STUDIO_APPLICATION_AUTHORITY, STUDIO_CAPABILITIES_SCHEMA_VERSION, STUDIO_CLI_EVENT_SCHEMA_VERSION, STUDIO_CLI_EVENT_TYPES, STUDIO_CLI_RESULT_SCHEMA_VERSION, STUDIO_PLATFORM_CONTRACT_VERSION, STUDIO_SITE_PROFILE_ENDPOINT, STUDIO_SITE_PROFILE_SCHEMA_VERSION, STUDIO_SITE_PROFILE_UNAVAILABLE_CODES, STUDIO_WORKSPACE_BINDING_SCHEMA_VERSION, STUDIO_WORKSPACE_INITIALIZATION_SCHEMA_VERSION, STUDIO_WORKSPACE_PROTOCOL_VERSION, WORKSPACE_TEMPLATE_BINDING_SCHEMA_VERSION, } from "./studio.js";
 import { aiCapabilityCatalogSchema } from "./ai.js";
 import { departmentReferenceValueSchema, resourceReferenceValueSchema, userReferenceValueSchema, } from "./field-value-schemas.js";
@@ -4292,6 +4292,14 @@ export const platformCapabilitiesSchema = {
                 executionOwner: { const: "platform" },
                 durableRuns: { const: true },
                 clientCanCheckpoint: { const: false },
+                runtimeCapacityPreflight: {
+                    type: 'object', additionalProperties: false, required: ['schemaVersion', 'endpointTemplate'],
+                    properties: {
+                        schemaVersion: { const: RUNTIME_CAPACITY_PREFLIGHT_SCHEMA },
+                        strategies: { type: 'array', minItems: 1, maxItems: 2, uniqueItems: true, items: { enum: ['rolling', 'maintenance-replace'] } },
+                        endpointTemplate: { const: '/openxiangda-api/v2/applications/{appCode}/runtime-capacity-preflight' },
+                    },
+                },
                 backendImageBuild: {
                     type: "object",
                     additionalProperties: false,
@@ -7974,7 +7982,36 @@ export const contractBundleSchema = {
         adminNavigation: appAdminNavigationContractSchema,
     },
 };
+export const runtimeCapacityPreflightSchema = {
+    $id: SCHEMA_VERSIONS.runtimeCapacityPreflight,
+    $schema: 'https://json-schema.org/draft/2020-12/schema',
+    type: 'object', additionalProperties: false,
+    required: ['schemaVersion', 'observedAt', 'environmentKey', 'environmentId', 'basis', 'existingRun', 'sufficient', 'capacity'],
+    properties: {
+        schemaVersion: { const: RUNTIME_CAPACITY_PREFLIGHT_SCHEMA },
+        deploymentStrategy: { enum: ['rolling', 'maintenance-replace'] },
+        maintenance: { anyOf: [{ type: 'null' }, { type: 'object', additionalProperties: false, required: ['downtime', 'estimatedAfterStop', 'previousAppVersionId', 'previousDeploymentId', 'headRevision'], properties: { downtime: { const: true }, estimatedAfterStop: { const: true }, previousAppVersionId: nonEmptyString, previousDeploymentId: nonEmptyString, headRevision: { type: 'integer', minimum: 1 } } }] },
+        observedAt: { type: 'string', minLength: 1 },
+        environmentKey: { const: 'preproduction' }, environmentId: nonEmptyString,
+        basis: { enum: ['new-candidate', 'existing-run', 'frontend-only'] },
+        existingRun: { anyOf: [{ type: 'null' }, { type: 'object', additionalProperties: false, required: ['id', 'status'], properties: { id: nonEmptyString, status: nonEmptyString } }] },
+        sufficient: { type: ['boolean', 'null'] },
+        capacity: { anyOf: [{ type: 'null' }, {
+                    type: 'object', additionalProperties: false, required: ['checked', 'namespace', 'additionalReplicas', 'required', 'quotas', 'shortages'],
+                    properties: {
+                        checked: { type: 'boolean' }, namespace: nonEmptyString,
+                        additionalReplicas: { type: 'integer', minimum: 0, maximum: 1 },
+                        profile: { enum: ['light', 'standard'] },
+                        required: { type: 'object', maxProperties: 10, additionalProperties: nonEmptyString },
+                        quotas: { type: 'array', maxItems: 100, items: { type: 'object', additionalProperties: false, required: ['name', 'available'], properties: { name: nonEmptyString, available: { type: 'object', maxProperties: 10, additionalProperties: nonEmptyString } } } },
+                        shortages: { type: 'array', maxItems: 500, items: { type: 'object', additionalProperties: false, required: ['quota', 'resource', 'required', 'available'], properties: { quota: nonEmptyString, resource: nonEmptyString, required: nonEmptyString, available: nonEmptyString } } },
+                    },
+                }] },
+    },
+    allOf: [{ if: { properties: { basis: { const: 'existing-run' } } }, then: { properties: { sufficient: { type: 'null' }, capacity: { type: 'null' }, existingRun: { type: 'object' } } }, else: { properties: { capacity: { type: 'object' }, existingRun: { type: 'null' } } } }],
+};
 export const contractSchemas = {
+    runtimeCapacityPreflight: runtimeCapacityPreflightSchema,
     diagnostic: diagnosticSchema,
     studioCapabilities: studioCapabilitiesSchema,
     studioCliEvent: studioCliEventSchema,