@objectstack/spec 0.9.2 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -370
- package/dist/ai/agent-action.zod.d.ts +3215 -624
- package/dist/ai/agent-action.zod.d.ts.map +1 -1
- package/dist/ai/agent-action.zod.js +45 -3
- package/dist/ai/agent.zod.d.ts +148 -36
- package/dist/ai/agent.zod.d.ts.map +1 -1
- package/dist/ai/agent.zod.js +24 -0
- package/dist/ai/conversation.zod.d.ts +1105 -149
- package/dist/ai/conversation.zod.d.ts.map +1 -1
- package/dist/ai/conversation.zod.js +40 -25
- package/dist/ai/cost.zod.d.ts +1714 -482
- package/dist/ai/cost.zod.d.ts.map +1 -1
- package/dist/ai/cost.zod.js +18 -20
- package/dist/ai/devops-agent.zod.d.ts +1761 -289
- package/dist/ai/devops-agent.zod.d.ts.map +1 -1
- package/dist/ai/devops-agent.zod.js +1 -0
- package/dist/ai/feedback-loop.zod.d.ts +28451 -2432
- package/dist/ai/feedback-loop.zod.d.ts.map +1 -1
- package/dist/ai/model-registry.zod.d.ts +1164 -145
- package/dist/ai/model-registry.zod.d.ts.map +1 -1
- package/dist/ai/model-registry.zod.js +2 -1
- package/dist/ai/nlq.zod.d.ts +918 -213
- package/dist/ai/nlq.zod.d.ts.map +1 -1
- package/dist/ai/nlq.zod.js +6 -6
- package/dist/ai/orchestration.zod.d.ts +465 -159
- package/dist/ai/orchestration.zod.d.ts.map +1 -1
- package/dist/ai/orchestration.zod.js +6 -4
- package/dist/ai/plugin-development.zod.d.ts +1154 -208
- package/dist/ai/plugin-development.zod.d.ts.map +1 -1
- package/dist/ai/predictive.zod.d.ts +702 -118
- package/dist/ai/predictive.zod.d.ts.map +1 -1
- package/dist/ai/predictive.zod.js +16 -5
- package/dist/ai/rag-pipeline.zod.d.ts +886 -195
- package/dist/ai/rag-pipeline.zod.d.ts.map +1 -1
- package/dist/ai/rag-pipeline.zod.js +30 -13
- package/dist/ai/runtime-ops.zod.d.ts +1591 -256
- package/dist/ai/runtime-ops.zod.d.ts.map +1 -1
- package/dist/ai/runtime-ops.zod.js +1 -1
- package/dist/api/analytics.zod.d.ts +715 -0
- package/dist/api/analytics.zod.d.ts.map +1 -0
- package/dist/api/analytics.zod.js +71 -0
- package/dist/api/auth.zod.d.ts +495 -0
- package/dist/api/auth.zod.d.ts.map +1 -0
- package/dist/api/auth.zod.js +78 -0
- package/dist/api/batch.zod.d.ts +892 -82
- package/dist/api/batch.zod.d.ts.map +1 -1
- package/dist/api/contract.zod.d.ts +1839 -207
- package/dist/api/contract.zod.d.ts.map +1 -1
- package/dist/api/contract.zod.js +23 -11
- package/dist/api/discovery.zod.d.ts +162 -12
- package/dist/api/discovery.zod.d.ts.map +1 -1
- package/dist/api/discovery.zod.js +6 -0
- package/dist/api/documentation.zod.d.ts +3646 -401
- package/dist/api/documentation.zod.d.ts.map +1 -1
- package/dist/api/endpoint.zod.d.ts +222 -56
- package/dist/api/endpoint.zod.d.ts.map +1 -1
- package/dist/api/errors.zod.d.ts +205 -376
- package/dist/api/errors.zod.d.ts.map +1 -1
- package/dist/api/graphql.zod.d.ts +5154 -670
- package/dist/api/graphql.zod.d.ts.map +1 -1
- package/dist/api/graphql.zod.js +3 -0
- package/dist/api/http-cache.zod.d.ts +229 -92
- package/dist/api/http-cache.zod.d.ts.map +1 -1
- package/dist/api/hub.zod.d.ts +27805 -3568
- package/dist/api/hub.zod.d.ts.map +1 -1
- package/dist/api/hub.zod.js +188 -150
- package/dist/api/index.d.ts +6 -0
- package/dist/api/index.d.ts.map +1 -1
- package/dist/api/index.js +6 -0
- package/dist/api/metadata.zod.d.ts +3757 -0
- package/dist/api/metadata.zod.d.ts.map +1 -0
- package/dist/api/metadata.zod.js +42 -0
- package/dist/api/odata.zod.d.ts +677 -72
- package/dist/api/odata.zod.d.ts.map +1 -1
- package/dist/api/protocol.zod.d.ts +9897 -318
- package/dist/api/protocol.zod.d.ts.map +1 -1
- package/dist/api/protocol.zod.js +167 -86
- package/dist/api/realtime.zod.d.ts +197 -73
- package/dist/api/realtime.zod.d.ts.map +1 -1
- package/dist/api/realtime.zod.js +2 -1
- package/dist/api/registry.example.d.ts +1 -2
- package/dist/api/registry.example.d.ts.map +1 -1
- package/dist/api/registry.example.js +1 -2
- package/dist/api/registry.zod.d.ts +8888 -1103
- package/dist/api/registry.zod.d.ts.map +1 -1
- package/dist/api/registry.zod.js +4 -7
- package/dist/api/rest-server.zod.d.ts +1942 -248
- package/dist/api/rest-server.zod.d.ts.map +1 -1
- package/dist/api/rest-server.zod.js +1 -1
- package/dist/api/router.zod.d.ts +155 -41
- package/dist/api/router.zod.d.ts.map +1 -1
- package/dist/api/router.zod.js +4 -0
- package/dist/api/storage.zod.d.ts +261 -0
- package/dist/api/storage.zod.d.ts.map +1 -0
- package/dist/api/storage.zod.js +43 -0
- package/dist/api/websocket.zod.d.ts +1209 -203
- package/dist/api/websocket.zod.d.ts.map +1 -1
- package/dist/automation/approval.zod.d.ts +713 -171
- package/dist/automation/approval.zod.d.ts.map +1 -1
- package/dist/automation/approval.zod.js +6 -2
- package/dist/automation/etl.zod.d.ts +453 -144
- package/dist/automation/etl.zod.d.ts.map +1 -1
- package/dist/automation/flow.zod.d.ts +290 -79
- package/dist/automation/flow.zod.d.ts.map +1 -1
- package/dist/automation/flow.zod.js +44 -1
- package/dist/automation/sync.zod.d.ts +813 -132
- package/dist/automation/sync.zod.d.ts.map +1 -1
- package/dist/automation/trigger-registry.zod.d.ts +1030 -184
- package/dist/automation/trigger-registry.zod.d.ts.map +1 -1
- package/dist/automation/webhook.zod.d.ts +125 -50
- package/dist/automation/webhook.zod.d.ts.map +1 -1
- package/dist/automation/workflow.zod.d.ts +1192 -597
- package/dist/automation/workflow.zod.d.ts.map +1 -1
- package/dist/automation/workflow.zod.js +101 -57
- package/dist/data/analytics.zod.d.ts +358 -0
- package/dist/data/analytics.zod.d.ts.map +1 -0
- package/dist/data/analytics.zod.js +135 -0
- package/dist/data/data-engine.zod.d.ts +2335 -326
- package/dist/data/data-engine.zod.d.ts.map +1 -1
- package/dist/data/data-engine.zod.js +21 -28
- package/dist/data/dataset.zod.d.ts +40 -21
- package/dist/data/dataset.zod.d.ts.map +1 -1
- package/dist/data/datasource.zod.d.ts +324 -0
- package/dist/data/datasource.zod.d.ts.map +1 -0
- package/dist/data/document.zod.d.ts +547 -39
- package/dist/data/document.zod.d.ts.map +1 -1
- package/dist/data/driver/mongo.zod.d.ts +39 -3
- package/dist/data/driver/mongo.zod.d.ts.map +1 -1
- package/dist/data/driver/mongo.zod.js +1 -1
- package/dist/data/driver/postgres.zod.d.ts +109 -3
- package/dist/data/driver/postgres.zod.d.ts.map +1 -1
- package/dist/data/driver-nosql.zod.d.ts +695 -189
- package/dist/data/driver-nosql.zod.d.ts.map +1 -1
- package/dist/data/driver-sql.zod.d.ts +481 -33
- package/dist/data/driver-sql.zod.d.ts.map +1 -1
- package/dist/data/driver.zod.d.ts +4237 -473
- package/dist/data/driver.zod.d.ts.map +1 -1
- package/dist/data/driver.zod.js +99 -103
- package/dist/data/external-lookup.zod.d.ts +505 -68
- package/dist/data/external-lookup.zod.d.ts.map +1 -1
- package/dist/data/field.zod.d.ts +1754 -770
- package/dist/data/field.zod.d.ts.map +1 -1
- package/dist/data/field.zod.js +25 -0
- package/dist/data/filter.zod.d.ts +224 -36
- package/dist/data/filter.zod.d.ts.map +1 -1
- package/dist/data/hook.zod.d.ts +143 -70
- package/dist/data/hook.zod.d.ts.map +1 -1
- package/dist/data/index.d.ts +2 -0
- package/dist/data/index.d.ts.map +1 -1
- package/dist/data/index.js +3 -0
- package/dist/data/mapping.zod.d.ts +483 -109
- package/dist/data/mapping.zod.d.ts.map +1 -1
- package/dist/data/object.zod.d.ts +2899 -506
- package/dist/data/object.zod.d.ts.map +1 -1
- package/dist/data/object.zod.js +40 -0
- package/dist/data/query.zod.d.ts +402 -157
- package/dist/data/query.zod.d.ts.map +1 -1
- package/dist/data/validation.zod.d.ts +284 -123
- package/dist/data/validation.zod.d.ts.map +1 -1
- package/dist/hub/composer.zod.d.ts +2579 -282
- package/dist/hub/composer.zod.d.ts.map +1 -1
- package/dist/hub/composer.zod.js +1 -1
- package/dist/hub/hub-federation.zod.d.ts +2124 -458
- package/dist/hub/hub-federation.zod.d.ts.map +1 -1
- package/dist/hub/index.d.ts +1 -1
- package/dist/hub/index.d.ts.map +1 -1
- package/dist/hub/index.js +1 -1
- package/dist/hub/license.zod.d.ts +74 -29
- package/dist/hub/license.zod.d.ts.map +1 -1
- package/dist/hub/marketplace.zod.d.ts +280 -37
- package/dist/hub/marketplace.zod.d.ts.map +1 -1
- package/dist/hub/marketplace.zod.js +38 -12
- package/dist/hub/plugin-registry.zod.d.ts +1461 -140
- package/dist/hub/plugin-registry.zod.d.ts.map +1 -1
- package/dist/hub/plugin-registry.zod.js +1 -1
- package/dist/hub/plugin-security.zod.d.ts +3720 -476
- package/dist/hub/plugin-security.zod.d.ts.map +1 -1
- package/dist/hub/plugin-security.zod.js +1 -1
- package/dist/hub/registry-config.zod.d.ts +450 -0
- package/dist/hub/registry-config.zod.d.ts.map +1 -0
- package/dist/hub/registry-config.zod.js +156 -0
- package/dist/hub/space.zod.d.ts +307 -72
- package/dist/hub/space.zod.d.ts.map +1 -1
- package/dist/hub/tenant.zod.d.ts +861 -107
- package/dist/hub/tenant.zod.d.ts.map +1 -1
- package/dist/identity/identity.zod.d.ts +258 -0
- package/dist/identity/identity.zod.d.ts.map +1 -0
- package/dist/{auth → identity}/index.d.ts +0 -2
- package/dist/identity/index.d.ts.map +1 -0
- package/dist/{auth → identity}/index.js +0 -2
- package/dist/identity/organization.zod.d.ts +179 -0
- package/dist/identity/organization.zod.d.ts.map +1 -0
- package/dist/identity/protocol.d.ts.map +1 -0
- package/dist/{auth → identity}/role.zod.d.ts +14 -1
- package/dist/identity/role.zod.d.ts.map +1 -0
- package/dist/identity/scim.zod.d.ts +2732 -0
- package/dist/identity/scim.zod.d.ts.map +1 -0
- package/dist/index.d.ts +4 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +6 -3
- package/dist/integration/connector/database.zod.d.ts +1253 -264
- package/dist/integration/connector/database.zod.d.ts.map +1 -1
- package/dist/integration/connector/file-storage.zod.d.ts +990 -259
- package/dist/integration/connector/file-storage.zod.d.ts.map +1 -1
- package/dist/integration/connector/github.zod.d.ts +1251 -226
- package/dist/integration/connector/github.zod.d.ts.map +1 -1
- package/dist/integration/connector/message-queue.zod.d.ts +1247 -314
- package/dist/integration/connector/message-queue.zod.d.ts.map +1 -1
- package/dist/integration/connector/saas.zod.d.ts +1129 -254
- package/dist/integration/connector/saas.zod.d.ts.map +1 -1
- package/dist/integration/connector/vercel.zod.d.ts +1799 -327
- package/dist/integration/connector/vercel.zod.d.ts.map +1 -1
- package/dist/integration/connector.zod.d.ts +1225 -382
- package/dist/integration/connector.zod.d.ts.map +1 -1
- package/dist/integration/connector.zod.js +26 -3
- package/dist/kernel/context.zod.d.ts +56 -0
- package/dist/kernel/context.zod.d.ts.map +1 -0
- package/dist/kernel/events.zod.d.ts +2716 -0
- package/dist/kernel/events.zod.d.ts.map +1 -0
- package/dist/{system → kernel}/events.zod.js +16 -16
- package/dist/kernel/feature.zod.d.ts +131 -0
- package/dist/kernel/feature.zod.d.ts.map +1 -0
- package/dist/kernel/index.d.ts +17 -0
- package/dist/kernel/index.d.ts.map +1 -0
- package/dist/kernel/index.js +32 -0
- package/dist/kernel/manifest.zod.d.ts +2124 -0
- package/dist/kernel/manifest.zod.d.ts.map +1 -0
- package/dist/{system → kernel}/manifest.zod.js +49 -8
- package/dist/kernel/metadata-loader.zod.d.ts +641 -0
- package/dist/kernel/metadata-loader.zod.d.ts.map +1 -0
- package/dist/kernel/plugin-capability.zod.d.ts +1130 -0
- package/dist/kernel/plugin-capability.zod.d.ts.map +1 -0
- package/dist/kernel/plugin-lifecycle-advanced.zod.d.ts +1458 -0
- package/dist/kernel/plugin-lifecycle-advanced.zod.d.ts.map +1 -0
- package/dist/{system → kernel}/plugin-lifecycle-events.zod.d.ts +209 -49
- package/dist/kernel/plugin-lifecycle-events.zod.d.ts.map +1 -0
- package/dist/kernel/plugin-loading.zod.d.ts +1774 -0
- package/dist/kernel/plugin-loading.zod.d.ts.map +1 -0
- package/dist/kernel/plugin-security-advanced.zod.d.ts +3833 -0
- package/dist/kernel/plugin-security-advanced.zod.d.ts.map +1 -0
- package/dist/kernel/plugin-structure.zod.d.ts +54 -0
- package/dist/kernel/plugin-structure.zod.d.ts.map +1 -0
- package/dist/kernel/plugin-structure.zod.js +107 -0
- package/dist/kernel/plugin-validator.zod.d.ts +245 -0
- package/dist/kernel/plugin-validator.zod.d.ts.map +1 -0
- package/dist/kernel/plugin-versioning.zod.d.ts +1309 -0
- package/dist/kernel/plugin-versioning.zod.d.ts.map +1 -0
- package/dist/{system → kernel}/plugin-versioning.zod.js +8 -8
- package/dist/kernel/plugin.zod.d.ts +3482 -0
- package/dist/kernel/plugin.zod.d.ts.map +1 -0
- package/dist/kernel/plugin.zod.js +80 -0
- package/dist/kernel/service-registry.zod.d.ts +247 -0
- package/dist/kernel/service-registry.zod.d.ts.map +1 -0
- package/dist/kernel/service-registry.zod.js +218 -0
- package/dist/kernel/startup-orchestrator.zod.d.ts +376 -0
- package/dist/kernel/startup-orchestrator.zod.d.ts.map +1 -0
- package/dist/qa/testing.zod.d.ts +765 -240
- package/dist/qa/testing.zod.d.ts.map +1 -1
- package/dist/{permission → security}/index.d.ts +1 -0
- package/dist/security/index.d.ts.map +1 -0
- package/dist/{permission → security}/index.js +1 -0
- package/dist/security/permission.zod.d.ts +342 -0
- package/dist/security/permission.zod.d.ts.map +1 -0
- package/dist/{permission → security}/permission.zod.js +1 -1
- package/dist/security/policy.zod.d.ts +209 -0
- package/dist/security/policy.zod.d.ts.map +1 -0
- package/dist/security/rls.zod.d.ts +605 -0
- package/dist/security/rls.zod.d.ts.map +1 -0
- package/dist/security/sharing.zod.d.ts +146 -0
- package/dist/security/sharing.zod.d.ts.map +1 -0
- package/dist/security/territory.zod.d.ts +104 -0
- package/dist/security/territory.zod.d.ts.map +1 -0
- package/dist/shared/connector-auth.zod.d.ts +176 -0
- package/dist/shared/connector-auth.zod.d.ts.map +1 -0
- package/dist/shared/connector-auth.zod.js +63 -0
- package/dist/shared/http.zod.d.ts +67 -22
- package/dist/shared/http.zod.d.ts.map +1 -1
- package/dist/shared/mapping.zod.d.ts +139 -25
- package/dist/shared/mapping.zod.d.ts.map +1 -1
- package/dist/stack.zod.d.ts +33170 -6871
- package/dist/stack.zod.d.ts.map +1 -1
- package/dist/stack.zod.js +7 -7
- package/dist/system/audit.zod.d.ts +974 -521
- package/dist/system/audit.zod.d.ts.map +1 -1
- package/dist/system/auth-config.zod.d.ts +143 -0
- package/dist/system/auth-config.zod.d.ts.map +1 -0
- package/dist/system/auth-config.zod.js +35 -0
- package/dist/system/cache.zod.d.ts +102 -64
- package/dist/system/cache.zod.d.ts.map +1 -1
- package/dist/system/change-management.zod.d.ts +452 -77
- package/dist/system/change-management.zod.d.ts.map +1 -1
- package/dist/system/collaboration.zod.d.ts +1609 -243
- package/dist/system/collaboration.zod.d.ts.map +1 -1
- package/dist/system/compliance.zod.d.ts +293 -63
- package/dist/system/compliance.zod.d.ts.map +1 -1
- package/dist/system/encryption.zod.d.ts +184 -54
- package/dist/system/encryption.zod.d.ts.map +1 -1
- package/dist/system/http-server.zod.d.ts +562 -116
- package/dist/system/http-server.zod.d.ts.map +1 -1
- package/dist/system/index.d.ts +23 -33
- package/dist/system/index.d.ts.map +1 -1
- package/dist/system/index.js +28 -49
- package/dist/system/job.zod.d.ts +169 -29
- package/dist/system/job.zod.d.ts.map +1 -1
- package/dist/system/job.zod.js +18 -5
- package/dist/system/logging.zod.d.ts +1875 -272
- package/dist/system/logging.zod.d.ts.map +1 -1
- package/dist/system/masking.zod.d.ts +66 -34
- package/dist/system/masking.zod.d.ts.map +1 -1
- package/dist/system/message-queue.zod.d.ts +135 -49
- package/dist/system/message-queue.zod.d.ts.map +1 -1
- package/dist/system/metadata-persistence.zod.d.ts +552 -0
- package/dist/system/metadata-persistence.zod.d.ts.map +1 -0
- package/dist/system/metadata-persistence.zod.js +214 -0
- package/dist/system/metrics.zod.d.ts +1705 -330
- package/dist/system/metrics.zod.d.ts.map +1 -1
- package/dist/system/migration.zod.d.ts +18486 -2398
- package/dist/system/migration.zod.d.ts.map +1 -1
- package/dist/system/notification.zod.d.ts +534 -75
- package/dist/system/notification.zod.d.ts.map +1 -1
- package/dist/system/object-storage.zod.d.ts +1101 -382
- package/dist/system/object-storage.zod.d.ts.map +1 -1
- package/dist/system/search-engine.zod.d.ts +209 -78
- package/dist/system/search-engine.zod.d.ts.map +1 -1
- package/dist/system/service-registry.zod.d.ts +67 -125
- package/dist/system/service-registry.zod.d.ts.map +1 -1
- package/dist/system/service-registry.zod.js +81 -202
- package/dist/system/tracing.zod.d.ts +1623 -286
- package/dist/system/tracing.zod.d.ts.map +1 -1
- package/dist/system/translation.zod.d.ts +136 -8
- package/dist/system/translation.zod.d.ts.map +1 -1
- package/dist/system/translation.zod.js +2 -0
- package/dist/system/worker.zod.d.ts +1138 -159
- package/dist/system/worker.zod.d.ts.map +1 -1
- package/dist/system/worker.zod.js +8 -8
- package/dist/ui/action.zod.d.ts +121 -118
- package/dist/ui/action.zod.d.ts.map +1 -1
- package/dist/ui/app.zod.d.ts +306 -22
- package/dist/ui/app.zod.d.ts.map +1 -1
- package/dist/ui/app.zod.js +20 -1
- package/dist/ui/chart.zod.d.ts +390 -66
- package/dist/ui/chart.zod.d.ts.map +1 -1
- package/dist/ui/chart.zod.js +90 -5
- package/dist/ui/component.zod.d.ts +210 -86
- package/dist/ui/component.zod.d.ts.map +1 -1
- package/dist/ui/component.zod.js +4 -1
- package/dist/ui/dashboard.zod.d.ts +1002 -153
- package/dist/ui/dashboard.zod.d.ts.map +1 -1
- package/dist/ui/dashboard.zod.js +25 -0
- package/dist/ui/page.zod.d.ts +251 -117
- package/dist/ui/page.zod.d.ts.map +1 -1
- package/dist/ui/page.zod.js +22 -1
- package/dist/ui/report.zod.d.ts +461 -138
- package/dist/ui/report.zod.d.ts.map +1 -1
- package/dist/ui/theme.zod.d.ts +944 -42
- package/dist/ui/theme.zod.d.ts.map +1 -1
- package/dist/ui/view.zod.d.ts +3021 -393
- package/dist/ui/view.zod.d.ts.map +1 -1
- package/dist/ui/view.zod.js +84 -10
- package/dist/ui/widget.zod.d.ts +1689 -203
- package/dist/ui/widget.zod.d.ts.map +1 -1
- package/dist/ui/widget.zod.js +32 -10
- package/json-schema/ai/AICodeReviewResult.json +219 -1
- package/json-schema/ai/AIKnowledge.json +24 -1
- package/json-schema/ai/AIModelConfig.json +35 -1
- package/json-schema/ai/AIOperationCost.json +73 -1
- package/json-schema/ai/AIOpsAgentConfig.json +470 -1
- package/json-schema/ai/AIOrchestration.json +385 -1
- package/json-schema/ai/AIOrchestrationExecutionResult.json +133 -1
- package/json-schema/ai/AIOrchestrationTrigger.json +12 -1
- package/json-schema/ai/AITask.json +127 -1
- package/json-schema/ai/AITaskType.json +15 -1
- package/json-schema/ai/AITool.json +27 -1
- package/json-schema/ai/Agent.json +147 -1
- package/json-schema/ai/AgentAction.json +431 -1
- package/json-schema/ai/AgentActionResult.json +63 -1
- package/json-schema/ai/AgentActionSequence.json +497 -1
- package/json-schema/ai/AgentActionSequenceResult.json +137 -1
- package/json-schema/ai/AnomalyDetectionConfig.json +66 -1
- package/json-schema/ai/AutoScalingPolicy.json +163 -1
- package/json-schema/ai/BatchAIOrchestrationExecution.json +42 -1
- package/json-schema/ai/BillingPeriod.json +12 -1
- package/json-schema/ai/BudgetLimit.json +105 -1
- package/json-schema/ai/BudgetStatus.json +88 -1
- package/json-schema/ai/BudgetType.json +11 -1
- package/json-schema/ai/CICDPipelineConfig.json +130 -1
- package/json-schema/ai/ChunkingStrategy.json +127 -1
- package/json-schema/ai/CodeContent.json +32 -0
- package/json-schema/ai/CodeGenerationConfig.json +59 -1
- package/json-schema/ai/CodeGenerationRequest.json +234 -1
- package/json-schema/ai/CodeGenerationTarget.json +13 -1
- package/json-schema/ai/ComponentActionParams.json +71 -1
- package/json-schema/ai/ComponentActionType.json +14 -1
- package/json-schema/ai/ComponentAgentAction.json +153 -0
- package/json-schema/ai/ConversationAnalytics.json +82 -1
- package/json-schema/ai/ConversationContext.json +42 -1
- package/json-schema/ai/ConversationMessage.json +282 -1
- package/json-schema/ai/ConversationSession.json +560 -1
- package/json-schema/ai/ConversationSummary.json +68 -1
- package/json-schema/ai/CostAlert.json +103 -1
- package/json-schema/ai/CostAlertType.json +10 -1
- package/json-schema/ai/CostAnalytics.json +603 -1
- package/json-schema/ai/CostBreakdownDimension.json +14 -1
- package/json-schema/ai/CostBreakdownEntry.json +56 -1
- package/json-schema/ai/CostEntry.json +116 -1
- package/json-schema/ai/CostMetricType.json +11 -1
- package/json-schema/ai/CostOptimizationRecommendation.json +95 -1
- package/json-schema/ai/CostQueryFilters.json +108 -1
- package/json-schema/ai/CostReport.json +987 -1
- package/json-schema/ai/DataActionParams.json +32 -1
- package/json-schema/ai/DataActionType.json +12 -1
- package/json-schema/ai/DataAgentAction.json +112 -0
- package/json-schema/ai/DeploymentStrategy.json +46 -1
- package/json-schema/ai/DevOpsAgent.json +809 -1
- package/json-schema/ai/DevOpsTool.json +32 -1
- package/json-schema/ai/DevelopmentConfig.json +164 -1
- package/json-schema/ai/DocumentChunk.json +94 -1
- package/json-schema/ai/DocumentLoaderConfig.json +63 -1
- package/json-schema/ai/DocumentMetadata.json +58 -1
- package/json-schema/ai/EmbeddingModel.json +55 -1
- package/json-schema/ai/Entity.json +49 -1
- package/json-schema/ai/EvaluationMetrics.json +58 -1
- package/json-schema/ai/FeedbackLoop.json +7571 -1
- package/json-schema/ai/FieldSynonymConfig.json +33 -1
- package/json-schema/ai/FileContent.json +37 -0
- package/json-schema/ai/FilterExpression.json +58 -0
- package/json-schema/ai/FilterGroup.json +83 -0
- package/json-schema/ai/FormActionParams.json +30 -1
- package/json-schema/ai/FormActionType.json +14 -1
- package/json-schema/ai/FormAgentAction.json +112 -0
- package/json-schema/ai/FunctionCall.json +22 -1
- package/json-schema/ai/GeneratedCode.json +195 -1
- package/json-schema/ai/GitHubIntegration.json +65 -1
- package/json-schema/ai/Hyperparameters.json +74 -1
- package/json-schema/ai/ImageContent.json +38 -0
- package/json-schema/ai/IntegrationConfig.json +145 -1
- package/json-schema/ai/IntentActionMapping.json +486 -1
- package/json-schema/ai/Issue.json +68 -1
- package/json-schema/ai/MessageContent.json +115 -1
- package/json-schema/ai/MessageContentType.json +10 -1
- package/json-schema/ai/MessagePruningEvent.json +71 -1
- package/json-schema/ai/MessageRole.json +10 -1
- package/json-schema/ai/MetadataFilter.json +164 -0
- package/json-schema/ai/MetadataSource.json +27 -1
- package/json-schema/ai/ModelCapability.json +41 -1
- package/json-schema/ai/ModelConfig.json +179 -1
- package/json-schema/ai/ModelDrift.json +68 -1
- package/json-schema/ai/ModelFeature.json +65 -1
- package/json-schema/ai/ModelLimits.json +39 -1
- package/json-schema/ai/ModelPricing.json +22 -1
- package/json-schema/ai/ModelProvider.json +13 -1
- package/json-schema/ai/ModelRegistry.json +425 -1
- package/json-schema/ai/ModelRegistryEntry.json +237 -1
- package/json-schema/ai/ModelSelectionCriteria.json +44 -1
- package/json-schema/ai/MonitoringConfig.json +74 -1
- package/json-schema/ai/NLQAnalytics.json +103 -1
- package/json-schema/ai/NLQFieldMapping.json +34 -1
- package/json-schema/ai/NLQModelConfig.json +72 -1
- package/json-schema/ai/NLQParseResult.json +249 -1
- package/json-schema/ai/NLQRequest.json +104 -1
- package/json-schema/ai/NLQResponse.json +317 -1
- package/json-schema/ai/NLQTrainingExample.json +117 -1
- package/json-schema/ai/NavigationActionParams.json +50 -1
- package/json-schema/ai/NavigationActionType.json +15 -1
- package/json-schema/ai/NavigationAgentAction.json +133 -0
- package/json-schema/ai/PerformanceOptimization.json +110 -1
- package/json-schema/ai/PipelineStage.json +71 -1
- package/json-schema/ai/PluginCompositionRequest.json +88 -1
- package/json-schema/ai/PluginCompositionResult.json +138 -1
- package/json-schema/ai/PluginRecommendation.json +135 -1
- package/json-schema/ai/PluginRecommendationRequest.json +75 -1
- package/json-schema/ai/PluginScaffoldingTemplate.json +122 -1
- package/json-schema/ai/PostProcessingAction.json +35 -1
- package/json-schema/ai/PredictionRequest.json +33 -1
- package/json-schema/ai/PredictionResult.json +109 -1
- package/json-schema/ai/PredictiveModel.json +442 -1
- package/json-schema/ai/PredictiveModelType.json +12 -1
- package/json-schema/ai/PromptTemplate.json +157 -1
- package/json-schema/ai/PromptVariable.json +50 -1
- package/json-schema/ai/QueryContext.json +66 -1
- package/json-schema/ai/QueryIntent.json +15 -1
- package/json-schema/ai/QueryTemplate.json +78 -1
- package/json-schema/ai/RAGPipelineConfig.json +687 -1
- package/json-schema/ai/RAGPipelineStatus.json +61 -1
- package/json-schema/ai/RAGQueryRequest.json +58 -1
- package/json-schema/ai/RAGQueryResponse.json +134 -1
- package/json-schema/ai/RerankingConfig.json +28 -1
- package/json-schema/ai/Resolution.json +7477 -1
- package/json-schema/ai/RetrievalStrategy.json +115 -1
- package/json-schema/ai/RootCauseAnalysisRequest.json +87 -1
- package/json-schema/ai/RootCauseAnalysisResult.json +193 -1
- package/json-schema/ai/SelfHealingAction.json +92 -1
- package/json-schema/ai/SelfHealingConfig.json +205 -1
- package/json-schema/ai/TestingConfig.json +51 -1
- package/json-schema/ai/TextContent.json +28 -0
- package/json-schema/ai/Timeframe.json +62 -1
- package/json-schema/ai/TokenBudgetConfig.json +86 -1
- package/json-schema/ai/TokenBudgetStrategy.json +10 -1
- package/json-schema/ai/TokenUsage.json +26 -1
- package/json-schema/ai/TokenUsageStats.json +60 -1
- package/json-schema/ai/ToolCall.json +43 -1
- package/json-schema/ai/TrainingConfig.json +82 -1
- package/json-schema/ai/TypedAgentAction.json +770 -0
- package/json-schema/ai/UIActionType.json +57 -1
- package/json-schema/ai/VectorStoreConfig.json +80 -1
- package/json-schema/ai/VectorStoreProvider.json +15 -1
- package/json-schema/ai/VercelIntegration.json +63 -1
- package/json-schema/ai/VersionManagement.json +52 -1
- package/json-schema/ai/ViewActionParams.json +68 -1
- package/json-schema/ai/ViewActionType.json +15 -1
- package/json-schema/ai/ViewAgentAction.json +151 -0
- package/json-schema/ai/WorkflowActionParams.json +55 -1
- package/json-schema/ai/WorkflowActionType.json +12 -1
- package/json-schema/ai/WorkflowAgentAction.json +135 -0
- package/json-schema/ai/WorkflowFieldCondition.json +27 -1
- package/json-schema/ai/WorkflowSchedule.json +45 -1
- package/json-schema/api/AckMessage.json +40 -1
- package/json-schema/api/AnalyticsEndpoint.json +14 -0
- package/json-schema/api/AnalyticsMetadataResponse.json +280 -0
- package/json-schema/api/AnalyticsQueryRequest.json +154 -0
- package/json-schema/api/AnalyticsResultResponse.json +114 -0
- package/json-schema/api/AnalyticsSqlResponse.json +88 -0
- package/json-schema/api/ApiCapabilities.json +32 -1
- package/json-schema/api/ApiChangelogEntry.json +79 -1
- package/json-schema/api/ApiDiscoveryQuery.json +51 -1
- package/json-schema/api/ApiDiscoveryResponse.json +606 -1
- package/json-schema/api/ApiDocumentationConfig.json +711 -1
- package/json-schema/api/ApiEndpoint.json +159 -1
- package/json-schema/api/ApiEndpointRegistration.json +397 -1
- package/json-schema/api/ApiError.json +29 -1
- package/json-schema/api/ApiMapping.json +22 -1
- package/json-schema/api/ApiMetadata.json +38 -1
- package/json-schema/api/ApiParameter.json +130 -1
- package/json-schema/api/ApiProtocolType.json +15 -1
- package/json-schema/api/ApiRegistry.json +1680 -1
- package/json-schema/api/ApiRegistryEntry.json +536 -1
- package/json-schema/api/ApiResponse.json +109 -1
- package/json-schema/api/ApiRoutes.json +43 -1
- package/json-schema/api/ApiTestCollection.json +209 -1
- package/json-schema/api/ApiTestRequest.json +79 -1
- package/json-schema/api/ApiTestingUiConfig.json +136 -1
- package/json-schema/api/ApiTestingUiType.json +14 -1
- package/json-schema/api/AppDefinitionResponse.json +380 -0
- package/json-schema/api/AuthProvider.json +17 -0
- package/json-schema/api/AutomationTriggerRequest.json +23 -0
- package/json-schema/api/AutomationTriggerResponse.json +22 -0
- package/json-schema/api/BaseResponse.json +65 -1
- package/json-schema/api/BatchConfig.json +45 -1
- package/json-schema/api/BatchDataRequest.json +87 -1
- package/json-schema/api/BatchDataResponse.json +154 -1
- package/json-schema/api/BatchEndpointsConfig.json +50 -1
- package/json-schema/api/BatchOperationResult.json +59 -1
- package/json-schema/api/BatchOperationType.json +9 -1
- package/json-schema/api/BatchOptions.json +26 -1
- package/json-schema/api/BatchRecord.json +19 -1
- package/json-schema/api/BatchUpdateRequest.json +72 -1
- package/json-schema/api/BatchUpdateResponse.json +154 -1
- package/json-schema/api/BuildStatusResponse.json +140 -1
- package/json-schema/api/BulkRequest.json +23 -1
- package/json-schema/api/BulkResponse.json +125 -1
- package/json-schema/api/CacheControl.json +36 -1
- package/json-schema/api/CacheDirective.json +11 -1
- package/json-schema/api/CacheInvalidationRequest.json +37 -1
- package/json-schema/api/CacheInvalidationResponse.json +25 -1
- package/json-schema/api/CacheInvalidationTarget.json +11 -1
- package/json-schema/api/CodeGenerationTemplate.json +30 -1
- package/json-schema/api/CompileManifestRequest.json +80 -1
- package/json-schema/api/CompileManifestResponse.json +1580 -1
- package/json-schema/api/CompleteUploadRequest.json +23 -0
- package/json-schema/api/ConceptListResponse.json +98 -0
- package/json-schema/api/ConflictResolutionStrategy.json +9 -1
- package/json-schema/api/CreateDataRequest.json +19 -1
- package/json-schema/api/CreateDataResponse.json +24 -1
- package/json-schema/api/CreateManyDataRequest.json +22 -1
- package/json-schema/api/CreateManyDataResponse.json +27 -1
- package/json-schema/api/CreateRequest.json +14 -1
- package/json-schema/api/CreateSpaceRequest.json +237 -1
- package/json-schema/api/CreateTenantRequest.json +50 -1
- package/json-schema/api/CrudEndpointPattern.json +35 -1
- package/json-schema/api/CrudEndpointsConfig.json +107 -1
- package/json-schema/api/CrudOperation.json +10 -1
- package/json-schema/api/CursorMessage.json +133 -1
- package/json-schema/api/CursorPosition.json +106 -1
- package/json-schema/api/DeleteDataRequest.json +18 -1
- package/json-schema/api/DeleteDataResponse.json +23 -1
- package/json-schema/api/DeleteManyDataRequest.json +48 -1
- package/json-schema/api/DeleteManyDataResponse.json +154 -1
- package/json-schema/api/DeleteManyRequest.json +45 -1
- package/json-schema/api/DeleteResponse.json +70 -1
- package/json-schema/api/Discovery.json +126 -1
- package/json-schema/api/DocumentState.json +43 -1
- package/json-schema/api/ETag.json +18 -1
- package/json-schema/api/EditMessage.json +129 -1
- package/json-schema/api/EditOperation.json +102 -1
- package/json-schema/api/EditOperationType.json +8 -1
- package/json-schema/api/EndpointRegistry.json +278 -1
- package/json-schema/api/EnhancedApiError.json +220 -1
- package/json-schema/api/ErrorCategory.json +14 -1
- package/json-schema/api/ErrorMessage.json +38 -1
- package/json-schema/api/ErrorResponse.json +253 -1
- package/json-schema/api/EventFilter.json +59 -1
- package/json-schema/api/EventFilterCondition.json +36 -1
- package/json-schema/api/EventMessage.json +49 -1
- package/json-schema/api/EventPattern.json +6 -1
- package/json-schema/api/EventSubscription.json +99 -1
- package/json-schema/api/ExportRequest.json +854 -1
- package/json-schema/api/FieldError.json +82 -1
- package/json-schema/api/FileUploadResponse.json +117 -0
- package/json-schema/api/FilterOperator.json +18 -1
- package/json-schema/api/FindDataRequest.json +503 -1
- package/json-schema/api/FindDataResponse.json +30 -1
- package/json-schema/api/GeneratedApiDocumentation.json +540 -1
- package/json-schema/api/GeneratedEndpoint.json +82 -1
- package/json-schema/api/GetAnalyticsMetaRequest.json +16 -0
- package/json-schema/api/GetBuildStatusRequest.json +12 -1
- package/json-schema/api/GetDataRequest.json +18 -1
- package/json-schema/api/GetDataResponse.json +24 -1
- package/json-schema/api/GetDiscoveryRequest.json +5 -1
- package/json-schema/api/GetDiscoveryResponse.json +95 -1
- package/json-schema/api/GetMarketplacePluginRequest.json +12 -1
- package/json-schema/api/GetMetaItemCachedRequest.json +71 -1
- package/json-schema/api/GetMetaItemCachedResponse.json +79 -1
- package/json-schema/api/GetMetaItemRequest.json +18 -1
- package/json-schema/api/GetMetaItemResponse.json +21 -1
- package/json-schema/api/GetMetaItemsRequest.json +13 -1
- package/json-schema/api/GetMetaItemsResponse.json +18 -1
- package/json-schema/api/GetMetaTypesRequest.json +5 -1
- package/json-schema/api/GetMetaTypesResponse.json +16 -1
- package/json-schema/api/GetPluginVersionsRequest.json +13 -1
- package/json-schema/api/GetPluginVersionsResponse.json +120 -1
- package/json-schema/api/GetPresignedUrlRequest.json +38 -0
- package/json-schema/api/GetUiViewRequest.json +22 -1
- package/json-schema/api/GetUiViewResponse.json +1622 -1
- package/json-schema/api/GraphQLConfig.json +1394 -1
- package/json-schema/api/GraphQLDataLoaderConfig.json +95 -1
- package/json-schema/api/GraphQLDirectiveConfig.json +102 -1
- package/json-schema/api/GraphQLDirectiveLocation.json +24 -1
- package/json-schema/api/GraphQLMutationConfig.json +174 -1
- package/json-schema/api/GraphQLPersistedQuery.json +145 -1
- package/json-schema/api/GraphQLQueryComplexity.json +77 -1
- package/json-schema/api/GraphQLQueryConfig.json +236 -1
- package/json-schema/api/GraphQLQueryDepthLimit.json +38 -1
- package/json-schema/api/GraphQLRateLimit.json +132 -1
- package/json-schema/api/GraphQLResolverConfig.json +92 -1
- package/json-schema/api/GraphQLScalarType.json +26 -1
- package/json-schema/api/GraphQLSubscriptionConfig.json +112 -1
- package/json-schema/api/GraphQLTypeConfig.json +107 -1
- package/json-schema/api/HttpMethod.json +12 -1
- package/json-schema/api/HttpStatusCode.json +18 -1
- package/json-schema/api/HubHealthResponse.json +125 -1
- package/json-schema/api/HubMetricsResponse.json +162 -1
- package/json-schema/api/IdRequest.json +19 -0
- package/json-schema/api/InstallPluginRequest.json +33 -0
- package/json-schema/api/InstallPluginResponse.json +72 -0
- package/json-schema/api/IssueLicenseRequest.json +40 -1
- package/json-schema/api/LicenseResponse.json +125 -1
- package/json-schema/api/ListLicensesRequest.json +43 -1
- package/json-schema/api/ListLicensesResponse.json +165 -1
- package/json-schema/api/ListMarketplaceRequest.json +43 -1
- package/json-schema/api/ListMarketplaceResponse.json +352 -1
- package/json-schema/api/ListRecordResponse.json +110 -1
- package/json-schema/api/ListSpacesRequest.json +36 -1
- package/json-schema/api/ListSpacesResponse.json +379 -1
- package/json-schema/api/ListTenantsRequest.json +39 -1
- package/json-schema/api/ListTenantsResponse.json +159 -1
- package/json-schema/api/LoginRequest.json +45 -0
- package/json-schema/api/LoginType.json +16 -0
- package/json-schema/api/MarketplacePluginResponse.json +288 -1
- package/json-schema/api/MetadataCacheRequest.json +52 -1
- package/json-schema/api/MetadataCacheResponse.json +79 -1
- package/json-schema/api/MetadataEndpointsConfig.json +48 -1
- package/json-schema/api/ModificationResult.json +55 -1
- package/json-schema/api/ODataConfig.json +126 -1
- package/json-schema/api/ODataError.json +59 -1
- package/json-schema/api/ODataFilterFunction.json +33 -1
- package/json-schema/api/ODataFilterOperator.json +18 -1
- package/json-schema/api/ODataMetadata.json +109 -1
- package/json-schema/api/ODataQuery.json +83 -1
- package/json-schema/api/ODataResponse.json +31 -1
- package/json-schema/api/ObjectDefinitionResponse.json +2755 -0
- package/json-schema/api/ObjectQLReference.json +36 -1
- package/json-schema/api/ObjectStackProtocol.json +5 -1
- package/json-schema/api/OpenApiSecurityScheme.json +60 -1
- package/json-schema/api/OpenApiServer.json +43 -1
- package/json-schema/api/OpenApiSpec.json +296 -1
- package/json-schema/api/PaginationRequest.json +28 -1
- package/json-schema/api/PaginationResponse.json +36 -1
- package/json-schema/api/PingMessage.json +25 -1
- package/json-schema/api/PluginResponse.json +893 -1
- package/json-schema/api/PluginVersionInfo.json +29 -1
- package/json-schema/api/PongMessage.json +30 -1
- package/json-schema/api/Presence.json +34 -1
- package/json-schema/api/PresenceMessage.json +86 -1
- package/json-schema/api/PresenceState.json +59 -1
- package/json-schema/api/PresenceStatus.json +8 -1
- package/json-schema/api/PresenceUpdate.json +29 -1
- package/json-schema/api/PresignedUrlResponse.json +115 -0
- package/json-schema/api/PublishPluginRequest.json +646 -1
- package/json-schema/api/RateLimit.json +21 -1
- package/json-schema/api/RealtimeAction.json +8 -1
- package/json-schema/api/RealtimeConfig.json +84 -1
- package/json-schema/api/RealtimeEvent.json +52 -1
- package/json-schema/api/RealtimeEventType.json +9 -1
- package/json-schema/api/RecordData.json +5 -1
- package/json-schema/api/RefreshTokenRequest.json +19 -0
- package/json-schema/api/RegisterRequest.json +30 -0
- package/json-schema/api/RestApiConfig.json +122 -1
- package/json-schema/api/RestServerConfig.json +403 -1
- package/json-schema/api/RetryStrategy.json +9 -1
- package/json-schema/api/RevokeLicenseRequest.json +15 -1
- package/json-schema/api/RouteCategory.json +11 -1
- package/json-schema/api/RouteDefinition.json +71 -1
- package/json-schema/api/RouteGenerationConfig.json +65 -1
- package/json-schema/api/RouterConfig.json +143 -1
- package/json-schema/api/SchemaDefinition.json +54 -1
- package/json-schema/api/SearchPluginsRequest.json +85 -1
- package/json-schema/api/SearchPluginsResponse.json +933 -1
- package/json-schema/api/Session.json +36 -0
- package/json-schema/api/SessionResponse.json +184 -0
- package/json-schema/api/SessionUser.json +72 -0
- package/json-schema/api/SimpleCursorPosition.json +47 -1
- package/json-schema/api/SimplePresenceState.json +38 -1
- package/json-schema/api/SingleRecordResponse.json +71 -1
- package/json-schema/api/SpaceResponse.json +339 -1
- package/json-schema/api/StandardErrorCode.json +56 -1
- package/json-schema/api/SubscribeMessage.json +126 -1
- package/json-schema/api/Subscription.json +59 -1
- package/json-schema/api/SubscriptionEvent.json +26 -1
- package/json-schema/api/TenantResponse.json +119 -1
- package/json-schema/api/TransportProtocol.json +8 -1
- package/json-schema/api/UnsubscribeMessage.json +41 -1
- package/json-schema/api/UnsubscribeRequest.json +14 -1
- package/json-schema/api/UpdateDataRequest.json +24 -1
- package/json-schema/api/UpdateDataResponse.json +24 -1
- package/json-schema/api/UpdateManyDataRequest.json +64 -1
- package/json-schema/api/UpdateManyDataResponse.json +154 -1
- package/json-schema/api/UpdateManyRequest.json +61 -1
- package/json-schema/api/UpdatePluginRequest.json +640 -1
- package/json-schema/api/UpdateRequest.json +14 -1
- package/json-schema/api/UpdateSpaceRequest.json +232 -1
- package/json-schema/api/UpdateTenantRequest.json +46 -1
- package/json-schema/api/UserProfileResponse.json +138 -0
- package/json-schema/api/ValidateLicenseRequest.json +17 -1
- package/json-schema/api/ValidateLicenseResponse.json +151 -1
- package/json-schema/api/WebSocketConfig.json +57 -1
- package/json-schema/api/WebSocketEvent.json +34 -1
- package/json-schema/api/WebSocketMessage.json +701 -1
- package/json-schema/api/WebSocketMessageType.json +15 -1
- package/json-schema/api/WebSocketPresenceStatus.json +9 -1
- package/json-schema/api/WebSocketServerConfig.json +36 -1
- package/json-schema/automation/ApprovalAction.json +36 -1
- package/json-schema/automation/ApprovalActionType.json +10 -1
- package/json-schema/automation/ApprovalProcess.json +362 -1
- package/json-schema/automation/ApprovalStep.json +155 -1
- package/json-schema/automation/ApproverType.json +10 -1
- package/json-schema/automation/AuthField.json +67 -1
- package/json-schema/automation/Authentication.json +153 -1
- package/json-schema/automation/AuthenticationType.json +12 -1
- package/json-schema/automation/ConflictResolution.json +10 -1
- package/json-schema/automation/Connector.json +434 -1
- package/json-schema/automation/ConnectorActionRef.json +40 -0
- package/json-schema/automation/ConnectorCategory.json +20 -1
- package/json-schema/automation/ConnectorInstance.json +63 -1
- package/json-schema/automation/ConnectorOperation.json +111 -1
- package/json-schema/automation/ConnectorTrigger.json +48 -1
- package/json-schema/automation/CustomScriptAction.json +43 -1
- package/json-schema/automation/DataDestinationConfig.json +189 -1
- package/json-schema/automation/DataSourceConfig.json +28 -1
- package/json-schema/automation/DataSyncConfig.json +455 -1
- package/json-schema/automation/ETLDestination.json +51 -1
- package/json-schema/automation/ETLEndpointType.json +13 -1
- package/json-schema/automation/ETLPipeline.json +246 -1
- package/json-schema/automation/ETLPipelineRun.json +101 -1
- package/json-schema/automation/ETLRunStatus.json +11 -1
- package/json-schema/automation/ETLSource.json +54 -1
- package/json-schema/automation/ETLSyncMode.json +8 -1
- package/json-schema/automation/ETLTransformation.json +40 -1
- package/json-schema/automation/ETLTransformationType.json +15 -1
- package/json-schema/automation/EmailAlertAction.json +31 -1
- package/json-schema/automation/FieldUpdateAction.json +26 -1
- package/json-schema/automation/Flow.json +233 -1
- package/json-schema/automation/FlowEdge.json +40 -1
- package/json-schema/automation/FlowNode.json +82 -1
- package/json-schema/automation/FlowNodeAction.json +19 -1
- package/json-schema/automation/FlowVariable.json +28 -1
- package/json-schema/automation/HttpCallAction.json +46 -1
- package/json-schema/automation/OAuth2Config.json +37 -1
- package/json-schema/automation/OperationParameter.json +53 -1
- package/json-schema/automation/OperationType.json +11 -1
- package/json-schema/automation/PushNotificationAction.json +53 -1
- package/json-schema/automation/SyncDirection.json +8 -1
- package/json-schema/automation/SyncExecutionResult.json +129 -1
- package/json-schema/automation/SyncExecutionStatus.json +11 -1
- package/json-schema/automation/SyncMode.json +8 -1
- package/json-schema/automation/TaskCreationAction.json +53 -1
- package/json-schema/automation/TimeTrigger.json +344 -1
- package/json-schema/automation/Webhook.json +167 -1
- package/json-schema/automation/WebhookReceiver.json +62 -1
- package/json-schema/automation/WebhookTriggerType.json +10 -1
- package/json-schema/automation/WorkflowAction.json +290 -1
- package/json-schema/automation/WorkflowRule.json +688 -1
- package/json-schema/automation/WorkflowTriggerType.json +10 -1
- package/json-schema/data/Address.json +34 -1
- package/json-schema/data/AggregationFunction.json +13 -1
- package/json-schema/data/AggregationNode.json +59 -1
- package/json-schema/data/AggregationPipeline.json +93 -1
- package/json-schema/data/AggregationStage.json +19 -1
- package/json-schema/data/AnalyticsQuery.json +129 -0
- package/json-schema/data/ApiMethod.json +19 -1
- package/json-schema/data/AsyncValidation.json +111 -1
- package/json-schema/data/CDCConfig.json +31 -1
- package/json-schema/data/ComparisonOperator.json +102 -1
- package/json-schema/data/ComputedFieldCache.json +27 -1
- package/json-schema/data/ConditionalValidation.json +1434 -1
- package/json-schema/data/ConsistencyLevel.json +11 -1
- package/json-schema/data/CrossFieldValidation.json +81 -1
- package/json-schema/data/Cube.json +201 -0
- package/json-schema/data/CubeJoin.json +33 -0
- package/json-schema/data/CurrencyConfig.json +29 -1
- package/json-schema/data/CurrencyValue.json +20 -1
- package/json-schema/data/CustomValidator.json +78 -1
- package/json-schema/data/DataEngineAggregateOptions.json +74 -1
- package/json-schema/data/DataEngineAggregateRequest.json +92 -1
- package/json-schema/data/DataEngineBatchRequest.json +693 -1
- package/json-schema/data/DataEngineContract.json +6 -1
- package/json-schema/data/DataEngineCountOptions.json +38 -1
- package/json-schema/data/DataEngineCountRequest.json +55 -1
- package/json-schema/data/DataEngineDeleteOptions.json +42 -1
- package/json-schema/data/DataEngineDeleteRequest.json +62 -1
- package/json-schema/data/DataEngineExecuteRequest.json +18 -1
- package/json-schema/data/DataEngineFilter.json +31 -1
- package/json-schema/data/DataEngineFindOneRequest.json +127 -1
- package/json-schema/data/DataEngineFindRequest.json +127 -1
- package/json-schema/data/DataEngineInsertOptions.json +11 -1
- package/json-schema/data/DataEngineInsertRequest.json +44 -1
- package/json-schema/data/DataEngineQueryOptions.json +110 -1
- package/json-schema/data/DataEngineRequest.json +1366 -1
- package/json-schema/data/DataEngineSort.json +48 -1
- package/json-schema/data/DataEngineUpdateOptions.json +50 -1
- package/json-schema/data/DataEngineUpdateRequest.json +75 -1
- package/json-schema/data/DataEngineVectorFindRequest.json +68 -1
- package/json-schema/data/DataQualityRules.json +39 -1
- package/json-schema/data/DataTypeMapping.json +45 -1
- package/json-schema/data/Dataset.json +57 -1
- package/json-schema/data/DatasetMode.json +10 -1
- package/json-schema/data/Datasource.json +130 -0
- package/json-schema/data/DatasourceCapabilities.json +56 -0
- package/json-schema/data/Dimension.json +60 -0
- package/json-schema/data/DimensionType.json +16 -0
- package/json-schema/data/Document.json +286 -1
- package/json-schema/data/DocumentTemplate.json +72 -1
- package/json-schema/data/DocumentValidationSchema.json +33 -1
- package/json-schema/data/DocumentVersion.json +44 -1
- package/json-schema/data/DriverCapabilities.json +174 -1
- package/json-schema/data/DriverConfig.json +237 -1
- package/json-schema/data/DriverDefinition.json +86 -0
- package/json-schema/data/DriverInterface.json +193 -1
- package/json-schema/data/DriverOptions.json +28 -1
- package/json-schema/{system → data}/DriverType.json +4 -1
- package/json-schema/data/ESignatureConfig.json +68 -1
- package/json-schema/data/EqualityOperator.json +8 -1
- package/json-schema/data/ExternalDataSource.json +62 -1
- package/json-schema/data/ExternalFieldMapping.json +145 -1
- package/json-schema/data/ExternalLookup.json +321 -1
- package/json-schema/data/Field.json +855 -1
- package/json-schema/data/FieldMapping.json +77 -1
- package/json-schema/data/FieldNode.json +26 -1
- package/json-schema/data/FieldOperators.json +180 -1
- package/json-schema/data/FieldReference.json +13 -1
- package/json-schema/data/FieldType.json +49 -1
- package/json-schema/data/FileAttachmentConfig.json +213 -1
- package/json-schema/data/FilterCondition.json +22 -1
- package/json-schema/data/FormatValidation.json +84 -1
- package/json-schema/data/FullTextSearch.json +54 -1
- package/json-schema/data/Hook.json +89 -1
- package/json-schema/data/HookContext.json +82 -1
- package/json-schema/data/HookEvent.json +23 -1
- package/json-schema/data/Index.json +41 -1
- package/json-schema/data/JSONValidation.json +79 -1
- package/json-schema/data/JoinNode.json +488 -1
- package/json-schema/data/JoinStrategy.json +9 -1
- package/json-schema/data/JoinType.json +9 -1
- package/json-schema/data/LocationCoordinates.json +30 -1
- package/json-schema/data/Mapping.json +633 -1
- package/json-schema/data/Metric.json +66 -0
- package/json-schema/data/MetricType.json +20 -0
- package/json-schema/data/NoSQLDataTypeMapping.json +57 -1
- package/json-schema/data/NoSQLDatabaseType.json +13 -1
- package/json-schema/data/NoSQLDriverConfig.json +446 -1
- package/json-schema/data/NoSQLIndex.json +81 -1
- package/json-schema/data/NoSQLIndexType.json +13 -1
- package/json-schema/data/NoSQLOperationType.json +16 -1
- package/json-schema/data/NoSQLQueryOptions.json +55 -1
- package/json-schema/data/NoSQLTransactionOptions.json +41 -1
- package/json-schema/data/NormalizedFilter.json +576 -1
- package/json-schema/data/Object.json +2682 -1
- package/json-schema/data/ObjectCapabilities.json +74 -1
- package/json-schema/data/PartitioningConfig.json +32 -1
- package/json-schema/data/PoolConfig.json +30 -1
- package/json-schema/data/Query.json +489 -1
- package/json-schema/data/QueryFilter.json +28 -1
- package/json-schema/data/RangeOperator.json +61 -1
- package/json-schema/data/ReplicationConfig.json +40 -1
- package/json-schema/data/SQLDialect.json +11 -1
- package/json-schema/data/SQLDriverConfig.json +319 -1
- package/json-schema/data/SSLConfig.json +23 -1
- package/json-schema/data/ScriptValidation.json +73 -1
- package/json-schema/data/SearchConfig.json +30 -1
- package/json-schema/data/SelectOption.json +28 -1
- package/json-schema/data/SetOperator.json +12 -1
- package/json-schema/data/ShardingConfig.json +29 -1
- package/json-schema/data/SoftDeleteConfig.json +23 -1
- package/json-schema/data/SortNode.json +20 -1
- package/json-schema/data/SpecialOperator.json +12 -1
- package/json-schema/data/StateMachineValidation.json +84 -1
- package/json-schema/data/StringOperator.json +15 -1
- package/json-schema/data/TenancyConfig.json +33 -1
- package/json-schema/data/TimeUpdateInterval.json +19 -0
- package/json-schema/data/TransformType.json +12 -1
- package/json-schema/data/UniquenessValidation.json +84 -1
- package/json-schema/data/ValidationRule.json +1435 -1
- package/json-schema/data/VectorConfig.json +45 -1
- package/json-schema/data/VersioningConfig.json +33 -1
- package/json-schema/data/WindowFunction.json +18 -1
- package/json-schema/data/WindowFunctionNode.json +98 -1
- package/json-schema/data/WindowSpec.json +59 -1
- package/json-schema/hub/BillOfMaterials.json +64 -1
- package/json-schema/hub/ComposerRequest.json +80 -1
- package/json-schema/hub/ComposerResponse.json +1514 -1
- package/json-schema/hub/ConflictReport.json +47 -1
- package/json-schema/hub/DatabaseLevelIsolationStrategy.json +133 -1
- package/json-schema/hub/DependencyConflict.json +72 -1
- package/json-schema/hub/DependencyGraph.json +161 -1
- package/json-schema/hub/DependencyGraphNode.json +81 -1
- package/json-schema/hub/DependencyRequirement.json +30 -1
- package/json-schema/hub/DependencyResolutionResult.json +285 -1
- package/json-schema/hub/DeploymentTarget.json +32 -1
- package/json-schema/hub/EdgeLocation.json +93 -1
- package/json-schema/hub/Feature.json +45 -1
- package/json-schema/hub/FederationTopology.json +406 -1
- package/json-schema/hub/GlobalRegistryEntry.json +60 -1
- package/json-schema/hub/HubInstance.json +115 -1
- package/json-schema/hub/HubSpace.json +273 -1
- package/json-schema/hub/LevelIsolationStrategySchema.json +87 -1
- package/json-schema/hub/License.json +59 -1
- package/json-schema/hub/MarketplacePlugin.json +222 -1
- package/json-schema/hub/MetricType.json +8 -1
- package/json-schema/hub/PackageDependency.json +30 -1
- package/json-schema/hub/Plan.json +47 -1
- package/json-schema/hub/PluginAuthor.json +41 -1
- package/json-schema/hub/PluginInstallConfig.json +47 -1
- package/json-schema/hub/PluginPricing.json +37 -1
- package/json-schema/hub/PluginProvenance.json +192 -1
- package/json-schema/hub/PluginQualityMetrics.json +95 -1
- package/json-schema/hub/PluginRegistryEntry.json +827 -1
- package/json-schema/hub/PluginSearchFilters.json +85 -1
- package/json-schema/hub/PluginStatistics.json +78 -1
- package/json-schema/hub/PluginTrustScore.json +88 -1
- package/json-schema/hub/PluginVendor.json +41 -1
- package/json-schema/hub/PluginVersion.json +63 -0
- package/json-schema/hub/Region.json +175 -1
- package/json-schema/hub/RegistryConfig.json +233 -1
- package/json-schema/hub/RegistrySyncPolicy.json +9 -1
- package/json-schema/hub/RegistryUpstream.json +104 -1
- package/json-schema/hub/ReplicationJob.json +134 -1
- package/json-schema/hub/RowLevelIsolationStrategy.json +68 -1
- package/json-schema/hub/SBOM.json +144 -1
- package/json-schema/hub/SBOMEntry.json +78 -1
- package/json-schema/hub/SecurityPolicy.json +140 -1
- package/json-schema/hub/SecurityScanResult.json +303 -1
- package/json-schema/hub/SecurityVulnerability.json +112 -1
- package/json-schema/hub/SpaceSubscription.json +71 -1
- package/json-schema/hub/SubscriptionStatus.json +10 -1
- package/json-schema/hub/Tenant.json +53 -1
- package/json-schema/hub/TenantIsolationConfig.json +292 -1
- package/json-schema/hub/TenantIsolationLevel.json +8 -1
- package/json-schema/hub/TenantPlacementPolicy.json +92 -1
- package/json-schema/hub/TenantQuota.json +21 -1
- package/json-schema/hub/TenantSecurityPolicy.json +109 -1
- package/json-schema/hub/VulnerabilitySeverity.json +10 -1
- package/json-schema/identity/Account.json +87 -0
- package/json-schema/identity/Invitation.json +69 -0
- package/json-schema/identity/InvitationStatus.json +15 -0
- package/json-schema/identity/Member.json +46 -0
- package/json-schema/identity/Organization.json +52 -0
- package/json-schema/identity/Role.json +33 -0
- package/json-schema/identity/SCIMAddress.json +50 -0
- package/json-schema/identity/SCIMEmail.json +38 -0
- package/json-schema/identity/SCIMEnterpriseUser.json +55 -0
- package/json-schema/identity/SCIMError.json +52 -0
- package/json-schema/identity/SCIMGroup.json +102 -0
- package/json-schema/identity/SCIMGroupReference.json +36 -0
- package/json-schema/identity/SCIMListResponse.json +606 -0
- package/json-schema/identity/SCIMMemberReference.json +36 -0
- package/json-schema/identity/SCIMMeta.json +35 -0
- package/json-schema/identity/SCIMName.json +36 -0
- package/json-schema/identity/SCIMPatchOperation.json +31 -0
- package/json-schema/identity/SCIMPatchRequest.json +56 -0
- package/json-schema/identity/SCIMPhoneNumber.json +40 -0
- package/json-schema/identity/SCIMUser.json +462 -0
- package/json-schema/identity/Session.json +63 -0
- package/json-schema/identity/User.json +51 -0
- package/json-schema/identity/VerificationToken.json +36 -0
- package/json-schema/integration/AckMode.json +9 -1
- package/json-schema/integration/ApiVersionConfig.json +26 -1
- package/json-schema/integration/Authentication.json +140 -1
- package/json-schema/integration/BuildConfig.json +33 -1
- package/json-schema/integration/CdcConfig.json +49 -1
- package/json-schema/integration/ConflictResolution.json +10 -1
- package/json-schema/integration/Connector.json +861 -1
- package/json-schema/integration/ConnectorAction.json +37 -0
- package/json-schema/integration/ConnectorStatus.json +10 -1
- package/json-schema/integration/ConnectorTrigger.json +40 -0
- package/json-schema/integration/ConnectorType.json +12 -1
- package/json-schema/integration/ConsumerConfig.json +61 -1
- package/json-schema/integration/DataSyncConfig.json +73 -1
- package/json-schema/integration/DatabaseConnector.json +1314 -1
- package/json-schema/integration/DatabasePoolConfig.json +47 -1
- package/json-schema/integration/DatabaseProvider.json +18 -1
- package/json-schema/integration/DatabaseTable.json +210 -1
- package/json-schema/integration/DeliveryGuarantee.json +9 -1
- package/json-schema/integration/DeploymentConfig.json +71 -1
- package/json-schema/integration/DlqConfig.json +31 -1
- package/json-schema/integration/DomainConfig.json +45 -1
- package/json-schema/integration/EdgeFunctionConfig.json +39 -1
- package/json-schema/integration/EnvironmentVariables.json +40 -1
- package/json-schema/integration/FieldMapping.json +164 -1
- package/json-schema/integration/FieldTransform.json +30 -1
- package/json-schema/integration/FileAccessPattern.json +11 -1
- package/json-schema/integration/FileFilterConfig.json +44 -1
- package/json-schema/integration/FileMetadataConfig.json +35 -1
- package/json-schema/integration/FileStorageConnector.json +1182 -1
- package/json-schema/integration/FileStorageProvider.json +17 -1
- package/json-schema/integration/FileVersioningConfig.json +22 -1
- package/json-schema/integration/GitHubActionsWorkflow.json +52 -1
- package/json-schema/integration/GitHubCommitConfig.json +29 -1
- package/json-schema/integration/GitHubConnector.json +1189 -1
- package/json-schema/integration/GitHubIssueTracking.json +55 -1
- package/json-schema/integration/GitHubProvider.json +8 -1
- package/json-schema/integration/GitHubPullRequestConfig.json +45 -1
- package/json-schema/integration/GitHubReleaseConfig.json +34 -1
- package/json-schema/integration/GitHubRepository.json +68 -1
- package/json-schema/integration/GitRepositoryConfig.json +38 -1
- package/json-schema/integration/MessageFormat.json +12 -1
- package/json-schema/integration/MessageQueueConnector.json +1267 -1
- package/json-schema/integration/MessageQueueProvider.json +19 -1
- package/json-schema/integration/MultipartUploadConfig.json +30 -1
- package/json-schema/integration/ProducerConfig.json +66 -1
- package/json-schema/integration/RateLimitConfig.json +63 -1
- package/json-schema/integration/RateLimitStrategy.json +10 -1
- package/json-schema/integration/RetryConfig.json +67 -1
- package/json-schema/integration/RetryStrategy.json +10 -1
- package/json-schema/integration/SaasConnector.json +1209 -1
- package/json-schema/integration/SaasObjectType.json +212 -1
- package/json-schema/integration/SaasProvider.json +18 -1
- package/json-schema/integration/SslConfig.json +28 -1
- package/json-schema/integration/StorageBucket.json +93 -1
- package/json-schema/integration/SyncStrategy.json +10 -1
- package/json-schema/integration/TopicQueue.json +246 -1
- package/json-schema/integration/VercelConnector.json +1286 -1
- package/json-schema/integration/VercelFramework.json +18 -1
- package/json-schema/integration/VercelMonitoring.json +58 -1
- package/json-schema/integration/VercelProject.json +316 -1
- package/json-schema/integration/VercelProvider.json +7 -1
- package/json-schema/integration/VercelTeam.json +14 -1
- package/json-schema/integration/WebhookConfig.json +195 -1
- package/json-schema/integration/WebhookEvent.json +14 -1
- package/json-schema/integration/WebhookSignatureAlgorithm.json +9 -1
- package/json-schema/kernel/AdvancedPluginLifecycleConfig.json +424 -0
- package/json-schema/kernel/BreakingChange.json +63 -0
- package/json-schema/kernel/CapabilityConformanceLevel.json +16 -0
- package/json-schema/kernel/CompatibilityLevel.json +17 -0
- package/json-schema/kernel/CompatibilityMatrixEntry.json +123 -0
- package/json-schema/kernel/DeadLetterQueueEntry.json +137 -0
- package/json-schema/kernel/DependencyConflict.json +102 -0
- package/json-schema/kernel/DependencyResolutionResult.json +163 -0
- package/json-schema/kernel/DeprecationNotice.json +38 -0
- package/json-schema/kernel/DistributedStateConfig.json +78 -0
- package/json-schema/kernel/Event.json +77 -0
- package/json-schema/kernel/EventBusConfig.json +552 -0
- package/json-schema/kernel/EventHandler.json +63 -0
- package/json-schema/kernel/EventLogEntry.json +153 -0
- package/json-schema/kernel/EventMessageQueueConfig.json +79 -0
- package/json-schema/kernel/EventMetadata.json +53 -0
- package/json-schema/kernel/EventPersistence.json +36 -0
- package/json-schema/kernel/EventPhase.json +15 -0
- package/json-schema/kernel/EventPriority.json +16 -0
- package/json-schema/kernel/EventQueueConfig.json +67 -0
- package/json-schema/kernel/EventReplayConfig.json +50 -0
- package/json-schema/kernel/EventRoute.json +27 -0
- package/json-schema/kernel/EventSourcingConfig.json +65 -0
- package/json-schema/kernel/EventTypeDefinition.json +45 -0
- package/json-schema/kernel/EventWebhookConfig.json +119 -0
- package/json-schema/kernel/ExtensionPoint.json +67 -0
- package/json-schema/kernel/FeatureFlag.json +87 -0
- package/json-schema/kernel/FeatureStrategy.json +16 -0
- package/json-schema/kernel/GracefulDegradation.json +87 -0
- package/json-schema/kernel/HealthStatus.json +33 -0
- package/json-schema/kernel/HookRegisteredEvent.json +30 -0
- package/json-schema/kernel/HookTriggeredEvent.json +34 -0
- package/json-schema/kernel/HotReloadConfig.json +138 -0
- package/json-schema/kernel/KernelContext.json +62 -0
- package/json-schema/kernel/KernelEventBase.json +19 -0
- package/json-schema/kernel/KernelReadyEvent.json +29 -0
- package/json-schema/kernel/KernelShutdownEvent.json +23 -0
- package/json-schema/kernel/Manifest.json +1432 -0
- package/json-schema/kernel/MetadataCollectionInfo.json +53 -0
- package/json-schema/kernel/MetadataExportOptions.json +49 -0
- package/json-schema/kernel/MetadataFormat.json +15 -0
- package/json-schema/kernel/MetadataImportOptions.json +42 -0
- package/json-schema/kernel/MetadataLoadOptions.json +52 -0
- package/json-schema/kernel/MetadataLoadResult.json +86 -0
- package/json-schema/kernel/MetadataLoaderContract.json +48 -0
- package/json-schema/kernel/MetadataManagerConfig.json +108 -0
- package/json-schema/kernel/MetadataSaveOptions.json +64 -0
- package/json-schema/kernel/MetadataSaveResult.json +42 -0
- package/json-schema/kernel/MetadataStats.json +51 -0
- package/json-schema/kernel/MetadataWatchEvent.json +48 -0
- package/json-schema/kernel/MultiVersionSupport.json +91 -0
- package/json-schema/kernel/OpsDomainModule.json +26 -0
- package/json-schema/kernel/OpsFilePath.json +9 -0
- package/json-schema/kernel/OpsPluginStructure.json +26 -0
- package/json-schema/kernel/Permission.json +110 -0
- package/json-schema/kernel/PermissionAction.json +23 -0
- package/json-schema/kernel/PermissionScope.json +17 -0
- package/json-schema/kernel/PermissionSet.json +160 -0
- package/json-schema/kernel/Plugin.json +32 -0
- package/json-schema/kernel/PluginCaching.json +77 -0
- package/json-schema/kernel/PluginCapability.json +127 -0
- package/json-schema/kernel/PluginCapabilityManifest.json +410 -0
- package/json-schema/kernel/PluginCodeSplitting.json +56 -0
- package/json-schema/kernel/PluginCompatibilityMatrix.json +177 -0
- package/json-schema/kernel/PluginContext.json +82 -0
- package/json-schema/kernel/PluginDependency.json +39 -0
- package/json-schema/kernel/PluginDependencyResolution.json +88 -0
- package/json-schema/kernel/PluginDynamicImport.json +69 -0
- package/json-schema/kernel/PluginErrorEvent.json +46 -0
- package/json-schema/kernel/PluginEventBase.json +24 -0
- package/json-schema/kernel/PluginHealthCheck.json +61 -0
- package/json-schema/kernel/PluginHealthReport.json +128 -0
- package/json-schema/kernel/PluginHealthStatus.json +18 -0
- package/json-schema/kernel/PluginHotReload.json +80 -0
- package/json-schema/kernel/PluginInitialization.json +64 -0
- package/json-schema/kernel/PluginInterface.json +141 -0
- package/json-schema/{system → kernel}/PluginLifecycle.json +5 -1
- package/json-schema/kernel/PluginLifecycleEventType.json +31 -0
- package/json-schema/kernel/PluginLifecyclePhaseEvent.json +38 -0
- package/json-schema/kernel/PluginLoadingConfig.json +635 -0
- package/json-schema/kernel/PluginLoadingEvent.json +67 -0
- package/json-schema/kernel/PluginLoadingState.json +54 -0
- package/json-schema/kernel/PluginLoadingStrategy.json +17 -0
- package/json-schema/kernel/PluginMetadata.json +37 -0
- package/json-schema/kernel/PluginPerformanceMonitoring.json +70 -0
- package/json-schema/kernel/PluginPreloadConfig.json +73 -0
- package/json-schema/kernel/PluginRegisteredEvent.json +28 -0
- package/json-schema/kernel/PluginSandboxing.json +87 -0
- package/json-schema/kernel/PluginSecurityManifest.json +1189 -0
- package/json-schema/kernel/PluginStartupResult.json +73 -0
- package/json-schema/kernel/PluginStateSnapshot.json +50 -0
- package/json-schema/kernel/PluginTrustLevel.json +17 -0
- package/json-schema/kernel/PluginUpdateStrategy.json +102 -0
- package/json-schema/kernel/PluginVersionMetadata.json +362 -0
- package/json-schema/kernel/ProtocolFeature.json +34 -0
- package/json-schema/kernel/ProtocolReference.json +56 -0
- package/json-schema/kernel/ProtocolVersion.json +30 -0
- package/json-schema/kernel/RealTimeNotificationConfig.json +85 -0
- package/json-schema/kernel/ResourceType.json +28 -0
- package/json-schema/kernel/RuntimeConfig.json +138 -0
- package/json-schema/kernel/RuntimeMode.json +16 -0
- package/json-schema/kernel/SandboxConfig.json +312 -0
- package/json-schema/kernel/ScopeConfig.json +28 -0
- package/json-schema/kernel/ScopeInfo.json +39 -0
- package/json-schema/kernel/SecurityPolicy.json +172 -0
- package/json-schema/kernel/SecurityScanResult.json +352 -0
- package/json-schema/kernel/SecurityVulnerability.json +92 -0
- package/json-schema/kernel/SemanticVersion.json +41 -0
- package/json-schema/kernel/ServiceFactoryRegistration.json +44 -0
- package/json-schema/kernel/ServiceMetadata.json +43 -0
- package/json-schema/kernel/ServiceRegisteredEvent.json +28 -0
- package/json-schema/kernel/ServiceRegistryConfig.json +39 -0
- package/json-schema/kernel/ServiceScopeType.json +15 -0
- package/json-schema/kernel/ServiceUnregisteredEvent.json +24 -0
- package/json-schema/kernel/StartupOptions.json +36 -0
- package/json-schema/kernel/StartupOrchestrationResult.json +104 -0
- package/json-schema/kernel/ValidationError.json +28 -0
- package/json-schema/kernel/ValidationResult.json +71 -0
- package/json-schema/kernel/ValidationWarning.json +28 -0
- package/json-schema/kernel/VersionConstraint.json +60 -0
- package/json-schema/qa/TestAction.json +36 -1
- package/json-schema/qa/TestActionType.json +13 -1
- package/json-schema/qa/TestAssertion.json +31 -1
- package/json-schema/qa/TestAssertionType.json +16 -1
- package/json-schema/qa/TestContext.json +5 -1
- package/json-schema/qa/TestScenario.json +335 -1
- package/json-schema/qa/TestStep.json +93 -1
- package/json-schema/qa/TestSuite.json +351 -1
- package/json-schema/security/AuditPolicy.json +31 -0
- package/json-schema/security/CriteriaSharingRule.json +82 -0
- package/json-schema/security/FieldPermission.json +22 -0
- package/json-schema/security/NetworkPolicy.json +31 -0
- package/json-schema/security/OWDModel.json +15 -0
- package/json-schema/security/ObjectPermission.json +57 -0
- package/json-schema/security/OwnerSharingRule.json +102 -0
- package/json-schema/security/PasswordPolicy.json +41 -0
- package/json-schema/security/PermissionSet.json +193 -0
- package/json-schema/security/Policy.json +138 -0
- package/json-schema/security/RLSConfig.json +59 -0
- package/json-schema/security/RLSEvaluationResult.json +40 -0
- package/json-schema/security/RLSOperation.json +16 -0
- package/json-schema/security/RLSUserContext.json +51 -0
- package/json-schema/security/RowLevelSecurityPolicy.json +77 -0
- package/json-schema/security/SessionPolicy.json +27 -0
- package/json-schema/security/ShareRecipientType.json +16 -0
- package/json-schema/security/SharingLevel.json +14 -0
- package/json-schema/security/SharingRule.json +182 -0
- package/json-schema/{permission → security}/SharingRuleType.json +7 -1
- package/json-schema/security/Territory.json +79 -0
- package/json-schema/security/TerritoryModel.json +34 -0
- package/json-schema/security/TerritoryType.json +15 -0
- package/json-schema/shared/CorsConfig.json +51 -1
- package/json-schema/shared/EventName.json +6 -1
- package/json-schema/shared/FieldMapping.json +136 -1
- package/json-schema/shared/HttpMethod.json +12 -1
- package/json-schema/shared/RateLimitConfig.json +21 -1
- package/json-schema/shared/SnakeCaseIdentifier.json +6 -1
- package/json-schema/shared/StaticMount.json +22 -1
- package/json-schema/shared/SystemIdentifier.json +6 -1
- package/json-schema/shared/TransformType.json +114 -1
- package/json-schema/system/AccessControlConfig.json +100 -1
- package/json-schema/system/AddFieldOperation.json +877 -1
- package/json-schema/system/AnalyzerConfig.json +35 -1
- package/json-schema/system/AuditConfig.json +580 -1
- package/json-schema/system/AuditEvent.json +226 -1
- package/json-schema/system/AuditEventActor.json +42 -1
- package/json-schema/system/AuditEventChange.json +19 -1
- package/json-schema/system/AuditEventFilter.json +121 -1
- package/json-schema/system/AuditEventSeverity.json +13 -1
- package/json-schema/system/AuditEventTarget.json +27 -1
- package/json-schema/system/AuditEventType.json +47 -1
- package/json-schema/system/AuditLogConfig.json +42 -1
- package/json-schema/system/AuditRetentionPolicy.json +67 -1
- package/json-schema/system/AuditStorageConfig.json +54 -1
- package/json-schema/system/AuthConfig.json +100 -0
- package/json-schema/system/AuthPluginConfig.json +32 -0
- package/json-schema/system/AuthProviderConfig.json +36 -0
- package/json-schema/system/AwarenessEvent.json +45 -1
- package/json-schema/system/AwarenessSession.json +111 -1
- package/json-schema/system/AwarenessUpdate.json +29 -1
- package/json-schema/system/AwarenessUserState.json +71 -1
- package/json-schema/system/BatchProgress.json +66 -1
- package/json-schema/system/BatchTask.json +57 -1
- package/json-schema/system/BucketConfig.json +326 -1
- package/json-schema/system/CRDTMergeResult.json +289 -1
- package/json-schema/system/CRDTState.json +252 -1
- package/json-schema/system/CRDTType.json +14 -1
- package/json-schema/system/CacheConfig.json +115 -1
- package/json-schema/system/CacheInvalidation.json +37 -1
- package/json-schema/system/CacheStrategy.json +10 -1
- package/json-schema/system/CacheTier.json +46 -1
- package/json-schema/system/ChangeImpact.json +49 -1
- package/json-schema/system/ChangePriority.json +9 -1
- package/json-schema/system/ChangeRequest.json +307 -1
- package/json-schema/system/ChangeSet.json +7418 -1
- package/json-schema/system/ChangeStatus.json +15 -1
- package/json-schema/system/ChangeType.json +9 -1
- package/json-schema/system/CollaborationMode.json +9 -1
- package/json-schema/system/CollaborationSession.json +569 -1
- package/json-schema/system/CollaborationSessionConfig.json +80 -1
- package/json-schema/system/CollaborativeCursor.json +183 -1
- package/json-schema/system/ComplianceConfig.json +196 -1
- package/json-schema/system/ConsoleDestinationConfig.json +23 -1
- package/json-schema/system/ConsumerConfig.json +28 -1
- package/json-schema/system/CoreServiceName.json +25 -0
- package/json-schema/system/CounterOperation.json +24 -1
- package/json-schema/system/CreateObjectOperation.json +2696 -1
- package/json-schema/system/CronSchedule.json +23 -1
- package/json-schema/system/CursorColorPreset.json +15 -1
- package/json-schema/system/CursorSelection.json +60 -1
- package/json-schema/system/CursorStyle.json +53 -1
- package/json-schema/system/CursorUpdate.json +95 -1
- package/json-schema/system/DeadLetterQueue.json +20 -1
- package/json-schema/system/DeleteObjectOperation.json +17 -1
- package/json-schema/system/EmailTemplate.json +63 -1
- package/json-schema/system/EncryptionAlgorithm.json +8 -1
- package/json-schema/system/EncryptionConfig.json +87 -1
- package/json-schema/system/ExecuteSqlOperation.json +20 -1
- package/json-schema/system/ExtendedLogLevel.json +12 -1
- package/json-schema/system/ExternalServiceDestinationConfig.json +45 -1
- package/json-schema/system/FacetConfig.json +24 -1
- package/json-schema/system/FieldEncryption.json +104 -1
- package/json-schema/system/FileDestinationConfig.json +50 -1
- package/json-schema/system/FileMetadata.json +44 -1
- package/json-schema/system/GCounter.json +22 -1
- package/json-schema/system/GDPRConfig.json +65 -1
- package/json-schema/system/HIPAAConfig.json +39 -1
- package/json-schema/system/HistogramBucketConfig.json +86 -1
- package/json-schema/system/HttpDestinationConfig.json +105 -1
- package/json-schema/system/HttpServerConfig.json +150 -1
- package/json-schema/system/InAppNotification.json +42 -1
- package/json-schema/system/IntervalSchedule.json +19 -1
- package/json-schema/system/Job.json +126 -1
- package/json-schema/system/JobExecution.json +43 -1
- package/json-schema/system/JobExecutionStatus.json +9 -1
- package/json-schema/system/KernelServiceMap.json +30 -0
- package/json-schema/system/KeyManagementProvider.json +10 -1
- package/json-schema/system/KeyRotationPolicy.json +23 -1
- package/json-schema/system/LWWRegister.json +45 -1
- package/json-schema/system/LifecycleAction.json +9 -1
- package/json-schema/system/LifecyclePolicyConfig.json +78 -1
- package/json-schema/system/LifecyclePolicyRule.json +62 -1
- package/json-schema/system/Locale.json +4 -1
- package/json-schema/system/LogDestination.json +289 -1
- package/json-schema/system/LogDestinationType.json +20 -1
- package/json-schema/system/LogEnrichmentConfig.json +53 -1
- package/json-schema/system/LogEntry.json +58 -1
- package/json-schema/system/LogFormat.json +9 -1
- package/json-schema/system/LogLevel.json +12 -1
- package/json-schema/system/LoggerConfig.json +69 -1
- package/json-schema/system/LoggingConfig.json +608 -1
- package/json-schema/system/MaskingConfig.json +71 -1
- package/json-schema/system/MaskingRule.json +51 -1
- package/json-schema/system/MaskingStrategy.json +12 -1
- package/json-schema/system/MessageQueueConfig.json +137 -1
- package/json-schema/system/MessageQueueProvider.json +11 -1
- package/json-schema/system/MetadataCollectionInfo.json +23 -1
- package/json-schema/system/MetadataExportOptions.json +38 -1
- package/json-schema/system/MetadataFormat.json +12 -1
- package/json-schema/system/MetadataImportOptions.json +26 -1
- package/json-schema/system/MetadataLoadOptions.json +45 -1
- package/json-schema/system/MetadataLoadResult.json +72 -1
- package/json-schema/system/MetadataLoaderContract.json +57 -1
- package/json-schema/system/MetadataManagerConfig.json +37 -1
- package/json-schema/system/MetadataRecord.json +83 -0
- package/json-schema/system/MetadataSaveOptions.json +44 -1
- package/json-schema/system/MetadataSaveResult.json +65 -1
- package/json-schema/system/MetadataScope.json +14 -0
- package/json-schema/system/MetadataState.json +15 -0
- package/json-schema/system/MetadataStats.json +38 -1
- package/json-schema/system/MetadataWatchEvent.json +73 -1
- package/json-schema/system/MetricAggregationConfig.json +63 -1
- package/json-schema/system/MetricAggregationType.json +19 -1
- package/json-schema/system/MetricDataPoint.json +129 -1
- package/json-schema/system/MetricDefinition.json +187 -1
- package/json-schema/system/MetricExportConfig.json +87 -1
- package/json-schema/system/MetricLabels.json +7 -1
- package/json-schema/system/MetricType.json +10 -1
- package/json-schema/system/MetricUnit.json +26 -1
- package/json-schema/system/MetricsConfig.json +712 -1
- package/json-schema/system/MiddlewareConfig.json +64 -1
- package/json-schema/system/MiddlewareType.json +12 -1
- package/json-schema/system/MigrationDependency.json +15 -1
- package/json-schema/system/MigrationOperation.json +3682 -1
- package/json-schema/system/ModifyFieldOperation.json +26 -1
- package/json-schema/system/MultipartUploadConfig.json +43 -1
- package/json-schema/system/NotificationChannel.json +12 -1
- package/json-schema/system/NotificationConfig.json +337 -1
- package/json-schema/system/ORSet.json +51 -1
- package/json-schema/system/ORSetElement.json +33 -1
- package/json-schema/system/OTComponent.json +70 -1
- package/json-schema/system/OTOperation.json +122 -1
- package/json-schema/system/OTOperationType.json +8 -1
- package/json-schema/system/OTTransformResult.json +144 -1
- package/json-schema/system/ObjectMetadata.json +84 -1
- package/json-schema/system/ObjectStorageConfig.json +469 -1
- package/json-schema/system/OnceSchedule.json +19 -1
- package/json-schema/system/OpenTelemetryCompatibility.json +190 -1
- package/json-schema/system/OtelExporterType.json +16 -1
- package/json-schema/system/PCIDSSConfig.json +41 -1
- package/json-schema/system/PNCounter.json +31 -1
- package/json-schema/system/PresignedUrlConfig.json +43 -1
- package/json-schema/system/PushNotification.json +54 -1
- package/json-schema/system/QueueConfig.json +127 -1
- package/json-schema/system/RemoveFieldOperation.json +21 -1
- package/json-schema/system/RenameObjectOperation.json +21 -1
- package/json-schema/system/RetryPolicy.json +24 -1
- package/json-schema/system/RollbackPlan.json +45 -1
- package/json-schema/system/RouteHandlerMetadata.json +79 -1
- package/json-schema/system/SMSTemplate.json +30 -1
- package/json-schema/system/SamplingDecision.json +9 -1
- package/json-schema/system/SamplingStrategyType.json +14 -1
- package/json-schema/system/Schedule.json +65 -1
- package/json-schema/system/SearchConfig.json +189 -1
- package/json-schema/system/SearchIndexConfig.json +72 -1
- package/json-schema/system/SearchProvider.json +10 -1
- package/json-schema/system/ServerCapabilities.json +57 -1
- package/json-schema/system/ServerEvent.json +33 -1
- package/json-schema/system/ServerEventType.json +12 -1
- package/json-schema/system/ServerStatus.json +87 -1
- package/json-schema/system/ServiceConfig.json +42 -0
- package/json-schema/system/ServiceCriticality.json +14 -0
- package/json-schema/system/ServiceLevelIndicator.json +99 -1
- package/json-schema/system/ServiceLevelObjective.json +164 -1
- package/json-schema/system/ServiceStatus.json +62 -0
- package/json-schema/system/Span.json +381 -1
- package/json-schema/system/SpanAttributeValue.json +32 -1
- package/json-schema/system/SpanAttributes.json +36 -1
- package/json-schema/system/SpanEvent.json +56 -1
- package/json-schema/system/SpanKind.json +11 -1
- package/json-schema/system/SpanLink.json +104 -1
- package/json-schema/system/SpanStatus.json +9 -1
- package/json-schema/system/StorageAcl.json +12 -1
- package/json-schema/system/StorageClass.json +11 -1
- package/json-schema/system/StorageConnection.json +56 -1
- package/json-schema/system/StorageProvider.json +15 -1
- package/json-schema/system/StorageScope.json +16 -1
- package/json-schema/system/StructuredLogEntry.json +185 -1
- package/json-schema/system/SuspiciousActivityRule.json +169 -1
- package/json-schema/system/Task.json +139 -1
- package/json-schema/system/TaskExecutionResult.json +79 -1
- package/json-schema/system/TaskPriority.json +10 -1
- package/json-schema/system/TaskRetryPolicy.json +40 -1
- package/json-schema/system/TaskStatus.json +13 -1
- package/json-schema/system/TextCRDTOperation.json +46 -1
- package/json-schema/system/TextCRDTState.json +99 -1
- package/json-schema/system/TimeSeries.json +63 -1
- package/json-schema/system/TimeSeriesDataPoint.json +27 -1
- package/json-schema/system/TopicConfig.json +33 -1
- package/json-schema/system/TraceContext.json +58 -1
- package/json-schema/system/TraceContextPropagation.json +73 -1
- package/json-schema/system/TraceFlags.json +6 -1
- package/json-schema/system/TracePropagationFormat.json +13 -1
- package/json-schema/system/TraceSamplingConfig.json +180 -1
- package/json-schema/system/TraceState.json +17 -1
- package/json-schema/system/TracingConfig.json +533 -1
- package/json-schema/system/TranslationBundle.json +72 -1
- package/json-schema/system/TranslationData.json +69 -1
- package/json-schema/system/UserActivityStatus.json +9 -1
- package/json-schema/system/VectorClock.json +17 -1
- package/json-schema/system/WorkerConfig.json +182 -1
- package/json-schema/system/WorkerStats.json +84 -1
- package/json-schema/ui/Action.json +180 -1
- package/json-schema/ui/ActionParam.json +89 -1
- package/json-schema/ui/Animation.json +50 -1
- package/json-schema/ui/App.json +307 -1
- package/json-schema/ui/AppBranding.json +18 -1
- package/json-schema/ui/BorderRadius.json +38 -1
- package/json-schema/ui/Breakpoints.json +30 -1
- package/json-schema/ui/CalendarConfig.json +22 -1
- package/json-schema/ui/ChartAnnotation.json +60 -0
- package/json-schema/ui/ChartAxis.json +57 -0
- package/json-schema/ui/ChartConfig.json +353 -1
- package/json-schema/ui/ChartInteraction.json +28 -0
- package/json-schema/ui/ChartSeries.json +84 -0
- package/json-schema/ui/ChartType.json +43 -1
- package/json-schema/ui/ColorPalette.json +77 -1
- package/json-schema/ui/Dashboard.json +515 -1
- package/json-schema/ui/DashboardNavItem.json +38 -1
- package/json-schema/ui/DashboardWidget.json +487 -1
- package/json-schema/ui/FieldWidgetProps.json +892 -1
- package/json-schema/ui/FormField.json +55 -1
- package/json-schema/ui/FormSection.json +95 -1
- package/json-schema/ui/FormView.json +351 -1
- package/json-schema/ui/GanttConfig.json +26 -1
- package/json-schema/ui/GroupNavItem.json +38 -1
- package/json-schema/ui/HttpMethod.json +10 -1
- package/json-schema/ui/HttpRequest.json +40 -1
- package/json-schema/ui/KanbanConfig.json +25 -1
- package/json-schema/ui/ListColumn.json +59 -1
- package/json-schema/ui/ListView.json +453 -1
- package/json-schema/ui/NavigationConfig.json +46 -0
- package/json-schema/ui/NavigationItem.json +223 -1
- package/json-schema/ui/NavigationMode.json +18 -0
- package/json-schema/ui/ObjectNavItem.json +42 -1
- package/json-schema/ui/Page.json +190 -1
- package/json-schema/ui/PageCardProps.json +27 -1
- package/json-schema/ui/PageComponent.json +78 -1
- package/json-schema/ui/PageComponentType.json +26 -1
- package/json-schema/ui/PageHeaderProps.json +33 -1
- package/json-schema/ui/PageNavItem.json +43 -1
- package/json-schema/ui/PageRegion.json +105 -1
- package/json-schema/ui/PageTabsProps.json +49 -1
- package/json-schema/ui/PageVariable.json +31 -0
- package/json-schema/ui/PaginationConfig.json +20 -1
- package/json-schema/ui/RecordDetailsProps.json +31 -1
- package/json-schema/ui/RecordHighlightsProps.json +18 -1
- package/json-schema/ui/RecordRelatedListProps.json +33 -1
- package/json-schema/ui/Report.json +428 -1
- package/json-schema/ui/ReportChart.json +260 -1
- package/json-schema/ui/ReportColumn.json +29 -1
- package/json-schema/ui/ReportGrouping.json +32 -1
- package/json-schema/ui/ReportType.json +9 -1
- package/json-schema/ui/SelectionConfig.json +16 -1
- package/json-schema/ui/Shadow.json +38 -1
- package/json-schema/ui/Spacing.json +58 -1
- package/json-schema/ui/Theme.json +537 -1
- package/json-schema/ui/ThemeMode.json +8 -1
- package/json-schema/ui/Typography.json +136 -1
- package/json-schema/ui/UrlNavItem.json +47 -1
- package/json-schema/ui/View.json +1622 -1
- package/json-schema/ui/ViewData.json +136 -1
- package/json-schema/ui/WidgetEvent.json +36 -1
- package/json-schema/ui/WidgetLifecycle.json +34 -1
- package/json-schema/ui/WidgetManifest.json +310 -1
- package/json-schema/ui/WidgetProperty.json +52 -1
- package/json-schema/ui/WidgetSource.json +83 -0
- package/json-schema/ui/ZIndex.json +38 -1
- package/package.json +3 -3
- package/dist/auth/config.zod.d.ts +0 -1050
- package/dist/auth/config.zod.d.ts.map +0 -1
- package/dist/auth/config.zod.js +0 -641
- package/dist/auth/identity.zod.d.ts +0 -81
- package/dist/auth/identity.zod.d.ts.map +0 -1
- package/dist/auth/index.d.ts.map +0 -1
- package/dist/auth/organization.zod.d.ts +0 -68
- package/dist/auth/organization.zod.d.ts.map +0 -1
- package/dist/auth/policy.zod.d.ts +0 -72
- package/dist/auth/policy.zod.d.ts.map +0 -1
- package/dist/auth/protocol.d.ts.map +0 -1
- package/dist/auth/role.zod.d.ts.map +0 -1
- package/dist/auth/scim.zod.d.ts +0 -570
- package/dist/auth/scim.zod.d.ts.map +0 -1
- package/dist/hub/marketplace-enhanced.zod.d.ts +0 -1028
- package/dist/hub/marketplace-enhanced.zod.d.ts.map +0 -1
- package/dist/hub/marketplace-enhanced.zod.js +0 -728
- package/dist/permission/index.d.ts.map +0 -1
- package/dist/permission/permission.zod.d.ts +0 -96
- package/dist/permission/permission.zod.d.ts.map +0 -1
- package/dist/permission/rls.zod.d.ts +0 -298
- package/dist/permission/rls.zod.d.ts.map +0 -1
- package/dist/permission/sharing.zod.d.ts +0 -112
- package/dist/permission/sharing.zod.d.ts.map +0 -1
- package/dist/permission/territory.zod.d.ts +0 -83
- package/dist/permission/territory.zod.d.ts.map +0 -1
- package/dist/system/context.zod.d.ts +0 -33
- package/dist/system/context.zod.d.ts.map +0 -1
- package/dist/system/datasource.zod.d.ts +0 -85
- package/dist/system/datasource.zod.d.ts.map +0 -1
- package/dist/system/events.zod.d.ts +0 -756
- package/dist/system/events.zod.d.ts.map +0 -1
- package/dist/system/feature.zod.d.ts +0 -73
- package/dist/system/feature.zod.d.ts.map +0 -1
- package/dist/system/manifest.zod.d.ts +0 -430
- package/dist/system/manifest.zod.d.ts.map +0 -1
- package/dist/system/metadata-loader.zod.d.ts +0 -222
- package/dist/system/metadata-loader.zod.d.ts.map +0 -1
- package/dist/system/plugin-capability.zod.d.ts +0 -286
- package/dist/system/plugin-capability.zod.d.ts.map +0 -1
- package/dist/system/plugin-lifecycle-advanced.zod.d.ts +0 -357
- package/dist/system/plugin-lifecycle-advanced.zod.d.ts.map +0 -1
- package/dist/system/plugin-lifecycle-events.zod.d.ts.map +0 -1
- package/dist/system/plugin-loading.zod.d.ts +0 -575
- package/dist/system/plugin-loading.zod.d.ts.map +0 -1
- package/dist/system/plugin-security-advanced.zod.d.ts +0 -904
- package/dist/system/plugin-security-advanced.zod.d.ts.map +0 -1
- package/dist/system/plugin-validator.zod.d.ts +0 -98
- package/dist/system/plugin-validator.zod.d.ts.map +0 -1
- package/dist/system/plugin-versioning.zod.d.ts +0 -438
- package/dist/system/plugin-versioning.zod.d.ts.map +0 -1
- package/dist/system/plugin.zod.d.ts +0 -421
- package/dist/system/plugin.zod.d.ts.map +0 -1
- package/dist/system/plugin.zod.js +0 -123
- package/dist/system/startup-orchestrator.zod.d.ts +0 -119
- package/dist/system/startup-orchestrator.zod.d.ts.map +0 -1
- package/json-schema/auth/APIKey.json +0 -7
- package/json-schema/auth/Account.json +0 -7
- package/json-schema/auth/AccountLinkingConfig.json +0 -7
- package/json-schema/auth/ApplicationAuthConfig.json +0 -7
- package/json-schema/auth/AuditPolicy.json +0 -7
- package/json-schema/auth/AuthConfig.json +0 -7
- package/json-schema/auth/AuthPluginConfig.json +0 -7
- package/json-schema/auth/AuthStrategy.json +0 -7
- package/json-schema/auth/BasicAuth.json +0 -7
- package/json-schema/auth/BearerAuth.json +0 -7
- package/json-schema/auth/CSRFConfig.json +0 -7
- package/json-schema/auth/DatabaseAdapter.json +0 -7
- package/json-schema/auth/DatabaseMapping.json +0 -7
- package/json-schema/auth/EmailPasswordConfig.json +0 -7
- package/json-schema/auth/EnterpriseAuthConfig.json +0 -7
- package/json-schema/auth/Invitation.json +0 -7
- package/json-schema/auth/InvitationStatus.json +0 -7
- package/json-schema/auth/JWTAuth.json +0 -7
- package/json-schema/auth/LDAPConfig.json +0 -7
- package/json-schema/auth/MagicLinkConfig.json +0 -7
- package/json-schema/auth/Member.json +0 -7
- package/json-schema/auth/NetworkPolicy.json +0 -7
- package/json-schema/auth/NoAuth.json +0 -7
- package/json-schema/auth/OAuth2.json +0 -7
- package/json-schema/auth/OAuthProvider.json +0 -7
- package/json-schema/auth/OIDCConfig.json +0 -7
- package/json-schema/auth/Organization.json +0 -7
- package/json-schema/auth/PasskeyConfig.json +0 -7
- package/json-schema/auth/PasswordPolicy.json +0 -7
- package/json-schema/auth/Policy.json +0 -7
- package/json-schema/auth/RateLimitConfig.json +0 -7
- package/json-schema/auth/Role.json +0 -7
- package/json-schema/auth/SAMLAuth.json +0 -7
- package/json-schema/auth/SAMLConfig.json +0 -7
- package/json-schema/auth/SCIMAddress.json +0 -7
- package/json-schema/auth/SCIMEmail.json +0 -7
- package/json-schema/auth/SCIMEnterpriseUser.json +0 -7
- package/json-schema/auth/SCIMError.json +0 -7
- package/json-schema/auth/SCIMGroup.json +0 -7
- package/json-schema/auth/SCIMGroupReference.json +0 -7
- package/json-schema/auth/SCIMListResponse.json +0 -7
- package/json-schema/auth/SCIMMemberReference.json +0 -7
- package/json-schema/auth/SCIMMeta.json +0 -7
- package/json-schema/auth/SCIMName.json +0 -7
- package/json-schema/auth/SCIMPatchOperation.json +0 -7
- package/json-schema/auth/SCIMPatchRequest.json +0 -7
- package/json-schema/auth/SCIMPhoneNumber.json +0 -7
- package/json-schema/auth/SCIMUser.json +0 -7
- package/json-schema/auth/Session.json +0 -7
- package/json-schema/auth/SessionConfig.json +0 -7
- package/json-schema/auth/SessionPolicy.json +0 -7
- package/json-schema/auth/StandardAuthProvider.json +0 -7
- package/json-schema/auth/TwoFactorConfig.json +0 -7
- package/json-schema/auth/User.json +0 -7
- package/json-schema/auth/UserFieldMapping.json +0 -7
- package/json-schema/auth/VerificationToken.json +0 -7
- package/json-schema/automation/SlackMessageAction.json +0 -7
- package/json-schema/automation/SmsNotificationAction.json +0 -7
- package/json-schema/automation/TeamsMessageAction.json +0 -7
- package/json-schema/automation/WebhookTriggerAction.json +0 -7
- package/json-schema/hub/MarketplaceQualityMetrics.json +0 -7
- package/json-schema/hub/PluginCategory.json +0 -7
- package/json-schema/hub/PluginCertification.json +0 -7
- package/json-schema/hub/PluginInstallationRequest.json +0 -7
- package/json-schema/hub/PluginInstallationStatus.json +0 -7
- package/json-schema/hub/PluginLicense.json +0 -7
- package/json-schema/hub/PluginMarketplaceListing.json +0 -7
- package/json-schema/hub/PluginRating.json +0 -7
- package/json-schema/hub/PluginRevenueSharing.json +0 -7
- package/json-schema/hub/PluginSearchQuery.json +0 -7
- package/json-schema/hub/PluginTag.json +0 -7
- package/json-schema/permission/CriteriaSharingRule.json +0 -7
- package/json-schema/permission/FieldPermission.json +0 -7
- package/json-schema/permission/OWDModel.json +0 -7
- package/json-schema/permission/ObjectPermission.json +0 -7
- package/json-schema/permission/OwnerSharingRule.json +0 -7
- package/json-schema/permission/PermissionSet.json +0 -7
- package/json-schema/permission/RLSConfig.json +0 -7
- package/json-schema/permission/RLSEvaluationResult.json +0 -7
- package/json-schema/permission/RLSOperation.json +0 -7
- package/json-schema/permission/RLSUserContext.json +0 -7
- package/json-schema/permission/RowLevelSecurityPolicy.json +0 -7
- package/json-schema/permission/ShareRecipientType.json +0 -7
- package/json-schema/permission/SharingLevel.json +0 -7
- package/json-schema/permission/SharingRule.json +0 -7
- package/json-schema/permission/Territory.json +0 -7
- package/json-schema/permission/TerritoryModel.json +0 -7
- package/json-schema/permission/TerritoryType.json +0 -7
- package/json-schema/system/AdvancedPluginLifecycleConfig.json +0 -7
- package/json-schema/system/BreakingChange.json +0 -7
- package/json-schema/system/CapabilityConformanceLevel.json +0 -7
- package/json-schema/system/CompatibilityLevel.json +0 -7
- package/json-schema/system/CompatibilityMatrixEntry.json +0 -7
- package/json-schema/system/Datasource.json +0 -7
- package/json-schema/system/DatasourceCapabilities.json +0 -7
- package/json-schema/system/DeadLetterQueueEntry.json +0 -7
- package/json-schema/system/DependencyConflict.json +0 -7
- package/json-schema/system/DependencyResolutionResult.json +0 -7
- package/json-schema/system/DeprecationNotice.json +0 -7
- package/json-schema/system/DistributedStateConfig.json +0 -7
- package/json-schema/system/DriverDefinition.json +0 -7
- package/json-schema/system/Event.json +0 -7
- package/json-schema/system/EventBusConfig.json +0 -7
- package/json-schema/system/EventHandler.json +0 -7
- package/json-schema/system/EventLogEntry.json +0 -7
- package/json-schema/system/EventMessageQueueConfig.json +0 -7
- package/json-schema/system/EventMetadata.json +0 -7
- package/json-schema/system/EventPersistence.json +0 -7
- package/json-schema/system/EventPhase.json +0 -7
- package/json-schema/system/EventPriority.json +0 -7
- package/json-schema/system/EventQueueConfig.json +0 -7
- package/json-schema/system/EventReplayConfig.json +0 -7
- package/json-schema/system/EventRoute.json +0 -7
- package/json-schema/system/EventSourcingConfig.json +0 -7
- package/json-schema/system/EventTypeDefinition.json +0 -7
- package/json-schema/system/EventWebhookConfig.json +0 -7
- package/json-schema/system/ExtensionPoint.json +0 -7
- package/json-schema/system/FeatureFlag.json +0 -7
- package/json-schema/system/FeatureStrategy.json +0 -7
- package/json-schema/system/GracefulDegradation.json +0 -7
- package/json-schema/system/HealthStatus.json +0 -7
- package/json-schema/system/HookRegisteredEvent.json +0 -7
- package/json-schema/system/HookTriggeredEvent.json +0 -7
- package/json-schema/system/HotReloadConfig.json +0 -7
- package/json-schema/system/KernelContext.json +0 -7
- package/json-schema/system/KernelEventBase.json +0 -7
- package/json-schema/system/KernelReadyEvent.json +0 -7
- package/json-schema/system/KernelShutdownEvent.json +0 -7
- package/json-schema/system/Manifest.json +0 -7
- package/json-schema/system/MultiVersionSupport.json +0 -7
- package/json-schema/system/Permission.json +0 -7
- package/json-schema/system/PermissionAction.json +0 -7
- package/json-schema/system/PermissionScope.json +0 -7
- package/json-schema/system/PermissionSet.json +0 -7
- package/json-schema/system/Plugin.json +0 -7
- package/json-schema/system/PluginCaching.json +0 -7
- package/json-schema/system/PluginCapability.json +0 -7
- package/json-schema/system/PluginCapabilityManifest.json +0 -7
- package/json-schema/system/PluginCodeSplitting.json +0 -7
- package/json-schema/system/PluginCompatibilityMatrix.json +0 -7
- package/json-schema/system/PluginContext.json +0 -7
- package/json-schema/system/PluginDependency.json +0 -7
- package/json-schema/system/PluginDependencyResolution.json +0 -7
- package/json-schema/system/PluginDynamicImport.json +0 -7
- package/json-schema/system/PluginErrorEvent.json +0 -7
- package/json-schema/system/PluginEventBase.json +0 -7
- package/json-schema/system/PluginHealthCheck.json +0 -7
- package/json-schema/system/PluginHealthReport.json +0 -7
- package/json-schema/system/PluginHealthStatus.json +0 -7
- package/json-schema/system/PluginHotReload.json +0 -7
- package/json-schema/system/PluginInitialization.json +0 -7
- package/json-schema/system/PluginInterface.json +0 -7
- package/json-schema/system/PluginLifecycleEventType.json +0 -7
- package/json-schema/system/PluginLifecyclePhaseEvent.json +0 -7
- package/json-schema/system/PluginLoadingConfig.json +0 -7
- package/json-schema/system/PluginLoadingEvent.json +0 -7
- package/json-schema/system/PluginLoadingState.json +0 -7
- package/json-schema/system/PluginLoadingStrategy.json +0 -7
- package/json-schema/system/PluginMetadata.json +0 -7
- package/json-schema/system/PluginPerformanceMonitoring.json +0 -7
- package/json-schema/system/PluginPreloadConfig.json +0 -7
- package/json-schema/system/PluginRegisteredEvent.json +0 -7
- package/json-schema/system/PluginSandboxing.json +0 -7
- package/json-schema/system/PluginSecurityManifest.json +0 -7
- package/json-schema/system/PluginStartupResult.json +0 -7
- package/json-schema/system/PluginStateSnapshot.json +0 -7
- package/json-schema/system/PluginTrustLevel.json +0 -7
- package/json-schema/system/PluginUpdateStrategy.json +0 -7
- package/json-schema/system/PluginVersionMetadata.json +0 -7
- package/json-schema/system/ProtocolFeature.json +0 -7
- package/json-schema/system/ProtocolReference.json +0 -7
- package/json-schema/system/ProtocolVersion.json +0 -7
- package/json-schema/system/RealTimeNotificationConfig.json +0 -7
- package/json-schema/system/ResourceType.json +0 -7
- package/json-schema/system/RuntimeConfig.json +0 -7
- package/json-schema/system/RuntimeMode.json +0 -7
- package/json-schema/system/SandboxConfig.json +0 -7
- package/json-schema/system/ScopeConfig.json +0 -7
- package/json-schema/system/ScopeInfo.json +0 -7
- package/json-schema/system/SecurityPolicy.json +0 -7
- package/json-schema/system/SecurityScanResult.json +0 -7
- package/json-schema/system/SecurityVulnerability.json +0 -7
- package/json-schema/system/SemanticVersion.json +0 -7
- package/json-schema/system/ServiceFactoryRegistration.json +0 -7
- package/json-schema/system/ServiceMetadata.json +0 -7
- package/json-schema/system/ServiceRegisteredEvent.json +0 -7
- package/json-schema/system/ServiceRegistryConfig.json +0 -7
- package/json-schema/system/ServiceScopeType.json +0 -7
- package/json-schema/system/ServiceUnregisteredEvent.json +0 -7
- package/json-schema/system/StartupOptions.json +0 -7
- package/json-schema/system/StartupOrchestrationResult.json +0 -7
- package/json-schema/system/ValidationError.json +0 -7
- package/json-schema/system/ValidationResult.json +0 -7
- package/json-schema/system/ValidationWarning.json +0 -7
- package/json-schema/system/VersionConstraint.json +0 -7
- /package/dist/{system → data}/datasource.zod.js +0 -0
- /package/dist/{auth → identity}/identity.zod.js +0 -0
- /package/dist/{auth → identity}/organization.zod.js +0 -0
- /package/dist/{auth → identity}/protocol.d.ts +0 -0
- /package/dist/{auth → identity}/protocol.js +0 -0
- /package/dist/{auth → identity}/role.zod.js +0 -0
- /package/dist/{auth → identity}/scim.zod.js +0 -0
- /package/dist/{system → kernel}/context.zod.js +0 -0
- /package/dist/{system → kernel}/feature.zod.js +0 -0
- /package/dist/{system → kernel}/metadata-loader.zod.js +0 -0
- /package/dist/{system → kernel}/plugin-capability.zod.js +0 -0
- /package/dist/{system → kernel}/plugin-lifecycle-advanced.zod.js +0 -0
- /package/dist/{system → kernel}/plugin-lifecycle-events.zod.js +0 -0
- /package/dist/{system → kernel}/plugin-loading.zod.js +0 -0
- /package/dist/{system → kernel}/plugin-security-advanced.zod.js +0 -0
- /package/dist/{system → kernel}/plugin-validator.zod.js +0 -0
- /package/dist/{system → kernel}/startup-orchestrator.zod.js +0 -0
- /package/dist/{auth → security}/policy.zod.js +0 -0
- /package/dist/{permission → security}/rls.zod.js +0 -0
- /package/dist/{permission → security}/sharing.zod.js +0 -0
- /package/dist/{permission → security}/territory.zod.js +0 -0
|
@@ -39,14 +39,41 @@ import { z } from 'zod';
|
|
|
39
39
|
* Server configuration for OpenAPI specification.
|
|
40
40
|
*/
|
|
41
41
|
export declare const OpenApiServerSchema: z.ZodObject<{
|
|
42
|
+
/** Server URL */
|
|
42
43
|
url: z.ZodString;
|
|
44
|
+
/** Server description */
|
|
43
45
|
description: z.ZodOptional<z.ZodString>;
|
|
46
|
+
/** Server variables */
|
|
44
47
|
variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
45
48
|
default: z.ZodString;
|
|
46
49
|
description: z.ZodOptional<z.ZodString>;
|
|
47
|
-
enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
48
|
-
}, z.
|
|
49
|
-
|
|
50
|
+
enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
51
|
+
}, "strip", z.ZodTypeAny, {
|
|
52
|
+
default: string;
|
|
53
|
+
description?: string | undefined;
|
|
54
|
+
enum?: string[] | undefined;
|
|
55
|
+
}, {
|
|
56
|
+
default: string;
|
|
57
|
+
description?: string | undefined;
|
|
58
|
+
enum?: string[] | undefined;
|
|
59
|
+
}>>>;
|
|
60
|
+
}, "strip", z.ZodTypeAny, {
|
|
61
|
+
url: string;
|
|
62
|
+
description?: string | undefined;
|
|
63
|
+
variables?: Record<string, {
|
|
64
|
+
default: string;
|
|
65
|
+
description?: string | undefined;
|
|
66
|
+
enum?: string[] | undefined;
|
|
67
|
+
}> | undefined;
|
|
68
|
+
}, {
|
|
69
|
+
url: string;
|
|
70
|
+
description?: string | undefined;
|
|
71
|
+
variables?: Record<string, {
|
|
72
|
+
default: string;
|
|
73
|
+
description?: string | undefined;
|
|
74
|
+
enum?: string[] | undefined;
|
|
75
|
+
}> | undefined;
|
|
76
|
+
}>;
|
|
50
77
|
export type OpenApiServer = z.infer<typeof OpenApiServerSchema>;
|
|
51
78
|
/**
|
|
52
79
|
* OpenAPI Security Scheme Schema
|
|
@@ -54,29 +81,66 @@ export type OpenApiServer = z.infer<typeof OpenApiServerSchema>;
|
|
|
54
81
|
* Security scheme definition for OpenAPI.
|
|
55
82
|
*/
|
|
56
83
|
export declare const OpenApiSecuritySchemeSchema: z.ZodObject<{
|
|
57
|
-
type
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
http: "http";
|
|
61
|
-
openIdConnect: "openIdConnect";
|
|
62
|
-
}>;
|
|
84
|
+
/** Security scheme type */
|
|
85
|
+
type: z.ZodEnum<["apiKey", "http", "oauth2", "openIdConnect"]>;
|
|
86
|
+
/** Scheme name */
|
|
63
87
|
scheme: z.ZodOptional<z.ZodString>;
|
|
88
|
+
/** Bearer format */
|
|
64
89
|
bearerFormat: z.ZodOptional<z.ZodString>;
|
|
90
|
+
/** API key name */
|
|
65
91
|
name: z.ZodOptional<z.ZodString>;
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
cookie: "cookie";
|
|
70
|
-
}>>;
|
|
92
|
+
/** API key location */
|
|
93
|
+
in: z.ZodOptional<z.ZodEnum<["header", "query", "cookie"]>>;
|
|
94
|
+
/** OAuth flows */
|
|
71
95
|
flows: z.ZodOptional<z.ZodObject<{
|
|
72
96
|
implicit: z.ZodOptional<z.ZodAny>;
|
|
73
97
|
password: z.ZodOptional<z.ZodAny>;
|
|
74
98
|
clientCredentials: z.ZodOptional<z.ZodAny>;
|
|
75
99
|
authorizationCode: z.ZodOptional<z.ZodAny>;
|
|
76
|
-
}, z.
|
|
100
|
+
}, "strip", z.ZodTypeAny, {
|
|
101
|
+
password?: any;
|
|
102
|
+
implicit?: any;
|
|
103
|
+
clientCredentials?: any;
|
|
104
|
+
authorizationCode?: any;
|
|
105
|
+
}, {
|
|
106
|
+
password?: any;
|
|
107
|
+
implicit?: any;
|
|
108
|
+
clientCredentials?: any;
|
|
109
|
+
authorizationCode?: any;
|
|
110
|
+
}>>;
|
|
111
|
+
/** OpenID Connect URL */
|
|
77
112
|
openIdConnectUrl: z.ZodOptional<z.ZodString>;
|
|
113
|
+
/** Description */
|
|
78
114
|
description: z.ZodOptional<z.ZodString>;
|
|
79
|
-
}, z.
|
|
115
|
+
}, "strip", z.ZodTypeAny, {
|
|
116
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
117
|
+
name?: string | undefined;
|
|
118
|
+
description?: string | undefined;
|
|
119
|
+
scheme?: string | undefined;
|
|
120
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
121
|
+
bearerFormat?: string | undefined;
|
|
122
|
+
flows?: {
|
|
123
|
+
password?: any;
|
|
124
|
+
implicit?: any;
|
|
125
|
+
clientCredentials?: any;
|
|
126
|
+
authorizationCode?: any;
|
|
127
|
+
} | undefined;
|
|
128
|
+
openIdConnectUrl?: string | undefined;
|
|
129
|
+
}, {
|
|
130
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
131
|
+
name?: string | undefined;
|
|
132
|
+
description?: string | undefined;
|
|
133
|
+
scheme?: string | undefined;
|
|
134
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
135
|
+
bearerFormat?: string | undefined;
|
|
136
|
+
flows?: {
|
|
137
|
+
password?: any;
|
|
138
|
+
implicit?: any;
|
|
139
|
+
clientCredentials?: any;
|
|
140
|
+
authorizationCode?: any;
|
|
141
|
+
} | undefined;
|
|
142
|
+
openIdConnectUrl?: string | undefined;
|
|
143
|
+
}>;
|
|
80
144
|
export type OpenApiSecurityScheme = z.infer<typeof OpenApiSecuritySchemeSchema>;
|
|
81
145
|
/**
|
|
82
146
|
* OpenAPI Specification Schema
|
|
@@ -103,7 +167,9 @@ export type OpenApiSecurityScheme = z.infer<typeof OpenApiSecuritySchemeSchema>;
|
|
|
103
167
|
* ```
|
|
104
168
|
*/
|
|
105
169
|
export declare const OpenApiSpecSchema: z.ZodObject<{
|
|
170
|
+
/** OpenAPI version */
|
|
106
171
|
openapi: z.ZodDefault<z.ZodString>;
|
|
172
|
+
/** API information */
|
|
107
173
|
info: z.ZodObject<{
|
|
108
174
|
title: z.ZodString;
|
|
109
175
|
version: z.ZodString;
|
|
@@ -113,22 +179,94 @@ export declare const OpenApiSpecSchema: z.ZodObject<{
|
|
|
113
179
|
name: z.ZodOptional<z.ZodString>;
|
|
114
180
|
url: z.ZodOptional<z.ZodString>;
|
|
115
181
|
email: z.ZodOptional<z.ZodString>;
|
|
116
|
-
}, z.
|
|
182
|
+
}, "strip", z.ZodTypeAny, {
|
|
183
|
+
email?: string | undefined;
|
|
184
|
+
url?: string | undefined;
|
|
185
|
+
name?: string | undefined;
|
|
186
|
+
}, {
|
|
187
|
+
email?: string | undefined;
|
|
188
|
+
url?: string | undefined;
|
|
189
|
+
name?: string | undefined;
|
|
190
|
+
}>>;
|
|
117
191
|
license: z.ZodOptional<z.ZodObject<{
|
|
118
192
|
name: z.ZodString;
|
|
119
193
|
url: z.ZodOptional<z.ZodString>;
|
|
120
|
-
}, z.
|
|
121
|
-
|
|
194
|
+
}, "strip", z.ZodTypeAny, {
|
|
195
|
+
name: string;
|
|
196
|
+
url?: string | undefined;
|
|
197
|
+
}, {
|
|
198
|
+
name: string;
|
|
199
|
+
url?: string | undefined;
|
|
200
|
+
}>>;
|
|
201
|
+
}, "strip", z.ZodTypeAny, {
|
|
202
|
+
version: string;
|
|
203
|
+
title: string;
|
|
204
|
+
description?: string | undefined;
|
|
205
|
+
license?: {
|
|
206
|
+
name: string;
|
|
207
|
+
url?: string | undefined;
|
|
208
|
+
} | undefined;
|
|
209
|
+
termsOfService?: string | undefined;
|
|
210
|
+
contact?: {
|
|
211
|
+
email?: string | undefined;
|
|
212
|
+
url?: string | undefined;
|
|
213
|
+
name?: string | undefined;
|
|
214
|
+
} | undefined;
|
|
215
|
+
}, {
|
|
216
|
+
version: string;
|
|
217
|
+
title: string;
|
|
218
|
+
description?: string | undefined;
|
|
219
|
+
license?: {
|
|
220
|
+
name: string;
|
|
221
|
+
url?: string | undefined;
|
|
222
|
+
} | undefined;
|
|
223
|
+
termsOfService?: string | undefined;
|
|
224
|
+
contact?: {
|
|
225
|
+
email?: string | undefined;
|
|
226
|
+
url?: string | undefined;
|
|
227
|
+
name?: string | undefined;
|
|
228
|
+
} | undefined;
|
|
229
|
+
}>;
|
|
230
|
+
/** Servers */
|
|
122
231
|
servers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
232
|
+
/** Server URL */
|
|
123
233
|
url: z.ZodString;
|
|
234
|
+
/** Server description */
|
|
124
235
|
description: z.ZodOptional<z.ZodString>;
|
|
236
|
+
/** Server variables */
|
|
125
237
|
variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
126
238
|
default: z.ZodString;
|
|
127
239
|
description: z.ZodOptional<z.ZodString>;
|
|
128
|
-
enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
129
|
-
}, z.
|
|
130
|
-
|
|
240
|
+
enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
241
|
+
}, "strip", z.ZodTypeAny, {
|
|
242
|
+
default: string;
|
|
243
|
+
description?: string | undefined;
|
|
244
|
+
enum?: string[] | undefined;
|
|
245
|
+
}, {
|
|
246
|
+
default: string;
|
|
247
|
+
description?: string | undefined;
|
|
248
|
+
enum?: string[] | undefined;
|
|
249
|
+
}>>>;
|
|
250
|
+
}, "strip", z.ZodTypeAny, {
|
|
251
|
+
url: string;
|
|
252
|
+
description?: string | undefined;
|
|
253
|
+
variables?: Record<string, {
|
|
254
|
+
default: string;
|
|
255
|
+
description?: string | undefined;
|
|
256
|
+
enum?: string[] | undefined;
|
|
257
|
+
}> | undefined;
|
|
258
|
+
}, {
|
|
259
|
+
url: string;
|
|
260
|
+
description?: string | undefined;
|
|
261
|
+
variables?: Record<string, {
|
|
262
|
+
default: string;
|
|
263
|
+
description?: string | undefined;
|
|
264
|
+
enum?: string[] | undefined;
|
|
265
|
+
}> | undefined;
|
|
266
|
+
}>, "many">>>;
|
|
267
|
+
/** API paths */
|
|
131
268
|
paths: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
269
|
+
/** Reusable components */
|
|
132
270
|
components: z.ZodOptional<z.ZodObject<{
|
|
133
271
|
schemas: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
134
272
|
responses: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
@@ -137,61 +275,295 @@ export declare const OpenApiSpecSchema: z.ZodObject<{
|
|
|
137
275
|
requestBodies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
138
276
|
headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
139
277
|
securitySchemes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
140
|
-
type
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
http: "http";
|
|
144
|
-
openIdConnect: "openIdConnect";
|
|
145
|
-
}>;
|
|
278
|
+
/** Security scheme type */
|
|
279
|
+
type: z.ZodEnum<["apiKey", "http", "oauth2", "openIdConnect"]>;
|
|
280
|
+
/** Scheme name */
|
|
146
281
|
scheme: z.ZodOptional<z.ZodString>;
|
|
282
|
+
/** Bearer format */
|
|
147
283
|
bearerFormat: z.ZodOptional<z.ZodString>;
|
|
284
|
+
/** API key name */
|
|
148
285
|
name: z.ZodOptional<z.ZodString>;
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
cookie: "cookie";
|
|
153
|
-
}>>;
|
|
286
|
+
/** API key location */
|
|
287
|
+
in: z.ZodOptional<z.ZodEnum<["header", "query", "cookie"]>>;
|
|
288
|
+
/** OAuth flows */
|
|
154
289
|
flows: z.ZodOptional<z.ZodObject<{
|
|
155
290
|
implicit: z.ZodOptional<z.ZodAny>;
|
|
156
291
|
password: z.ZodOptional<z.ZodAny>;
|
|
157
292
|
clientCredentials: z.ZodOptional<z.ZodAny>;
|
|
158
293
|
authorizationCode: z.ZodOptional<z.ZodAny>;
|
|
159
|
-
}, z.
|
|
294
|
+
}, "strip", z.ZodTypeAny, {
|
|
295
|
+
password?: any;
|
|
296
|
+
implicit?: any;
|
|
297
|
+
clientCredentials?: any;
|
|
298
|
+
authorizationCode?: any;
|
|
299
|
+
}, {
|
|
300
|
+
password?: any;
|
|
301
|
+
implicit?: any;
|
|
302
|
+
clientCredentials?: any;
|
|
303
|
+
authorizationCode?: any;
|
|
304
|
+
}>>;
|
|
305
|
+
/** OpenID Connect URL */
|
|
160
306
|
openIdConnectUrl: z.ZodOptional<z.ZodString>;
|
|
307
|
+
/** Description */
|
|
161
308
|
description: z.ZodOptional<z.ZodString>;
|
|
162
|
-
}, z.
|
|
309
|
+
}, "strip", z.ZodTypeAny, {
|
|
310
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
311
|
+
name?: string | undefined;
|
|
312
|
+
description?: string | undefined;
|
|
313
|
+
scheme?: string | undefined;
|
|
314
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
315
|
+
bearerFormat?: string | undefined;
|
|
316
|
+
flows?: {
|
|
317
|
+
password?: any;
|
|
318
|
+
implicit?: any;
|
|
319
|
+
clientCredentials?: any;
|
|
320
|
+
authorizationCode?: any;
|
|
321
|
+
} | undefined;
|
|
322
|
+
openIdConnectUrl?: string | undefined;
|
|
323
|
+
}, {
|
|
324
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
325
|
+
name?: string | undefined;
|
|
326
|
+
description?: string | undefined;
|
|
327
|
+
scheme?: string | undefined;
|
|
328
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
329
|
+
bearerFormat?: string | undefined;
|
|
330
|
+
flows?: {
|
|
331
|
+
password?: any;
|
|
332
|
+
implicit?: any;
|
|
333
|
+
clientCredentials?: any;
|
|
334
|
+
authorizationCode?: any;
|
|
335
|
+
} | undefined;
|
|
336
|
+
openIdConnectUrl?: string | undefined;
|
|
337
|
+
}>>>;
|
|
163
338
|
links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
164
339
|
callbacks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
165
|
-
}, z.
|
|
166
|
-
|
|
340
|
+
}, "strip", z.ZodTypeAny, {
|
|
341
|
+
headers?: Record<string, any> | undefined;
|
|
342
|
+
parameters?: Record<string, any> | undefined;
|
|
343
|
+
links?: Record<string, any> | undefined;
|
|
344
|
+
schemas?: Record<string, any> | undefined;
|
|
345
|
+
examples?: Record<string, any> | undefined;
|
|
346
|
+
responses?: Record<string, any> | undefined;
|
|
347
|
+
requestBodies?: Record<string, any> | undefined;
|
|
348
|
+
securitySchemes?: Record<string, {
|
|
349
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
350
|
+
name?: string | undefined;
|
|
351
|
+
description?: string | undefined;
|
|
352
|
+
scheme?: string | undefined;
|
|
353
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
354
|
+
bearerFormat?: string | undefined;
|
|
355
|
+
flows?: {
|
|
356
|
+
password?: any;
|
|
357
|
+
implicit?: any;
|
|
358
|
+
clientCredentials?: any;
|
|
359
|
+
authorizationCode?: any;
|
|
360
|
+
} | undefined;
|
|
361
|
+
openIdConnectUrl?: string | undefined;
|
|
362
|
+
}> | undefined;
|
|
363
|
+
callbacks?: Record<string, any> | undefined;
|
|
364
|
+
}, {
|
|
365
|
+
headers?: Record<string, any> | undefined;
|
|
366
|
+
parameters?: Record<string, any> | undefined;
|
|
367
|
+
links?: Record<string, any> | undefined;
|
|
368
|
+
schemas?: Record<string, any> | undefined;
|
|
369
|
+
examples?: Record<string, any> | undefined;
|
|
370
|
+
responses?: Record<string, any> | undefined;
|
|
371
|
+
requestBodies?: Record<string, any> | undefined;
|
|
372
|
+
securitySchemes?: Record<string, {
|
|
373
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
374
|
+
name?: string | undefined;
|
|
375
|
+
description?: string | undefined;
|
|
376
|
+
scheme?: string | undefined;
|
|
377
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
378
|
+
bearerFormat?: string | undefined;
|
|
379
|
+
flows?: {
|
|
380
|
+
password?: any;
|
|
381
|
+
implicit?: any;
|
|
382
|
+
clientCredentials?: any;
|
|
383
|
+
authorizationCode?: any;
|
|
384
|
+
} | undefined;
|
|
385
|
+
openIdConnectUrl?: string | undefined;
|
|
386
|
+
}> | undefined;
|
|
387
|
+
callbacks?: Record<string, any> | undefined;
|
|
388
|
+
}>>;
|
|
389
|
+
/** Security requirements */
|
|
390
|
+
security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>, "many">>;
|
|
391
|
+
/** Tags */
|
|
167
392
|
tags: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
168
393
|
name: z.ZodString;
|
|
169
394
|
description: z.ZodOptional<z.ZodString>;
|
|
170
395
|
externalDocs: z.ZodOptional<z.ZodObject<{
|
|
171
396
|
description: z.ZodOptional<z.ZodString>;
|
|
172
397
|
url: z.ZodString;
|
|
173
|
-
}, z.
|
|
174
|
-
|
|
398
|
+
}, "strip", z.ZodTypeAny, {
|
|
399
|
+
url: string;
|
|
400
|
+
description?: string | undefined;
|
|
401
|
+
}, {
|
|
402
|
+
url: string;
|
|
403
|
+
description?: string | undefined;
|
|
404
|
+
}>>;
|
|
405
|
+
}, "strip", z.ZodTypeAny, {
|
|
406
|
+
name: string;
|
|
407
|
+
description?: string | undefined;
|
|
408
|
+
externalDocs?: {
|
|
409
|
+
url: string;
|
|
410
|
+
description?: string | undefined;
|
|
411
|
+
} | undefined;
|
|
412
|
+
}, {
|
|
413
|
+
name: string;
|
|
414
|
+
description?: string | undefined;
|
|
415
|
+
externalDocs?: {
|
|
416
|
+
url: string;
|
|
417
|
+
description?: string | undefined;
|
|
418
|
+
} | undefined;
|
|
419
|
+
}>, "many">>;
|
|
420
|
+
/** External documentation */
|
|
175
421
|
externalDocs: z.ZodOptional<z.ZodObject<{
|
|
176
422
|
description: z.ZodOptional<z.ZodString>;
|
|
177
423
|
url: z.ZodString;
|
|
178
|
-
}, z.
|
|
179
|
-
|
|
424
|
+
}, "strip", z.ZodTypeAny, {
|
|
425
|
+
url: string;
|
|
426
|
+
description?: string | undefined;
|
|
427
|
+
}, {
|
|
428
|
+
url: string;
|
|
429
|
+
description?: string | undefined;
|
|
430
|
+
}>>;
|
|
431
|
+
}, "strip", z.ZodTypeAny, {
|
|
432
|
+
info: {
|
|
433
|
+
version: string;
|
|
434
|
+
title: string;
|
|
435
|
+
description?: string | undefined;
|
|
436
|
+
license?: {
|
|
437
|
+
name: string;
|
|
438
|
+
url?: string | undefined;
|
|
439
|
+
} | undefined;
|
|
440
|
+
termsOfService?: string | undefined;
|
|
441
|
+
contact?: {
|
|
442
|
+
email?: string | undefined;
|
|
443
|
+
url?: string | undefined;
|
|
444
|
+
name?: string | undefined;
|
|
445
|
+
} | undefined;
|
|
446
|
+
};
|
|
447
|
+
paths: Record<string, any>;
|
|
448
|
+
openapi: string;
|
|
449
|
+
servers: {
|
|
450
|
+
url: string;
|
|
451
|
+
description?: string | undefined;
|
|
452
|
+
variables?: Record<string, {
|
|
453
|
+
default: string;
|
|
454
|
+
description?: string | undefined;
|
|
455
|
+
enum?: string[] | undefined;
|
|
456
|
+
}> | undefined;
|
|
457
|
+
}[];
|
|
458
|
+
tags?: {
|
|
459
|
+
name: string;
|
|
460
|
+
description?: string | undefined;
|
|
461
|
+
externalDocs?: {
|
|
462
|
+
url: string;
|
|
463
|
+
description?: string | undefined;
|
|
464
|
+
} | undefined;
|
|
465
|
+
}[] | undefined;
|
|
466
|
+
components?: {
|
|
467
|
+
headers?: Record<string, any> | undefined;
|
|
468
|
+
parameters?: Record<string, any> | undefined;
|
|
469
|
+
links?: Record<string, any> | undefined;
|
|
470
|
+
schemas?: Record<string, any> | undefined;
|
|
471
|
+
examples?: Record<string, any> | undefined;
|
|
472
|
+
responses?: Record<string, any> | undefined;
|
|
473
|
+
requestBodies?: Record<string, any> | undefined;
|
|
474
|
+
securitySchemes?: Record<string, {
|
|
475
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
476
|
+
name?: string | undefined;
|
|
477
|
+
description?: string | undefined;
|
|
478
|
+
scheme?: string | undefined;
|
|
479
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
480
|
+
bearerFormat?: string | undefined;
|
|
481
|
+
flows?: {
|
|
482
|
+
password?: any;
|
|
483
|
+
implicit?: any;
|
|
484
|
+
clientCredentials?: any;
|
|
485
|
+
authorizationCode?: any;
|
|
486
|
+
} | undefined;
|
|
487
|
+
openIdConnectUrl?: string | undefined;
|
|
488
|
+
}> | undefined;
|
|
489
|
+
callbacks?: Record<string, any> | undefined;
|
|
490
|
+
} | undefined;
|
|
491
|
+
security?: Record<string, string[]>[] | undefined;
|
|
492
|
+
externalDocs?: {
|
|
493
|
+
url: string;
|
|
494
|
+
description?: string | undefined;
|
|
495
|
+
} | undefined;
|
|
496
|
+
}, {
|
|
497
|
+
info: {
|
|
498
|
+
version: string;
|
|
499
|
+
title: string;
|
|
500
|
+
description?: string | undefined;
|
|
501
|
+
license?: {
|
|
502
|
+
name: string;
|
|
503
|
+
url?: string | undefined;
|
|
504
|
+
} | undefined;
|
|
505
|
+
termsOfService?: string | undefined;
|
|
506
|
+
contact?: {
|
|
507
|
+
email?: string | undefined;
|
|
508
|
+
url?: string | undefined;
|
|
509
|
+
name?: string | undefined;
|
|
510
|
+
} | undefined;
|
|
511
|
+
};
|
|
512
|
+
paths: Record<string, any>;
|
|
513
|
+
tags?: {
|
|
514
|
+
name: string;
|
|
515
|
+
description?: string | undefined;
|
|
516
|
+
externalDocs?: {
|
|
517
|
+
url: string;
|
|
518
|
+
description?: string | undefined;
|
|
519
|
+
} | undefined;
|
|
520
|
+
}[] | undefined;
|
|
521
|
+
components?: {
|
|
522
|
+
headers?: Record<string, any> | undefined;
|
|
523
|
+
parameters?: Record<string, any> | undefined;
|
|
524
|
+
links?: Record<string, any> | undefined;
|
|
525
|
+
schemas?: Record<string, any> | undefined;
|
|
526
|
+
examples?: Record<string, any> | undefined;
|
|
527
|
+
responses?: Record<string, any> | undefined;
|
|
528
|
+
requestBodies?: Record<string, any> | undefined;
|
|
529
|
+
securitySchemes?: Record<string, {
|
|
530
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
531
|
+
name?: string | undefined;
|
|
532
|
+
description?: string | undefined;
|
|
533
|
+
scheme?: string | undefined;
|
|
534
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
535
|
+
bearerFormat?: string | undefined;
|
|
536
|
+
flows?: {
|
|
537
|
+
password?: any;
|
|
538
|
+
implicit?: any;
|
|
539
|
+
clientCredentials?: any;
|
|
540
|
+
authorizationCode?: any;
|
|
541
|
+
} | undefined;
|
|
542
|
+
openIdConnectUrl?: string | undefined;
|
|
543
|
+
}> | undefined;
|
|
544
|
+
callbacks?: Record<string, any> | undefined;
|
|
545
|
+
} | undefined;
|
|
546
|
+
security?: Record<string, string[]>[] | undefined;
|
|
547
|
+
externalDocs?: {
|
|
548
|
+
url: string;
|
|
549
|
+
description?: string | undefined;
|
|
550
|
+
} | undefined;
|
|
551
|
+
openapi?: string | undefined;
|
|
552
|
+
servers?: {
|
|
553
|
+
url: string;
|
|
554
|
+
description?: string | undefined;
|
|
555
|
+
variables?: Record<string, {
|
|
556
|
+
default: string;
|
|
557
|
+
description?: string | undefined;
|
|
558
|
+
enum?: string[] | undefined;
|
|
559
|
+
}> | undefined;
|
|
560
|
+
}[] | undefined;
|
|
561
|
+
}>;
|
|
180
562
|
export type OpenApiSpec = z.infer<typeof OpenApiSpecSchema>;
|
|
181
563
|
/**
|
|
182
564
|
* API Testing UI Type
|
|
183
565
|
*/
|
|
184
|
-
export declare const ApiTestingUiType: z.ZodEnum<
|
|
185
|
-
custom: "custom";
|
|
186
|
-
"swagger-ui": "swagger-ui";
|
|
187
|
-
redoc: "redoc";
|
|
188
|
-
rapidoc: "rapidoc";
|
|
189
|
-
stoplight: "stoplight";
|
|
190
|
-
scalar: "scalar";
|
|
191
|
-
"graphql-playground": "graphql-playground";
|
|
192
|
-
graphiql: "graphiql";
|
|
193
|
-
postman: "postman";
|
|
194
|
-
}>;
|
|
566
|
+
export declare const ApiTestingUiType: z.ZodEnum<["swagger-ui", "redoc", "rapidoc", "stoplight", "scalar", "graphql-playground", "graphiql", "postman", "custom"]>;
|
|
195
567
|
export type ApiTestingUiType = z.infer<typeof ApiTestingUiType>;
|
|
196
568
|
/**
|
|
197
569
|
* API Testing UI Configuration Schema
|
|
@@ -212,49 +584,102 @@ export type ApiTestingUiType = z.infer<typeof ApiTestingUiType>;
|
|
|
212
584
|
* ```
|
|
213
585
|
*/
|
|
214
586
|
export declare const ApiTestingUiConfigSchema: z.ZodObject<{
|
|
215
|
-
type
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
redoc: "redoc";
|
|
219
|
-
rapidoc: "rapidoc";
|
|
220
|
-
stoplight: "stoplight";
|
|
221
|
-
scalar: "scalar";
|
|
222
|
-
"graphql-playground": "graphql-playground";
|
|
223
|
-
graphiql: "graphiql";
|
|
224
|
-
postman: "postman";
|
|
225
|
-
}>;
|
|
587
|
+
/** UI type */
|
|
588
|
+
type: z.ZodEnum<["swagger-ui", "redoc", "rapidoc", "stoplight", "scalar", "graphql-playground", "graphiql", "postman", "custom"]>;
|
|
589
|
+
/** UI path */
|
|
226
590
|
path: z.ZodDefault<z.ZodString>;
|
|
227
|
-
theme
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
dark: "dark";
|
|
231
|
-
}>>;
|
|
591
|
+
/** UI theme */
|
|
592
|
+
theme: z.ZodDefault<z.ZodEnum<["light", "dark", "auto"]>>;
|
|
593
|
+
/** Enable try-it-out feature */
|
|
232
594
|
enableTryItOut: z.ZodDefault<z.ZodBoolean>;
|
|
595
|
+
/** Enable filtering */
|
|
233
596
|
enableFilter: z.ZodDefault<z.ZodBoolean>;
|
|
597
|
+
/** Enable CORS for testing */
|
|
234
598
|
enableCors: z.ZodDefault<z.ZodBoolean>;
|
|
599
|
+
/** Default expand depth for models */
|
|
235
600
|
defaultModelsExpandDepth: z.ZodDefault<z.ZodNumber>;
|
|
601
|
+
/** Display request duration */
|
|
236
602
|
displayRequestDuration: z.ZodDefault<z.ZodBoolean>;
|
|
603
|
+
/** Syntax highlighting */
|
|
237
604
|
syntaxHighlighting: z.ZodDefault<z.ZodBoolean>;
|
|
605
|
+
/** Custom CSS URL */
|
|
238
606
|
customCssUrl: z.ZodOptional<z.ZodString>;
|
|
607
|
+
/** Custom JavaScript URL */
|
|
239
608
|
customJsUrl: z.ZodOptional<z.ZodString>;
|
|
609
|
+
/** Layout options */
|
|
240
610
|
layout: z.ZodOptional<z.ZodObject<{
|
|
241
611
|
showExtensions: z.ZodDefault<z.ZodBoolean>;
|
|
242
612
|
showCommonExtensions: z.ZodDefault<z.ZodBoolean>;
|
|
243
613
|
deepLinking: z.ZodDefault<z.ZodBoolean>;
|
|
244
614
|
displayOperationId: z.ZodDefault<z.ZodBoolean>;
|
|
245
|
-
defaultModelRendering: z.ZodDefault<z.ZodEnum<
|
|
246
|
-
model: "model";
|
|
247
|
-
example: "example";
|
|
248
|
-
}>>;
|
|
615
|
+
defaultModelRendering: z.ZodDefault<z.ZodEnum<["example", "model"]>>;
|
|
249
616
|
defaultModelsExpandDepth: z.ZodDefault<z.ZodNumber>;
|
|
250
617
|
defaultModelExpandDepth: z.ZodDefault<z.ZodNumber>;
|
|
251
|
-
docExpansion: z.ZodDefault<z.ZodEnum<
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
618
|
+
docExpansion: z.ZodDefault<z.ZodEnum<["list", "full", "none"]>>;
|
|
619
|
+
}, "strip", z.ZodTypeAny, {
|
|
620
|
+
defaultModelsExpandDepth: number;
|
|
621
|
+
showExtensions: boolean;
|
|
622
|
+
showCommonExtensions: boolean;
|
|
623
|
+
deepLinking: boolean;
|
|
624
|
+
displayOperationId: boolean;
|
|
625
|
+
defaultModelRendering: "model" | "example";
|
|
626
|
+
defaultModelExpandDepth: number;
|
|
627
|
+
docExpansion: "full" | "list" | "none";
|
|
628
|
+
}, {
|
|
629
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
630
|
+
showExtensions?: boolean | undefined;
|
|
631
|
+
showCommonExtensions?: boolean | undefined;
|
|
632
|
+
deepLinking?: boolean | undefined;
|
|
633
|
+
displayOperationId?: boolean | undefined;
|
|
634
|
+
defaultModelRendering?: "model" | "example" | undefined;
|
|
635
|
+
defaultModelExpandDepth?: number | undefined;
|
|
636
|
+
docExpansion?: "full" | "list" | "none" | undefined;
|
|
637
|
+
}>>;
|
|
638
|
+
}, "strip", z.ZodTypeAny, {
|
|
639
|
+
path: string;
|
|
640
|
+
type: "custom" | "swagger-ui" | "redoc" | "rapidoc" | "stoplight" | "scalar" | "graphql-playground" | "graphiql" | "postman";
|
|
641
|
+
theme: "auto" | "light" | "dark";
|
|
642
|
+
enableTryItOut: boolean;
|
|
643
|
+
enableFilter: boolean;
|
|
644
|
+
enableCors: boolean;
|
|
645
|
+
defaultModelsExpandDepth: number;
|
|
646
|
+
displayRequestDuration: boolean;
|
|
647
|
+
syntaxHighlighting: boolean;
|
|
648
|
+
layout?: {
|
|
649
|
+
defaultModelsExpandDepth: number;
|
|
650
|
+
showExtensions: boolean;
|
|
651
|
+
showCommonExtensions: boolean;
|
|
652
|
+
deepLinking: boolean;
|
|
653
|
+
displayOperationId: boolean;
|
|
654
|
+
defaultModelRendering: "model" | "example";
|
|
655
|
+
defaultModelExpandDepth: number;
|
|
656
|
+
docExpansion: "full" | "list" | "none";
|
|
657
|
+
} | undefined;
|
|
658
|
+
customCssUrl?: string | undefined;
|
|
659
|
+
customJsUrl?: string | undefined;
|
|
660
|
+
}, {
|
|
661
|
+
type: "custom" | "swagger-ui" | "redoc" | "rapidoc" | "stoplight" | "scalar" | "graphql-playground" | "graphiql" | "postman";
|
|
662
|
+
path?: string | undefined;
|
|
663
|
+
theme?: "auto" | "light" | "dark" | undefined;
|
|
664
|
+
layout?: {
|
|
665
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
666
|
+
showExtensions?: boolean | undefined;
|
|
667
|
+
showCommonExtensions?: boolean | undefined;
|
|
668
|
+
deepLinking?: boolean | undefined;
|
|
669
|
+
displayOperationId?: boolean | undefined;
|
|
670
|
+
defaultModelRendering?: "model" | "example" | undefined;
|
|
671
|
+
defaultModelExpandDepth?: number | undefined;
|
|
672
|
+
docExpansion?: "full" | "list" | "none" | undefined;
|
|
673
|
+
} | undefined;
|
|
674
|
+
enableTryItOut?: boolean | undefined;
|
|
675
|
+
enableFilter?: boolean | undefined;
|
|
676
|
+
enableCors?: boolean | undefined;
|
|
677
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
678
|
+
displayRequestDuration?: boolean | undefined;
|
|
679
|
+
syntaxHighlighting?: boolean | undefined;
|
|
680
|
+
customCssUrl?: string | undefined;
|
|
681
|
+
customJsUrl?: string | undefined;
|
|
682
|
+
}>;
|
|
258
683
|
export type ApiTestingUiConfig = z.infer<typeof ApiTestingUiConfigSchema>;
|
|
259
684
|
/**
|
|
260
685
|
* API Test Request Schema
|
|
@@ -278,27 +703,60 @@ export type ApiTestingUiConfig = z.infer<typeof ApiTestingUiConfigSchema>;
|
|
|
278
703
|
* ```
|
|
279
704
|
*/
|
|
280
705
|
export declare const ApiTestRequestSchema: z.ZodObject<{
|
|
706
|
+
/** Request name */
|
|
281
707
|
name: z.ZodString;
|
|
708
|
+
/** Request description */
|
|
282
709
|
description: z.ZodOptional<z.ZodString>;
|
|
283
|
-
method
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
PUT: "PUT";
|
|
287
|
-
DELETE: "DELETE";
|
|
288
|
-
PATCH: "PATCH";
|
|
289
|
-
HEAD: "HEAD";
|
|
290
|
-
OPTIONS: "OPTIONS";
|
|
291
|
-
}>;
|
|
710
|
+
/** HTTP method */
|
|
711
|
+
method: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
|
|
712
|
+
/** Request URL */
|
|
292
713
|
url: z.ZodString;
|
|
714
|
+
/** Request headers */
|
|
293
715
|
headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
294
|
-
|
|
716
|
+
/** Query parameters */
|
|
717
|
+
queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
|
|
718
|
+
/** Request body */
|
|
295
719
|
body: z.ZodOptional<z.ZodAny>;
|
|
720
|
+
/** Environment variables */
|
|
296
721
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
722
|
+
/** Expected response */
|
|
297
723
|
expectedResponse: z.ZodOptional<z.ZodObject<{
|
|
298
724
|
statusCode: z.ZodNumber;
|
|
299
725
|
body: z.ZodOptional<z.ZodAny>;
|
|
300
|
-
}, z.
|
|
301
|
-
|
|
726
|
+
}, "strip", z.ZodTypeAny, {
|
|
727
|
+
statusCode: number;
|
|
728
|
+
body?: any;
|
|
729
|
+
}, {
|
|
730
|
+
statusCode: number;
|
|
731
|
+
body?: any;
|
|
732
|
+
}>>;
|
|
733
|
+
}, "strip", z.ZodTypeAny, {
|
|
734
|
+
url: string;
|
|
735
|
+
name: string;
|
|
736
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
737
|
+
headers: Record<string, string>;
|
|
738
|
+
variables: Record<string, any>;
|
|
739
|
+
queryParams: Record<string, string | number | boolean>;
|
|
740
|
+
description?: string | undefined;
|
|
741
|
+
body?: any;
|
|
742
|
+
expectedResponse?: {
|
|
743
|
+
statusCode: number;
|
|
744
|
+
body?: any;
|
|
745
|
+
} | undefined;
|
|
746
|
+
}, {
|
|
747
|
+
url: string;
|
|
748
|
+
name: string;
|
|
749
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
750
|
+
description?: string | undefined;
|
|
751
|
+
headers?: Record<string, string> | undefined;
|
|
752
|
+
body?: any;
|
|
753
|
+
variables?: Record<string, any> | undefined;
|
|
754
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
755
|
+
expectedResponse?: {
|
|
756
|
+
statusCode: number;
|
|
757
|
+
body?: any;
|
|
758
|
+
} | undefined;
|
|
759
|
+
}>;
|
|
302
760
|
export type ApiTestRequest = z.infer<typeof ApiTestRequestSchema>;
|
|
303
761
|
/**
|
|
304
762
|
* API Test Collection Schema
|
|
@@ -319,58 +777,235 @@ export type ApiTestRequest = z.infer<typeof ApiTestRequestSchema>;
|
|
|
319
777
|
* ```
|
|
320
778
|
*/
|
|
321
779
|
export declare const ApiTestCollectionSchema: z.ZodObject<{
|
|
780
|
+
/** Collection name */
|
|
322
781
|
name: z.ZodString;
|
|
782
|
+
/** Collection description */
|
|
323
783
|
description: z.ZodOptional<z.ZodString>;
|
|
784
|
+
/** Collection variables */
|
|
324
785
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
786
|
+
/** Test requests */
|
|
325
787
|
requests: z.ZodArray<z.ZodObject<{
|
|
788
|
+
/** Request name */
|
|
326
789
|
name: z.ZodString;
|
|
790
|
+
/** Request description */
|
|
327
791
|
description: z.ZodOptional<z.ZodString>;
|
|
328
|
-
method
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
PUT: "PUT";
|
|
332
|
-
DELETE: "DELETE";
|
|
333
|
-
PATCH: "PATCH";
|
|
334
|
-
HEAD: "HEAD";
|
|
335
|
-
OPTIONS: "OPTIONS";
|
|
336
|
-
}>;
|
|
792
|
+
/** HTTP method */
|
|
793
|
+
method: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
|
|
794
|
+
/** Request URL */
|
|
337
795
|
url: z.ZodString;
|
|
796
|
+
/** Request headers */
|
|
338
797
|
headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
339
|
-
|
|
798
|
+
/** Query parameters */
|
|
799
|
+
queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
|
|
800
|
+
/** Request body */
|
|
340
801
|
body: z.ZodOptional<z.ZodAny>;
|
|
802
|
+
/** Environment variables */
|
|
341
803
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
804
|
+
/** Expected response */
|
|
342
805
|
expectedResponse: z.ZodOptional<z.ZodObject<{
|
|
343
806
|
statusCode: z.ZodNumber;
|
|
344
807
|
body: z.ZodOptional<z.ZodAny>;
|
|
345
|
-
}, z.
|
|
346
|
-
|
|
808
|
+
}, "strip", z.ZodTypeAny, {
|
|
809
|
+
statusCode: number;
|
|
810
|
+
body?: any;
|
|
811
|
+
}, {
|
|
812
|
+
statusCode: number;
|
|
813
|
+
body?: any;
|
|
814
|
+
}>>;
|
|
815
|
+
}, "strip", z.ZodTypeAny, {
|
|
816
|
+
url: string;
|
|
817
|
+
name: string;
|
|
818
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
819
|
+
headers: Record<string, string>;
|
|
820
|
+
variables: Record<string, any>;
|
|
821
|
+
queryParams: Record<string, string | number | boolean>;
|
|
822
|
+
description?: string | undefined;
|
|
823
|
+
body?: any;
|
|
824
|
+
expectedResponse?: {
|
|
825
|
+
statusCode: number;
|
|
826
|
+
body?: any;
|
|
827
|
+
} | undefined;
|
|
828
|
+
}, {
|
|
829
|
+
url: string;
|
|
830
|
+
name: string;
|
|
831
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
832
|
+
description?: string | undefined;
|
|
833
|
+
headers?: Record<string, string> | undefined;
|
|
834
|
+
body?: any;
|
|
835
|
+
variables?: Record<string, any> | undefined;
|
|
836
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
837
|
+
expectedResponse?: {
|
|
838
|
+
statusCode: number;
|
|
839
|
+
body?: any;
|
|
840
|
+
} | undefined;
|
|
841
|
+
}>, "many">;
|
|
842
|
+
/** Folders/grouping */
|
|
347
843
|
folders: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
348
844
|
name: z.ZodString;
|
|
349
845
|
description: z.ZodOptional<z.ZodString>;
|
|
350
846
|
requests: z.ZodArray<z.ZodObject<{
|
|
847
|
+
/** Request name */
|
|
351
848
|
name: z.ZodString;
|
|
849
|
+
/** Request description */
|
|
352
850
|
description: z.ZodOptional<z.ZodString>;
|
|
353
|
-
method
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
PUT: "PUT";
|
|
357
|
-
DELETE: "DELETE";
|
|
358
|
-
PATCH: "PATCH";
|
|
359
|
-
HEAD: "HEAD";
|
|
360
|
-
OPTIONS: "OPTIONS";
|
|
361
|
-
}>;
|
|
851
|
+
/** HTTP method */
|
|
852
|
+
method: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
|
|
853
|
+
/** Request URL */
|
|
362
854
|
url: z.ZodString;
|
|
855
|
+
/** Request headers */
|
|
363
856
|
headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
364
|
-
|
|
857
|
+
/** Query parameters */
|
|
858
|
+
queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
|
|
859
|
+
/** Request body */
|
|
365
860
|
body: z.ZodOptional<z.ZodAny>;
|
|
861
|
+
/** Environment variables */
|
|
366
862
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
863
|
+
/** Expected response */
|
|
367
864
|
expectedResponse: z.ZodOptional<z.ZodObject<{
|
|
368
865
|
statusCode: z.ZodNumber;
|
|
369
866
|
body: z.ZodOptional<z.ZodAny>;
|
|
370
|
-
}, z.
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
},
|
|
867
|
+
}, "strip", z.ZodTypeAny, {
|
|
868
|
+
statusCode: number;
|
|
869
|
+
body?: any;
|
|
870
|
+
}, {
|
|
871
|
+
statusCode: number;
|
|
872
|
+
body?: any;
|
|
873
|
+
}>>;
|
|
874
|
+
}, "strip", z.ZodTypeAny, {
|
|
875
|
+
url: string;
|
|
876
|
+
name: string;
|
|
877
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
878
|
+
headers: Record<string, string>;
|
|
879
|
+
variables: Record<string, any>;
|
|
880
|
+
queryParams: Record<string, string | number | boolean>;
|
|
881
|
+
description?: string | undefined;
|
|
882
|
+
body?: any;
|
|
883
|
+
expectedResponse?: {
|
|
884
|
+
statusCode: number;
|
|
885
|
+
body?: any;
|
|
886
|
+
} | undefined;
|
|
887
|
+
}, {
|
|
888
|
+
url: string;
|
|
889
|
+
name: string;
|
|
890
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
891
|
+
description?: string | undefined;
|
|
892
|
+
headers?: Record<string, string> | undefined;
|
|
893
|
+
body?: any;
|
|
894
|
+
variables?: Record<string, any> | undefined;
|
|
895
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
896
|
+
expectedResponse?: {
|
|
897
|
+
statusCode: number;
|
|
898
|
+
body?: any;
|
|
899
|
+
} | undefined;
|
|
900
|
+
}>, "many">;
|
|
901
|
+
}, "strip", z.ZodTypeAny, {
|
|
902
|
+
name: string;
|
|
903
|
+
requests: {
|
|
904
|
+
url: string;
|
|
905
|
+
name: string;
|
|
906
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
907
|
+
headers: Record<string, string>;
|
|
908
|
+
variables: Record<string, any>;
|
|
909
|
+
queryParams: Record<string, string | number | boolean>;
|
|
910
|
+
description?: string | undefined;
|
|
911
|
+
body?: any;
|
|
912
|
+
expectedResponse?: {
|
|
913
|
+
statusCode: number;
|
|
914
|
+
body?: any;
|
|
915
|
+
} | undefined;
|
|
916
|
+
}[];
|
|
917
|
+
description?: string | undefined;
|
|
918
|
+
}, {
|
|
919
|
+
name: string;
|
|
920
|
+
requests: {
|
|
921
|
+
url: string;
|
|
922
|
+
name: string;
|
|
923
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
924
|
+
description?: string | undefined;
|
|
925
|
+
headers?: Record<string, string> | undefined;
|
|
926
|
+
body?: any;
|
|
927
|
+
variables?: Record<string, any> | undefined;
|
|
928
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
929
|
+
expectedResponse?: {
|
|
930
|
+
statusCode: number;
|
|
931
|
+
body?: any;
|
|
932
|
+
} | undefined;
|
|
933
|
+
}[];
|
|
934
|
+
description?: string | undefined;
|
|
935
|
+
}>, "many">>;
|
|
936
|
+
}, "strip", z.ZodTypeAny, {
|
|
937
|
+
name: string;
|
|
938
|
+
requests: {
|
|
939
|
+
url: string;
|
|
940
|
+
name: string;
|
|
941
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
942
|
+
headers: Record<string, string>;
|
|
943
|
+
variables: Record<string, any>;
|
|
944
|
+
queryParams: Record<string, string | number | boolean>;
|
|
945
|
+
description?: string | undefined;
|
|
946
|
+
body?: any;
|
|
947
|
+
expectedResponse?: {
|
|
948
|
+
statusCode: number;
|
|
949
|
+
body?: any;
|
|
950
|
+
} | undefined;
|
|
951
|
+
}[];
|
|
952
|
+
variables: Record<string, any>;
|
|
953
|
+
description?: string | undefined;
|
|
954
|
+
folders?: {
|
|
955
|
+
name: string;
|
|
956
|
+
requests: {
|
|
957
|
+
url: string;
|
|
958
|
+
name: string;
|
|
959
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
960
|
+
headers: Record<string, string>;
|
|
961
|
+
variables: Record<string, any>;
|
|
962
|
+
queryParams: Record<string, string | number | boolean>;
|
|
963
|
+
description?: string | undefined;
|
|
964
|
+
body?: any;
|
|
965
|
+
expectedResponse?: {
|
|
966
|
+
statusCode: number;
|
|
967
|
+
body?: any;
|
|
968
|
+
} | undefined;
|
|
969
|
+
}[];
|
|
970
|
+
description?: string | undefined;
|
|
971
|
+
}[] | undefined;
|
|
972
|
+
}, {
|
|
973
|
+
name: string;
|
|
974
|
+
requests: {
|
|
975
|
+
url: string;
|
|
976
|
+
name: string;
|
|
977
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
978
|
+
description?: string | undefined;
|
|
979
|
+
headers?: Record<string, string> | undefined;
|
|
980
|
+
body?: any;
|
|
981
|
+
variables?: Record<string, any> | undefined;
|
|
982
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
983
|
+
expectedResponse?: {
|
|
984
|
+
statusCode: number;
|
|
985
|
+
body?: any;
|
|
986
|
+
} | undefined;
|
|
987
|
+
}[];
|
|
988
|
+
description?: string | undefined;
|
|
989
|
+
variables?: Record<string, any> | undefined;
|
|
990
|
+
folders?: {
|
|
991
|
+
name: string;
|
|
992
|
+
requests: {
|
|
993
|
+
url: string;
|
|
994
|
+
name: string;
|
|
995
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
996
|
+
description?: string | undefined;
|
|
997
|
+
headers?: Record<string, string> | undefined;
|
|
998
|
+
body?: any;
|
|
999
|
+
variables?: Record<string, any> | undefined;
|
|
1000
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
1001
|
+
expectedResponse?: {
|
|
1002
|
+
statusCode: number;
|
|
1003
|
+
body?: any;
|
|
1004
|
+
} | undefined;
|
|
1005
|
+
}[];
|
|
1006
|
+
description?: string | undefined;
|
|
1007
|
+
}[] | undefined;
|
|
1008
|
+
}>;
|
|
374
1009
|
export type ApiTestCollection = z.infer<typeof ApiTestCollectionSchema>;
|
|
375
1010
|
/**
|
|
376
1011
|
* API Changelog Entry Schema
|
|
@@ -378,18 +1013,60 @@ export type ApiTestCollection = z.infer<typeof ApiTestCollectionSchema>;
|
|
|
378
1013
|
* Documents changes in API versions.
|
|
379
1014
|
*/
|
|
380
1015
|
export declare const ApiChangelogEntrySchema: z.ZodObject<{
|
|
1016
|
+
/** Version */
|
|
381
1017
|
version: z.ZodString;
|
|
1018
|
+
/** Release date */
|
|
382
1019
|
date: z.ZodString;
|
|
1020
|
+
/** Changes */
|
|
383
1021
|
changes: z.ZodObject<{
|
|
384
|
-
added: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
385
|
-
changed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
386
|
-
deprecated: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
387
|
-
removed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
388
|
-
fixed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
389
|
-
security: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
390
|
-
}, z.
|
|
1022
|
+
added: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1023
|
+
changed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1024
|
+
deprecated: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1025
|
+
removed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1026
|
+
fixed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1027
|
+
security: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1028
|
+
}, "strip", z.ZodTypeAny, {
|
|
1029
|
+
fixed: string[];
|
|
1030
|
+
security: string[];
|
|
1031
|
+
removed: string[];
|
|
1032
|
+
deprecated: string[];
|
|
1033
|
+
added: string[];
|
|
1034
|
+
changed: string[];
|
|
1035
|
+
}, {
|
|
1036
|
+
fixed?: string[] | undefined;
|
|
1037
|
+
security?: string[] | undefined;
|
|
1038
|
+
removed?: string[] | undefined;
|
|
1039
|
+
deprecated?: string[] | undefined;
|
|
1040
|
+
added?: string[] | undefined;
|
|
1041
|
+
changed?: string[] | undefined;
|
|
1042
|
+
}>;
|
|
1043
|
+
/** Migration guide */
|
|
391
1044
|
migrationGuide: z.ZodOptional<z.ZodString>;
|
|
392
|
-
}, z.
|
|
1045
|
+
}, "strip", z.ZodTypeAny, {
|
|
1046
|
+
date: string;
|
|
1047
|
+
version: string;
|
|
1048
|
+
changes: {
|
|
1049
|
+
fixed: string[];
|
|
1050
|
+
security: string[];
|
|
1051
|
+
removed: string[];
|
|
1052
|
+
deprecated: string[];
|
|
1053
|
+
added: string[];
|
|
1054
|
+
changed: string[];
|
|
1055
|
+
};
|
|
1056
|
+
migrationGuide?: string | undefined;
|
|
1057
|
+
}, {
|
|
1058
|
+
date: string;
|
|
1059
|
+
version: string;
|
|
1060
|
+
changes: {
|
|
1061
|
+
fixed?: string[] | undefined;
|
|
1062
|
+
security?: string[] | undefined;
|
|
1063
|
+
removed?: string[] | undefined;
|
|
1064
|
+
deprecated?: string[] | undefined;
|
|
1065
|
+
added?: string[] | undefined;
|
|
1066
|
+
changed?: string[] | undefined;
|
|
1067
|
+
};
|
|
1068
|
+
migrationGuide?: string | undefined;
|
|
1069
|
+
}>;
|
|
393
1070
|
export type ApiChangelogEntry = z.infer<typeof ApiChangelogEntrySchema>;
|
|
394
1071
|
/**
|
|
395
1072
|
* Code Generation Template Schema
|
|
@@ -397,11 +1074,25 @@ export type ApiChangelogEntry = z.infer<typeof ApiChangelogEntrySchema>;
|
|
|
397
1074
|
* Templates for generating client code.
|
|
398
1075
|
*/
|
|
399
1076
|
export declare const CodeGenerationTemplateSchema: z.ZodObject<{
|
|
1077
|
+
/** Language/framework */
|
|
400
1078
|
language: z.ZodString;
|
|
1079
|
+
/** Template name */
|
|
401
1080
|
name: z.ZodString;
|
|
1081
|
+
/** Template content */
|
|
402
1082
|
template: z.ZodString;
|
|
403
|
-
variables
|
|
404
|
-
|
|
1083
|
+
/** Template variables */
|
|
1084
|
+
variables: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
1085
|
+
}, "strip", z.ZodTypeAny, {
|
|
1086
|
+
language: string;
|
|
1087
|
+
name: string;
|
|
1088
|
+
template: string;
|
|
1089
|
+
variables?: string[] | undefined;
|
|
1090
|
+
}, {
|
|
1091
|
+
language: string;
|
|
1092
|
+
name: string;
|
|
1093
|
+
template: string;
|
|
1094
|
+
variables?: string[] | undefined;
|
|
1095
|
+
}>;
|
|
405
1096
|
export type CodeGenerationTemplate = z.infer<typeof CodeGenerationTemplateSchema>;
|
|
406
1097
|
/**
|
|
407
1098
|
* API Documentation Configuration Schema
|
|
@@ -429,184 +1120,855 @@ export type CodeGenerationTemplate = z.infer<typeof CodeGenerationTemplateSchema
|
|
|
429
1120
|
* ```
|
|
430
1121
|
*/
|
|
431
1122
|
export declare const ApiDocumentationConfigSchema: z.ZodObject<{
|
|
1123
|
+
/** Enable documentation */
|
|
432
1124
|
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
1125
|
+
/** Documentation title */
|
|
433
1126
|
title: z.ZodDefault<z.ZodString>;
|
|
1127
|
+
/** API version */
|
|
434
1128
|
version: z.ZodString;
|
|
1129
|
+
/** API description */
|
|
435
1130
|
description: z.ZodOptional<z.ZodString>;
|
|
1131
|
+
/** Server configurations */
|
|
436
1132
|
servers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1133
|
+
/** Server URL */
|
|
437
1134
|
url: z.ZodString;
|
|
1135
|
+
/** Server description */
|
|
438
1136
|
description: z.ZodOptional<z.ZodString>;
|
|
1137
|
+
/** Server variables */
|
|
439
1138
|
variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
440
1139
|
default: z.ZodString;
|
|
441
1140
|
description: z.ZodOptional<z.ZodString>;
|
|
442
|
-
enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
443
|
-
}, z.
|
|
444
|
-
|
|
1141
|
+
enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
1142
|
+
}, "strip", z.ZodTypeAny, {
|
|
1143
|
+
default: string;
|
|
1144
|
+
description?: string | undefined;
|
|
1145
|
+
enum?: string[] | undefined;
|
|
1146
|
+
}, {
|
|
1147
|
+
default: string;
|
|
1148
|
+
description?: string | undefined;
|
|
1149
|
+
enum?: string[] | undefined;
|
|
1150
|
+
}>>>;
|
|
1151
|
+
}, "strip", z.ZodTypeAny, {
|
|
1152
|
+
url: string;
|
|
1153
|
+
description?: string | undefined;
|
|
1154
|
+
variables?: Record<string, {
|
|
1155
|
+
default: string;
|
|
1156
|
+
description?: string | undefined;
|
|
1157
|
+
enum?: string[] | undefined;
|
|
1158
|
+
}> | undefined;
|
|
1159
|
+
}, {
|
|
1160
|
+
url: string;
|
|
1161
|
+
description?: string | undefined;
|
|
1162
|
+
variables?: Record<string, {
|
|
1163
|
+
default: string;
|
|
1164
|
+
description?: string | undefined;
|
|
1165
|
+
enum?: string[] | undefined;
|
|
1166
|
+
}> | undefined;
|
|
1167
|
+
}>, "many">>>;
|
|
1168
|
+
/** UI configuration */
|
|
445
1169
|
ui: z.ZodOptional<z.ZodObject<{
|
|
446
|
-
type
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
redoc: "redoc";
|
|
450
|
-
rapidoc: "rapidoc";
|
|
451
|
-
stoplight: "stoplight";
|
|
452
|
-
scalar: "scalar";
|
|
453
|
-
"graphql-playground": "graphql-playground";
|
|
454
|
-
graphiql: "graphiql";
|
|
455
|
-
postman: "postman";
|
|
456
|
-
}>;
|
|
1170
|
+
/** UI type */
|
|
1171
|
+
type: z.ZodEnum<["swagger-ui", "redoc", "rapidoc", "stoplight", "scalar", "graphql-playground", "graphiql", "postman", "custom"]>;
|
|
1172
|
+
/** UI path */
|
|
457
1173
|
path: z.ZodDefault<z.ZodString>;
|
|
458
|
-
theme
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
dark: "dark";
|
|
462
|
-
}>>;
|
|
1174
|
+
/** UI theme */
|
|
1175
|
+
theme: z.ZodDefault<z.ZodEnum<["light", "dark", "auto"]>>;
|
|
1176
|
+
/** Enable try-it-out feature */
|
|
463
1177
|
enableTryItOut: z.ZodDefault<z.ZodBoolean>;
|
|
1178
|
+
/** Enable filtering */
|
|
464
1179
|
enableFilter: z.ZodDefault<z.ZodBoolean>;
|
|
1180
|
+
/** Enable CORS for testing */
|
|
465
1181
|
enableCors: z.ZodDefault<z.ZodBoolean>;
|
|
1182
|
+
/** Default expand depth for models */
|
|
466
1183
|
defaultModelsExpandDepth: z.ZodDefault<z.ZodNumber>;
|
|
1184
|
+
/** Display request duration */
|
|
467
1185
|
displayRequestDuration: z.ZodDefault<z.ZodBoolean>;
|
|
1186
|
+
/** Syntax highlighting */
|
|
468
1187
|
syntaxHighlighting: z.ZodDefault<z.ZodBoolean>;
|
|
1188
|
+
/** Custom CSS URL */
|
|
469
1189
|
customCssUrl: z.ZodOptional<z.ZodString>;
|
|
1190
|
+
/** Custom JavaScript URL */
|
|
470
1191
|
customJsUrl: z.ZodOptional<z.ZodString>;
|
|
1192
|
+
/** Layout options */
|
|
471
1193
|
layout: z.ZodOptional<z.ZodObject<{
|
|
472
1194
|
showExtensions: z.ZodDefault<z.ZodBoolean>;
|
|
473
1195
|
showCommonExtensions: z.ZodDefault<z.ZodBoolean>;
|
|
474
1196
|
deepLinking: z.ZodDefault<z.ZodBoolean>;
|
|
475
1197
|
displayOperationId: z.ZodDefault<z.ZodBoolean>;
|
|
476
|
-
defaultModelRendering: z.ZodDefault<z.ZodEnum<
|
|
477
|
-
model: "model";
|
|
478
|
-
example: "example";
|
|
479
|
-
}>>;
|
|
1198
|
+
defaultModelRendering: z.ZodDefault<z.ZodEnum<["example", "model"]>>;
|
|
480
1199
|
defaultModelsExpandDepth: z.ZodDefault<z.ZodNumber>;
|
|
481
1200
|
defaultModelExpandDepth: z.ZodDefault<z.ZodNumber>;
|
|
482
|
-
docExpansion: z.ZodDefault<z.ZodEnum<
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
1201
|
+
docExpansion: z.ZodDefault<z.ZodEnum<["list", "full", "none"]>>;
|
|
1202
|
+
}, "strip", z.ZodTypeAny, {
|
|
1203
|
+
defaultModelsExpandDepth: number;
|
|
1204
|
+
showExtensions: boolean;
|
|
1205
|
+
showCommonExtensions: boolean;
|
|
1206
|
+
deepLinking: boolean;
|
|
1207
|
+
displayOperationId: boolean;
|
|
1208
|
+
defaultModelRendering: "model" | "example";
|
|
1209
|
+
defaultModelExpandDepth: number;
|
|
1210
|
+
docExpansion: "full" | "list" | "none";
|
|
1211
|
+
}, {
|
|
1212
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
1213
|
+
showExtensions?: boolean | undefined;
|
|
1214
|
+
showCommonExtensions?: boolean | undefined;
|
|
1215
|
+
deepLinking?: boolean | undefined;
|
|
1216
|
+
displayOperationId?: boolean | undefined;
|
|
1217
|
+
defaultModelRendering?: "model" | "example" | undefined;
|
|
1218
|
+
defaultModelExpandDepth?: number | undefined;
|
|
1219
|
+
docExpansion?: "full" | "list" | "none" | undefined;
|
|
1220
|
+
}>>;
|
|
1221
|
+
}, "strip", z.ZodTypeAny, {
|
|
1222
|
+
path: string;
|
|
1223
|
+
type: "custom" | "swagger-ui" | "redoc" | "rapidoc" | "stoplight" | "scalar" | "graphql-playground" | "graphiql" | "postman";
|
|
1224
|
+
theme: "auto" | "light" | "dark";
|
|
1225
|
+
enableTryItOut: boolean;
|
|
1226
|
+
enableFilter: boolean;
|
|
1227
|
+
enableCors: boolean;
|
|
1228
|
+
defaultModelsExpandDepth: number;
|
|
1229
|
+
displayRequestDuration: boolean;
|
|
1230
|
+
syntaxHighlighting: boolean;
|
|
1231
|
+
layout?: {
|
|
1232
|
+
defaultModelsExpandDepth: number;
|
|
1233
|
+
showExtensions: boolean;
|
|
1234
|
+
showCommonExtensions: boolean;
|
|
1235
|
+
deepLinking: boolean;
|
|
1236
|
+
displayOperationId: boolean;
|
|
1237
|
+
defaultModelRendering: "model" | "example";
|
|
1238
|
+
defaultModelExpandDepth: number;
|
|
1239
|
+
docExpansion: "full" | "list" | "none";
|
|
1240
|
+
} | undefined;
|
|
1241
|
+
customCssUrl?: string | undefined;
|
|
1242
|
+
customJsUrl?: string | undefined;
|
|
1243
|
+
}, {
|
|
1244
|
+
type: "custom" | "swagger-ui" | "redoc" | "rapidoc" | "stoplight" | "scalar" | "graphql-playground" | "graphiql" | "postman";
|
|
1245
|
+
path?: string | undefined;
|
|
1246
|
+
theme?: "auto" | "light" | "dark" | undefined;
|
|
1247
|
+
layout?: {
|
|
1248
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
1249
|
+
showExtensions?: boolean | undefined;
|
|
1250
|
+
showCommonExtensions?: boolean | undefined;
|
|
1251
|
+
deepLinking?: boolean | undefined;
|
|
1252
|
+
displayOperationId?: boolean | undefined;
|
|
1253
|
+
defaultModelRendering?: "model" | "example" | undefined;
|
|
1254
|
+
defaultModelExpandDepth?: number | undefined;
|
|
1255
|
+
docExpansion?: "full" | "list" | "none" | undefined;
|
|
1256
|
+
} | undefined;
|
|
1257
|
+
enableTryItOut?: boolean | undefined;
|
|
1258
|
+
enableFilter?: boolean | undefined;
|
|
1259
|
+
enableCors?: boolean | undefined;
|
|
1260
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
1261
|
+
displayRequestDuration?: boolean | undefined;
|
|
1262
|
+
syntaxHighlighting?: boolean | undefined;
|
|
1263
|
+
customCssUrl?: string | undefined;
|
|
1264
|
+
customJsUrl?: string | undefined;
|
|
1265
|
+
}>>;
|
|
1266
|
+
/** Generate OpenAPI spec */
|
|
489
1267
|
generateOpenApi: z.ZodDefault<z.ZodBoolean>;
|
|
1268
|
+
/** Generate test collections */
|
|
490
1269
|
generateTestCollections: z.ZodDefault<z.ZodBoolean>;
|
|
1270
|
+
/** Test collections */
|
|
491
1271
|
testCollections: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1272
|
+
/** Collection name */
|
|
492
1273
|
name: z.ZodString;
|
|
1274
|
+
/** Collection description */
|
|
493
1275
|
description: z.ZodOptional<z.ZodString>;
|
|
1276
|
+
/** Collection variables */
|
|
494
1277
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
1278
|
+
/** Test requests */
|
|
495
1279
|
requests: z.ZodArray<z.ZodObject<{
|
|
1280
|
+
/** Request name */
|
|
496
1281
|
name: z.ZodString;
|
|
1282
|
+
/** Request description */
|
|
497
1283
|
description: z.ZodOptional<z.ZodString>;
|
|
498
|
-
method
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
PUT: "PUT";
|
|
502
|
-
DELETE: "DELETE";
|
|
503
|
-
PATCH: "PATCH";
|
|
504
|
-
HEAD: "HEAD";
|
|
505
|
-
OPTIONS: "OPTIONS";
|
|
506
|
-
}>;
|
|
1284
|
+
/** HTTP method */
|
|
1285
|
+
method: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
|
|
1286
|
+
/** Request URL */
|
|
507
1287
|
url: z.ZodString;
|
|
1288
|
+
/** Request headers */
|
|
508
1289
|
headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
509
|
-
|
|
1290
|
+
/** Query parameters */
|
|
1291
|
+
queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
|
|
1292
|
+
/** Request body */
|
|
510
1293
|
body: z.ZodOptional<z.ZodAny>;
|
|
1294
|
+
/** Environment variables */
|
|
511
1295
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
1296
|
+
/** Expected response */
|
|
512
1297
|
expectedResponse: z.ZodOptional<z.ZodObject<{
|
|
513
1298
|
statusCode: z.ZodNumber;
|
|
514
1299
|
body: z.ZodOptional<z.ZodAny>;
|
|
515
|
-
}, z.
|
|
516
|
-
|
|
1300
|
+
}, "strip", z.ZodTypeAny, {
|
|
1301
|
+
statusCode: number;
|
|
1302
|
+
body?: any;
|
|
1303
|
+
}, {
|
|
1304
|
+
statusCode: number;
|
|
1305
|
+
body?: any;
|
|
1306
|
+
}>>;
|
|
1307
|
+
}, "strip", z.ZodTypeAny, {
|
|
1308
|
+
url: string;
|
|
1309
|
+
name: string;
|
|
1310
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1311
|
+
headers: Record<string, string>;
|
|
1312
|
+
variables: Record<string, any>;
|
|
1313
|
+
queryParams: Record<string, string | number | boolean>;
|
|
1314
|
+
description?: string | undefined;
|
|
1315
|
+
body?: any;
|
|
1316
|
+
expectedResponse?: {
|
|
1317
|
+
statusCode: number;
|
|
1318
|
+
body?: any;
|
|
1319
|
+
} | undefined;
|
|
1320
|
+
}, {
|
|
1321
|
+
url: string;
|
|
1322
|
+
name: string;
|
|
1323
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1324
|
+
description?: string | undefined;
|
|
1325
|
+
headers?: Record<string, string> | undefined;
|
|
1326
|
+
body?: any;
|
|
1327
|
+
variables?: Record<string, any> | undefined;
|
|
1328
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
1329
|
+
expectedResponse?: {
|
|
1330
|
+
statusCode: number;
|
|
1331
|
+
body?: any;
|
|
1332
|
+
} | undefined;
|
|
1333
|
+
}>, "many">;
|
|
1334
|
+
/** Folders/grouping */
|
|
517
1335
|
folders: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
518
1336
|
name: z.ZodString;
|
|
519
1337
|
description: z.ZodOptional<z.ZodString>;
|
|
520
1338
|
requests: z.ZodArray<z.ZodObject<{
|
|
1339
|
+
/** Request name */
|
|
521
1340
|
name: z.ZodString;
|
|
1341
|
+
/** Request description */
|
|
522
1342
|
description: z.ZodOptional<z.ZodString>;
|
|
523
|
-
method
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
PUT: "PUT";
|
|
527
|
-
DELETE: "DELETE";
|
|
528
|
-
PATCH: "PATCH";
|
|
529
|
-
HEAD: "HEAD";
|
|
530
|
-
OPTIONS: "OPTIONS";
|
|
531
|
-
}>;
|
|
1343
|
+
/** HTTP method */
|
|
1344
|
+
method: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
|
|
1345
|
+
/** Request URL */
|
|
532
1346
|
url: z.ZodString;
|
|
1347
|
+
/** Request headers */
|
|
533
1348
|
headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
534
|
-
|
|
1349
|
+
/** Query parameters */
|
|
1350
|
+
queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
|
|
1351
|
+
/** Request body */
|
|
535
1352
|
body: z.ZodOptional<z.ZodAny>;
|
|
1353
|
+
/** Environment variables */
|
|
536
1354
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
1355
|
+
/** Expected response */
|
|
537
1356
|
expectedResponse: z.ZodOptional<z.ZodObject<{
|
|
538
1357
|
statusCode: z.ZodNumber;
|
|
539
1358
|
body: z.ZodOptional<z.ZodAny>;
|
|
540
|
-
}, z.
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
1359
|
+
}, "strip", z.ZodTypeAny, {
|
|
1360
|
+
statusCode: number;
|
|
1361
|
+
body?: any;
|
|
1362
|
+
}, {
|
|
1363
|
+
statusCode: number;
|
|
1364
|
+
body?: any;
|
|
1365
|
+
}>>;
|
|
1366
|
+
}, "strip", z.ZodTypeAny, {
|
|
1367
|
+
url: string;
|
|
1368
|
+
name: string;
|
|
1369
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1370
|
+
headers: Record<string, string>;
|
|
1371
|
+
variables: Record<string, any>;
|
|
1372
|
+
queryParams: Record<string, string | number | boolean>;
|
|
1373
|
+
description?: string | undefined;
|
|
1374
|
+
body?: any;
|
|
1375
|
+
expectedResponse?: {
|
|
1376
|
+
statusCode: number;
|
|
1377
|
+
body?: any;
|
|
1378
|
+
} | undefined;
|
|
1379
|
+
}, {
|
|
1380
|
+
url: string;
|
|
1381
|
+
name: string;
|
|
1382
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1383
|
+
description?: string | undefined;
|
|
1384
|
+
headers?: Record<string, string> | undefined;
|
|
1385
|
+
body?: any;
|
|
1386
|
+
variables?: Record<string, any> | undefined;
|
|
1387
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
1388
|
+
expectedResponse?: {
|
|
1389
|
+
statusCode: number;
|
|
1390
|
+
body?: any;
|
|
1391
|
+
} | undefined;
|
|
1392
|
+
}>, "many">;
|
|
1393
|
+
}, "strip", z.ZodTypeAny, {
|
|
1394
|
+
name: string;
|
|
1395
|
+
requests: {
|
|
1396
|
+
url: string;
|
|
1397
|
+
name: string;
|
|
1398
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1399
|
+
headers: Record<string, string>;
|
|
1400
|
+
variables: Record<string, any>;
|
|
1401
|
+
queryParams: Record<string, string | number | boolean>;
|
|
1402
|
+
description?: string | undefined;
|
|
1403
|
+
body?: any;
|
|
1404
|
+
expectedResponse?: {
|
|
1405
|
+
statusCode: number;
|
|
1406
|
+
body?: any;
|
|
1407
|
+
} | undefined;
|
|
1408
|
+
}[];
|
|
1409
|
+
description?: string | undefined;
|
|
1410
|
+
}, {
|
|
1411
|
+
name: string;
|
|
1412
|
+
requests: {
|
|
1413
|
+
url: string;
|
|
1414
|
+
name: string;
|
|
1415
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1416
|
+
description?: string | undefined;
|
|
1417
|
+
headers?: Record<string, string> | undefined;
|
|
1418
|
+
body?: any;
|
|
1419
|
+
variables?: Record<string, any> | undefined;
|
|
1420
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
1421
|
+
expectedResponse?: {
|
|
1422
|
+
statusCode: number;
|
|
1423
|
+
body?: any;
|
|
1424
|
+
} | undefined;
|
|
1425
|
+
}[];
|
|
1426
|
+
description?: string | undefined;
|
|
1427
|
+
}>, "many">>;
|
|
1428
|
+
}, "strip", z.ZodTypeAny, {
|
|
1429
|
+
name: string;
|
|
1430
|
+
requests: {
|
|
1431
|
+
url: string;
|
|
1432
|
+
name: string;
|
|
1433
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1434
|
+
headers: Record<string, string>;
|
|
1435
|
+
variables: Record<string, any>;
|
|
1436
|
+
queryParams: Record<string, string | number | boolean>;
|
|
1437
|
+
description?: string | undefined;
|
|
1438
|
+
body?: any;
|
|
1439
|
+
expectedResponse?: {
|
|
1440
|
+
statusCode: number;
|
|
1441
|
+
body?: any;
|
|
1442
|
+
} | undefined;
|
|
1443
|
+
}[];
|
|
1444
|
+
variables: Record<string, any>;
|
|
1445
|
+
description?: string | undefined;
|
|
1446
|
+
folders?: {
|
|
1447
|
+
name: string;
|
|
1448
|
+
requests: {
|
|
1449
|
+
url: string;
|
|
1450
|
+
name: string;
|
|
1451
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1452
|
+
headers: Record<string, string>;
|
|
1453
|
+
variables: Record<string, any>;
|
|
1454
|
+
queryParams: Record<string, string | number | boolean>;
|
|
1455
|
+
description?: string | undefined;
|
|
1456
|
+
body?: any;
|
|
1457
|
+
expectedResponse?: {
|
|
1458
|
+
statusCode: number;
|
|
1459
|
+
body?: any;
|
|
1460
|
+
} | undefined;
|
|
1461
|
+
}[];
|
|
1462
|
+
description?: string | undefined;
|
|
1463
|
+
}[] | undefined;
|
|
1464
|
+
}, {
|
|
1465
|
+
name: string;
|
|
1466
|
+
requests: {
|
|
1467
|
+
url: string;
|
|
1468
|
+
name: string;
|
|
1469
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1470
|
+
description?: string | undefined;
|
|
1471
|
+
headers?: Record<string, string> | undefined;
|
|
1472
|
+
body?: any;
|
|
1473
|
+
variables?: Record<string, any> | undefined;
|
|
1474
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
1475
|
+
expectedResponse?: {
|
|
1476
|
+
statusCode: number;
|
|
1477
|
+
body?: any;
|
|
1478
|
+
} | undefined;
|
|
1479
|
+
}[];
|
|
1480
|
+
description?: string | undefined;
|
|
1481
|
+
variables?: Record<string, any> | undefined;
|
|
1482
|
+
folders?: {
|
|
1483
|
+
name: string;
|
|
1484
|
+
requests: {
|
|
1485
|
+
url: string;
|
|
1486
|
+
name: string;
|
|
1487
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1488
|
+
description?: string | undefined;
|
|
1489
|
+
headers?: Record<string, string> | undefined;
|
|
1490
|
+
body?: any;
|
|
1491
|
+
variables?: Record<string, any> | undefined;
|
|
1492
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
1493
|
+
expectedResponse?: {
|
|
1494
|
+
statusCode: number;
|
|
1495
|
+
body?: any;
|
|
1496
|
+
} | undefined;
|
|
1497
|
+
}[];
|
|
1498
|
+
description?: string | undefined;
|
|
1499
|
+
}[] | undefined;
|
|
1500
|
+
}>, "many">>>;
|
|
1501
|
+
/** API changelog */
|
|
544
1502
|
changelog: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1503
|
+
/** Version */
|
|
545
1504
|
version: z.ZodString;
|
|
1505
|
+
/** Release date */
|
|
546
1506
|
date: z.ZodString;
|
|
1507
|
+
/** Changes */
|
|
547
1508
|
changes: z.ZodObject<{
|
|
548
|
-
added: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
549
|
-
changed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
550
|
-
deprecated: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
551
|
-
removed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
552
|
-
fixed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
553
|
-
security: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
554
|
-
}, z.
|
|
1509
|
+
added: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1510
|
+
changed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1511
|
+
deprecated: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1512
|
+
removed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1513
|
+
fixed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1514
|
+
security: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1515
|
+
}, "strip", z.ZodTypeAny, {
|
|
1516
|
+
fixed: string[];
|
|
1517
|
+
security: string[];
|
|
1518
|
+
removed: string[];
|
|
1519
|
+
deprecated: string[];
|
|
1520
|
+
added: string[];
|
|
1521
|
+
changed: string[];
|
|
1522
|
+
}, {
|
|
1523
|
+
fixed?: string[] | undefined;
|
|
1524
|
+
security?: string[] | undefined;
|
|
1525
|
+
removed?: string[] | undefined;
|
|
1526
|
+
deprecated?: string[] | undefined;
|
|
1527
|
+
added?: string[] | undefined;
|
|
1528
|
+
changed?: string[] | undefined;
|
|
1529
|
+
}>;
|
|
1530
|
+
/** Migration guide */
|
|
555
1531
|
migrationGuide: z.ZodOptional<z.ZodString>;
|
|
556
|
-
}, z.
|
|
1532
|
+
}, "strip", z.ZodTypeAny, {
|
|
1533
|
+
date: string;
|
|
1534
|
+
version: string;
|
|
1535
|
+
changes: {
|
|
1536
|
+
fixed: string[];
|
|
1537
|
+
security: string[];
|
|
1538
|
+
removed: string[];
|
|
1539
|
+
deprecated: string[];
|
|
1540
|
+
added: string[];
|
|
1541
|
+
changed: string[];
|
|
1542
|
+
};
|
|
1543
|
+
migrationGuide?: string | undefined;
|
|
1544
|
+
}, {
|
|
1545
|
+
date: string;
|
|
1546
|
+
version: string;
|
|
1547
|
+
changes: {
|
|
1548
|
+
fixed?: string[] | undefined;
|
|
1549
|
+
security?: string[] | undefined;
|
|
1550
|
+
removed?: string[] | undefined;
|
|
1551
|
+
deprecated?: string[] | undefined;
|
|
1552
|
+
added?: string[] | undefined;
|
|
1553
|
+
changed?: string[] | undefined;
|
|
1554
|
+
};
|
|
1555
|
+
migrationGuide?: string | undefined;
|
|
1556
|
+
}>, "many">>>;
|
|
1557
|
+
/** Code generation templates */
|
|
557
1558
|
codeTemplates: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1559
|
+
/** Language/framework */
|
|
558
1560
|
language: z.ZodString;
|
|
1561
|
+
/** Template name */
|
|
559
1562
|
name: z.ZodString;
|
|
1563
|
+
/** Template content */
|
|
560
1564
|
template: z.ZodString;
|
|
561
|
-
variables
|
|
562
|
-
|
|
1565
|
+
/** Template variables */
|
|
1566
|
+
variables: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
1567
|
+
}, "strip", z.ZodTypeAny, {
|
|
1568
|
+
language: string;
|
|
1569
|
+
name: string;
|
|
1570
|
+
template: string;
|
|
1571
|
+
variables?: string[] | undefined;
|
|
1572
|
+
}, {
|
|
1573
|
+
language: string;
|
|
1574
|
+
name: string;
|
|
1575
|
+
template: string;
|
|
1576
|
+
variables?: string[] | undefined;
|
|
1577
|
+
}>, "many">>>;
|
|
1578
|
+
/** Terms of service */
|
|
563
1579
|
termsOfService: z.ZodOptional<z.ZodString>;
|
|
1580
|
+
/** Contact information */
|
|
564
1581
|
contact: z.ZodOptional<z.ZodObject<{
|
|
565
1582
|
name: z.ZodOptional<z.ZodString>;
|
|
566
1583
|
url: z.ZodOptional<z.ZodString>;
|
|
567
1584
|
email: z.ZodOptional<z.ZodString>;
|
|
568
|
-
}, z.
|
|
1585
|
+
}, "strip", z.ZodTypeAny, {
|
|
1586
|
+
email?: string | undefined;
|
|
1587
|
+
url?: string | undefined;
|
|
1588
|
+
name?: string | undefined;
|
|
1589
|
+
}, {
|
|
1590
|
+
email?: string | undefined;
|
|
1591
|
+
url?: string | undefined;
|
|
1592
|
+
name?: string | undefined;
|
|
1593
|
+
}>>;
|
|
1594
|
+
/** License */
|
|
569
1595
|
license: z.ZodOptional<z.ZodObject<{
|
|
570
1596
|
name: z.ZodString;
|
|
571
1597
|
url: z.ZodOptional<z.ZodString>;
|
|
572
|
-
}, z.
|
|
1598
|
+
}, "strip", z.ZodTypeAny, {
|
|
1599
|
+
name: string;
|
|
1600
|
+
url?: string | undefined;
|
|
1601
|
+
}, {
|
|
1602
|
+
name: string;
|
|
1603
|
+
url?: string | undefined;
|
|
1604
|
+
}>>;
|
|
1605
|
+
/** External documentation */
|
|
573
1606
|
externalDocs: z.ZodOptional<z.ZodObject<{
|
|
574
1607
|
description: z.ZodOptional<z.ZodString>;
|
|
575
1608
|
url: z.ZodString;
|
|
576
|
-
}, z.
|
|
1609
|
+
}, "strip", z.ZodTypeAny, {
|
|
1610
|
+
url: string;
|
|
1611
|
+
description?: string | undefined;
|
|
1612
|
+
}, {
|
|
1613
|
+
url: string;
|
|
1614
|
+
description?: string | undefined;
|
|
1615
|
+
}>>;
|
|
1616
|
+
/** Security schemes */
|
|
577
1617
|
securitySchemes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
578
|
-
type
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
http: "http";
|
|
582
|
-
openIdConnect: "openIdConnect";
|
|
583
|
-
}>;
|
|
1618
|
+
/** Security scheme type */
|
|
1619
|
+
type: z.ZodEnum<["apiKey", "http", "oauth2", "openIdConnect"]>;
|
|
1620
|
+
/** Scheme name */
|
|
584
1621
|
scheme: z.ZodOptional<z.ZodString>;
|
|
1622
|
+
/** Bearer format */
|
|
585
1623
|
bearerFormat: z.ZodOptional<z.ZodString>;
|
|
1624
|
+
/** API key name */
|
|
586
1625
|
name: z.ZodOptional<z.ZodString>;
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
cookie: "cookie";
|
|
591
|
-
}>>;
|
|
1626
|
+
/** API key location */
|
|
1627
|
+
in: z.ZodOptional<z.ZodEnum<["header", "query", "cookie"]>>;
|
|
1628
|
+
/** OAuth flows */
|
|
592
1629
|
flows: z.ZodOptional<z.ZodObject<{
|
|
593
1630
|
implicit: z.ZodOptional<z.ZodAny>;
|
|
594
1631
|
password: z.ZodOptional<z.ZodAny>;
|
|
595
1632
|
clientCredentials: z.ZodOptional<z.ZodAny>;
|
|
596
1633
|
authorizationCode: z.ZodOptional<z.ZodAny>;
|
|
597
|
-
}, z.
|
|
1634
|
+
}, "strip", z.ZodTypeAny, {
|
|
1635
|
+
password?: any;
|
|
1636
|
+
implicit?: any;
|
|
1637
|
+
clientCredentials?: any;
|
|
1638
|
+
authorizationCode?: any;
|
|
1639
|
+
}, {
|
|
1640
|
+
password?: any;
|
|
1641
|
+
implicit?: any;
|
|
1642
|
+
clientCredentials?: any;
|
|
1643
|
+
authorizationCode?: any;
|
|
1644
|
+
}>>;
|
|
1645
|
+
/** OpenID Connect URL */
|
|
598
1646
|
openIdConnectUrl: z.ZodOptional<z.ZodString>;
|
|
1647
|
+
/** Description */
|
|
599
1648
|
description: z.ZodOptional<z.ZodString>;
|
|
600
|
-
}, z.
|
|
1649
|
+
}, "strip", z.ZodTypeAny, {
|
|
1650
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
1651
|
+
name?: string | undefined;
|
|
1652
|
+
description?: string | undefined;
|
|
1653
|
+
scheme?: string | undefined;
|
|
1654
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
1655
|
+
bearerFormat?: string | undefined;
|
|
1656
|
+
flows?: {
|
|
1657
|
+
password?: any;
|
|
1658
|
+
implicit?: any;
|
|
1659
|
+
clientCredentials?: any;
|
|
1660
|
+
authorizationCode?: any;
|
|
1661
|
+
} | undefined;
|
|
1662
|
+
openIdConnectUrl?: string | undefined;
|
|
1663
|
+
}, {
|
|
1664
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
1665
|
+
name?: string | undefined;
|
|
1666
|
+
description?: string | undefined;
|
|
1667
|
+
scheme?: string | undefined;
|
|
1668
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
1669
|
+
bearerFormat?: string | undefined;
|
|
1670
|
+
flows?: {
|
|
1671
|
+
password?: any;
|
|
1672
|
+
implicit?: any;
|
|
1673
|
+
clientCredentials?: any;
|
|
1674
|
+
authorizationCode?: any;
|
|
1675
|
+
} | undefined;
|
|
1676
|
+
openIdConnectUrl?: string | undefined;
|
|
1677
|
+
}>>>;
|
|
1678
|
+
/** Global tags */
|
|
601
1679
|
tags: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
602
1680
|
name: z.ZodString;
|
|
603
1681
|
description: z.ZodOptional<z.ZodString>;
|
|
604
1682
|
externalDocs: z.ZodOptional<z.ZodObject<{
|
|
605
1683
|
description: z.ZodOptional<z.ZodString>;
|
|
606
1684
|
url: z.ZodString;
|
|
607
|
-
}, z.
|
|
608
|
-
|
|
609
|
-
|
|
1685
|
+
}, "strip", z.ZodTypeAny, {
|
|
1686
|
+
url: string;
|
|
1687
|
+
description?: string | undefined;
|
|
1688
|
+
}, {
|
|
1689
|
+
url: string;
|
|
1690
|
+
description?: string | undefined;
|
|
1691
|
+
}>>;
|
|
1692
|
+
}, "strip", z.ZodTypeAny, {
|
|
1693
|
+
name: string;
|
|
1694
|
+
description?: string | undefined;
|
|
1695
|
+
externalDocs?: {
|
|
1696
|
+
url: string;
|
|
1697
|
+
description?: string | undefined;
|
|
1698
|
+
} | undefined;
|
|
1699
|
+
}, {
|
|
1700
|
+
name: string;
|
|
1701
|
+
description?: string | undefined;
|
|
1702
|
+
externalDocs?: {
|
|
1703
|
+
url: string;
|
|
1704
|
+
description?: string | undefined;
|
|
1705
|
+
} | undefined;
|
|
1706
|
+
}>, "many">>;
|
|
1707
|
+
}, "strip", z.ZodTypeAny, {
|
|
1708
|
+
enabled: boolean;
|
|
1709
|
+
version: string;
|
|
1710
|
+
title: string;
|
|
1711
|
+
changelog: {
|
|
1712
|
+
date: string;
|
|
1713
|
+
version: string;
|
|
1714
|
+
changes: {
|
|
1715
|
+
fixed: string[];
|
|
1716
|
+
security: string[];
|
|
1717
|
+
removed: string[];
|
|
1718
|
+
deprecated: string[];
|
|
1719
|
+
added: string[];
|
|
1720
|
+
changed: string[];
|
|
1721
|
+
};
|
|
1722
|
+
migrationGuide?: string | undefined;
|
|
1723
|
+
}[];
|
|
1724
|
+
servers: {
|
|
1725
|
+
url: string;
|
|
1726
|
+
description?: string | undefined;
|
|
1727
|
+
variables?: Record<string, {
|
|
1728
|
+
default: string;
|
|
1729
|
+
description?: string | undefined;
|
|
1730
|
+
enum?: string[] | undefined;
|
|
1731
|
+
}> | undefined;
|
|
1732
|
+
}[];
|
|
1733
|
+
generateOpenApi: boolean;
|
|
1734
|
+
generateTestCollections: boolean;
|
|
1735
|
+
testCollections: {
|
|
1736
|
+
name: string;
|
|
1737
|
+
requests: {
|
|
1738
|
+
url: string;
|
|
1739
|
+
name: string;
|
|
1740
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1741
|
+
headers: Record<string, string>;
|
|
1742
|
+
variables: Record<string, any>;
|
|
1743
|
+
queryParams: Record<string, string | number | boolean>;
|
|
1744
|
+
description?: string | undefined;
|
|
1745
|
+
body?: any;
|
|
1746
|
+
expectedResponse?: {
|
|
1747
|
+
statusCode: number;
|
|
1748
|
+
body?: any;
|
|
1749
|
+
} | undefined;
|
|
1750
|
+
}[];
|
|
1751
|
+
variables: Record<string, any>;
|
|
1752
|
+
description?: string | undefined;
|
|
1753
|
+
folders?: {
|
|
1754
|
+
name: string;
|
|
1755
|
+
requests: {
|
|
1756
|
+
url: string;
|
|
1757
|
+
name: string;
|
|
1758
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1759
|
+
headers: Record<string, string>;
|
|
1760
|
+
variables: Record<string, any>;
|
|
1761
|
+
queryParams: Record<string, string | number | boolean>;
|
|
1762
|
+
description?: string | undefined;
|
|
1763
|
+
body?: any;
|
|
1764
|
+
expectedResponse?: {
|
|
1765
|
+
statusCode: number;
|
|
1766
|
+
body?: any;
|
|
1767
|
+
} | undefined;
|
|
1768
|
+
}[];
|
|
1769
|
+
description?: string | undefined;
|
|
1770
|
+
}[] | undefined;
|
|
1771
|
+
}[];
|
|
1772
|
+
codeTemplates: {
|
|
1773
|
+
language: string;
|
|
1774
|
+
name: string;
|
|
1775
|
+
template: string;
|
|
1776
|
+
variables?: string[] | undefined;
|
|
1777
|
+
}[];
|
|
1778
|
+
tags?: {
|
|
1779
|
+
name: string;
|
|
1780
|
+
description?: string | undefined;
|
|
1781
|
+
externalDocs?: {
|
|
1782
|
+
url: string;
|
|
1783
|
+
description?: string | undefined;
|
|
1784
|
+
} | undefined;
|
|
1785
|
+
}[] | undefined;
|
|
1786
|
+
description?: string | undefined;
|
|
1787
|
+
license?: {
|
|
1788
|
+
name: string;
|
|
1789
|
+
url?: string | undefined;
|
|
1790
|
+
} | undefined;
|
|
1791
|
+
ui?: {
|
|
1792
|
+
path: string;
|
|
1793
|
+
type: "custom" | "swagger-ui" | "redoc" | "rapidoc" | "stoplight" | "scalar" | "graphql-playground" | "graphiql" | "postman";
|
|
1794
|
+
theme: "auto" | "light" | "dark";
|
|
1795
|
+
enableTryItOut: boolean;
|
|
1796
|
+
enableFilter: boolean;
|
|
1797
|
+
enableCors: boolean;
|
|
1798
|
+
defaultModelsExpandDepth: number;
|
|
1799
|
+
displayRequestDuration: boolean;
|
|
1800
|
+
syntaxHighlighting: boolean;
|
|
1801
|
+
layout?: {
|
|
1802
|
+
defaultModelsExpandDepth: number;
|
|
1803
|
+
showExtensions: boolean;
|
|
1804
|
+
showCommonExtensions: boolean;
|
|
1805
|
+
deepLinking: boolean;
|
|
1806
|
+
displayOperationId: boolean;
|
|
1807
|
+
defaultModelRendering: "model" | "example";
|
|
1808
|
+
defaultModelExpandDepth: number;
|
|
1809
|
+
docExpansion: "full" | "list" | "none";
|
|
1810
|
+
} | undefined;
|
|
1811
|
+
customCssUrl?: string | undefined;
|
|
1812
|
+
customJsUrl?: string | undefined;
|
|
1813
|
+
} | undefined;
|
|
1814
|
+
termsOfService?: string | undefined;
|
|
1815
|
+
contact?: {
|
|
1816
|
+
email?: string | undefined;
|
|
1817
|
+
url?: string | undefined;
|
|
1818
|
+
name?: string | undefined;
|
|
1819
|
+
} | undefined;
|
|
1820
|
+
externalDocs?: {
|
|
1821
|
+
url: string;
|
|
1822
|
+
description?: string | undefined;
|
|
1823
|
+
} | undefined;
|
|
1824
|
+
securitySchemes?: Record<string, {
|
|
1825
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
1826
|
+
name?: string | undefined;
|
|
1827
|
+
description?: string | undefined;
|
|
1828
|
+
scheme?: string | undefined;
|
|
1829
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
1830
|
+
bearerFormat?: string | undefined;
|
|
1831
|
+
flows?: {
|
|
1832
|
+
password?: any;
|
|
1833
|
+
implicit?: any;
|
|
1834
|
+
clientCredentials?: any;
|
|
1835
|
+
authorizationCode?: any;
|
|
1836
|
+
} | undefined;
|
|
1837
|
+
openIdConnectUrl?: string | undefined;
|
|
1838
|
+
}> | undefined;
|
|
1839
|
+
}, {
|
|
1840
|
+
version: string;
|
|
1841
|
+
enabled?: boolean | undefined;
|
|
1842
|
+
tags?: {
|
|
1843
|
+
name: string;
|
|
1844
|
+
description?: string | undefined;
|
|
1845
|
+
externalDocs?: {
|
|
1846
|
+
url: string;
|
|
1847
|
+
description?: string | undefined;
|
|
1848
|
+
} | undefined;
|
|
1849
|
+
}[] | undefined;
|
|
1850
|
+
description?: string | undefined;
|
|
1851
|
+
title?: string | undefined;
|
|
1852
|
+
license?: {
|
|
1853
|
+
name: string;
|
|
1854
|
+
url?: string | undefined;
|
|
1855
|
+
} | undefined;
|
|
1856
|
+
ui?: {
|
|
1857
|
+
type: "custom" | "swagger-ui" | "redoc" | "rapidoc" | "stoplight" | "scalar" | "graphql-playground" | "graphiql" | "postman";
|
|
1858
|
+
path?: string | undefined;
|
|
1859
|
+
theme?: "auto" | "light" | "dark" | undefined;
|
|
1860
|
+
layout?: {
|
|
1861
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
1862
|
+
showExtensions?: boolean | undefined;
|
|
1863
|
+
showCommonExtensions?: boolean | undefined;
|
|
1864
|
+
deepLinking?: boolean | undefined;
|
|
1865
|
+
displayOperationId?: boolean | undefined;
|
|
1866
|
+
defaultModelRendering?: "model" | "example" | undefined;
|
|
1867
|
+
defaultModelExpandDepth?: number | undefined;
|
|
1868
|
+
docExpansion?: "full" | "list" | "none" | undefined;
|
|
1869
|
+
} | undefined;
|
|
1870
|
+
enableTryItOut?: boolean | undefined;
|
|
1871
|
+
enableFilter?: boolean | undefined;
|
|
1872
|
+
enableCors?: boolean | undefined;
|
|
1873
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
1874
|
+
displayRequestDuration?: boolean | undefined;
|
|
1875
|
+
syntaxHighlighting?: boolean | undefined;
|
|
1876
|
+
customCssUrl?: string | undefined;
|
|
1877
|
+
customJsUrl?: string | undefined;
|
|
1878
|
+
} | undefined;
|
|
1879
|
+
changelog?: {
|
|
1880
|
+
date: string;
|
|
1881
|
+
version: string;
|
|
1882
|
+
changes: {
|
|
1883
|
+
fixed?: string[] | undefined;
|
|
1884
|
+
security?: string[] | undefined;
|
|
1885
|
+
removed?: string[] | undefined;
|
|
1886
|
+
deprecated?: string[] | undefined;
|
|
1887
|
+
added?: string[] | undefined;
|
|
1888
|
+
changed?: string[] | undefined;
|
|
1889
|
+
};
|
|
1890
|
+
migrationGuide?: string | undefined;
|
|
1891
|
+
}[] | undefined;
|
|
1892
|
+
termsOfService?: string | undefined;
|
|
1893
|
+
contact?: {
|
|
1894
|
+
email?: string | undefined;
|
|
1895
|
+
url?: string | undefined;
|
|
1896
|
+
name?: string | undefined;
|
|
1897
|
+
} | undefined;
|
|
1898
|
+
externalDocs?: {
|
|
1899
|
+
url: string;
|
|
1900
|
+
description?: string | undefined;
|
|
1901
|
+
} | undefined;
|
|
1902
|
+
servers?: {
|
|
1903
|
+
url: string;
|
|
1904
|
+
description?: string | undefined;
|
|
1905
|
+
variables?: Record<string, {
|
|
1906
|
+
default: string;
|
|
1907
|
+
description?: string | undefined;
|
|
1908
|
+
enum?: string[] | undefined;
|
|
1909
|
+
}> | undefined;
|
|
1910
|
+
}[] | undefined;
|
|
1911
|
+
securitySchemes?: Record<string, {
|
|
1912
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
1913
|
+
name?: string | undefined;
|
|
1914
|
+
description?: string | undefined;
|
|
1915
|
+
scheme?: string | undefined;
|
|
1916
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
1917
|
+
bearerFormat?: string | undefined;
|
|
1918
|
+
flows?: {
|
|
1919
|
+
password?: any;
|
|
1920
|
+
implicit?: any;
|
|
1921
|
+
clientCredentials?: any;
|
|
1922
|
+
authorizationCode?: any;
|
|
1923
|
+
} | undefined;
|
|
1924
|
+
openIdConnectUrl?: string | undefined;
|
|
1925
|
+
}> | undefined;
|
|
1926
|
+
generateOpenApi?: boolean | undefined;
|
|
1927
|
+
generateTestCollections?: boolean | undefined;
|
|
1928
|
+
testCollections?: {
|
|
1929
|
+
name: string;
|
|
1930
|
+
requests: {
|
|
1931
|
+
url: string;
|
|
1932
|
+
name: string;
|
|
1933
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1934
|
+
description?: string | undefined;
|
|
1935
|
+
headers?: Record<string, string> | undefined;
|
|
1936
|
+
body?: any;
|
|
1937
|
+
variables?: Record<string, any> | undefined;
|
|
1938
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
1939
|
+
expectedResponse?: {
|
|
1940
|
+
statusCode: number;
|
|
1941
|
+
body?: any;
|
|
1942
|
+
} | undefined;
|
|
1943
|
+
}[];
|
|
1944
|
+
description?: string | undefined;
|
|
1945
|
+
variables?: Record<string, any> | undefined;
|
|
1946
|
+
folders?: {
|
|
1947
|
+
name: string;
|
|
1948
|
+
requests: {
|
|
1949
|
+
url: string;
|
|
1950
|
+
name: string;
|
|
1951
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
1952
|
+
description?: string | undefined;
|
|
1953
|
+
headers?: Record<string, string> | undefined;
|
|
1954
|
+
body?: any;
|
|
1955
|
+
variables?: Record<string, any> | undefined;
|
|
1956
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
1957
|
+
expectedResponse?: {
|
|
1958
|
+
statusCode: number;
|
|
1959
|
+
body?: any;
|
|
1960
|
+
} | undefined;
|
|
1961
|
+
}[];
|
|
1962
|
+
description?: string | undefined;
|
|
1963
|
+
}[] | undefined;
|
|
1964
|
+
}[] | undefined;
|
|
1965
|
+
codeTemplates?: {
|
|
1966
|
+
language: string;
|
|
1967
|
+
name: string;
|
|
1968
|
+
template: string;
|
|
1969
|
+
variables?: string[] | undefined;
|
|
1970
|
+
}[] | undefined;
|
|
1971
|
+
}>;
|
|
610
1972
|
export type ApiDocumentationConfig = z.infer<typeof ApiDocumentationConfigSchema>;
|
|
611
1973
|
/**
|
|
612
1974
|
* Generated API Documentation Schema
|
|
@@ -614,8 +1976,11 @@ export type ApiDocumentationConfig = z.infer<typeof ApiDocumentationConfigSchema
|
|
|
614
1976
|
* Output of documentation generation process.
|
|
615
1977
|
*/
|
|
616
1978
|
export declare const GeneratedApiDocumentationSchema: z.ZodObject<{
|
|
1979
|
+
/** OpenAPI specification */
|
|
617
1980
|
openApiSpec: z.ZodOptional<z.ZodObject<{
|
|
1981
|
+
/** OpenAPI version */
|
|
618
1982
|
openapi: z.ZodDefault<z.ZodString>;
|
|
1983
|
+
/** API information */
|
|
619
1984
|
info: z.ZodObject<{
|
|
620
1985
|
title: z.ZodString;
|
|
621
1986
|
version: z.ZodString;
|
|
@@ -625,22 +1990,94 @@ export declare const GeneratedApiDocumentationSchema: z.ZodObject<{
|
|
|
625
1990
|
name: z.ZodOptional<z.ZodString>;
|
|
626
1991
|
url: z.ZodOptional<z.ZodString>;
|
|
627
1992
|
email: z.ZodOptional<z.ZodString>;
|
|
628
|
-
}, z.
|
|
1993
|
+
}, "strip", z.ZodTypeAny, {
|
|
1994
|
+
email?: string | undefined;
|
|
1995
|
+
url?: string | undefined;
|
|
1996
|
+
name?: string | undefined;
|
|
1997
|
+
}, {
|
|
1998
|
+
email?: string | undefined;
|
|
1999
|
+
url?: string | undefined;
|
|
2000
|
+
name?: string | undefined;
|
|
2001
|
+
}>>;
|
|
629
2002
|
license: z.ZodOptional<z.ZodObject<{
|
|
630
2003
|
name: z.ZodString;
|
|
631
2004
|
url: z.ZodOptional<z.ZodString>;
|
|
632
|
-
}, z.
|
|
633
|
-
|
|
2005
|
+
}, "strip", z.ZodTypeAny, {
|
|
2006
|
+
name: string;
|
|
2007
|
+
url?: string | undefined;
|
|
2008
|
+
}, {
|
|
2009
|
+
name: string;
|
|
2010
|
+
url?: string | undefined;
|
|
2011
|
+
}>>;
|
|
2012
|
+
}, "strip", z.ZodTypeAny, {
|
|
2013
|
+
version: string;
|
|
2014
|
+
title: string;
|
|
2015
|
+
description?: string | undefined;
|
|
2016
|
+
license?: {
|
|
2017
|
+
name: string;
|
|
2018
|
+
url?: string | undefined;
|
|
2019
|
+
} | undefined;
|
|
2020
|
+
termsOfService?: string | undefined;
|
|
2021
|
+
contact?: {
|
|
2022
|
+
email?: string | undefined;
|
|
2023
|
+
url?: string | undefined;
|
|
2024
|
+
name?: string | undefined;
|
|
2025
|
+
} | undefined;
|
|
2026
|
+
}, {
|
|
2027
|
+
version: string;
|
|
2028
|
+
title: string;
|
|
2029
|
+
description?: string | undefined;
|
|
2030
|
+
license?: {
|
|
2031
|
+
name: string;
|
|
2032
|
+
url?: string | undefined;
|
|
2033
|
+
} | undefined;
|
|
2034
|
+
termsOfService?: string | undefined;
|
|
2035
|
+
contact?: {
|
|
2036
|
+
email?: string | undefined;
|
|
2037
|
+
url?: string | undefined;
|
|
2038
|
+
name?: string | undefined;
|
|
2039
|
+
} | undefined;
|
|
2040
|
+
}>;
|
|
2041
|
+
/** Servers */
|
|
634
2042
|
servers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2043
|
+
/** Server URL */
|
|
635
2044
|
url: z.ZodString;
|
|
2045
|
+
/** Server description */
|
|
636
2046
|
description: z.ZodOptional<z.ZodString>;
|
|
2047
|
+
/** Server variables */
|
|
637
2048
|
variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
638
2049
|
default: z.ZodString;
|
|
639
2050
|
description: z.ZodOptional<z.ZodString>;
|
|
640
|
-
enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
641
|
-
}, z.
|
|
642
|
-
|
|
2051
|
+
enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
2052
|
+
}, "strip", z.ZodTypeAny, {
|
|
2053
|
+
default: string;
|
|
2054
|
+
description?: string | undefined;
|
|
2055
|
+
enum?: string[] | undefined;
|
|
2056
|
+
}, {
|
|
2057
|
+
default: string;
|
|
2058
|
+
description?: string | undefined;
|
|
2059
|
+
enum?: string[] | undefined;
|
|
2060
|
+
}>>>;
|
|
2061
|
+
}, "strip", z.ZodTypeAny, {
|
|
2062
|
+
url: string;
|
|
2063
|
+
description?: string | undefined;
|
|
2064
|
+
variables?: Record<string, {
|
|
2065
|
+
default: string;
|
|
2066
|
+
description?: string | undefined;
|
|
2067
|
+
enum?: string[] | undefined;
|
|
2068
|
+
}> | undefined;
|
|
2069
|
+
}, {
|
|
2070
|
+
url: string;
|
|
2071
|
+
description?: string | undefined;
|
|
2072
|
+
variables?: Record<string, {
|
|
2073
|
+
default: string;
|
|
2074
|
+
description?: string | undefined;
|
|
2075
|
+
enum?: string[] | undefined;
|
|
2076
|
+
}> | undefined;
|
|
2077
|
+
}>, "many">>>;
|
|
2078
|
+
/** API paths */
|
|
643
2079
|
paths: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
2080
|
+
/** Reusable components */
|
|
644
2081
|
components: z.ZodOptional<z.ZodObject<{
|
|
645
2082
|
schemas: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
646
2083
|
responses: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
@@ -649,352 +2086,1844 @@ export declare const GeneratedApiDocumentationSchema: z.ZodObject<{
|
|
|
649
2086
|
requestBodies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
650
2087
|
headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
651
2088
|
securitySchemes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
652
|
-
type
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
http: "http";
|
|
656
|
-
openIdConnect: "openIdConnect";
|
|
657
|
-
}>;
|
|
2089
|
+
/** Security scheme type */
|
|
2090
|
+
type: z.ZodEnum<["apiKey", "http", "oauth2", "openIdConnect"]>;
|
|
2091
|
+
/** Scheme name */
|
|
658
2092
|
scheme: z.ZodOptional<z.ZodString>;
|
|
2093
|
+
/** Bearer format */
|
|
659
2094
|
bearerFormat: z.ZodOptional<z.ZodString>;
|
|
2095
|
+
/** API key name */
|
|
660
2096
|
name: z.ZodOptional<z.ZodString>;
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
cookie: "cookie";
|
|
665
|
-
}>>;
|
|
2097
|
+
/** API key location */
|
|
2098
|
+
in: z.ZodOptional<z.ZodEnum<["header", "query", "cookie"]>>;
|
|
2099
|
+
/** OAuth flows */
|
|
666
2100
|
flows: z.ZodOptional<z.ZodObject<{
|
|
667
2101
|
implicit: z.ZodOptional<z.ZodAny>;
|
|
668
2102
|
password: z.ZodOptional<z.ZodAny>;
|
|
669
2103
|
clientCredentials: z.ZodOptional<z.ZodAny>;
|
|
670
2104
|
authorizationCode: z.ZodOptional<z.ZodAny>;
|
|
671
|
-
}, z.
|
|
2105
|
+
}, "strip", z.ZodTypeAny, {
|
|
2106
|
+
password?: any;
|
|
2107
|
+
implicit?: any;
|
|
2108
|
+
clientCredentials?: any;
|
|
2109
|
+
authorizationCode?: any;
|
|
2110
|
+
}, {
|
|
2111
|
+
password?: any;
|
|
2112
|
+
implicit?: any;
|
|
2113
|
+
clientCredentials?: any;
|
|
2114
|
+
authorizationCode?: any;
|
|
2115
|
+
}>>;
|
|
2116
|
+
/** OpenID Connect URL */
|
|
672
2117
|
openIdConnectUrl: z.ZodOptional<z.ZodString>;
|
|
2118
|
+
/** Description */
|
|
673
2119
|
description: z.ZodOptional<z.ZodString>;
|
|
674
|
-
}, z.
|
|
2120
|
+
}, "strip", z.ZodTypeAny, {
|
|
2121
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
2122
|
+
name?: string | undefined;
|
|
2123
|
+
description?: string | undefined;
|
|
2124
|
+
scheme?: string | undefined;
|
|
2125
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
2126
|
+
bearerFormat?: string | undefined;
|
|
2127
|
+
flows?: {
|
|
2128
|
+
password?: any;
|
|
2129
|
+
implicit?: any;
|
|
2130
|
+
clientCredentials?: any;
|
|
2131
|
+
authorizationCode?: any;
|
|
2132
|
+
} | undefined;
|
|
2133
|
+
openIdConnectUrl?: string | undefined;
|
|
2134
|
+
}, {
|
|
2135
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
2136
|
+
name?: string | undefined;
|
|
2137
|
+
description?: string | undefined;
|
|
2138
|
+
scheme?: string | undefined;
|
|
2139
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
2140
|
+
bearerFormat?: string | undefined;
|
|
2141
|
+
flows?: {
|
|
2142
|
+
password?: any;
|
|
2143
|
+
implicit?: any;
|
|
2144
|
+
clientCredentials?: any;
|
|
2145
|
+
authorizationCode?: any;
|
|
2146
|
+
} | undefined;
|
|
2147
|
+
openIdConnectUrl?: string | undefined;
|
|
2148
|
+
}>>>;
|
|
675
2149
|
links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
676
2150
|
callbacks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
677
|
-
}, z.
|
|
678
|
-
|
|
2151
|
+
}, "strip", z.ZodTypeAny, {
|
|
2152
|
+
headers?: Record<string, any> | undefined;
|
|
2153
|
+
parameters?: Record<string, any> | undefined;
|
|
2154
|
+
links?: Record<string, any> | undefined;
|
|
2155
|
+
schemas?: Record<string, any> | undefined;
|
|
2156
|
+
examples?: Record<string, any> | undefined;
|
|
2157
|
+
responses?: Record<string, any> | undefined;
|
|
2158
|
+
requestBodies?: Record<string, any> | undefined;
|
|
2159
|
+
securitySchemes?: Record<string, {
|
|
2160
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
2161
|
+
name?: string | undefined;
|
|
2162
|
+
description?: string | undefined;
|
|
2163
|
+
scheme?: string | undefined;
|
|
2164
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
2165
|
+
bearerFormat?: string | undefined;
|
|
2166
|
+
flows?: {
|
|
2167
|
+
password?: any;
|
|
2168
|
+
implicit?: any;
|
|
2169
|
+
clientCredentials?: any;
|
|
2170
|
+
authorizationCode?: any;
|
|
2171
|
+
} | undefined;
|
|
2172
|
+
openIdConnectUrl?: string | undefined;
|
|
2173
|
+
}> | undefined;
|
|
2174
|
+
callbacks?: Record<string, any> | undefined;
|
|
2175
|
+
}, {
|
|
2176
|
+
headers?: Record<string, any> | undefined;
|
|
2177
|
+
parameters?: Record<string, any> | undefined;
|
|
2178
|
+
links?: Record<string, any> | undefined;
|
|
2179
|
+
schemas?: Record<string, any> | undefined;
|
|
2180
|
+
examples?: Record<string, any> | undefined;
|
|
2181
|
+
responses?: Record<string, any> | undefined;
|
|
2182
|
+
requestBodies?: Record<string, any> | undefined;
|
|
2183
|
+
securitySchemes?: Record<string, {
|
|
2184
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
2185
|
+
name?: string | undefined;
|
|
2186
|
+
description?: string | undefined;
|
|
2187
|
+
scheme?: string | undefined;
|
|
2188
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
2189
|
+
bearerFormat?: string | undefined;
|
|
2190
|
+
flows?: {
|
|
2191
|
+
password?: any;
|
|
2192
|
+
implicit?: any;
|
|
2193
|
+
clientCredentials?: any;
|
|
2194
|
+
authorizationCode?: any;
|
|
2195
|
+
} | undefined;
|
|
2196
|
+
openIdConnectUrl?: string | undefined;
|
|
2197
|
+
}> | undefined;
|
|
2198
|
+
callbacks?: Record<string, any> | undefined;
|
|
2199
|
+
}>>;
|
|
2200
|
+
/** Security requirements */
|
|
2201
|
+
security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>, "many">>;
|
|
2202
|
+
/** Tags */
|
|
679
2203
|
tags: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
680
2204
|
name: z.ZodString;
|
|
681
2205
|
description: z.ZodOptional<z.ZodString>;
|
|
682
2206
|
externalDocs: z.ZodOptional<z.ZodObject<{
|
|
683
2207
|
description: z.ZodOptional<z.ZodString>;
|
|
684
2208
|
url: z.ZodString;
|
|
685
|
-
}, z.
|
|
686
|
-
|
|
2209
|
+
}, "strip", z.ZodTypeAny, {
|
|
2210
|
+
url: string;
|
|
2211
|
+
description?: string | undefined;
|
|
2212
|
+
}, {
|
|
2213
|
+
url: string;
|
|
2214
|
+
description?: string | undefined;
|
|
2215
|
+
}>>;
|
|
2216
|
+
}, "strip", z.ZodTypeAny, {
|
|
2217
|
+
name: string;
|
|
2218
|
+
description?: string | undefined;
|
|
2219
|
+
externalDocs?: {
|
|
2220
|
+
url: string;
|
|
2221
|
+
description?: string | undefined;
|
|
2222
|
+
} | undefined;
|
|
2223
|
+
}, {
|
|
2224
|
+
name: string;
|
|
2225
|
+
description?: string | undefined;
|
|
2226
|
+
externalDocs?: {
|
|
2227
|
+
url: string;
|
|
2228
|
+
description?: string | undefined;
|
|
2229
|
+
} | undefined;
|
|
2230
|
+
}>, "many">>;
|
|
2231
|
+
/** External documentation */
|
|
687
2232
|
externalDocs: z.ZodOptional<z.ZodObject<{
|
|
688
2233
|
description: z.ZodOptional<z.ZodString>;
|
|
689
2234
|
url: z.ZodString;
|
|
690
|
-
}, z.
|
|
691
|
-
|
|
2235
|
+
}, "strip", z.ZodTypeAny, {
|
|
2236
|
+
url: string;
|
|
2237
|
+
description?: string | undefined;
|
|
2238
|
+
}, {
|
|
2239
|
+
url: string;
|
|
2240
|
+
description?: string | undefined;
|
|
2241
|
+
}>>;
|
|
2242
|
+
}, "strip", z.ZodTypeAny, {
|
|
2243
|
+
info: {
|
|
2244
|
+
version: string;
|
|
2245
|
+
title: string;
|
|
2246
|
+
description?: string | undefined;
|
|
2247
|
+
license?: {
|
|
2248
|
+
name: string;
|
|
2249
|
+
url?: string | undefined;
|
|
2250
|
+
} | undefined;
|
|
2251
|
+
termsOfService?: string | undefined;
|
|
2252
|
+
contact?: {
|
|
2253
|
+
email?: string | undefined;
|
|
2254
|
+
url?: string | undefined;
|
|
2255
|
+
name?: string | undefined;
|
|
2256
|
+
} | undefined;
|
|
2257
|
+
};
|
|
2258
|
+
paths: Record<string, any>;
|
|
2259
|
+
openapi: string;
|
|
2260
|
+
servers: {
|
|
2261
|
+
url: string;
|
|
2262
|
+
description?: string | undefined;
|
|
2263
|
+
variables?: Record<string, {
|
|
2264
|
+
default: string;
|
|
2265
|
+
description?: string | undefined;
|
|
2266
|
+
enum?: string[] | undefined;
|
|
2267
|
+
}> | undefined;
|
|
2268
|
+
}[];
|
|
2269
|
+
tags?: {
|
|
2270
|
+
name: string;
|
|
2271
|
+
description?: string | undefined;
|
|
2272
|
+
externalDocs?: {
|
|
2273
|
+
url: string;
|
|
2274
|
+
description?: string | undefined;
|
|
2275
|
+
} | undefined;
|
|
2276
|
+
}[] | undefined;
|
|
2277
|
+
components?: {
|
|
2278
|
+
headers?: Record<string, any> | undefined;
|
|
2279
|
+
parameters?: Record<string, any> | undefined;
|
|
2280
|
+
links?: Record<string, any> | undefined;
|
|
2281
|
+
schemas?: Record<string, any> | undefined;
|
|
2282
|
+
examples?: Record<string, any> | undefined;
|
|
2283
|
+
responses?: Record<string, any> | undefined;
|
|
2284
|
+
requestBodies?: Record<string, any> | undefined;
|
|
2285
|
+
securitySchemes?: Record<string, {
|
|
2286
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
2287
|
+
name?: string | undefined;
|
|
2288
|
+
description?: string | undefined;
|
|
2289
|
+
scheme?: string | undefined;
|
|
2290
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
2291
|
+
bearerFormat?: string | undefined;
|
|
2292
|
+
flows?: {
|
|
2293
|
+
password?: any;
|
|
2294
|
+
implicit?: any;
|
|
2295
|
+
clientCredentials?: any;
|
|
2296
|
+
authorizationCode?: any;
|
|
2297
|
+
} | undefined;
|
|
2298
|
+
openIdConnectUrl?: string | undefined;
|
|
2299
|
+
}> | undefined;
|
|
2300
|
+
callbacks?: Record<string, any> | undefined;
|
|
2301
|
+
} | undefined;
|
|
2302
|
+
security?: Record<string, string[]>[] | undefined;
|
|
2303
|
+
externalDocs?: {
|
|
2304
|
+
url: string;
|
|
2305
|
+
description?: string | undefined;
|
|
2306
|
+
} | undefined;
|
|
2307
|
+
}, {
|
|
2308
|
+
info: {
|
|
2309
|
+
version: string;
|
|
2310
|
+
title: string;
|
|
2311
|
+
description?: string | undefined;
|
|
2312
|
+
license?: {
|
|
2313
|
+
name: string;
|
|
2314
|
+
url?: string | undefined;
|
|
2315
|
+
} | undefined;
|
|
2316
|
+
termsOfService?: string | undefined;
|
|
2317
|
+
contact?: {
|
|
2318
|
+
email?: string | undefined;
|
|
2319
|
+
url?: string | undefined;
|
|
2320
|
+
name?: string | undefined;
|
|
2321
|
+
} | undefined;
|
|
2322
|
+
};
|
|
2323
|
+
paths: Record<string, any>;
|
|
2324
|
+
tags?: {
|
|
2325
|
+
name: string;
|
|
2326
|
+
description?: string | undefined;
|
|
2327
|
+
externalDocs?: {
|
|
2328
|
+
url: string;
|
|
2329
|
+
description?: string | undefined;
|
|
2330
|
+
} | undefined;
|
|
2331
|
+
}[] | undefined;
|
|
2332
|
+
components?: {
|
|
2333
|
+
headers?: Record<string, any> | undefined;
|
|
2334
|
+
parameters?: Record<string, any> | undefined;
|
|
2335
|
+
links?: Record<string, any> | undefined;
|
|
2336
|
+
schemas?: Record<string, any> | undefined;
|
|
2337
|
+
examples?: Record<string, any> | undefined;
|
|
2338
|
+
responses?: Record<string, any> | undefined;
|
|
2339
|
+
requestBodies?: Record<string, any> | undefined;
|
|
2340
|
+
securitySchemes?: Record<string, {
|
|
2341
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
2342
|
+
name?: string | undefined;
|
|
2343
|
+
description?: string | undefined;
|
|
2344
|
+
scheme?: string | undefined;
|
|
2345
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
2346
|
+
bearerFormat?: string | undefined;
|
|
2347
|
+
flows?: {
|
|
2348
|
+
password?: any;
|
|
2349
|
+
implicit?: any;
|
|
2350
|
+
clientCredentials?: any;
|
|
2351
|
+
authorizationCode?: any;
|
|
2352
|
+
} | undefined;
|
|
2353
|
+
openIdConnectUrl?: string | undefined;
|
|
2354
|
+
}> | undefined;
|
|
2355
|
+
callbacks?: Record<string, any> | undefined;
|
|
2356
|
+
} | undefined;
|
|
2357
|
+
security?: Record<string, string[]>[] | undefined;
|
|
2358
|
+
externalDocs?: {
|
|
2359
|
+
url: string;
|
|
2360
|
+
description?: string | undefined;
|
|
2361
|
+
} | undefined;
|
|
2362
|
+
openapi?: string | undefined;
|
|
2363
|
+
servers?: {
|
|
2364
|
+
url: string;
|
|
2365
|
+
description?: string | undefined;
|
|
2366
|
+
variables?: Record<string, {
|
|
2367
|
+
default: string;
|
|
2368
|
+
description?: string | undefined;
|
|
2369
|
+
enum?: string[] | undefined;
|
|
2370
|
+
}> | undefined;
|
|
2371
|
+
}[] | undefined;
|
|
2372
|
+
}>>;
|
|
2373
|
+
/** Test collections */
|
|
692
2374
|
testCollections: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2375
|
+
/** Collection name */
|
|
693
2376
|
name: z.ZodString;
|
|
2377
|
+
/** Collection description */
|
|
694
2378
|
description: z.ZodOptional<z.ZodString>;
|
|
2379
|
+
/** Collection variables */
|
|
695
2380
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
2381
|
+
/** Test requests */
|
|
696
2382
|
requests: z.ZodArray<z.ZodObject<{
|
|
2383
|
+
/** Request name */
|
|
697
2384
|
name: z.ZodString;
|
|
2385
|
+
/** Request description */
|
|
698
2386
|
description: z.ZodOptional<z.ZodString>;
|
|
699
|
-
method
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
PUT: "PUT";
|
|
703
|
-
DELETE: "DELETE";
|
|
704
|
-
PATCH: "PATCH";
|
|
705
|
-
HEAD: "HEAD";
|
|
706
|
-
OPTIONS: "OPTIONS";
|
|
707
|
-
}>;
|
|
2387
|
+
/** HTTP method */
|
|
2388
|
+
method: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
|
|
2389
|
+
/** Request URL */
|
|
708
2390
|
url: z.ZodString;
|
|
2391
|
+
/** Request headers */
|
|
709
2392
|
headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
710
|
-
|
|
2393
|
+
/** Query parameters */
|
|
2394
|
+
queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
|
|
2395
|
+
/** Request body */
|
|
711
2396
|
body: z.ZodOptional<z.ZodAny>;
|
|
2397
|
+
/** Environment variables */
|
|
712
2398
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
2399
|
+
/** Expected response */
|
|
713
2400
|
expectedResponse: z.ZodOptional<z.ZodObject<{
|
|
714
2401
|
statusCode: z.ZodNumber;
|
|
715
2402
|
body: z.ZodOptional<z.ZodAny>;
|
|
716
|
-
}, z.
|
|
717
|
-
|
|
2403
|
+
}, "strip", z.ZodTypeAny, {
|
|
2404
|
+
statusCode: number;
|
|
2405
|
+
body?: any;
|
|
2406
|
+
}, {
|
|
2407
|
+
statusCode: number;
|
|
2408
|
+
body?: any;
|
|
2409
|
+
}>>;
|
|
2410
|
+
}, "strip", z.ZodTypeAny, {
|
|
2411
|
+
url: string;
|
|
2412
|
+
name: string;
|
|
2413
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2414
|
+
headers: Record<string, string>;
|
|
2415
|
+
variables: Record<string, any>;
|
|
2416
|
+
queryParams: Record<string, string | number | boolean>;
|
|
2417
|
+
description?: string | undefined;
|
|
2418
|
+
body?: any;
|
|
2419
|
+
expectedResponse?: {
|
|
2420
|
+
statusCode: number;
|
|
2421
|
+
body?: any;
|
|
2422
|
+
} | undefined;
|
|
2423
|
+
}, {
|
|
2424
|
+
url: string;
|
|
2425
|
+
name: string;
|
|
2426
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2427
|
+
description?: string | undefined;
|
|
2428
|
+
headers?: Record<string, string> | undefined;
|
|
2429
|
+
body?: any;
|
|
2430
|
+
variables?: Record<string, any> | undefined;
|
|
2431
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
2432
|
+
expectedResponse?: {
|
|
2433
|
+
statusCode: number;
|
|
2434
|
+
body?: any;
|
|
2435
|
+
} | undefined;
|
|
2436
|
+
}>, "many">;
|
|
2437
|
+
/** Folders/grouping */
|
|
718
2438
|
folders: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
719
2439
|
name: z.ZodString;
|
|
720
2440
|
description: z.ZodOptional<z.ZodString>;
|
|
721
2441
|
requests: z.ZodArray<z.ZodObject<{
|
|
2442
|
+
/** Request name */
|
|
722
2443
|
name: z.ZodString;
|
|
2444
|
+
/** Request description */
|
|
723
2445
|
description: z.ZodOptional<z.ZodString>;
|
|
724
|
-
method
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
PUT: "PUT";
|
|
728
|
-
DELETE: "DELETE";
|
|
729
|
-
PATCH: "PATCH";
|
|
730
|
-
HEAD: "HEAD";
|
|
731
|
-
OPTIONS: "OPTIONS";
|
|
732
|
-
}>;
|
|
2446
|
+
/** HTTP method */
|
|
2447
|
+
method: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
|
|
2448
|
+
/** Request URL */
|
|
733
2449
|
url: z.ZodString;
|
|
2450
|
+
/** Request headers */
|
|
734
2451
|
headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
735
|
-
|
|
2452
|
+
/** Query parameters */
|
|
2453
|
+
queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
|
|
2454
|
+
/** Request body */
|
|
736
2455
|
body: z.ZodOptional<z.ZodAny>;
|
|
2456
|
+
/** Environment variables */
|
|
737
2457
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
2458
|
+
/** Expected response */
|
|
738
2459
|
expectedResponse: z.ZodOptional<z.ZodObject<{
|
|
739
2460
|
statusCode: z.ZodNumber;
|
|
740
2461
|
body: z.ZodOptional<z.ZodAny>;
|
|
741
|
-
}, z.
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
2462
|
+
}, "strip", z.ZodTypeAny, {
|
|
2463
|
+
statusCode: number;
|
|
2464
|
+
body?: any;
|
|
2465
|
+
}, {
|
|
2466
|
+
statusCode: number;
|
|
2467
|
+
body?: any;
|
|
2468
|
+
}>>;
|
|
2469
|
+
}, "strip", z.ZodTypeAny, {
|
|
2470
|
+
url: string;
|
|
2471
|
+
name: string;
|
|
2472
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2473
|
+
headers: Record<string, string>;
|
|
2474
|
+
variables: Record<string, any>;
|
|
2475
|
+
queryParams: Record<string, string | number | boolean>;
|
|
2476
|
+
description?: string | undefined;
|
|
2477
|
+
body?: any;
|
|
2478
|
+
expectedResponse?: {
|
|
2479
|
+
statusCode: number;
|
|
2480
|
+
body?: any;
|
|
2481
|
+
} | undefined;
|
|
2482
|
+
}, {
|
|
2483
|
+
url: string;
|
|
2484
|
+
name: string;
|
|
2485
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2486
|
+
description?: string | undefined;
|
|
2487
|
+
headers?: Record<string, string> | undefined;
|
|
2488
|
+
body?: any;
|
|
2489
|
+
variables?: Record<string, any> | undefined;
|
|
2490
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
2491
|
+
expectedResponse?: {
|
|
2492
|
+
statusCode: number;
|
|
2493
|
+
body?: any;
|
|
2494
|
+
} | undefined;
|
|
2495
|
+
}>, "many">;
|
|
2496
|
+
}, "strip", z.ZodTypeAny, {
|
|
2497
|
+
name: string;
|
|
2498
|
+
requests: {
|
|
2499
|
+
url: string;
|
|
2500
|
+
name: string;
|
|
2501
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2502
|
+
headers: Record<string, string>;
|
|
2503
|
+
variables: Record<string, any>;
|
|
2504
|
+
queryParams: Record<string, string | number | boolean>;
|
|
2505
|
+
description?: string | undefined;
|
|
2506
|
+
body?: any;
|
|
2507
|
+
expectedResponse?: {
|
|
2508
|
+
statusCode: number;
|
|
2509
|
+
body?: any;
|
|
2510
|
+
} | undefined;
|
|
2511
|
+
}[];
|
|
2512
|
+
description?: string | undefined;
|
|
2513
|
+
}, {
|
|
2514
|
+
name: string;
|
|
2515
|
+
requests: {
|
|
2516
|
+
url: string;
|
|
2517
|
+
name: string;
|
|
2518
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2519
|
+
description?: string | undefined;
|
|
2520
|
+
headers?: Record<string, string> | undefined;
|
|
2521
|
+
body?: any;
|
|
2522
|
+
variables?: Record<string, any> | undefined;
|
|
2523
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
2524
|
+
expectedResponse?: {
|
|
2525
|
+
statusCode: number;
|
|
2526
|
+
body?: any;
|
|
2527
|
+
} | undefined;
|
|
2528
|
+
}[];
|
|
2529
|
+
description?: string | undefined;
|
|
2530
|
+
}>, "many">>;
|
|
2531
|
+
}, "strip", z.ZodTypeAny, {
|
|
2532
|
+
name: string;
|
|
2533
|
+
requests: {
|
|
2534
|
+
url: string;
|
|
2535
|
+
name: string;
|
|
2536
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2537
|
+
headers: Record<string, string>;
|
|
2538
|
+
variables: Record<string, any>;
|
|
2539
|
+
queryParams: Record<string, string | number | boolean>;
|
|
2540
|
+
description?: string | undefined;
|
|
2541
|
+
body?: any;
|
|
2542
|
+
expectedResponse?: {
|
|
2543
|
+
statusCode: number;
|
|
2544
|
+
body?: any;
|
|
2545
|
+
} | undefined;
|
|
2546
|
+
}[];
|
|
2547
|
+
variables: Record<string, any>;
|
|
2548
|
+
description?: string | undefined;
|
|
2549
|
+
folders?: {
|
|
2550
|
+
name: string;
|
|
2551
|
+
requests: {
|
|
2552
|
+
url: string;
|
|
2553
|
+
name: string;
|
|
2554
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2555
|
+
headers: Record<string, string>;
|
|
2556
|
+
variables: Record<string, any>;
|
|
2557
|
+
queryParams: Record<string, string | number | boolean>;
|
|
2558
|
+
description?: string | undefined;
|
|
2559
|
+
body?: any;
|
|
2560
|
+
expectedResponse?: {
|
|
2561
|
+
statusCode: number;
|
|
2562
|
+
body?: any;
|
|
2563
|
+
} | undefined;
|
|
2564
|
+
}[];
|
|
2565
|
+
description?: string | undefined;
|
|
2566
|
+
}[] | undefined;
|
|
2567
|
+
}, {
|
|
2568
|
+
name: string;
|
|
2569
|
+
requests: {
|
|
2570
|
+
url: string;
|
|
2571
|
+
name: string;
|
|
2572
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2573
|
+
description?: string | undefined;
|
|
2574
|
+
headers?: Record<string, string> | undefined;
|
|
2575
|
+
body?: any;
|
|
2576
|
+
variables?: Record<string, any> | undefined;
|
|
2577
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
2578
|
+
expectedResponse?: {
|
|
2579
|
+
statusCode: number;
|
|
2580
|
+
body?: any;
|
|
2581
|
+
} | undefined;
|
|
2582
|
+
}[];
|
|
2583
|
+
description?: string | undefined;
|
|
2584
|
+
variables?: Record<string, any> | undefined;
|
|
2585
|
+
folders?: {
|
|
2586
|
+
name: string;
|
|
2587
|
+
requests: {
|
|
2588
|
+
url: string;
|
|
2589
|
+
name: string;
|
|
2590
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2591
|
+
description?: string | undefined;
|
|
2592
|
+
headers?: Record<string, string> | undefined;
|
|
2593
|
+
body?: any;
|
|
2594
|
+
variables?: Record<string, any> | undefined;
|
|
2595
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
2596
|
+
expectedResponse?: {
|
|
2597
|
+
statusCode: number;
|
|
2598
|
+
body?: any;
|
|
2599
|
+
} | undefined;
|
|
2600
|
+
}[];
|
|
2601
|
+
description?: string | undefined;
|
|
2602
|
+
}[] | undefined;
|
|
2603
|
+
}>, "many">>;
|
|
2604
|
+
/** Markdown documentation */
|
|
745
2605
|
markdown: z.ZodOptional<z.ZodString>;
|
|
2606
|
+
/** HTML documentation */
|
|
746
2607
|
html: z.ZodOptional<z.ZodString>;
|
|
2608
|
+
/** Generation timestamp */
|
|
747
2609
|
generatedAt: z.ZodString;
|
|
748
|
-
|
|
749
|
-
|
|
2610
|
+
/** Source APIs */
|
|
2611
|
+
sourceApis: z.ZodArray<z.ZodString, "many">;
|
|
2612
|
+
}, "strip", z.ZodTypeAny, {
|
|
2613
|
+
generatedAt: string;
|
|
2614
|
+
sourceApis: string[];
|
|
2615
|
+
markdown?: string | undefined;
|
|
2616
|
+
html?: string | undefined;
|
|
2617
|
+
testCollections?: {
|
|
2618
|
+
name: string;
|
|
2619
|
+
requests: {
|
|
2620
|
+
url: string;
|
|
2621
|
+
name: string;
|
|
2622
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2623
|
+
headers: Record<string, string>;
|
|
2624
|
+
variables: Record<string, any>;
|
|
2625
|
+
queryParams: Record<string, string | number | boolean>;
|
|
2626
|
+
description?: string | undefined;
|
|
2627
|
+
body?: any;
|
|
2628
|
+
expectedResponse?: {
|
|
2629
|
+
statusCode: number;
|
|
2630
|
+
body?: any;
|
|
2631
|
+
} | undefined;
|
|
2632
|
+
}[];
|
|
2633
|
+
variables: Record<string, any>;
|
|
2634
|
+
description?: string | undefined;
|
|
2635
|
+
folders?: {
|
|
2636
|
+
name: string;
|
|
2637
|
+
requests: {
|
|
2638
|
+
url: string;
|
|
2639
|
+
name: string;
|
|
2640
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2641
|
+
headers: Record<string, string>;
|
|
2642
|
+
variables: Record<string, any>;
|
|
2643
|
+
queryParams: Record<string, string | number | boolean>;
|
|
2644
|
+
description?: string | undefined;
|
|
2645
|
+
body?: any;
|
|
2646
|
+
expectedResponse?: {
|
|
2647
|
+
statusCode: number;
|
|
2648
|
+
body?: any;
|
|
2649
|
+
} | undefined;
|
|
2650
|
+
}[];
|
|
2651
|
+
description?: string | undefined;
|
|
2652
|
+
}[] | undefined;
|
|
2653
|
+
}[] | undefined;
|
|
2654
|
+
openApiSpec?: {
|
|
2655
|
+
info: {
|
|
2656
|
+
version: string;
|
|
2657
|
+
title: string;
|
|
2658
|
+
description?: string | undefined;
|
|
2659
|
+
license?: {
|
|
2660
|
+
name: string;
|
|
2661
|
+
url?: string | undefined;
|
|
2662
|
+
} | undefined;
|
|
2663
|
+
termsOfService?: string | undefined;
|
|
2664
|
+
contact?: {
|
|
2665
|
+
email?: string | undefined;
|
|
2666
|
+
url?: string | undefined;
|
|
2667
|
+
name?: string | undefined;
|
|
2668
|
+
} | undefined;
|
|
2669
|
+
};
|
|
2670
|
+
paths: Record<string, any>;
|
|
2671
|
+
openapi: string;
|
|
2672
|
+
servers: {
|
|
2673
|
+
url: string;
|
|
2674
|
+
description?: string | undefined;
|
|
2675
|
+
variables?: Record<string, {
|
|
2676
|
+
default: string;
|
|
2677
|
+
description?: string | undefined;
|
|
2678
|
+
enum?: string[] | undefined;
|
|
2679
|
+
}> | undefined;
|
|
2680
|
+
}[];
|
|
2681
|
+
tags?: {
|
|
2682
|
+
name: string;
|
|
2683
|
+
description?: string | undefined;
|
|
2684
|
+
externalDocs?: {
|
|
2685
|
+
url: string;
|
|
2686
|
+
description?: string | undefined;
|
|
2687
|
+
} | undefined;
|
|
2688
|
+
}[] | undefined;
|
|
2689
|
+
components?: {
|
|
2690
|
+
headers?: Record<string, any> | undefined;
|
|
2691
|
+
parameters?: Record<string, any> | undefined;
|
|
2692
|
+
links?: Record<string, any> | undefined;
|
|
2693
|
+
schemas?: Record<string, any> | undefined;
|
|
2694
|
+
examples?: Record<string, any> | undefined;
|
|
2695
|
+
responses?: Record<string, any> | undefined;
|
|
2696
|
+
requestBodies?: Record<string, any> | undefined;
|
|
2697
|
+
securitySchemes?: Record<string, {
|
|
2698
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
2699
|
+
name?: string | undefined;
|
|
2700
|
+
description?: string | undefined;
|
|
2701
|
+
scheme?: string | undefined;
|
|
2702
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
2703
|
+
bearerFormat?: string | undefined;
|
|
2704
|
+
flows?: {
|
|
2705
|
+
password?: any;
|
|
2706
|
+
implicit?: any;
|
|
2707
|
+
clientCredentials?: any;
|
|
2708
|
+
authorizationCode?: any;
|
|
2709
|
+
} | undefined;
|
|
2710
|
+
openIdConnectUrl?: string | undefined;
|
|
2711
|
+
}> | undefined;
|
|
2712
|
+
callbacks?: Record<string, any> | undefined;
|
|
2713
|
+
} | undefined;
|
|
2714
|
+
security?: Record<string, string[]>[] | undefined;
|
|
2715
|
+
externalDocs?: {
|
|
2716
|
+
url: string;
|
|
2717
|
+
description?: string | undefined;
|
|
2718
|
+
} | undefined;
|
|
2719
|
+
} | undefined;
|
|
2720
|
+
}, {
|
|
2721
|
+
generatedAt: string;
|
|
2722
|
+
sourceApis: string[];
|
|
2723
|
+
markdown?: string | undefined;
|
|
2724
|
+
html?: string | undefined;
|
|
2725
|
+
testCollections?: {
|
|
2726
|
+
name: string;
|
|
2727
|
+
requests: {
|
|
2728
|
+
url: string;
|
|
2729
|
+
name: string;
|
|
2730
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2731
|
+
description?: string | undefined;
|
|
2732
|
+
headers?: Record<string, string> | undefined;
|
|
2733
|
+
body?: any;
|
|
2734
|
+
variables?: Record<string, any> | undefined;
|
|
2735
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
2736
|
+
expectedResponse?: {
|
|
2737
|
+
statusCode: number;
|
|
2738
|
+
body?: any;
|
|
2739
|
+
} | undefined;
|
|
2740
|
+
}[];
|
|
2741
|
+
description?: string | undefined;
|
|
2742
|
+
variables?: Record<string, any> | undefined;
|
|
2743
|
+
folders?: {
|
|
2744
|
+
name: string;
|
|
2745
|
+
requests: {
|
|
2746
|
+
url: string;
|
|
2747
|
+
name: string;
|
|
2748
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
2749
|
+
description?: string | undefined;
|
|
2750
|
+
headers?: Record<string, string> | undefined;
|
|
2751
|
+
body?: any;
|
|
2752
|
+
variables?: Record<string, any> | undefined;
|
|
2753
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
2754
|
+
expectedResponse?: {
|
|
2755
|
+
statusCode: number;
|
|
2756
|
+
body?: any;
|
|
2757
|
+
} | undefined;
|
|
2758
|
+
}[];
|
|
2759
|
+
description?: string | undefined;
|
|
2760
|
+
}[] | undefined;
|
|
2761
|
+
}[] | undefined;
|
|
2762
|
+
openApiSpec?: {
|
|
2763
|
+
info: {
|
|
2764
|
+
version: string;
|
|
2765
|
+
title: string;
|
|
2766
|
+
description?: string | undefined;
|
|
2767
|
+
license?: {
|
|
2768
|
+
name: string;
|
|
2769
|
+
url?: string | undefined;
|
|
2770
|
+
} | undefined;
|
|
2771
|
+
termsOfService?: string | undefined;
|
|
2772
|
+
contact?: {
|
|
2773
|
+
email?: string | undefined;
|
|
2774
|
+
url?: string | undefined;
|
|
2775
|
+
name?: string | undefined;
|
|
2776
|
+
} | undefined;
|
|
2777
|
+
};
|
|
2778
|
+
paths: Record<string, any>;
|
|
2779
|
+
tags?: {
|
|
2780
|
+
name: string;
|
|
2781
|
+
description?: string | undefined;
|
|
2782
|
+
externalDocs?: {
|
|
2783
|
+
url: string;
|
|
2784
|
+
description?: string | undefined;
|
|
2785
|
+
} | undefined;
|
|
2786
|
+
}[] | undefined;
|
|
2787
|
+
components?: {
|
|
2788
|
+
headers?: Record<string, any> | undefined;
|
|
2789
|
+
parameters?: Record<string, any> | undefined;
|
|
2790
|
+
links?: Record<string, any> | undefined;
|
|
2791
|
+
schemas?: Record<string, any> | undefined;
|
|
2792
|
+
examples?: Record<string, any> | undefined;
|
|
2793
|
+
responses?: Record<string, any> | undefined;
|
|
2794
|
+
requestBodies?: Record<string, any> | undefined;
|
|
2795
|
+
securitySchemes?: Record<string, {
|
|
2796
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
2797
|
+
name?: string | undefined;
|
|
2798
|
+
description?: string | undefined;
|
|
2799
|
+
scheme?: string | undefined;
|
|
2800
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
2801
|
+
bearerFormat?: string | undefined;
|
|
2802
|
+
flows?: {
|
|
2803
|
+
password?: any;
|
|
2804
|
+
implicit?: any;
|
|
2805
|
+
clientCredentials?: any;
|
|
2806
|
+
authorizationCode?: any;
|
|
2807
|
+
} | undefined;
|
|
2808
|
+
openIdConnectUrl?: string | undefined;
|
|
2809
|
+
}> | undefined;
|
|
2810
|
+
callbacks?: Record<string, any> | undefined;
|
|
2811
|
+
} | undefined;
|
|
2812
|
+
security?: Record<string, string[]>[] | undefined;
|
|
2813
|
+
externalDocs?: {
|
|
2814
|
+
url: string;
|
|
2815
|
+
description?: string | undefined;
|
|
2816
|
+
} | undefined;
|
|
2817
|
+
openapi?: string | undefined;
|
|
2818
|
+
servers?: {
|
|
2819
|
+
url: string;
|
|
2820
|
+
description?: string | undefined;
|
|
2821
|
+
variables?: Record<string, {
|
|
2822
|
+
default: string;
|
|
2823
|
+
description?: string | undefined;
|
|
2824
|
+
enum?: string[] | undefined;
|
|
2825
|
+
}> | undefined;
|
|
2826
|
+
}[] | undefined;
|
|
2827
|
+
} | undefined;
|
|
2828
|
+
}>;
|
|
750
2829
|
export type GeneratedApiDocumentation = z.infer<typeof GeneratedApiDocumentationSchema>;
|
|
751
2830
|
/**
|
|
752
2831
|
* Helper to create API documentation config
|
|
753
2832
|
*/
|
|
754
2833
|
export declare const ApiDocumentationConfig: z.ZodObject<{
|
|
2834
|
+
/** Enable documentation */
|
|
755
2835
|
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
2836
|
+
/** Documentation title */
|
|
756
2837
|
title: z.ZodDefault<z.ZodString>;
|
|
2838
|
+
/** API version */
|
|
757
2839
|
version: z.ZodString;
|
|
2840
|
+
/** API description */
|
|
758
2841
|
description: z.ZodOptional<z.ZodString>;
|
|
2842
|
+
/** Server configurations */
|
|
759
2843
|
servers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2844
|
+
/** Server URL */
|
|
760
2845
|
url: z.ZodString;
|
|
2846
|
+
/** Server description */
|
|
761
2847
|
description: z.ZodOptional<z.ZodString>;
|
|
2848
|
+
/** Server variables */
|
|
762
2849
|
variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
763
2850
|
default: z.ZodString;
|
|
764
2851
|
description: z.ZodOptional<z.ZodString>;
|
|
765
|
-
enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
766
|
-
}, z.
|
|
767
|
-
|
|
2852
|
+
enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
2853
|
+
}, "strip", z.ZodTypeAny, {
|
|
2854
|
+
default: string;
|
|
2855
|
+
description?: string | undefined;
|
|
2856
|
+
enum?: string[] | undefined;
|
|
2857
|
+
}, {
|
|
2858
|
+
default: string;
|
|
2859
|
+
description?: string | undefined;
|
|
2860
|
+
enum?: string[] | undefined;
|
|
2861
|
+
}>>>;
|
|
2862
|
+
}, "strip", z.ZodTypeAny, {
|
|
2863
|
+
url: string;
|
|
2864
|
+
description?: string | undefined;
|
|
2865
|
+
variables?: Record<string, {
|
|
2866
|
+
default: string;
|
|
2867
|
+
description?: string | undefined;
|
|
2868
|
+
enum?: string[] | undefined;
|
|
2869
|
+
}> | undefined;
|
|
2870
|
+
}, {
|
|
2871
|
+
url: string;
|
|
2872
|
+
description?: string | undefined;
|
|
2873
|
+
variables?: Record<string, {
|
|
2874
|
+
default: string;
|
|
2875
|
+
description?: string | undefined;
|
|
2876
|
+
enum?: string[] | undefined;
|
|
2877
|
+
}> | undefined;
|
|
2878
|
+
}>, "many">>>;
|
|
2879
|
+
/** UI configuration */
|
|
768
2880
|
ui: z.ZodOptional<z.ZodObject<{
|
|
769
|
-
type
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
redoc: "redoc";
|
|
773
|
-
rapidoc: "rapidoc";
|
|
774
|
-
stoplight: "stoplight";
|
|
775
|
-
scalar: "scalar";
|
|
776
|
-
"graphql-playground": "graphql-playground";
|
|
777
|
-
graphiql: "graphiql";
|
|
778
|
-
postman: "postman";
|
|
779
|
-
}>;
|
|
2881
|
+
/** UI type */
|
|
2882
|
+
type: z.ZodEnum<["swagger-ui", "redoc", "rapidoc", "stoplight", "scalar", "graphql-playground", "graphiql", "postman", "custom"]>;
|
|
2883
|
+
/** UI path */
|
|
780
2884
|
path: z.ZodDefault<z.ZodString>;
|
|
781
|
-
theme
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
dark: "dark";
|
|
785
|
-
}>>;
|
|
2885
|
+
/** UI theme */
|
|
2886
|
+
theme: z.ZodDefault<z.ZodEnum<["light", "dark", "auto"]>>;
|
|
2887
|
+
/** Enable try-it-out feature */
|
|
786
2888
|
enableTryItOut: z.ZodDefault<z.ZodBoolean>;
|
|
2889
|
+
/** Enable filtering */
|
|
787
2890
|
enableFilter: z.ZodDefault<z.ZodBoolean>;
|
|
2891
|
+
/** Enable CORS for testing */
|
|
788
2892
|
enableCors: z.ZodDefault<z.ZodBoolean>;
|
|
2893
|
+
/** Default expand depth for models */
|
|
789
2894
|
defaultModelsExpandDepth: z.ZodDefault<z.ZodNumber>;
|
|
2895
|
+
/** Display request duration */
|
|
790
2896
|
displayRequestDuration: z.ZodDefault<z.ZodBoolean>;
|
|
2897
|
+
/** Syntax highlighting */
|
|
791
2898
|
syntaxHighlighting: z.ZodDefault<z.ZodBoolean>;
|
|
2899
|
+
/** Custom CSS URL */
|
|
792
2900
|
customCssUrl: z.ZodOptional<z.ZodString>;
|
|
2901
|
+
/** Custom JavaScript URL */
|
|
793
2902
|
customJsUrl: z.ZodOptional<z.ZodString>;
|
|
2903
|
+
/** Layout options */
|
|
794
2904
|
layout: z.ZodOptional<z.ZodObject<{
|
|
795
2905
|
showExtensions: z.ZodDefault<z.ZodBoolean>;
|
|
796
2906
|
showCommonExtensions: z.ZodDefault<z.ZodBoolean>;
|
|
797
2907
|
deepLinking: z.ZodDefault<z.ZodBoolean>;
|
|
798
2908
|
displayOperationId: z.ZodDefault<z.ZodBoolean>;
|
|
799
|
-
defaultModelRendering: z.ZodDefault<z.ZodEnum<
|
|
800
|
-
model: "model";
|
|
801
|
-
example: "example";
|
|
802
|
-
}>>;
|
|
2909
|
+
defaultModelRendering: z.ZodDefault<z.ZodEnum<["example", "model"]>>;
|
|
803
2910
|
defaultModelsExpandDepth: z.ZodDefault<z.ZodNumber>;
|
|
804
2911
|
defaultModelExpandDepth: z.ZodDefault<z.ZodNumber>;
|
|
805
|
-
docExpansion: z.ZodDefault<z.ZodEnum<
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
2912
|
+
docExpansion: z.ZodDefault<z.ZodEnum<["list", "full", "none"]>>;
|
|
2913
|
+
}, "strip", z.ZodTypeAny, {
|
|
2914
|
+
defaultModelsExpandDepth: number;
|
|
2915
|
+
showExtensions: boolean;
|
|
2916
|
+
showCommonExtensions: boolean;
|
|
2917
|
+
deepLinking: boolean;
|
|
2918
|
+
displayOperationId: boolean;
|
|
2919
|
+
defaultModelRendering: "model" | "example";
|
|
2920
|
+
defaultModelExpandDepth: number;
|
|
2921
|
+
docExpansion: "full" | "list" | "none";
|
|
2922
|
+
}, {
|
|
2923
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
2924
|
+
showExtensions?: boolean | undefined;
|
|
2925
|
+
showCommonExtensions?: boolean | undefined;
|
|
2926
|
+
deepLinking?: boolean | undefined;
|
|
2927
|
+
displayOperationId?: boolean | undefined;
|
|
2928
|
+
defaultModelRendering?: "model" | "example" | undefined;
|
|
2929
|
+
defaultModelExpandDepth?: number | undefined;
|
|
2930
|
+
docExpansion?: "full" | "list" | "none" | undefined;
|
|
2931
|
+
}>>;
|
|
2932
|
+
}, "strip", z.ZodTypeAny, {
|
|
2933
|
+
path: string;
|
|
2934
|
+
type: "custom" | "swagger-ui" | "redoc" | "rapidoc" | "stoplight" | "scalar" | "graphql-playground" | "graphiql" | "postman";
|
|
2935
|
+
theme: "auto" | "light" | "dark";
|
|
2936
|
+
enableTryItOut: boolean;
|
|
2937
|
+
enableFilter: boolean;
|
|
2938
|
+
enableCors: boolean;
|
|
2939
|
+
defaultModelsExpandDepth: number;
|
|
2940
|
+
displayRequestDuration: boolean;
|
|
2941
|
+
syntaxHighlighting: boolean;
|
|
2942
|
+
layout?: {
|
|
2943
|
+
defaultModelsExpandDepth: number;
|
|
2944
|
+
showExtensions: boolean;
|
|
2945
|
+
showCommonExtensions: boolean;
|
|
2946
|
+
deepLinking: boolean;
|
|
2947
|
+
displayOperationId: boolean;
|
|
2948
|
+
defaultModelRendering: "model" | "example";
|
|
2949
|
+
defaultModelExpandDepth: number;
|
|
2950
|
+
docExpansion: "full" | "list" | "none";
|
|
2951
|
+
} | undefined;
|
|
2952
|
+
customCssUrl?: string | undefined;
|
|
2953
|
+
customJsUrl?: string | undefined;
|
|
2954
|
+
}, {
|
|
2955
|
+
type: "custom" | "swagger-ui" | "redoc" | "rapidoc" | "stoplight" | "scalar" | "graphql-playground" | "graphiql" | "postman";
|
|
2956
|
+
path?: string | undefined;
|
|
2957
|
+
theme?: "auto" | "light" | "dark" | undefined;
|
|
2958
|
+
layout?: {
|
|
2959
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
2960
|
+
showExtensions?: boolean | undefined;
|
|
2961
|
+
showCommonExtensions?: boolean | undefined;
|
|
2962
|
+
deepLinking?: boolean | undefined;
|
|
2963
|
+
displayOperationId?: boolean | undefined;
|
|
2964
|
+
defaultModelRendering?: "model" | "example" | undefined;
|
|
2965
|
+
defaultModelExpandDepth?: number | undefined;
|
|
2966
|
+
docExpansion?: "full" | "list" | "none" | undefined;
|
|
2967
|
+
} | undefined;
|
|
2968
|
+
enableTryItOut?: boolean | undefined;
|
|
2969
|
+
enableFilter?: boolean | undefined;
|
|
2970
|
+
enableCors?: boolean | undefined;
|
|
2971
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
2972
|
+
displayRequestDuration?: boolean | undefined;
|
|
2973
|
+
syntaxHighlighting?: boolean | undefined;
|
|
2974
|
+
customCssUrl?: string | undefined;
|
|
2975
|
+
customJsUrl?: string | undefined;
|
|
2976
|
+
}>>;
|
|
2977
|
+
/** Generate OpenAPI spec */
|
|
812
2978
|
generateOpenApi: z.ZodDefault<z.ZodBoolean>;
|
|
2979
|
+
/** Generate test collections */
|
|
813
2980
|
generateTestCollections: z.ZodDefault<z.ZodBoolean>;
|
|
2981
|
+
/** Test collections */
|
|
814
2982
|
testCollections: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2983
|
+
/** Collection name */
|
|
815
2984
|
name: z.ZodString;
|
|
2985
|
+
/** Collection description */
|
|
816
2986
|
description: z.ZodOptional<z.ZodString>;
|
|
2987
|
+
/** Collection variables */
|
|
817
2988
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
2989
|
+
/** Test requests */
|
|
818
2990
|
requests: z.ZodArray<z.ZodObject<{
|
|
2991
|
+
/** Request name */
|
|
819
2992
|
name: z.ZodString;
|
|
2993
|
+
/** Request description */
|
|
820
2994
|
description: z.ZodOptional<z.ZodString>;
|
|
821
|
-
method
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
PUT: "PUT";
|
|
825
|
-
DELETE: "DELETE";
|
|
826
|
-
PATCH: "PATCH";
|
|
827
|
-
HEAD: "HEAD";
|
|
828
|
-
OPTIONS: "OPTIONS";
|
|
829
|
-
}>;
|
|
2995
|
+
/** HTTP method */
|
|
2996
|
+
method: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
|
|
2997
|
+
/** Request URL */
|
|
830
2998
|
url: z.ZodString;
|
|
2999
|
+
/** Request headers */
|
|
831
3000
|
headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
832
|
-
|
|
3001
|
+
/** Query parameters */
|
|
3002
|
+
queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
|
|
3003
|
+
/** Request body */
|
|
833
3004
|
body: z.ZodOptional<z.ZodAny>;
|
|
3005
|
+
/** Environment variables */
|
|
834
3006
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
3007
|
+
/** Expected response */
|
|
835
3008
|
expectedResponse: z.ZodOptional<z.ZodObject<{
|
|
836
3009
|
statusCode: z.ZodNumber;
|
|
837
3010
|
body: z.ZodOptional<z.ZodAny>;
|
|
838
|
-
}, z.
|
|
839
|
-
|
|
3011
|
+
}, "strip", z.ZodTypeAny, {
|
|
3012
|
+
statusCode: number;
|
|
3013
|
+
body?: any;
|
|
3014
|
+
}, {
|
|
3015
|
+
statusCode: number;
|
|
3016
|
+
body?: any;
|
|
3017
|
+
}>>;
|
|
3018
|
+
}, "strip", z.ZodTypeAny, {
|
|
3019
|
+
url: string;
|
|
3020
|
+
name: string;
|
|
3021
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3022
|
+
headers: Record<string, string>;
|
|
3023
|
+
variables: Record<string, any>;
|
|
3024
|
+
queryParams: Record<string, string | number | boolean>;
|
|
3025
|
+
description?: string | undefined;
|
|
3026
|
+
body?: any;
|
|
3027
|
+
expectedResponse?: {
|
|
3028
|
+
statusCode: number;
|
|
3029
|
+
body?: any;
|
|
3030
|
+
} | undefined;
|
|
3031
|
+
}, {
|
|
3032
|
+
url: string;
|
|
3033
|
+
name: string;
|
|
3034
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3035
|
+
description?: string | undefined;
|
|
3036
|
+
headers?: Record<string, string> | undefined;
|
|
3037
|
+
body?: any;
|
|
3038
|
+
variables?: Record<string, any> | undefined;
|
|
3039
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
3040
|
+
expectedResponse?: {
|
|
3041
|
+
statusCode: number;
|
|
3042
|
+
body?: any;
|
|
3043
|
+
} | undefined;
|
|
3044
|
+
}>, "many">;
|
|
3045
|
+
/** Folders/grouping */
|
|
840
3046
|
folders: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
841
3047
|
name: z.ZodString;
|
|
842
3048
|
description: z.ZodOptional<z.ZodString>;
|
|
843
3049
|
requests: z.ZodArray<z.ZodObject<{
|
|
3050
|
+
/** Request name */
|
|
844
3051
|
name: z.ZodString;
|
|
3052
|
+
/** Request description */
|
|
845
3053
|
description: z.ZodOptional<z.ZodString>;
|
|
846
|
-
method
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
PUT: "PUT";
|
|
850
|
-
DELETE: "DELETE";
|
|
851
|
-
PATCH: "PATCH";
|
|
852
|
-
HEAD: "HEAD";
|
|
853
|
-
OPTIONS: "OPTIONS";
|
|
854
|
-
}>;
|
|
3054
|
+
/** HTTP method */
|
|
3055
|
+
method: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
|
|
3056
|
+
/** Request URL */
|
|
855
3057
|
url: z.ZodString;
|
|
3058
|
+
/** Request headers */
|
|
856
3059
|
headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
857
|
-
|
|
3060
|
+
/** Query parameters */
|
|
3061
|
+
queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
|
|
3062
|
+
/** Request body */
|
|
858
3063
|
body: z.ZodOptional<z.ZodAny>;
|
|
3064
|
+
/** Environment variables */
|
|
859
3065
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
3066
|
+
/** Expected response */
|
|
860
3067
|
expectedResponse: z.ZodOptional<z.ZodObject<{
|
|
861
3068
|
statusCode: z.ZodNumber;
|
|
862
3069
|
body: z.ZodOptional<z.ZodAny>;
|
|
863
|
-
}, z.
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
3070
|
+
}, "strip", z.ZodTypeAny, {
|
|
3071
|
+
statusCode: number;
|
|
3072
|
+
body?: any;
|
|
3073
|
+
}, {
|
|
3074
|
+
statusCode: number;
|
|
3075
|
+
body?: any;
|
|
3076
|
+
}>>;
|
|
3077
|
+
}, "strip", z.ZodTypeAny, {
|
|
3078
|
+
url: string;
|
|
3079
|
+
name: string;
|
|
3080
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3081
|
+
headers: Record<string, string>;
|
|
3082
|
+
variables: Record<string, any>;
|
|
3083
|
+
queryParams: Record<string, string | number | boolean>;
|
|
3084
|
+
description?: string | undefined;
|
|
3085
|
+
body?: any;
|
|
3086
|
+
expectedResponse?: {
|
|
3087
|
+
statusCode: number;
|
|
3088
|
+
body?: any;
|
|
3089
|
+
} | undefined;
|
|
3090
|
+
}, {
|
|
3091
|
+
url: string;
|
|
3092
|
+
name: string;
|
|
3093
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3094
|
+
description?: string | undefined;
|
|
3095
|
+
headers?: Record<string, string> | undefined;
|
|
3096
|
+
body?: any;
|
|
3097
|
+
variables?: Record<string, any> | undefined;
|
|
3098
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
3099
|
+
expectedResponse?: {
|
|
3100
|
+
statusCode: number;
|
|
3101
|
+
body?: any;
|
|
3102
|
+
} | undefined;
|
|
3103
|
+
}>, "many">;
|
|
3104
|
+
}, "strip", z.ZodTypeAny, {
|
|
3105
|
+
name: string;
|
|
3106
|
+
requests: {
|
|
3107
|
+
url: string;
|
|
3108
|
+
name: string;
|
|
3109
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3110
|
+
headers: Record<string, string>;
|
|
3111
|
+
variables: Record<string, any>;
|
|
3112
|
+
queryParams: Record<string, string | number | boolean>;
|
|
3113
|
+
description?: string | undefined;
|
|
3114
|
+
body?: any;
|
|
3115
|
+
expectedResponse?: {
|
|
3116
|
+
statusCode: number;
|
|
3117
|
+
body?: any;
|
|
3118
|
+
} | undefined;
|
|
3119
|
+
}[];
|
|
3120
|
+
description?: string | undefined;
|
|
3121
|
+
}, {
|
|
3122
|
+
name: string;
|
|
3123
|
+
requests: {
|
|
3124
|
+
url: string;
|
|
3125
|
+
name: string;
|
|
3126
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3127
|
+
description?: string | undefined;
|
|
3128
|
+
headers?: Record<string, string> | undefined;
|
|
3129
|
+
body?: any;
|
|
3130
|
+
variables?: Record<string, any> | undefined;
|
|
3131
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
3132
|
+
expectedResponse?: {
|
|
3133
|
+
statusCode: number;
|
|
3134
|
+
body?: any;
|
|
3135
|
+
} | undefined;
|
|
3136
|
+
}[];
|
|
3137
|
+
description?: string | undefined;
|
|
3138
|
+
}>, "many">>;
|
|
3139
|
+
}, "strip", z.ZodTypeAny, {
|
|
3140
|
+
name: string;
|
|
3141
|
+
requests: {
|
|
3142
|
+
url: string;
|
|
3143
|
+
name: string;
|
|
3144
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3145
|
+
headers: Record<string, string>;
|
|
3146
|
+
variables: Record<string, any>;
|
|
3147
|
+
queryParams: Record<string, string | number | boolean>;
|
|
3148
|
+
description?: string | undefined;
|
|
3149
|
+
body?: any;
|
|
3150
|
+
expectedResponse?: {
|
|
3151
|
+
statusCode: number;
|
|
3152
|
+
body?: any;
|
|
3153
|
+
} | undefined;
|
|
3154
|
+
}[];
|
|
3155
|
+
variables: Record<string, any>;
|
|
3156
|
+
description?: string | undefined;
|
|
3157
|
+
folders?: {
|
|
3158
|
+
name: string;
|
|
3159
|
+
requests: {
|
|
3160
|
+
url: string;
|
|
3161
|
+
name: string;
|
|
3162
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3163
|
+
headers: Record<string, string>;
|
|
3164
|
+
variables: Record<string, any>;
|
|
3165
|
+
queryParams: Record<string, string | number | boolean>;
|
|
3166
|
+
description?: string | undefined;
|
|
3167
|
+
body?: any;
|
|
3168
|
+
expectedResponse?: {
|
|
3169
|
+
statusCode: number;
|
|
3170
|
+
body?: any;
|
|
3171
|
+
} | undefined;
|
|
3172
|
+
}[];
|
|
3173
|
+
description?: string | undefined;
|
|
3174
|
+
}[] | undefined;
|
|
3175
|
+
}, {
|
|
3176
|
+
name: string;
|
|
3177
|
+
requests: {
|
|
3178
|
+
url: string;
|
|
3179
|
+
name: string;
|
|
3180
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3181
|
+
description?: string | undefined;
|
|
3182
|
+
headers?: Record<string, string> | undefined;
|
|
3183
|
+
body?: any;
|
|
3184
|
+
variables?: Record<string, any> | undefined;
|
|
3185
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
3186
|
+
expectedResponse?: {
|
|
3187
|
+
statusCode: number;
|
|
3188
|
+
body?: any;
|
|
3189
|
+
} | undefined;
|
|
3190
|
+
}[];
|
|
3191
|
+
description?: string | undefined;
|
|
3192
|
+
variables?: Record<string, any> | undefined;
|
|
3193
|
+
folders?: {
|
|
3194
|
+
name: string;
|
|
3195
|
+
requests: {
|
|
3196
|
+
url: string;
|
|
3197
|
+
name: string;
|
|
3198
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3199
|
+
description?: string | undefined;
|
|
3200
|
+
headers?: Record<string, string> | undefined;
|
|
3201
|
+
body?: any;
|
|
3202
|
+
variables?: Record<string, any> | undefined;
|
|
3203
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
3204
|
+
expectedResponse?: {
|
|
3205
|
+
statusCode: number;
|
|
3206
|
+
body?: any;
|
|
3207
|
+
} | undefined;
|
|
3208
|
+
}[];
|
|
3209
|
+
description?: string | undefined;
|
|
3210
|
+
}[] | undefined;
|
|
3211
|
+
}>, "many">>>;
|
|
3212
|
+
/** API changelog */
|
|
867
3213
|
changelog: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3214
|
+
/** Version */
|
|
868
3215
|
version: z.ZodString;
|
|
3216
|
+
/** Release date */
|
|
869
3217
|
date: z.ZodString;
|
|
3218
|
+
/** Changes */
|
|
870
3219
|
changes: z.ZodObject<{
|
|
871
|
-
added: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
872
|
-
changed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
873
|
-
deprecated: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
874
|
-
removed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
875
|
-
fixed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
876
|
-
security: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
|
|
877
|
-
}, z.
|
|
3220
|
+
added: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
3221
|
+
changed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
3222
|
+
deprecated: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
3223
|
+
removed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
3224
|
+
fixed: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
3225
|
+
security: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
3226
|
+
}, "strip", z.ZodTypeAny, {
|
|
3227
|
+
fixed: string[];
|
|
3228
|
+
security: string[];
|
|
3229
|
+
removed: string[];
|
|
3230
|
+
deprecated: string[];
|
|
3231
|
+
added: string[];
|
|
3232
|
+
changed: string[];
|
|
3233
|
+
}, {
|
|
3234
|
+
fixed?: string[] | undefined;
|
|
3235
|
+
security?: string[] | undefined;
|
|
3236
|
+
removed?: string[] | undefined;
|
|
3237
|
+
deprecated?: string[] | undefined;
|
|
3238
|
+
added?: string[] | undefined;
|
|
3239
|
+
changed?: string[] | undefined;
|
|
3240
|
+
}>;
|
|
3241
|
+
/** Migration guide */
|
|
878
3242
|
migrationGuide: z.ZodOptional<z.ZodString>;
|
|
879
|
-
}, z.
|
|
3243
|
+
}, "strip", z.ZodTypeAny, {
|
|
3244
|
+
date: string;
|
|
3245
|
+
version: string;
|
|
3246
|
+
changes: {
|
|
3247
|
+
fixed: string[];
|
|
3248
|
+
security: string[];
|
|
3249
|
+
removed: string[];
|
|
3250
|
+
deprecated: string[];
|
|
3251
|
+
added: string[];
|
|
3252
|
+
changed: string[];
|
|
3253
|
+
};
|
|
3254
|
+
migrationGuide?: string | undefined;
|
|
3255
|
+
}, {
|
|
3256
|
+
date: string;
|
|
3257
|
+
version: string;
|
|
3258
|
+
changes: {
|
|
3259
|
+
fixed?: string[] | undefined;
|
|
3260
|
+
security?: string[] | undefined;
|
|
3261
|
+
removed?: string[] | undefined;
|
|
3262
|
+
deprecated?: string[] | undefined;
|
|
3263
|
+
added?: string[] | undefined;
|
|
3264
|
+
changed?: string[] | undefined;
|
|
3265
|
+
};
|
|
3266
|
+
migrationGuide?: string | undefined;
|
|
3267
|
+
}>, "many">>>;
|
|
3268
|
+
/** Code generation templates */
|
|
880
3269
|
codeTemplates: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3270
|
+
/** Language/framework */
|
|
881
3271
|
language: z.ZodString;
|
|
3272
|
+
/** Template name */
|
|
882
3273
|
name: z.ZodString;
|
|
3274
|
+
/** Template content */
|
|
883
3275
|
template: z.ZodString;
|
|
884
|
-
variables
|
|
885
|
-
|
|
3276
|
+
/** Template variables */
|
|
3277
|
+
variables: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
3278
|
+
}, "strip", z.ZodTypeAny, {
|
|
3279
|
+
language: string;
|
|
3280
|
+
name: string;
|
|
3281
|
+
template: string;
|
|
3282
|
+
variables?: string[] | undefined;
|
|
3283
|
+
}, {
|
|
3284
|
+
language: string;
|
|
3285
|
+
name: string;
|
|
3286
|
+
template: string;
|
|
3287
|
+
variables?: string[] | undefined;
|
|
3288
|
+
}>, "many">>>;
|
|
3289
|
+
/** Terms of service */
|
|
886
3290
|
termsOfService: z.ZodOptional<z.ZodString>;
|
|
3291
|
+
/** Contact information */
|
|
887
3292
|
contact: z.ZodOptional<z.ZodObject<{
|
|
888
3293
|
name: z.ZodOptional<z.ZodString>;
|
|
889
3294
|
url: z.ZodOptional<z.ZodString>;
|
|
890
3295
|
email: z.ZodOptional<z.ZodString>;
|
|
891
|
-
}, z.
|
|
3296
|
+
}, "strip", z.ZodTypeAny, {
|
|
3297
|
+
email?: string | undefined;
|
|
3298
|
+
url?: string | undefined;
|
|
3299
|
+
name?: string | undefined;
|
|
3300
|
+
}, {
|
|
3301
|
+
email?: string | undefined;
|
|
3302
|
+
url?: string | undefined;
|
|
3303
|
+
name?: string | undefined;
|
|
3304
|
+
}>>;
|
|
3305
|
+
/** License */
|
|
892
3306
|
license: z.ZodOptional<z.ZodObject<{
|
|
893
3307
|
name: z.ZodString;
|
|
894
3308
|
url: z.ZodOptional<z.ZodString>;
|
|
895
|
-
}, z.
|
|
3309
|
+
}, "strip", z.ZodTypeAny, {
|
|
3310
|
+
name: string;
|
|
3311
|
+
url?: string | undefined;
|
|
3312
|
+
}, {
|
|
3313
|
+
name: string;
|
|
3314
|
+
url?: string | undefined;
|
|
3315
|
+
}>>;
|
|
3316
|
+
/** External documentation */
|
|
896
3317
|
externalDocs: z.ZodOptional<z.ZodObject<{
|
|
897
3318
|
description: z.ZodOptional<z.ZodString>;
|
|
898
3319
|
url: z.ZodString;
|
|
899
|
-
}, z.
|
|
3320
|
+
}, "strip", z.ZodTypeAny, {
|
|
3321
|
+
url: string;
|
|
3322
|
+
description?: string | undefined;
|
|
3323
|
+
}, {
|
|
3324
|
+
url: string;
|
|
3325
|
+
description?: string | undefined;
|
|
3326
|
+
}>>;
|
|
3327
|
+
/** Security schemes */
|
|
900
3328
|
securitySchemes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
901
|
-
type
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
http: "http";
|
|
905
|
-
openIdConnect: "openIdConnect";
|
|
906
|
-
}>;
|
|
3329
|
+
/** Security scheme type */
|
|
3330
|
+
type: z.ZodEnum<["apiKey", "http", "oauth2", "openIdConnect"]>;
|
|
3331
|
+
/** Scheme name */
|
|
907
3332
|
scheme: z.ZodOptional<z.ZodString>;
|
|
3333
|
+
/** Bearer format */
|
|
908
3334
|
bearerFormat: z.ZodOptional<z.ZodString>;
|
|
3335
|
+
/** API key name */
|
|
909
3336
|
name: z.ZodOptional<z.ZodString>;
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
cookie: "cookie";
|
|
914
|
-
}>>;
|
|
3337
|
+
/** API key location */
|
|
3338
|
+
in: z.ZodOptional<z.ZodEnum<["header", "query", "cookie"]>>;
|
|
3339
|
+
/** OAuth flows */
|
|
915
3340
|
flows: z.ZodOptional<z.ZodObject<{
|
|
916
3341
|
implicit: z.ZodOptional<z.ZodAny>;
|
|
917
3342
|
password: z.ZodOptional<z.ZodAny>;
|
|
918
3343
|
clientCredentials: z.ZodOptional<z.ZodAny>;
|
|
919
3344
|
authorizationCode: z.ZodOptional<z.ZodAny>;
|
|
920
|
-
}, z.
|
|
3345
|
+
}, "strip", z.ZodTypeAny, {
|
|
3346
|
+
password?: any;
|
|
3347
|
+
implicit?: any;
|
|
3348
|
+
clientCredentials?: any;
|
|
3349
|
+
authorizationCode?: any;
|
|
3350
|
+
}, {
|
|
3351
|
+
password?: any;
|
|
3352
|
+
implicit?: any;
|
|
3353
|
+
clientCredentials?: any;
|
|
3354
|
+
authorizationCode?: any;
|
|
3355
|
+
}>>;
|
|
3356
|
+
/** OpenID Connect URL */
|
|
921
3357
|
openIdConnectUrl: z.ZodOptional<z.ZodString>;
|
|
3358
|
+
/** Description */
|
|
922
3359
|
description: z.ZodOptional<z.ZodString>;
|
|
923
|
-
}, z.
|
|
3360
|
+
}, "strip", z.ZodTypeAny, {
|
|
3361
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
3362
|
+
name?: string | undefined;
|
|
3363
|
+
description?: string | undefined;
|
|
3364
|
+
scheme?: string | undefined;
|
|
3365
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
3366
|
+
bearerFormat?: string | undefined;
|
|
3367
|
+
flows?: {
|
|
3368
|
+
password?: any;
|
|
3369
|
+
implicit?: any;
|
|
3370
|
+
clientCredentials?: any;
|
|
3371
|
+
authorizationCode?: any;
|
|
3372
|
+
} | undefined;
|
|
3373
|
+
openIdConnectUrl?: string | undefined;
|
|
3374
|
+
}, {
|
|
3375
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
3376
|
+
name?: string | undefined;
|
|
3377
|
+
description?: string | undefined;
|
|
3378
|
+
scheme?: string | undefined;
|
|
3379
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
3380
|
+
bearerFormat?: string | undefined;
|
|
3381
|
+
flows?: {
|
|
3382
|
+
password?: any;
|
|
3383
|
+
implicit?: any;
|
|
3384
|
+
clientCredentials?: any;
|
|
3385
|
+
authorizationCode?: any;
|
|
3386
|
+
} | undefined;
|
|
3387
|
+
openIdConnectUrl?: string | undefined;
|
|
3388
|
+
}>>>;
|
|
3389
|
+
/** Global tags */
|
|
924
3390
|
tags: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
925
3391
|
name: z.ZodString;
|
|
926
3392
|
description: z.ZodOptional<z.ZodString>;
|
|
927
3393
|
externalDocs: z.ZodOptional<z.ZodObject<{
|
|
928
3394
|
description: z.ZodOptional<z.ZodString>;
|
|
929
3395
|
url: z.ZodString;
|
|
930
|
-
}, z.
|
|
931
|
-
|
|
932
|
-
|
|
3396
|
+
}, "strip", z.ZodTypeAny, {
|
|
3397
|
+
url: string;
|
|
3398
|
+
description?: string | undefined;
|
|
3399
|
+
}, {
|
|
3400
|
+
url: string;
|
|
3401
|
+
description?: string | undefined;
|
|
3402
|
+
}>>;
|
|
3403
|
+
}, "strip", z.ZodTypeAny, {
|
|
3404
|
+
name: string;
|
|
3405
|
+
description?: string | undefined;
|
|
3406
|
+
externalDocs?: {
|
|
3407
|
+
url: string;
|
|
3408
|
+
description?: string | undefined;
|
|
3409
|
+
} | undefined;
|
|
3410
|
+
}, {
|
|
3411
|
+
name: string;
|
|
3412
|
+
description?: string | undefined;
|
|
3413
|
+
externalDocs?: {
|
|
3414
|
+
url: string;
|
|
3415
|
+
description?: string | undefined;
|
|
3416
|
+
} | undefined;
|
|
3417
|
+
}>, "many">>;
|
|
3418
|
+
}, "strip", z.ZodTypeAny, {
|
|
3419
|
+
enabled: boolean;
|
|
3420
|
+
version: string;
|
|
3421
|
+
title: string;
|
|
3422
|
+
changelog: {
|
|
3423
|
+
date: string;
|
|
3424
|
+
version: string;
|
|
3425
|
+
changes: {
|
|
3426
|
+
fixed: string[];
|
|
3427
|
+
security: string[];
|
|
3428
|
+
removed: string[];
|
|
3429
|
+
deprecated: string[];
|
|
3430
|
+
added: string[];
|
|
3431
|
+
changed: string[];
|
|
3432
|
+
};
|
|
3433
|
+
migrationGuide?: string | undefined;
|
|
3434
|
+
}[];
|
|
3435
|
+
servers: {
|
|
3436
|
+
url: string;
|
|
3437
|
+
description?: string | undefined;
|
|
3438
|
+
variables?: Record<string, {
|
|
3439
|
+
default: string;
|
|
3440
|
+
description?: string | undefined;
|
|
3441
|
+
enum?: string[] | undefined;
|
|
3442
|
+
}> | undefined;
|
|
3443
|
+
}[];
|
|
3444
|
+
generateOpenApi: boolean;
|
|
3445
|
+
generateTestCollections: boolean;
|
|
3446
|
+
testCollections: {
|
|
3447
|
+
name: string;
|
|
3448
|
+
requests: {
|
|
3449
|
+
url: string;
|
|
3450
|
+
name: string;
|
|
3451
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3452
|
+
headers: Record<string, string>;
|
|
3453
|
+
variables: Record<string, any>;
|
|
3454
|
+
queryParams: Record<string, string | number | boolean>;
|
|
3455
|
+
description?: string | undefined;
|
|
3456
|
+
body?: any;
|
|
3457
|
+
expectedResponse?: {
|
|
3458
|
+
statusCode: number;
|
|
3459
|
+
body?: any;
|
|
3460
|
+
} | undefined;
|
|
3461
|
+
}[];
|
|
3462
|
+
variables: Record<string, any>;
|
|
3463
|
+
description?: string | undefined;
|
|
3464
|
+
folders?: {
|
|
3465
|
+
name: string;
|
|
3466
|
+
requests: {
|
|
3467
|
+
url: string;
|
|
3468
|
+
name: string;
|
|
3469
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3470
|
+
headers: Record<string, string>;
|
|
3471
|
+
variables: Record<string, any>;
|
|
3472
|
+
queryParams: Record<string, string | number | boolean>;
|
|
3473
|
+
description?: string | undefined;
|
|
3474
|
+
body?: any;
|
|
3475
|
+
expectedResponse?: {
|
|
3476
|
+
statusCode: number;
|
|
3477
|
+
body?: any;
|
|
3478
|
+
} | undefined;
|
|
3479
|
+
}[];
|
|
3480
|
+
description?: string | undefined;
|
|
3481
|
+
}[] | undefined;
|
|
3482
|
+
}[];
|
|
3483
|
+
codeTemplates: {
|
|
3484
|
+
language: string;
|
|
3485
|
+
name: string;
|
|
3486
|
+
template: string;
|
|
3487
|
+
variables?: string[] | undefined;
|
|
3488
|
+
}[];
|
|
3489
|
+
tags?: {
|
|
3490
|
+
name: string;
|
|
3491
|
+
description?: string | undefined;
|
|
3492
|
+
externalDocs?: {
|
|
3493
|
+
url: string;
|
|
3494
|
+
description?: string | undefined;
|
|
3495
|
+
} | undefined;
|
|
3496
|
+
}[] | undefined;
|
|
3497
|
+
description?: string | undefined;
|
|
3498
|
+
license?: {
|
|
3499
|
+
name: string;
|
|
3500
|
+
url?: string | undefined;
|
|
3501
|
+
} | undefined;
|
|
3502
|
+
ui?: {
|
|
3503
|
+
path: string;
|
|
3504
|
+
type: "custom" | "swagger-ui" | "redoc" | "rapidoc" | "stoplight" | "scalar" | "graphql-playground" | "graphiql" | "postman";
|
|
3505
|
+
theme: "auto" | "light" | "dark";
|
|
3506
|
+
enableTryItOut: boolean;
|
|
3507
|
+
enableFilter: boolean;
|
|
3508
|
+
enableCors: boolean;
|
|
3509
|
+
defaultModelsExpandDepth: number;
|
|
3510
|
+
displayRequestDuration: boolean;
|
|
3511
|
+
syntaxHighlighting: boolean;
|
|
3512
|
+
layout?: {
|
|
3513
|
+
defaultModelsExpandDepth: number;
|
|
3514
|
+
showExtensions: boolean;
|
|
3515
|
+
showCommonExtensions: boolean;
|
|
3516
|
+
deepLinking: boolean;
|
|
3517
|
+
displayOperationId: boolean;
|
|
3518
|
+
defaultModelRendering: "model" | "example";
|
|
3519
|
+
defaultModelExpandDepth: number;
|
|
3520
|
+
docExpansion: "full" | "list" | "none";
|
|
3521
|
+
} | undefined;
|
|
3522
|
+
customCssUrl?: string | undefined;
|
|
3523
|
+
customJsUrl?: string | undefined;
|
|
3524
|
+
} | undefined;
|
|
3525
|
+
termsOfService?: string | undefined;
|
|
3526
|
+
contact?: {
|
|
3527
|
+
email?: string | undefined;
|
|
3528
|
+
url?: string | undefined;
|
|
3529
|
+
name?: string | undefined;
|
|
3530
|
+
} | undefined;
|
|
3531
|
+
externalDocs?: {
|
|
3532
|
+
url: string;
|
|
3533
|
+
description?: string | undefined;
|
|
3534
|
+
} | undefined;
|
|
3535
|
+
securitySchemes?: Record<string, {
|
|
3536
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
3537
|
+
name?: string | undefined;
|
|
3538
|
+
description?: string | undefined;
|
|
3539
|
+
scheme?: string | undefined;
|
|
3540
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
3541
|
+
bearerFormat?: string | undefined;
|
|
3542
|
+
flows?: {
|
|
3543
|
+
password?: any;
|
|
3544
|
+
implicit?: any;
|
|
3545
|
+
clientCredentials?: any;
|
|
3546
|
+
authorizationCode?: any;
|
|
3547
|
+
} | undefined;
|
|
3548
|
+
openIdConnectUrl?: string | undefined;
|
|
3549
|
+
}> | undefined;
|
|
3550
|
+
}, {
|
|
3551
|
+
version: string;
|
|
3552
|
+
enabled?: boolean | undefined;
|
|
3553
|
+
tags?: {
|
|
3554
|
+
name: string;
|
|
3555
|
+
description?: string | undefined;
|
|
3556
|
+
externalDocs?: {
|
|
3557
|
+
url: string;
|
|
3558
|
+
description?: string | undefined;
|
|
3559
|
+
} | undefined;
|
|
3560
|
+
}[] | undefined;
|
|
3561
|
+
description?: string | undefined;
|
|
3562
|
+
title?: string | undefined;
|
|
3563
|
+
license?: {
|
|
3564
|
+
name: string;
|
|
3565
|
+
url?: string | undefined;
|
|
3566
|
+
} | undefined;
|
|
3567
|
+
ui?: {
|
|
3568
|
+
type: "custom" | "swagger-ui" | "redoc" | "rapidoc" | "stoplight" | "scalar" | "graphql-playground" | "graphiql" | "postman";
|
|
3569
|
+
path?: string | undefined;
|
|
3570
|
+
theme?: "auto" | "light" | "dark" | undefined;
|
|
3571
|
+
layout?: {
|
|
3572
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
3573
|
+
showExtensions?: boolean | undefined;
|
|
3574
|
+
showCommonExtensions?: boolean | undefined;
|
|
3575
|
+
deepLinking?: boolean | undefined;
|
|
3576
|
+
displayOperationId?: boolean | undefined;
|
|
3577
|
+
defaultModelRendering?: "model" | "example" | undefined;
|
|
3578
|
+
defaultModelExpandDepth?: number | undefined;
|
|
3579
|
+
docExpansion?: "full" | "list" | "none" | undefined;
|
|
3580
|
+
} | undefined;
|
|
3581
|
+
enableTryItOut?: boolean | undefined;
|
|
3582
|
+
enableFilter?: boolean | undefined;
|
|
3583
|
+
enableCors?: boolean | undefined;
|
|
3584
|
+
defaultModelsExpandDepth?: number | undefined;
|
|
3585
|
+
displayRequestDuration?: boolean | undefined;
|
|
3586
|
+
syntaxHighlighting?: boolean | undefined;
|
|
3587
|
+
customCssUrl?: string | undefined;
|
|
3588
|
+
customJsUrl?: string | undefined;
|
|
3589
|
+
} | undefined;
|
|
3590
|
+
changelog?: {
|
|
3591
|
+
date: string;
|
|
3592
|
+
version: string;
|
|
3593
|
+
changes: {
|
|
3594
|
+
fixed?: string[] | undefined;
|
|
3595
|
+
security?: string[] | undefined;
|
|
3596
|
+
removed?: string[] | undefined;
|
|
3597
|
+
deprecated?: string[] | undefined;
|
|
3598
|
+
added?: string[] | undefined;
|
|
3599
|
+
changed?: string[] | undefined;
|
|
3600
|
+
};
|
|
3601
|
+
migrationGuide?: string | undefined;
|
|
3602
|
+
}[] | undefined;
|
|
3603
|
+
termsOfService?: string | undefined;
|
|
3604
|
+
contact?: {
|
|
3605
|
+
email?: string | undefined;
|
|
3606
|
+
url?: string | undefined;
|
|
3607
|
+
name?: string | undefined;
|
|
3608
|
+
} | undefined;
|
|
3609
|
+
externalDocs?: {
|
|
3610
|
+
url: string;
|
|
3611
|
+
description?: string | undefined;
|
|
3612
|
+
} | undefined;
|
|
3613
|
+
servers?: {
|
|
3614
|
+
url: string;
|
|
3615
|
+
description?: string | undefined;
|
|
3616
|
+
variables?: Record<string, {
|
|
3617
|
+
default: string;
|
|
3618
|
+
description?: string | undefined;
|
|
3619
|
+
enum?: string[] | undefined;
|
|
3620
|
+
}> | undefined;
|
|
3621
|
+
}[] | undefined;
|
|
3622
|
+
securitySchemes?: Record<string, {
|
|
3623
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
3624
|
+
name?: string | undefined;
|
|
3625
|
+
description?: string | undefined;
|
|
3626
|
+
scheme?: string | undefined;
|
|
3627
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
3628
|
+
bearerFormat?: string | undefined;
|
|
3629
|
+
flows?: {
|
|
3630
|
+
password?: any;
|
|
3631
|
+
implicit?: any;
|
|
3632
|
+
clientCredentials?: any;
|
|
3633
|
+
authorizationCode?: any;
|
|
3634
|
+
} | undefined;
|
|
3635
|
+
openIdConnectUrl?: string | undefined;
|
|
3636
|
+
}> | undefined;
|
|
3637
|
+
generateOpenApi?: boolean | undefined;
|
|
3638
|
+
generateTestCollections?: boolean | undefined;
|
|
3639
|
+
testCollections?: {
|
|
3640
|
+
name: string;
|
|
3641
|
+
requests: {
|
|
3642
|
+
url: string;
|
|
3643
|
+
name: string;
|
|
3644
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3645
|
+
description?: string | undefined;
|
|
3646
|
+
headers?: Record<string, string> | undefined;
|
|
3647
|
+
body?: any;
|
|
3648
|
+
variables?: Record<string, any> | undefined;
|
|
3649
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
3650
|
+
expectedResponse?: {
|
|
3651
|
+
statusCode: number;
|
|
3652
|
+
body?: any;
|
|
3653
|
+
} | undefined;
|
|
3654
|
+
}[];
|
|
3655
|
+
description?: string | undefined;
|
|
3656
|
+
variables?: Record<string, any> | undefined;
|
|
3657
|
+
folders?: {
|
|
3658
|
+
name: string;
|
|
3659
|
+
requests: {
|
|
3660
|
+
url: string;
|
|
3661
|
+
name: string;
|
|
3662
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3663
|
+
description?: string | undefined;
|
|
3664
|
+
headers?: Record<string, string> | undefined;
|
|
3665
|
+
body?: any;
|
|
3666
|
+
variables?: Record<string, any> | undefined;
|
|
3667
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
3668
|
+
expectedResponse?: {
|
|
3669
|
+
statusCode: number;
|
|
3670
|
+
body?: any;
|
|
3671
|
+
} | undefined;
|
|
3672
|
+
}[];
|
|
3673
|
+
description?: string | undefined;
|
|
3674
|
+
}[] | undefined;
|
|
3675
|
+
}[] | undefined;
|
|
3676
|
+
codeTemplates?: {
|
|
3677
|
+
language: string;
|
|
3678
|
+
name: string;
|
|
3679
|
+
template: string;
|
|
3680
|
+
variables?: string[] | undefined;
|
|
3681
|
+
}[] | undefined;
|
|
3682
|
+
}> & {
|
|
933
3683
|
create: <T extends z.input<typeof ApiDocumentationConfigSchema>>(config: T) => T;
|
|
934
3684
|
};
|
|
935
3685
|
/**
|
|
936
3686
|
* Helper to create API test collection
|
|
937
3687
|
*/
|
|
938
3688
|
export declare const ApiTestCollection: z.ZodObject<{
|
|
3689
|
+
/** Collection name */
|
|
939
3690
|
name: z.ZodString;
|
|
3691
|
+
/** Collection description */
|
|
940
3692
|
description: z.ZodOptional<z.ZodString>;
|
|
3693
|
+
/** Collection variables */
|
|
941
3694
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
3695
|
+
/** Test requests */
|
|
942
3696
|
requests: z.ZodArray<z.ZodObject<{
|
|
3697
|
+
/** Request name */
|
|
943
3698
|
name: z.ZodString;
|
|
3699
|
+
/** Request description */
|
|
944
3700
|
description: z.ZodOptional<z.ZodString>;
|
|
945
|
-
method
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
PUT: "PUT";
|
|
949
|
-
DELETE: "DELETE";
|
|
950
|
-
PATCH: "PATCH";
|
|
951
|
-
HEAD: "HEAD";
|
|
952
|
-
OPTIONS: "OPTIONS";
|
|
953
|
-
}>;
|
|
3701
|
+
/** HTTP method */
|
|
3702
|
+
method: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
|
|
3703
|
+
/** Request URL */
|
|
954
3704
|
url: z.ZodString;
|
|
3705
|
+
/** Request headers */
|
|
955
3706
|
headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
956
|
-
|
|
3707
|
+
/** Query parameters */
|
|
3708
|
+
queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
|
|
3709
|
+
/** Request body */
|
|
957
3710
|
body: z.ZodOptional<z.ZodAny>;
|
|
3711
|
+
/** Environment variables */
|
|
958
3712
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
3713
|
+
/** Expected response */
|
|
959
3714
|
expectedResponse: z.ZodOptional<z.ZodObject<{
|
|
960
3715
|
statusCode: z.ZodNumber;
|
|
961
3716
|
body: z.ZodOptional<z.ZodAny>;
|
|
962
|
-
}, z.
|
|
963
|
-
|
|
3717
|
+
}, "strip", z.ZodTypeAny, {
|
|
3718
|
+
statusCode: number;
|
|
3719
|
+
body?: any;
|
|
3720
|
+
}, {
|
|
3721
|
+
statusCode: number;
|
|
3722
|
+
body?: any;
|
|
3723
|
+
}>>;
|
|
3724
|
+
}, "strip", z.ZodTypeAny, {
|
|
3725
|
+
url: string;
|
|
3726
|
+
name: string;
|
|
3727
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3728
|
+
headers: Record<string, string>;
|
|
3729
|
+
variables: Record<string, any>;
|
|
3730
|
+
queryParams: Record<string, string | number | boolean>;
|
|
3731
|
+
description?: string | undefined;
|
|
3732
|
+
body?: any;
|
|
3733
|
+
expectedResponse?: {
|
|
3734
|
+
statusCode: number;
|
|
3735
|
+
body?: any;
|
|
3736
|
+
} | undefined;
|
|
3737
|
+
}, {
|
|
3738
|
+
url: string;
|
|
3739
|
+
name: string;
|
|
3740
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3741
|
+
description?: string | undefined;
|
|
3742
|
+
headers?: Record<string, string> | undefined;
|
|
3743
|
+
body?: any;
|
|
3744
|
+
variables?: Record<string, any> | undefined;
|
|
3745
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
3746
|
+
expectedResponse?: {
|
|
3747
|
+
statusCode: number;
|
|
3748
|
+
body?: any;
|
|
3749
|
+
} | undefined;
|
|
3750
|
+
}>, "many">;
|
|
3751
|
+
/** Folders/grouping */
|
|
964
3752
|
folders: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
965
3753
|
name: z.ZodString;
|
|
966
3754
|
description: z.ZodOptional<z.ZodString>;
|
|
967
3755
|
requests: z.ZodArray<z.ZodObject<{
|
|
3756
|
+
/** Request name */
|
|
968
3757
|
name: z.ZodString;
|
|
3758
|
+
/** Request description */
|
|
969
3759
|
description: z.ZodOptional<z.ZodString>;
|
|
970
|
-
method
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
PUT: "PUT";
|
|
974
|
-
DELETE: "DELETE";
|
|
975
|
-
PATCH: "PATCH";
|
|
976
|
-
HEAD: "HEAD";
|
|
977
|
-
OPTIONS: "OPTIONS";
|
|
978
|
-
}>;
|
|
3760
|
+
/** HTTP method */
|
|
3761
|
+
method: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
|
|
3762
|
+
/** Request URL */
|
|
979
3763
|
url: z.ZodString;
|
|
3764
|
+
/** Request headers */
|
|
980
3765
|
headers: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
981
|
-
|
|
3766
|
+
/** Query parameters */
|
|
3767
|
+
queryParams: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>>>;
|
|
3768
|
+
/** Request body */
|
|
982
3769
|
body: z.ZodOptional<z.ZodAny>;
|
|
3770
|
+
/** Environment variables */
|
|
983
3771
|
variables: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
3772
|
+
/** Expected response */
|
|
984
3773
|
expectedResponse: z.ZodOptional<z.ZodObject<{
|
|
985
3774
|
statusCode: z.ZodNumber;
|
|
986
3775
|
body: z.ZodOptional<z.ZodAny>;
|
|
987
|
-
}, z.
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
},
|
|
3776
|
+
}, "strip", z.ZodTypeAny, {
|
|
3777
|
+
statusCode: number;
|
|
3778
|
+
body?: any;
|
|
3779
|
+
}, {
|
|
3780
|
+
statusCode: number;
|
|
3781
|
+
body?: any;
|
|
3782
|
+
}>>;
|
|
3783
|
+
}, "strip", z.ZodTypeAny, {
|
|
3784
|
+
url: string;
|
|
3785
|
+
name: string;
|
|
3786
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3787
|
+
headers: Record<string, string>;
|
|
3788
|
+
variables: Record<string, any>;
|
|
3789
|
+
queryParams: Record<string, string | number | boolean>;
|
|
3790
|
+
description?: string | undefined;
|
|
3791
|
+
body?: any;
|
|
3792
|
+
expectedResponse?: {
|
|
3793
|
+
statusCode: number;
|
|
3794
|
+
body?: any;
|
|
3795
|
+
} | undefined;
|
|
3796
|
+
}, {
|
|
3797
|
+
url: string;
|
|
3798
|
+
name: string;
|
|
3799
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3800
|
+
description?: string | undefined;
|
|
3801
|
+
headers?: Record<string, string> | undefined;
|
|
3802
|
+
body?: any;
|
|
3803
|
+
variables?: Record<string, any> | undefined;
|
|
3804
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
3805
|
+
expectedResponse?: {
|
|
3806
|
+
statusCode: number;
|
|
3807
|
+
body?: any;
|
|
3808
|
+
} | undefined;
|
|
3809
|
+
}>, "many">;
|
|
3810
|
+
}, "strip", z.ZodTypeAny, {
|
|
3811
|
+
name: string;
|
|
3812
|
+
requests: {
|
|
3813
|
+
url: string;
|
|
3814
|
+
name: string;
|
|
3815
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3816
|
+
headers: Record<string, string>;
|
|
3817
|
+
variables: Record<string, any>;
|
|
3818
|
+
queryParams: Record<string, string | number | boolean>;
|
|
3819
|
+
description?: string | undefined;
|
|
3820
|
+
body?: any;
|
|
3821
|
+
expectedResponse?: {
|
|
3822
|
+
statusCode: number;
|
|
3823
|
+
body?: any;
|
|
3824
|
+
} | undefined;
|
|
3825
|
+
}[];
|
|
3826
|
+
description?: string | undefined;
|
|
3827
|
+
}, {
|
|
3828
|
+
name: string;
|
|
3829
|
+
requests: {
|
|
3830
|
+
url: string;
|
|
3831
|
+
name: string;
|
|
3832
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3833
|
+
description?: string | undefined;
|
|
3834
|
+
headers?: Record<string, string> | undefined;
|
|
3835
|
+
body?: any;
|
|
3836
|
+
variables?: Record<string, any> | undefined;
|
|
3837
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
3838
|
+
expectedResponse?: {
|
|
3839
|
+
statusCode: number;
|
|
3840
|
+
body?: any;
|
|
3841
|
+
} | undefined;
|
|
3842
|
+
}[];
|
|
3843
|
+
description?: string | undefined;
|
|
3844
|
+
}>, "many">>;
|
|
3845
|
+
}, "strip", z.ZodTypeAny, {
|
|
3846
|
+
name: string;
|
|
3847
|
+
requests: {
|
|
3848
|
+
url: string;
|
|
3849
|
+
name: string;
|
|
3850
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3851
|
+
headers: Record<string, string>;
|
|
3852
|
+
variables: Record<string, any>;
|
|
3853
|
+
queryParams: Record<string, string | number | boolean>;
|
|
3854
|
+
description?: string | undefined;
|
|
3855
|
+
body?: any;
|
|
3856
|
+
expectedResponse?: {
|
|
3857
|
+
statusCode: number;
|
|
3858
|
+
body?: any;
|
|
3859
|
+
} | undefined;
|
|
3860
|
+
}[];
|
|
3861
|
+
variables: Record<string, any>;
|
|
3862
|
+
description?: string | undefined;
|
|
3863
|
+
folders?: {
|
|
3864
|
+
name: string;
|
|
3865
|
+
requests: {
|
|
3866
|
+
url: string;
|
|
3867
|
+
name: string;
|
|
3868
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3869
|
+
headers: Record<string, string>;
|
|
3870
|
+
variables: Record<string, any>;
|
|
3871
|
+
queryParams: Record<string, string | number | boolean>;
|
|
3872
|
+
description?: string | undefined;
|
|
3873
|
+
body?: any;
|
|
3874
|
+
expectedResponse?: {
|
|
3875
|
+
statusCode: number;
|
|
3876
|
+
body?: any;
|
|
3877
|
+
} | undefined;
|
|
3878
|
+
}[];
|
|
3879
|
+
description?: string | undefined;
|
|
3880
|
+
}[] | undefined;
|
|
3881
|
+
}, {
|
|
3882
|
+
name: string;
|
|
3883
|
+
requests: {
|
|
3884
|
+
url: string;
|
|
3885
|
+
name: string;
|
|
3886
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3887
|
+
description?: string | undefined;
|
|
3888
|
+
headers?: Record<string, string> | undefined;
|
|
3889
|
+
body?: any;
|
|
3890
|
+
variables?: Record<string, any> | undefined;
|
|
3891
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
3892
|
+
expectedResponse?: {
|
|
3893
|
+
statusCode: number;
|
|
3894
|
+
body?: any;
|
|
3895
|
+
} | undefined;
|
|
3896
|
+
}[];
|
|
3897
|
+
description?: string | undefined;
|
|
3898
|
+
variables?: Record<string, any> | undefined;
|
|
3899
|
+
folders?: {
|
|
3900
|
+
name: string;
|
|
3901
|
+
requests: {
|
|
3902
|
+
url: string;
|
|
3903
|
+
name: string;
|
|
3904
|
+
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
|
|
3905
|
+
description?: string | undefined;
|
|
3906
|
+
headers?: Record<string, string> | undefined;
|
|
3907
|
+
body?: any;
|
|
3908
|
+
variables?: Record<string, any> | undefined;
|
|
3909
|
+
queryParams?: Record<string, string | number | boolean> | undefined;
|
|
3910
|
+
expectedResponse?: {
|
|
3911
|
+
statusCode: number;
|
|
3912
|
+
body?: any;
|
|
3913
|
+
} | undefined;
|
|
3914
|
+
}[];
|
|
3915
|
+
description?: string | undefined;
|
|
3916
|
+
}[] | undefined;
|
|
3917
|
+
}> & {
|
|
991
3918
|
create: <T extends z.input<typeof ApiTestCollectionSchema>>(config: T) => T;
|
|
992
3919
|
};
|
|
993
3920
|
/**
|
|
994
3921
|
* Helper to create OpenAPI specification
|
|
995
3922
|
*/
|
|
996
3923
|
export declare const OpenApiSpec: z.ZodObject<{
|
|
3924
|
+
/** OpenAPI version */
|
|
997
3925
|
openapi: z.ZodDefault<z.ZodString>;
|
|
3926
|
+
/** API information */
|
|
998
3927
|
info: z.ZodObject<{
|
|
999
3928
|
title: z.ZodString;
|
|
1000
3929
|
version: z.ZodString;
|
|
@@ -1004,22 +3933,94 @@ export declare const OpenApiSpec: z.ZodObject<{
|
|
|
1004
3933
|
name: z.ZodOptional<z.ZodString>;
|
|
1005
3934
|
url: z.ZodOptional<z.ZodString>;
|
|
1006
3935
|
email: z.ZodOptional<z.ZodString>;
|
|
1007
|
-
}, z.
|
|
3936
|
+
}, "strip", z.ZodTypeAny, {
|
|
3937
|
+
email?: string | undefined;
|
|
3938
|
+
url?: string | undefined;
|
|
3939
|
+
name?: string | undefined;
|
|
3940
|
+
}, {
|
|
3941
|
+
email?: string | undefined;
|
|
3942
|
+
url?: string | undefined;
|
|
3943
|
+
name?: string | undefined;
|
|
3944
|
+
}>>;
|
|
1008
3945
|
license: z.ZodOptional<z.ZodObject<{
|
|
1009
3946
|
name: z.ZodString;
|
|
1010
3947
|
url: z.ZodOptional<z.ZodString>;
|
|
1011
|
-
}, z.
|
|
1012
|
-
|
|
3948
|
+
}, "strip", z.ZodTypeAny, {
|
|
3949
|
+
name: string;
|
|
3950
|
+
url?: string | undefined;
|
|
3951
|
+
}, {
|
|
3952
|
+
name: string;
|
|
3953
|
+
url?: string | undefined;
|
|
3954
|
+
}>>;
|
|
3955
|
+
}, "strip", z.ZodTypeAny, {
|
|
3956
|
+
version: string;
|
|
3957
|
+
title: string;
|
|
3958
|
+
description?: string | undefined;
|
|
3959
|
+
license?: {
|
|
3960
|
+
name: string;
|
|
3961
|
+
url?: string | undefined;
|
|
3962
|
+
} | undefined;
|
|
3963
|
+
termsOfService?: string | undefined;
|
|
3964
|
+
contact?: {
|
|
3965
|
+
email?: string | undefined;
|
|
3966
|
+
url?: string | undefined;
|
|
3967
|
+
name?: string | undefined;
|
|
3968
|
+
} | undefined;
|
|
3969
|
+
}, {
|
|
3970
|
+
version: string;
|
|
3971
|
+
title: string;
|
|
3972
|
+
description?: string | undefined;
|
|
3973
|
+
license?: {
|
|
3974
|
+
name: string;
|
|
3975
|
+
url?: string | undefined;
|
|
3976
|
+
} | undefined;
|
|
3977
|
+
termsOfService?: string | undefined;
|
|
3978
|
+
contact?: {
|
|
3979
|
+
email?: string | undefined;
|
|
3980
|
+
url?: string | undefined;
|
|
3981
|
+
name?: string | undefined;
|
|
3982
|
+
} | undefined;
|
|
3983
|
+
}>;
|
|
3984
|
+
/** Servers */
|
|
1013
3985
|
servers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3986
|
+
/** Server URL */
|
|
1014
3987
|
url: z.ZodString;
|
|
3988
|
+
/** Server description */
|
|
1015
3989
|
description: z.ZodOptional<z.ZodString>;
|
|
3990
|
+
/** Server variables */
|
|
1016
3991
|
variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
1017
3992
|
default: z.ZodString;
|
|
1018
3993
|
description: z.ZodOptional<z.ZodString>;
|
|
1019
|
-
enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
1020
|
-
}, z.
|
|
1021
|
-
|
|
3994
|
+
enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
3995
|
+
}, "strip", z.ZodTypeAny, {
|
|
3996
|
+
default: string;
|
|
3997
|
+
description?: string | undefined;
|
|
3998
|
+
enum?: string[] | undefined;
|
|
3999
|
+
}, {
|
|
4000
|
+
default: string;
|
|
4001
|
+
description?: string | undefined;
|
|
4002
|
+
enum?: string[] | undefined;
|
|
4003
|
+
}>>>;
|
|
4004
|
+
}, "strip", z.ZodTypeAny, {
|
|
4005
|
+
url: string;
|
|
4006
|
+
description?: string | undefined;
|
|
4007
|
+
variables?: Record<string, {
|
|
4008
|
+
default: string;
|
|
4009
|
+
description?: string | undefined;
|
|
4010
|
+
enum?: string[] | undefined;
|
|
4011
|
+
}> | undefined;
|
|
4012
|
+
}, {
|
|
4013
|
+
url: string;
|
|
4014
|
+
description?: string | undefined;
|
|
4015
|
+
variables?: Record<string, {
|
|
4016
|
+
default: string;
|
|
4017
|
+
description?: string | undefined;
|
|
4018
|
+
enum?: string[] | undefined;
|
|
4019
|
+
}> | undefined;
|
|
4020
|
+
}>, "many">>>;
|
|
4021
|
+
/** API paths */
|
|
1022
4022
|
paths: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
4023
|
+
/** Reusable components */
|
|
1023
4024
|
components: z.ZodOptional<z.ZodObject<{
|
|
1024
4025
|
schemas: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
1025
4026
|
responses: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
@@ -1028,46 +4029,290 @@ export declare const OpenApiSpec: z.ZodObject<{
|
|
|
1028
4029
|
requestBodies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
1029
4030
|
headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
1030
4031
|
securitySchemes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
1031
|
-
type
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
http: "http";
|
|
1035
|
-
openIdConnect: "openIdConnect";
|
|
1036
|
-
}>;
|
|
4032
|
+
/** Security scheme type */
|
|
4033
|
+
type: z.ZodEnum<["apiKey", "http", "oauth2", "openIdConnect"]>;
|
|
4034
|
+
/** Scheme name */
|
|
1037
4035
|
scheme: z.ZodOptional<z.ZodString>;
|
|
4036
|
+
/** Bearer format */
|
|
1038
4037
|
bearerFormat: z.ZodOptional<z.ZodString>;
|
|
4038
|
+
/** API key name */
|
|
1039
4039
|
name: z.ZodOptional<z.ZodString>;
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
cookie: "cookie";
|
|
1044
|
-
}>>;
|
|
4040
|
+
/** API key location */
|
|
4041
|
+
in: z.ZodOptional<z.ZodEnum<["header", "query", "cookie"]>>;
|
|
4042
|
+
/** OAuth flows */
|
|
1045
4043
|
flows: z.ZodOptional<z.ZodObject<{
|
|
1046
4044
|
implicit: z.ZodOptional<z.ZodAny>;
|
|
1047
4045
|
password: z.ZodOptional<z.ZodAny>;
|
|
1048
4046
|
clientCredentials: z.ZodOptional<z.ZodAny>;
|
|
1049
4047
|
authorizationCode: z.ZodOptional<z.ZodAny>;
|
|
1050
|
-
}, z.
|
|
4048
|
+
}, "strip", z.ZodTypeAny, {
|
|
4049
|
+
password?: any;
|
|
4050
|
+
implicit?: any;
|
|
4051
|
+
clientCredentials?: any;
|
|
4052
|
+
authorizationCode?: any;
|
|
4053
|
+
}, {
|
|
4054
|
+
password?: any;
|
|
4055
|
+
implicit?: any;
|
|
4056
|
+
clientCredentials?: any;
|
|
4057
|
+
authorizationCode?: any;
|
|
4058
|
+
}>>;
|
|
4059
|
+
/** OpenID Connect URL */
|
|
1051
4060
|
openIdConnectUrl: z.ZodOptional<z.ZodString>;
|
|
4061
|
+
/** Description */
|
|
1052
4062
|
description: z.ZodOptional<z.ZodString>;
|
|
1053
|
-
}, z.
|
|
4063
|
+
}, "strip", z.ZodTypeAny, {
|
|
4064
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
4065
|
+
name?: string | undefined;
|
|
4066
|
+
description?: string | undefined;
|
|
4067
|
+
scheme?: string | undefined;
|
|
4068
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
4069
|
+
bearerFormat?: string | undefined;
|
|
4070
|
+
flows?: {
|
|
4071
|
+
password?: any;
|
|
4072
|
+
implicit?: any;
|
|
4073
|
+
clientCredentials?: any;
|
|
4074
|
+
authorizationCode?: any;
|
|
4075
|
+
} | undefined;
|
|
4076
|
+
openIdConnectUrl?: string | undefined;
|
|
4077
|
+
}, {
|
|
4078
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
4079
|
+
name?: string | undefined;
|
|
4080
|
+
description?: string | undefined;
|
|
4081
|
+
scheme?: string | undefined;
|
|
4082
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
4083
|
+
bearerFormat?: string | undefined;
|
|
4084
|
+
flows?: {
|
|
4085
|
+
password?: any;
|
|
4086
|
+
implicit?: any;
|
|
4087
|
+
clientCredentials?: any;
|
|
4088
|
+
authorizationCode?: any;
|
|
4089
|
+
} | undefined;
|
|
4090
|
+
openIdConnectUrl?: string | undefined;
|
|
4091
|
+
}>>>;
|
|
1054
4092
|
links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
1055
4093
|
callbacks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
1056
|
-
}, z.
|
|
1057
|
-
|
|
4094
|
+
}, "strip", z.ZodTypeAny, {
|
|
4095
|
+
headers?: Record<string, any> | undefined;
|
|
4096
|
+
parameters?: Record<string, any> | undefined;
|
|
4097
|
+
links?: Record<string, any> | undefined;
|
|
4098
|
+
schemas?: Record<string, any> | undefined;
|
|
4099
|
+
examples?: Record<string, any> | undefined;
|
|
4100
|
+
responses?: Record<string, any> | undefined;
|
|
4101
|
+
requestBodies?: Record<string, any> | undefined;
|
|
4102
|
+
securitySchemes?: Record<string, {
|
|
4103
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
4104
|
+
name?: string | undefined;
|
|
4105
|
+
description?: string | undefined;
|
|
4106
|
+
scheme?: string | undefined;
|
|
4107
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
4108
|
+
bearerFormat?: string | undefined;
|
|
4109
|
+
flows?: {
|
|
4110
|
+
password?: any;
|
|
4111
|
+
implicit?: any;
|
|
4112
|
+
clientCredentials?: any;
|
|
4113
|
+
authorizationCode?: any;
|
|
4114
|
+
} | undefined;
|
|
4115
|
+
openIdConnectUrl?: string | undefined;
|
|
4116
|
+
}> | undefined;
|
|
4117
|
+
callbacks?: Record<string, any> | undefined;
|
|
4118
|
+
}, {
|
|
4119
|
+
headers?: Record<string, any> | undefined;
|
|
4120
|
+
parameters?: Record<string, any> | undefined;
|
|
4121
|
+
links?: Record<string, any> | undefined;
|
|
4122
|
+
schemas?: Record<string, any> | undefined;
|
|
4123
|
+
examples?: Record<string, any> | undefined;
|
|
4124
|
+
responses?: Record<string, any> | undefined;
|
|
4125
|
+
requestBodies?: Record<string, any> | undefined;
|
|
4126
|
+
securitySchemes?: Record<string, {
|
|
4127
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
4128
|
+
name?: string | undefined;
|
|
4129
|
+
description?: string | undefined;
|
|
4130
|
+
scheme?: string | undefined;
|
|
4131
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
4132
|
+
bearerFormat?: string | undefined;
|
|
4133
|
+
flows?: {
|
|
4134
|
+
password?: any;
|
|
4135
|
+
implicit?: any;
|
|
4136
|
+
clientCredentials?: any;
|
|
4137
|
+
authorizationCode?: any;
|
|
4138
|
+
} | undefined;
|
|
4139
|
+
openIdConnectUrl?: string | undefined;
|
|
4140
|
+
}> | undefined;
|
|
4141
|
+
callbacks?: Record<string, any> | undefined;
|
|
4142
|
+
}>>;
|
|
4143
|
+
/** Security requirements */
|
|
4144
|
+
security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>, "many">>;
|
|
4145
|
+
/** Tags */
|
|
1058
4146
|
tags: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1059
4147
|
name: z.ZodString;
|
|
1060
4148
|
description: z.ZodOptional<z.ZodString>;
|
|
1061
4149
|
externalDocs: z.ZodOptional<z.ZodObject<{
|
|
1062
4150
|
description: z.ZodOptional<z.ZodString>;
|
|
1063
4151
|
url: z.ZodString;
|
|
1064
|
-
}, z.
|
|
1065
|
-
|
|
4152
|
+
}, "strip", z.ZodTypeAny, {
|
|
4153
|
+
url: string;
|
|
4154
|
+
description?: string | undefined;
|
|
4155
|
+
}, {
|
|
4156
|
+
url: string;
|
|
4157
|
+
description?: string | undefined;
|
|
4158
|
+
}>>;
|
|
4159
|
+
}, "strip", z.ZodTypeAny, {
|
|
4160
|
+
name: string;
|
|
4161
|
+
description?: string | undefined;
|
|
4162
|
+
externalDocs?: {
|
|
4163
|
+
url: string;
|
|
4164
|
+
description?: string | undefined;
|
|
4165
|
+
} | undefined;
|
|
4166
|
+
}, {
|
|
4167
|
+
name: string;
|
|
4168
|
+
description?: string | undefined;
|
|
4169
|
+
externalDocs?: {
|
|
4170
|
+
url: string;
|
|
4171
|
+
description?: string | undefined;
|
|
4172
|
+
} | undefined;
|
|
4173
|
+
}>, "many">>;
|
|
4174
|
+
/** External documentation */
|
|
1066
4175
|
externalDocs: z.ZodOptional<z.ZodObject<{
|
|
1067
4176
|
description: z.ZodOptional<z.ZodString>;
|
|
1068
4177
|
url: z.ZodString;
|
|
1069
|
-
}, z.
|
|
1070
|
-
|
|
4178
|
+
}, "strip", z.ZodTypeAny, {
|
|
4179
|
+
url: string;
|
|
4180
|
+
description?: string | undefined;
|
|
4181
|
+
}, {
|
|
4182
|
+
url: string;
|
|
4183
|
+
description?: string | undefined;
|
|
4184
|
+
}>>;
|
|
4185
|
+
}, "strip", z.ZodTypeAny, {
|
|
4186
|
+
info: {
|
|
4187
|
+
version: string;
|
|
4188
|
+
title: string;
|
|
4189
|
+
description?: string | undefined;
|
|
4190
|
+
license?: {
|
|
4191
|
+
name: string;
|
|
4192
|
+
url?: string | undefined;
|
|
4193
|
+
} | undefined;
|
|
4194
|
+
termsOfService?: string | undefined;
|
|
4195
|
+
contact?: {
|
|
4196
|
+
email?: string | undefined;
|
|
4197
|
+
url?: string | undefined;
|
|
4198
|
+
name?: string | undefined;
|
|
4199
|
+
} | undefined;
|
|
4200
|
+
};
|
|
4201
|
+
paths: Record<string, any>;
|
|
4202
|
+
openapi: string;
|
|
4203
|
+
servers: {
|
|
4204
|
+
url: string;
|
|
4205
|
+
description?: string | undefined;
|
|
4206
|
+
variables?: Record<string, {
|
|
4207
|
+
default: string;
|
|
4208
|
+
description?: string | undefined;
|
|
4209
|
+
enum?: string[] | undefined;
|
|
4210
|
+
}> | undefined;
|
|
4211
|
+
}[];
|
|
4212
|
+
tags?: {
|
|
4213
|
+
name: string;
|
|
4214
|
+
description?: string | undefined;
|
|
4215
|
+
externalDocs?: {
|
|
4216
|
+
url: string;
|
|
4217
|
+
description?: string | undefined;
|
|
4218
|
+
} | undefined;
|
|
4219
|
+
}[] | undefined;
|
|
4220
|
+
components?: {
|
|
4221
|
+
headers?: Record<string, any> | undefined;
|
|
4222
|
+
parameters?: Record<string, any> | undefined;
|
|
4223
|
+
links?: Record<string, any> | undefined;
|
|
4224
|
+
schemas?: Record<string, any> | undefined;
|
|
4225
|
+
examples?: Record<string, any> | undefined;
|
|
4226
|
+
responses?: Record<string, any> | undefined;
|
|
4227
|
+
requestBodies?: Record<string, any> | undefined;
|
|
4228
|
+
securitySchemes?: Record<string, {
|
|
4229
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
4230
|
+
name?: string | undefined;
|
|
4231
|
+
description?: string | undefined;
|
|
4232
|
+
scheme?: string | undefined;
|
|
4233
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
4234
|
+
bearerFormat?: string | undefined;
|
|
4235
|
+
flows?: {
|
|
4236
|
+
password?: any;
|
|
4237
|
+
implicit?: any;
|
|
4238
|
+
clientCredentials?: any;
|
|
4239
|
+
authorizationCode?: any;
|
|
4240
|
+
} | undefined;
|
|
4241
|
+
openIdConnectUrl?: string | undefined;
|
|
4242
|
+
}> | undefined;
|
|
4243
|
+
callbacks?: Record<string, any> | undefined;
|
|
4244
|
+
} | undefined;
|
|
4245
|
+
security?: Record<string, string[]>[] | undefined;
|
|
4246
|
+
externalDocs?: {
|
|
4247
|
+
url: string;
|
|
4248
|
+
description?: string | undefined;
|
|
4249
|
+
} | undefined;
|
|
4250
|
+
}, {
|
|
4251
|
+
info: {
|
|
4252
|
+
version: string;
|
|
4253
|
+
title: string;
|
|
4254
|
+
description?: string | undefined;
|
|
4255
|
+
license?: {
|
|
4256
|
+
name: string;
|
|
4257
|
+
url?: string | undefined;
|
|
4258
|
+
} | undefined;
|
|
4259
|
+
termsOfService?: string | undefined;
|
|
4260
|
+
contact?: {
|
|
4261
|
+
email?: string | undefined;
|
|
4262
|
+
url?: string | undefined;
|
|
4263
|
+
name?: string | undefined;
|
|
4264
|
+
} | undefined;
|
|
4265
|
+
};
|
|
4266
|
+
paths: Record<string, any>;
|
|
4267
|
+
tags?: {
|
|
4268
|
+
name: string;
|
|
4269
|
+
description?: string | undefined;
|
|
4270
|
+
externalDocs?: {
|
|
4271
|
+
url: string;
|
|
4272
|
+
description?: string | undefined;
|
|
4273
|
+
} | undefined;
|
|
4274
|
+
}[] | undefined;
|
|
4275
|
+
components?: {
|
|
4276
|
+
headers?: Record<string, any> | undefined;
|
|
4277
|
+
parameters?: Record<string, any> | undefined;
|
|
4278
|
+
links?: Record<string, any> | undefined;
|
|
4279
|
+
schemas?: Record<string, any> | undefined;
|
|
4280
|
+
examples?: Record<string, any> | undefined;
|
|
4281
|
+
responses?: Record<string, any> | undefined;
|
|
4282
|
+
requestBodies?: Record<string, any> | undefined;
|
|
4283
|
+
securitySchemes?: Record<string, {
|
|
4284
|
+
type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
4285
|
+
name?: string | undefined;
|
|
4286
|
+
description?: string | undefined;
|
|
4287
|
+
scheme?: string | undefined;
|
|
4288
|
+
in?: "query" | "header" | "cookie" | undefined;
|
|
4289
|
+
bearerFormat?: string | undefined;
|
|
4290
|
+
flows?: {
|
|
4291
|
+
password?: any;
|
|
4292
|
+
implicit?: any;
|
|
4293
|
+
clientCredentials?: any;
|
|
4294
|
+
authorizationCode?: any;
|
|
4295
|
+
} | undefined;
|
|
4296
|
+
openIdConnectUrl?: string | undefined;
|
|
4297
|
+
}> | undefined;
|
|
4298
|
+
callbacks?: Record<string, any> | undefined;
|
|
4299
|
+
} | undefined;
|
|
4300
|
+
security?: Record<string, string[]>[] | undefined;
|
|
4301
|
+
externalDocs?: {
|
|
4302
|
+
url: string;
|
|
4303
|
+
description?: string | undefined;
|
|
4304
|
+
} | undefined;
|
|
4305
|
+
openapi?: string | undefined;
|
|
4306
|
+
servers?: {
|
|
4307
|
+
url: string;
|
|
4308
|
+
description?: string | undefined;
|
|
4309
|
+
variables?: Record<string, {
|
|
4310
|
+
default: string;
|
|
4311
|
+
description?: string | undefined;
|
|
4312
|
+
enum?: string[] | undefined;
|
|
4313
|
+
}> | undefined;
|
|
4314
|
+
}[] | undefined;
|
|
4315
|
+
}> & {
|
|
1071
4316
|
create: <T extends z.input<typeof OpenApiSpecSchema>>(config: T) => T;
|
|
1072
4317
|
};
|
|
1073
4318
|
//# sourceMappingURL=documentation.zod.d.ts.map
|