{ "author": { "email": "opensource@almamedia.dev", "name": "Alma Media", "organization": true, "roles": [ "author" ] }, "bundled": { "change-case": "^4.1.2", "es-toolkit": "^1.45.1", "js-yaml": "^4.1.0", "semver": "^7.3.8" }, "dependencies": { "aws-cdk-lib": "^2.220.0", "constructs": "^10.3.0" }, "dependencyClosure": { "@aws-cdk/asset-awscli-v1": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Asset.AwsCliV1", "packageId": "Amazon.CDK.Asset.AwsCliV1" }, "go": { "moduleName": "github.com/cdklabs/awscdk-asset-awscli-go", "packageName": "awscliv1" }, "java": { "maven": { "artifactId": "cdk-asset-awscli-v1", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cdk.asset.awscli.v1" }, "js": { "npm": "@aws-cdk/asset-awscli-v1" }, "python": { "distName": "aws-cdk.asset-awscli-v1", "module": "aws_cdk.asset_awscli_v1" } } }, "@aws-cdk/asset-node-proxy-agent-v6": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Asset.NodeProxyAgentV6", "packageId": "Amazon.CDK.Asset.NodeProxyAgentV6" }, "go": { "moduleName": "github.com/cdklabs/awscdk-asset-node-proxy-agent-go", "packageName": "nodeproxyagentv6" }, "java": { "maven": { "artifactId": "cdk-asset-node-proxy-agent-v6", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cdk.asset.node.proxy.agent.v6" }, "js": { "npm": "@aws-cdk/asset-node-proxy-agent-v6" }, "python": { "distName": "aws-cdk.asset-node-proxy-agent-v6", "module": "aws_cdk.asset_node_proxy_agent_v6" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/main/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "go": { "moduleName": "github.com/cdklabs/cloud-assembly-schema-go" }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 2" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "aws-cdk-lib": { "submodules": { "aws-cdk-lib.alexa_ask": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Alexa.Ask" }, "java": { "package": "software.amazon.awscdk.alexa.ask" }, "python": { "module": "aws_cdk.alexa_ask" } } }, "aws-cdk-lib.assertions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Assertions" }, "java": { "package": "software.amazon.awscdk.assertions" }, "python": { "module": "aws_cdk.assertions" } } }, "aws-cdk-lib.assets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Assets" }, "java": { "package": "software.amazon.awscdk.assets" }, "python": { "module": "aws_cdk.assets" } } }, "aws-cdk-lib.aws_accessanalyzer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AccessAnalyzer" }, "java": { "package": "software.amazon.awscdk.services.accessanalyzer" }, "python": { "module": "aws_cdk.aws_accessanalyzer" } } }, "aws-cdk-lib.aws_acmpca": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ACMPCA" }, "java": { "package": "software.amazon.awscdk.services.acmpca" }, "python": { "module": "aws_cdk.aws_acmpca" } } }, "aws-cdk-lib.aws_aiops": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.AIOps" }, "java": { "package": "software.amazon.awscdk.services.aiops" }, "python": { "module": "aws_cdk.aws_aiops" } } }, "aws-cdk-lib.aws_amazonmq": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AmazonMQ" }, "java": { "package": "software.amazon.awscdk.services.amazonmq" }, "python": { "module": "aws_cdk.aws_amazonmq" } } }, "aws-cdk-lib.aws_amplify": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Amplify" }, "java": { "package": "software.amazon.awscdk.services.amplify" }, "python": { "module": "aws_cdk.aws_amplify" } } }, "aws-cdk-lib.aws_amplifyuibuilder": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AmplifyUIBuilder" }, "java": { "package": "software.amazon.awscdk.services.amplifyuibuilder" }, "python": { "module": "aws_cdk.aws_amplifyuibuilder" } } }, "aws-cdk-lib.aws_apigateway": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.APIGateway" }, "java": { "package": "software.amazon.awscdk.services.apigateway" }, "python": { "module": "aws_cdk.aws_apigateway" } } }, "aws-cdk-lib.aws_apigatewayv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Apigatewayv2" }, "java": { "package": "software.amazon.awscdk.services.apigatewayv2" }, "python": { "module": "aws_cdk.aws_apigatewayv2" } } }, "aws-cdk-lib.aws_apigatewayv2_authorizers": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AwsApigatewayv2Authorizers" }, "java": { "package": "software.amazon.awscdk.aws_apigatewayv2_authorizers" }, "python": { "module": "aws_cdk.aws_apigatewayv2_authorizers" } } }, "aws-cdk-lib.aws_apigatewayv2_integrations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AwsApigatewayv2Integrations" }, "java": { "package": "software.amazon.awscdk.aws_apigatewayv2_integrations" }, "python": { "module": "aws_cdk.aws_apigatewayv2_integrations" } } }, "aws-cdk-lib.aws_appconfig": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppConfig" }, "java": { "package": "software.amazon.awscdk.services.appconfig" }, "python": { "module": "aws_cdk.aws_appconfig" } } }, "aws-cdk-lib.aws_appflow": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppFlow" }, "java": { "package": "software.amazon.awscdk.services.appflow" }, "python": { "module": "aws_cdk.aws_appflow" } } }, "aws-cdk-lib.aws_appintegrations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppIntegrations" }, "java": { "package": "software.amazon.awscdk.services.appintegrations" }, "python": { "module": "aws_cdk.aws_appintegrations" } } }, "aws-cdk-lib.aws_applicationautoscaling": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ApplicationAutoScaling" }, "java": { "package": "software.amazon.awscdk.services.applicationautoscaling" }, "python": { "module": "aws_cdk.aws_applicationautoscaling" } } }, "aws-cdk-lib.aws_applicationinsights": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ApplicationInsights" }, "java": { "package": "software.amazon.awscdk.services.applicationinsights" }, "python": { "module": "aws_cdk.aws_applicationinsights" } } }, "aws-cdk-lib.aws_applicationsignals": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.ApplicationSignals" }, "java": { "package": "software.amazon.awscdk.services.applicationsignals" }, "python": { "module": "aws_cdk.aws_applicationsignals" } } }, "aws-cdk-lib.aws_appmesh": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppMesh" }, "java": { "package": "software.amazon.awscdk.services.appmesh" }, "python": { "module": "aws_cdk.aws_appmesh" } } }, "aws-cdk-lib.aws_apprunner": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppRunner" }, "java": { "package": "software.amazon.awscdk.services.apprunner" }, "python": { "module": "aws_cdk.aws_apprunner" } } }, "aws-cdk-lib.aws_appstream": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppStream" }, "java": { "package": "software.amazon.awscdk.services.appstream" }, "python": { "module": "aws_cdk.aws_appstream" } } }, "aws-cdk-lib.aws_appsync": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppSync" }, "java": { "package": "software.amazon.awscdk.services.appsync" }, "python": { "module": "aws_cdk.aws_appsync" } } }, "aws-cdk-lib.aws_apptest": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.AppTest" }, "java": { "package": "software.amazon.awscdk.services.apptest" }, "python": { "module": "aws_cdk.aws_apptest" } } }, "aws-cdk-lib.aws_aps": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.APS" }, "java": { "package": "software.amazon.awscdk.services.aps" }, "python": { "module": "aws_cdk.aws_aps" } } }, "aws-cdk-lib.aws_arcregionswitch": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.ARCRegionSwitch" }, "java": { "package": "software.amazon.awscdk.services.arcregionswitch" }, "python": { "module": "aws_cdk.aws_arcregionswitch" } } }, "aws-cdk-lib.aws_arczonalshift": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.ARCZonalShift" }, "java": { "package": "software.amazon.awscdk.services.arczonalshift" }, "python": { "module": "aws_cdk.aws_arczonalshift" } } }, "aws-cdk-lib.aws_athena": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Athena" }, "java": { "package": "software.amazon.awscdk.services.athena" }, "python": { "module": "aws_cdk.aws_athena" } } }, "aws-cdk-lib.aws_auditmanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AuditManager" }, "java": { "package": "software.amazon.awscdk.services.auditmanager" }, "python": { "module": "aws_cdk.aws_auditmanager" } } }, "aws-cdk-lib.aws_autoscaling": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScaling" }, "java": { "package": "software.amazon.awscdk.services.autoscaling" }, "python": { "module": "aws_cdk.aws_autoscaling" } } }, "aws-cdk-lib.aws_autoscaling_common": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScaling.Common" }, "java": { "package": "software.amazon.awscdk.services.autoscaling.common" }, "python": { "module": "aws_cdk.aws_autoscaling_common" } } }, "aws-cdk-lib.aws_autoscaling_hooktargets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScaling.HookTargets" }, "java": { "package": "software.amazon.awscdk.services.autoscaling.hooktargets" }, "python": { "module": "aws_cdk.aws_autoscaling_hooktargets" } } }, "aws-cdk-lib.aws_autoscalingplans": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScalingPlans" }, "java": { "package": "software.amazon.awscdk.services.autoscalingplans" }, "python": { "module": "aws_cdk.aws_autoscalingplans" } } }, "aws-cdk-lib.aws_b2bi": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.B2BI" }, "java": { "package": "software.amazon.awscdk.services.b2bi" }, "python": { "module": "aws_cdk.aws_b2bi" } } }, "aws-cdk-lib.aws_backup": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Backup" }, "java": { "package": "software.amazon.awscdk.services.backup" }, "python": { "module": "aws_cdk.aws_backup" } } }, "aws-cdk-lib.aws_backupgateway": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.BackupGateway" }, "java": { "package": "software.amazon.awscdk.services.backupgateway" }, "python": { "module": "aws_cdk.aws_backupgateway" } } }, "aws-cdk-lib.aws_batch": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Batch" }, "java": { "package": "software.amazon.awscdk.services.batch" }, "python": { "module": "aws_cdk.aws_batch" } } }, "aws-cdk-lib.aws_bcmdataexports": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.BCMDataExports" }, "java": { "package": "software.amazon.awscdk.services.bcmdataexports" }, "python": { "module": "aws_cdk.aws_bcmdataexports" } } }, "aws-cdk-lib.aws_bedrock": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Bedrock" }, "java": { "package": "software.amazon.awscdk.services.bedrock" }, "python": { "module": "aws_cdk.aws_bedrock" } } }, "aws-cdk-lib.aws_bedrockagentcore": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.BedrockAgentCore" }, "java": { "package": "software.amazon.awscdk.services.bedrockagentcore" }, "python": { "module": "aws_cdk.aws_bedrockagentcore" } } }, "aws-cdk-lib.aws_billingconductor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.BillingConductor" }, "java": { "package": "software.amazon.awscdk.services.billingconductor" }, "python": { "module": "aws_cdk.aws_billingconductor" } } }, "aws-cdk-lib.aws_budgets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Budgets" }, "java": { "package": "software.amazon.awscdk.services.budgets" }, "python": { "module": "aws_cdk.aws_budgets" } } }, "aws-cdk-lib.aws_cassandra": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cassandra" }, "java": { "package": "software.amazon.awscdk.services.cassandra" }, "python": { "module": "aws_cdk.aws_cassandra" } } }, "aws-cdk-lib.aws_ce": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CE" }, "java": { "package": "software.amazon.awscdk.services.ce" }, "python": { "module": "aws_cdk.aws_ce" } } }, "aws-cdk-lib.aws_certificatemanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CertificateManager" }, "java": { "package": "software.amazon.awscdk.services.certificatemanager" }, "python": { "module": "aws_cdk.aws_certificatemanager" } } }, "aws-cdk-lib.aws_chatbot": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Chatbot" }, "java": { "package": "software.amazon.awscdk.services.chatbot" }, "python": { "module": "aws_cdk.aws_chatbot" } } }, "aws-cdk-lib.aws_cleanrooms": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.CleanRooms" }, "java": { "package": "software.amazon.awscdk.services.cleanrooms" }, "python": { "module": "aws_cdk.aws_cleanrooms" } } }, "aws-cdk-lib.aws_cleanroomsml": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.CleanRoomsML" }, "java": { "package": "software.amazon.awscdk.services.cleanroomsml" }, "python": { "module": "aws_cdk.aws_cleanroomsml" } } }, "aws-cdk-lib.aws_cloud9": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cloud9" }, "java": { "package": "software.amazon.awscdk.services.cloud9" }, "python": { "module": "aws_cdk.aws_cloud9" } } }, "aws-cdk-lib.aws_cloudformation": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudFormation" }, "java": { "package": "software.amazon.awscdk.services.cloudformation" }, "python": { "module": "aws_cdk.aws_cloudformation" } } }, "aws-cdk-lib.aws_cloudfront": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudFront" }, "java": { "package": "software.amazon.awscdk.services.cloudfront" }, "python": { "module": "aws_cdk.aws_cloudfront" } } }, "aws-cdk-lib.aws_cloudfront.experimental": {}, "aws-cdk-lib.aws_cloudfront_origins": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudFront.Origins" }, "java": { "package": "software.amazon.awscdk.services.cloudfront.origins" }, "python": { "module": "aws_cdk.aws_cloudfront_origins" } } }, "aws-cdk-lib.aws_cloudtrail": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudTrail" }, "java": { "package": "software.amazon.awscdk.services.cloudtrail" }, "python": { "module": "aws_cdk.aws_cloudtrail" } } }, "aws-cdk-lib.aws_cloudwatch": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudWatch" }, "java": { "package": "software.amazon.awscdk.services.cloudwatch" }, "python": { "module": "aws_cdk.aws_cloudwatch" } } }, "aws-cdk-lib.aws_cloudwatch_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudWatch.Actions" }, "java": { "package": "software.amazon.awscdk.services.cloudwatch.actions" }, "python": { "module": "aws_cdk.aws_cloudwatch_actions" } } }, "aws-cdk-lib.aws_codeartifact": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeArtifact" }, "java": { "package": "software.amazon.awscdk.services.codeartifact" }, "python": { "module": "aws_cdk.aws_codeartifact" } } }, "aws-cdk-lib.aws_codebuild": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeBuild" }, "java": { "package": "software.amazon.awscdk.services.codebuild" }, "python": { "module": "aws_cdk.aws_codebuild" } } }, "aws-cdk-lib.aws_codecommit": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeCommit" }, "java": { "package": "software.amazon.awscdk.services.codecommit" }, "python": { "module": "aws_cdk.aws_codecommit" } } }, "aws-cdk-lib.aws_codeconnections": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.CodeConnections" }, "java": { "package": "software.amazon.awscdk.services.codeconnections" }, "python": { "module": "aws_cdk.aws_codeconnections" } } }, "aws-cdk-lib.aws_codedeploy": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeDeploy" }, "java": { "package": "software.amazon.awscdk.services.codedeploy" }, "python": { "module": "aws_cdk.aws_codedeploy" } } }, "aws-cdk-lib.aws_codeguruprofiler": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeGuruProfiler" }, "java": { "package": "software.amazon.awscdk.services.codeguruprofiler" }, "python": { "module": "aws_cdk.aws_codeguruprofiler" } } }, "aws-cdk-lib.aws_codegurureviewer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeGuruReviewer" }, "java": { "package": "software.amazon.awscdk.services.codegurureviewer" }, "python": { "module": "aws_cdk.aws_codegurureviewer" } } }, "aws-cdk-lib.aws_codepipeline": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodePipeline" }, "java": { "package": "software.amazon.awscdk.services.codepipeline" }, "python": { "module": "aws_cdk.aws_codepipeline" } } }, "aws-cdk-lib.aws_codepipeline_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodePipeline.Actions" }, "java": { "package": "software.amazon.awscdk.services.codepipeline.actions" }, "python": { "module": "aws_cdk.aws_codepipeline_actions" } } }, "aws-cdk-lib.aws_codestar": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Codestar" }, "java": { "package": "software.amazon.awscdk.services.codestar" }, "python": { "module": "aws_cdk.aws_codestar" } } }, "aws-cdk-lib.aws_codestarconnections": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeStarConnections" }, "java": { "package": "software.amazon.awscdk.services.codestarconnections" }, "python": { "module": "aws_cdk.aws_codestarconnections" } } }, "aws-cdk-lib.aws_codestarnotifications": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeStarNotifications" }, "java": { "package": "software.amazon.awscdk.services.codestarnotifications" }, "python": { "module": "aws_cdk.aws_codestarnotifications" } } }, "aws-cdk-lib.aws_cognito": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cognito" }, "java": { "package": "software.amazon.awscdk.services.cognito" }, "python": { "module": "aws_cdk.aws_cognito" } } }, "aws-cdk-lib.aws_cognito_identitypool": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cognito.Identitypool" }, "java": { "package": "software.amazon.awscdk.services.cognito.identitypool" }, "python": { "module": "aws_cdk.aws_cognito_identitypool" } } }, "aws-cdk-lib.aws_comprehend": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Comprehend" }, "java": { "package": "software.amazon.awscdk.services.comprehend" }, "python": { "module": "aws_cdk.aws_comprehend" } } }, "aws-cdk-lib.aws_config": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Config" }, "java": { "package": "software.amazon.awscdk.services.config" }, "python": { "module": "aws_cdk.aws_config" } } }, "aws-cdk-lib.aws_connect": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Connect" }, "java": { "package": "software.amazon.awscdk.services.connect" }, "python": { "module": "aws_cdk.aws_connect" } } }, "aws-cdk-lib.aws_connectcampaigns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ConnectCampaigns" }, "java": { "package": "software.amazon.awscdk.services.connectcampaigns" }, "python": { "module": "aws_cdk.aws_connectcampaigns" } } }, "aws-cdk-lib.aws_connectcampaignsv2": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.ConnectCampaignsV2" }, "java": { "package": "software.amazon.awscdk.services.connectcampaignsv2" }, "python": { "module": "aws_cdk.aws_connectcampaignsv2" } } }, "aws-cdk-lib.aws_controltower": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ControlTower" }, "java": { "package": "software.amazon.awscdk.services.controltower" }, "python": { "module": "aws_cdk.aws_controltower" } } }, "aws-cdk-lib.aws_cur": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CUR" }, "java": { "package": "software.amazon.awscdk.services.cur" }, "python": { "module": "aws_cdk.aws_cur" } } }, "aws-cdk-lib.aws_customerprofiles": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CustomerProfiles" }, "java": { "package": "software.amazon.awscdk.services.customerprofiles" }, "python": { "module": "aws_cdk.aws_customerprofiles" } } }, "aws-cdk-lib.aws_databrew": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DataBrew" }, "java": { "package": "software.amazon.awscdk.services.databrew" }, "python": { "module": "aws_cdk.aws_databrew" } } }, "aws-cdk-lib.aws_datapipeline": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DataPipeline" }, "java": { "package": "software.amazon.awscdk.services.datapipeline" }, "python": { "module": "aws_cdk.aws_datapipeline" } } }, "aws-cdk-lib.aws_datasync": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DataSync" }, "java": { "package": "software.amazon.awscdk.services.datasync" }, "python": { "module": "aws_cdk.aws_datasync" } } }, "aws-cdk-lib.aws_datazone": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.DataZone" }, "java": { "package": "software.amazon.awscdk.services.datazone" }, "python": { "module": "aws_cdk.aws_datazone" } } }, "aws-cdk-lib.aws_dax": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DAX" }, "java": { "package": "software.amazon.awscdk.services.dax" }, "python": { "module": "aws_cdk.aws_dax" } } }, "aws-cdk-lib.aws_deadline": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Deadline" }, "java": { "package": "software.amazon.awscdk.services.deadline" }, "python": { "module": "aws_cdk.aws_deadline" } } }, "aws-cdk-lib.aws_detective": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Detective" }, "java": { "package": "software.amazon.awscdk.services.detective" }, "python": { "module": "aws_cdk.aws_detective" } } }, "aws-cdk-lib.aws_devicefarm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DeviceFarm" }, "java": { "package": "software.amazon.awscdk.services.devicefarm" }, "python": { "module": "aws_cdk.aws_devicefarm" } } }, "aws-cdk-lib.aws_devopsguru": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DevOpsGuru" }, "java": { "package": "software.amazon.awscdk.services.devopsguru" }, "python": { "module": "aws_cdk.aws_devopsguru" } } }, "aws-cdk-lib.aws_directoryservice": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DirectoryService" }, "java": { "package": "software.amazon.awscdk.services.directoryservice" }, "python": { "module": "aws_cdk.aws_directoryservice" } } }, "aws-cdk-lib.aws_dlm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DLM" }, "java": { "package": "software.amazon.awscdk.services.dlm" }, "python": { "module": "aws_cdk.aws_dlm" } } }, "aws-cdk-lib.aws_dms": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DMS" }, "java": { "package": "software.amazon.awscdk.services.dms" }, "python": { "module": "aws_cdk.aws_dms" } } }, "aws-cdk-lib.aws_docdb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DocDB" }, "java": { "package": "software.amazon.awscdk.services.docdb" }, "python": { "module": "aws_cdk.aws_docdb" } } }, "aws-cdk-lib.aws_docdbelastic": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DocDBElastic" }, "java": { "package": "software.amazon.awscdk.services.docdbelastic" }, "python": { "module": "aws_cdk.aws_docdbelastic" } } }, "aws-cdk-lib.aws_dsql": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.DSQL" }, "java": { "package": "software.amazon.awscdk.services.dsql" }, "python": { "module": "aws_cdk.aws_dsql" } } }, "aws-cdk-lib.aws_dynamodb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DynamoDB" }, "java": { "package": "software.amazon.awscdk.services.dynamodb" }, "python": { "module": "aws_cdk.aws_dynamodb" } } }, "aws-cdk-lib.aws_ec2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EC2" }, "java": { "package": "software.amazon.awscdk.services.ec2" }, "python": { "module": "aws_cdk.aws_ec2" } } }, "aws-cdk-lib.aws_ecr": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ECR" }, "java": { "package": "software.amazon.awscdk.services.ecr" }, "python": { "module": "aws_cdk.aws_ecr" } } }, "aws-cdk-lib.aws_ecr_assets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Ecr.Assets" }, "java": { "package": "software.amazon.awscdk.services.ecr.assets" }, "python": { "module": "aws_cdk.aws_ecr_assets" } } }, "aws-cdk-lib.aws_ecs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ECS" }, "java": { "package": "software.amazon.awscdk.services.ecs" }, "python": { "module": "aws_cdk.aws_ecs" } } }, "aws-cdk-lib.aws_ecs_patterns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ECS.Patterns" }, "java": { "package": "software.amazon.awscdk.services.ecs.patterns" }, "python": { "module": "aws_cdk.aws_ecs_patterns" } } }, "aws-cdk-lib.aws_efs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EFS" }, "java": { "package": "software.amazon.awscdk.services.efs" }, "python": { "module": "aws_cdk.aws_efs" } } }, "aws-cdk-lib.aws_eks": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EKS" }, "java": { "package": "software.amazon.awscdk.services.eks" }, "python": { "module": "aws_cdk.aws_eks" } } }, "aws-cdk-lib.aws_elasticache": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElastiCache" }, "java": { "package": "software.amazon.awscdk.services.elasticache" }, "python": { "module": "aws_cdk.aws_elasticache" } } }, "aws-cdk-lib.aws_elasticbeanstalk": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticBeanstalk" }, "java": { "package": "software.amazon.awscdk.services.elasticbeanstalk" }, "python": { "module": "aws_cdk.aws_elasticbeanstalk" } } }, "aws-cdk-lib.aws_elasticloadbalancing": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancing" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancing" }, "python": { "module": "aws_cdk.aws_elasticloadbalancing" } } }, "aws-cdk-lib.aws_elasticloadbalancingv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancingv2" }, "python": { "module": "aws_cdk.aws_elasticloadbalancingv2" } } }, "aws-cdk-lib.aws_elasticloadbalancingv2_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2.Actions" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancingv2.actions" }, "python": { "module": "aws_cdk.aws_elasticloadbalancingv2_actions" } } }, "aws-cdk-lib.aws_elasticloadbalancingv2_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2.Targets" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancingv2.targets" }, "python": { "module": "aws_cdk.aws_elasticloadbalancingv2_targets" } } }, "aws-cdk-lib.aws_elasticsearch": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Elasticsearch" }, "java": { "package": "software.amazon.awscdk.services.elasticsearch" }, "python": { "module": "aws_cdk.aws_elasticsearch" } } }, "aws-cdk-lib.aws_emr": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EMR" }, "java": { "package": "software.amazon.awscdk.services.emr" }, "python": { "module": "aws_cdk.aws_emr" } } }, "aws-cdk-lib.aws_emrcontainers": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EMRContainers" }, "java": { "package": "software.amazon.awscdk.services.emrcontainers" }, "python": { "module": "aws_cdk.aws_emrcontainers" } } }, "aws-cdk-lib.aws_emrserverless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EMRServerless" }, "java": { "package": "software.amazon.awscdk.services.emrserverless" }, "python": { "module": "aws_cdk.aws_emrserverless" } } }, "aws-cdk-lib.aws_entityresolution": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.EntityResolution" }, "java": { "package": "software.amazon.awscdk.services.entityresolution" }, "python": { "module": "aws_cdk.aws_entityresolution" } } }, "aws-cdk-lib.aws_events": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Events" }, "java": { "package": "software.amazon.awscdk.services.events" }, "python": { "module": "aws_cdk.aws_events" } } }, "aws-cdk-lib.aws_events_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Events.Targets" }, "java": { "package": "software.amazon.awscdk.services.events.targets" }, "python": { "module": "aws_cdk.aws_events_targets" } } }, "aws-cdk-lib.aws_eventschemas": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EventSchemas" }, "java": { "package": "software.amazon.awscdk.services.eventschemas" }, "python": { "module": "aws_cdk.aws_eventschemas" } } }, "aws-cdk-lib.aws_evidently": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Evidently" }, "java": { "package": "software.amazon.awscdk.services.evidently" }, "python": { "module": "aws_cdk.aws_evidently" } } }, "aws-cdk-lib.aws_evs": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.EVS" }, "java": { "package": "software.amazon.awscdk.services.evs" }, "python": { "module": "aws_cdk.aws_evs" } } }, "aws-cdk-lib.aws_finspace": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FinSpace" }, "java": { "package": "software.amazon.awscdk.services.finspace" }, "python": { "module": "aws_cdk.aws_finspace" } } }, "aws-cdk-lib.aws_fis": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FIS" }, "java": { "package": "software.amazon.awscdk.services.fis" }, "python": { "module": "aws_cdk.aws_fis" } } }, "aws-cdk-lib.aws_fms": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FMS" }, "java": { "package": "software.amazon.awscdk.services.fms" }, "python": { "module": "aws_cdk.aws_fms" } } }, "aws-cdk-lib.aws_forecast": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Forecast" }, "java": { "package": "software.amazon.awscdk.services.forecast" }, "python": { "module": "aws_cdk.aws_forecast" } } }, "aws-cdk-lib.aws_frauddetector": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FraudDetector" }, "java": { "package": "software.amazon.awscdk.services.frauddetector" }, "python": { "module": "aws_cdk.aws_frauddetector" } } }, "aws-cdk-lib.aws_fsx": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FSx" }, "java": { "package": "software.amazon.awscdk.services.fsx" }, "python": { "module": "aws_cdk.aws_fsx" } } }, "aws-cdk-lib.aws_gamelift": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GameLift" }, "java": { "package": "software.amazon.awscdk.services.gamelift" }, "python": { "module": "aws_cdk.aws_gamelift" } } }, "aws-cdk-lib.aws_gameliftstreams": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.GameLiftStreams" }, "java": { "package": "software.amazon.awscdk.services.gameliftstreams" }, "python": { "module": "aws_cdk.aws_gameliftstreams" } } }, "aws-cdk-lib.aws_globalaccelerator": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GlobalAccelerator" }, "java": { "package": "software.amazon.awscdk.services.globalaccelerator" }, "python": { "module": "aws_cdk.aws_globalaccelerator" } } }, "aws-cdk-lib.aws_globalaccelerator_endpoints": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GlobalAccelerator.Endpoints" }, "java": { "package": "software.amazon.awscdk.services.globalaccelerator.endpoints" }, "python": { "module": "aws_cdk.aws_globalaccelerator_endpoints" } } }, "aws-cdk-lib.aws_glue": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Glue" }, "java": { "package": "software.amazon.awscdk.services.glue" }, "python": { "module": "aws_cdk.aws_glue" } } }, "aws-cdk-lib.aws_grafana": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Grafana" }, "java": { "package": "software.amazon.awscdk.services.grafana" }, "python": { "module": "aws_cdk.aws_grafana" } } }, "aws-cdk-lib.aws_greengrass": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Greengrass" }, "java": { "package": "software.amazon.awscdk.services.greengrass" }, "python": { "module": "aws_cdk.aws_greengrass" } } }, "aws-cdk-lib.aws_greengrassv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GreengrassV2" }, "java": { "package": "software.amazon.awscdk.services.greengrassv2" }, "python": { "module": "aws_cdk.aws_greengrassv2" } } }, "aws-cdk-lib.aws_groundstation": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GroundStation" }, "java": { "package": "software.amazon.awscdk.services.groundstation" }, "python": { "module": "aws_cdk.aws_groundstation" } } }, "aws-cdk-lib.aws_guardduty": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GuardDuty" }, "java": { "package": "software.amazon.awscdk.services.guardduty" }, "python": { "module": "aws_cdk.aws_guardduty" } } }, "aws-cdk-lib.aws_healthimaging": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.HealthImaging" }, "java": { "package": "software.amazon.awscdk.services.healthimaging" }, "python": { "module": "aws_cdk.aws_healthimaging" } } }, "aws-cdk-lib.aws_healthlake": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.HealthLake" }, "java": { "package": "software.amazon.awscdk.services.healthlake" }, "python": { "module": "aws_cdk.aws_healthlake" } } }, "aws-cdk-lib.aws_iam": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IAM" }, "java": { "package": "software.amazon.awscdk.services.iam" }, "python": { "module": "aws_cdk.aws_iam" } } }, "aws-cdk-lib.aws_identitystore": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IdentityStore" }, "java": { "package": "software.amazon.awscdk.services.identitystore" }, "python": { "module": "aws_cdk.aws_identitystore" } } }, "aws-cdk-lib.aws_imagebuilder": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ImageBuilder" }, "java": { "package": "software.amazon.awscdk.services.imagebuilder" }, "python": { "module": "aws_cdk.aws_imagebuilder" } } }, "aws-cdk-lib.aws_inspector": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Inspector" }, "java": { "package": "software.amazon.awscdk.services.inspector" }, "python": { "module": "aws_cdk.aws_inspector" } } }, "aws-cdk-lib.aws_inspectorv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.InspectorV2" }, "java": { "package": "software.amazon.awscdk.services.inspectorv2" }, "python": { "module": "aws_cdk.aws_inspectorv2" } } }, "aws-cdk-lib.aws_internetmonitor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.InternetMonitor" }, "java": { "package": "software.amazon.awscdk.services.internetmonitor" }, "python": { "module": "aws_cdk.aws_internetmonitor" } } }, "aws-cdk-lib.aws_invoicing": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Invoicing" }, "java": { "package": "software.amazon.awscdk.services.invoicing" }, "python": { "module": "aws_cdk.aws_invoicing" } } }, "aws-cdk-lib.aws_iot": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoT" }, "java": { "package": "software.amazon.awscdk.services.iot" }, "python": { "module": "aws_cdk.aws_iot" } } }, "aws-cdk-lib.aws_iotanalytics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTAnalytics" }, "java": { "package": "software.amazon.awscdk.services.iotanalytics" }, "python": { "module": "aws_cdk.aws_iotanalytics" } } }, "aws-cdk-lib.aws_iotcoredeviceadvisor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTCoreDeviceAdvisor" }, "java": { "package": "software.amazon.awscdk.services.iotcoredeviceadvisor" }, "python": { "module": "aws_cdk.aws_iotcoredeviceadvisor" } } }, "aws-cdk-lib.aws_iotevents": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTEvents" }, "java": { "package": "software.amazon.awscdk.services.iotevents" }, "python": { "module": "aws_cdk.aws_iotevents" } } }, "aws-cdk-lib.aws_iotfleethub": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTFleetHub" }, "java": { "package": "software.amazon.awscdk.services.iotfleethub" }, "python": { "module": "aws_cdk.aws_iotfleethub" } } }, "aws-cdk-lib.aws_iotfleetwise": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTFleetWise" }, "java": { "package": "software.amazon.awscdk.services.iotfleetwise" }, "python": { "module": "aws_cdk.aws_iotfleetwise" } } }, "aws-cdk-lib.aws_iotsitewise": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTSiteWise" }, "java": { "package": "software.amazon.awscdk.services.iotsitewise" }, "python": { "module": "aws_cdk.aws_iotsitewise" } } }, "aws-cdk-lib.aws_iotthingsgraph": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTThingsGraph" }, "java": { "package": "software.amazon.awscdk.services.iotthingsgraph" }, "python": { "module": "aws_cdk.aws_iotthingsgraph" } } }, "aws-cdk-lib.aws_iottwinmaker": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTTwinMaker" }, "java": { "package": "software.amazon.awscdk.services.iottwinmaker" }, "python": { "module": "aws_cdk.aws_iottwinmaker" } } }, "aws-cdk-lib.aws_iotwireless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTWireless" }, "java": { "package": "software.amazon.awscdk.services.iotwireless" }, "python": { "module": "aws_cdk.aws_iotwireless" } } }, "aws-cdk-lib.aws_ivs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Ivs" }, "java": { "package": "software.amazon.awscdk.services.ivs" }, "python": { "module": "aws_cdk.aws_ivs" } } }, "aws-cdk-lib.aws_ivschat": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IVSChat" }, "java": { "package": "software.amazon.awscdk.services.ivschat" }, "python": { "module": "aws_cdk.aws_ivschat" } } }, "aws-cdk-lib.aws_kafkaconnect": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KafkaConnect" }, "java": { "package": "software.amazon.awscdk.services.kafkaconnect" }, "python": { "module": "aws_cdk.aws_kafkaconnect" } } }, "aws-cdk-lib.aws_kendra": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Kendra" }, "java": { "package": "software.amazon.awscdk.services.kendra" }, "python": { "module": "aws_cdk.aws_kendra" } } }, "aws-cdk-lib.aws_kendraranking": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KendraRanking" }, "java": { "package": "software.amazon.awscdk.services.kendraranking" }, "python": { "module": "aws_cdk.aws_kendraranking" } } }, "aws-cdk-lib.aws_kinesis": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Kinesis" }, "java": { "package": "software.amazon.awscdk.services.kinesis" }, "python": { "module": "aws_cdk.aws_kinesis" } } }, "aws-cdk-lib.aws_kinesisanalytics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisAnalytics" }, "java": { "package": "software.amazon.awscdk.services.kinesisanalytics" }, "python": { "module": "aws_cdk.aws_kinesisanalytics" } } }, "aws-cdk-lib.aws_kinesisanalyticsv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisAnalyticsV2" }, "java": { "package": "software.amazon.awscdk.services.kinesisanalyticsv2" }, "python": { "module": "aws_cdk.aws_kinesisanalyticsv2" } } }, "aws-cdk-lib.aws_kinesisfirehose": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisFirehose" }, "java": { "package": "software.amazon.awscdk.services.kinesisfirehose" }, "python": { "module": "aws_cdk.aws_kinesisfirehose" } } }, "aws-cdk-lib.aws_kinesisvideo": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisVideo" }, "java": { "package": "software.amazon.awscdk.services.kinesisvideo" }, "python": { "module": "aws_cdk.aws_kinesisvideo" } } }, "aws-cdk-lib.aws_kms": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KMS" }, "java": { "package": "software.amazon.awscdk.services.kms" }, "python": { "module": "aws_cdk.aws_kms" } } }, "aws-cdk-lib.aws_lakeformation": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LakeFormation" }, "java": { "package": "software.amazon.awscdk.services.lakeformation" }, "python": { "module": "aws_cdk.aws_lakeformation" } } }, "aws-cdk-lib.aws_lambda": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda" }, "java": { "package": "software.amazon.awscdk.services.lambda" }, "python": { "module": "aws_cdk.aws_lambda" } } }, "aws-cdk-lib.aws_lambda_destinations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda.Destinations" }, "java": { "package": "software.amazon.awscdk.services.lambda.destinations" }, "python": { "module": "aws_cdk.aws_lambda_destinations" } } }, "aws-cdk-lib.aws_lambda_event_sources": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda.EventSources" }, "java": { "package": "software.amazon.awscdk.services.lambda.eventsources" }, "python": { "module": "aws_cdk.aws_lambda_event_sources" } } }, "aws-cdk-lib.aws_lambda_nodejs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda.Nodejs" }, "java": { "package": "software.amazon.awscdk.services.lambda.nodejs" }, "python": { "module": "aws_cdk.aws_lambda_nodejs" } } }, "aws-cdk-lib.aws_launchwizard": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.LaunchWizard" }, "java": { "package": "software.amazon.awscdk.services.launchwizard" }, "python": { "module": "aws_cdk.aws_launchwizard" } } }, "aws-cdk-lib.aws_lex": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lex" }, "java": { "package": "software.amazon.awscdk.services.lex" }, "python": { "module": "aws_cdk.aws_lex" } } }, "aws-cdk-lib.aws_licensemanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LicenseManager" }, "java": { "package": "software.amazon.awscdk.services.licensemanager" }, "python": { "module": "aws_cdk.aws_licensemanager" } } }, "aws-cdk-lib.aws_lightsail": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lightsail" }, "java": { "package": "software.amazon.awscdk.services.lightsail" }, "python": { "module": "aws_cdk.aws_lightsail" } } }, "aws-cdk-lib.aws_location": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Location" }, "java": { "package": "software.amazon.awscdk.services.location" }, "python": { "module": "aws_cdk.aws_location" } } }, "aws-cdk-lib.aws_logs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Logs" }, "java": { "package": "software.amazon.awscdk.services.logs" }, "python": { "module": "aws_cdk.aws_logs" } } }, "aws-cdk-lib.aws_logs_destinations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Logs.Destinations" }, "java": { "package": "software.amazon.awscdk.services.logs.destinations" }, "python": { "module": "aws_cdk.aws_logs_destinations" } } }, "aws-cdk-lib.aws_lookoutequipment": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LookoutEquipment" }, "java": { "package": "software.amazon.awscdk.services.lookoutequipment" }, "python": { "module": "aws_cdk.aws_lookoutequipment" } } }, "aws-cdk-lib.aws_lookoutmetrics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LookoutMetrics" }, "java": { "package": "software.amazon.awscdk.services.lookoutmetrics" }, "python": { "module": "aws_cdk.aws_lookoutmetrics" } } }, "aws-cdk-lib.aws_lookoutvision": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LookoutVision" }, "java": { "package": "software.amazon.awscdk.services.lookoutvision" }, "python": { "module": "aws_cdk.aws_lookoutvision" } } }, "aws-cdk-lib.aws_m2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.M2" }, "java": { "package": "software.amazon.awscdk.services.m2" }, "python": { "module": "aws_cdk.aws_m2" } } }, "aws-cdk-lib.aws_macie": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Macie" }, "java": { "package": "software.amazon.awscdk.services.macie" }, "python": { "module": "aws_cdk.aws_macie" } } }, "aws-cdk-lib.aws_managedblockchain": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ManagedBlockchain" }, "java": { "package": "software.amazon.awscdk.services.managedblockchain" }, "python": { "module": "aws_cdk.aws_managedblockchain" } } }, "aws-cdk-lib.aws_mediaconnect": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaConnect" }, "java": { "package": "software.amazon.awscdk.services.mediaconnect" }, "python": { "module": "aws_cdk.aws_mediaconnect" } } }, "aws-cdk-lib.aws_mediaconvert": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaConvert" }, "java": { "package": "software.amazon.awscdk.services.mediaconvert" }, "python": { "module": "aws_cdk.aws_mediaconvert" } } }, "aws-cdk-lib.aws_medialive": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaLive" }, "java": { "package": "software.amazon.awscdk.services.medialive" }, "python": { "module": "aws_cdk.aws_medialive" } } }, "aws-cdk-lib.aws_mediapackage": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaPackage" }, "java": { "package": "software.amazon.awscdk.services.mediapackage" }, "python": { "module": "aws_cdk.aws_mediapackage" } } }, "aws-cdk-lib.aws_mediapackagev2": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.MediaPackageV2" }, "java": { "package": "software.amazon.awscdk.services.mediapackagev2" }, "python": { "module": "aws_cdk.aws_mediapackagev2" } } }, "aws-cdk-lib.aws_mediastore": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaStore" }, "java": { "package": "software.amazon.awscdk.services.mediastore" }, "python": { "module": "aws_cdk.aws_mediastore" } } }, "aws-cdk-lib.aws_mediatailor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaTailor" }, "java": { "package": "software.amazon.awscdk.services.mediatailor" }, "python": { "module": "aws_cdk.aws_mediatailor" } } }, "aws-cdk-lib.aws_memorydb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MemoryDB" }, "java": { "package": "software.amazon.awscdk.services.memorydb" }, "python": { "module": "aws_cdk.aws_memorydb" } } }, "aws-cdk-lib.aws_mpa": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.MPA" }, "java": { "package": "software.amazon.awscdk.services.mpa" }, "python": { "module": "aws_cdk.aws_mpa" } } }, "aws-cdk-lib.aws_msk": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MSK" }, "java": { "package": "software.amazon.awscdk.services.msk" }, "python": { "module": "aws_cdk.aws_msk" } } }, "aws-cdk-lib.aws_mwaa": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MWAA" }, "java": { "package": "software.amazon.awscdk.services.mwaa" }, "python": { "module": "aws_cdk.aws_mwaa" } } }, "aws-cdk-lib.aws_neptune": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Neptune" }, "java": { "package": "software.amazon.awscdk.services.neptune" }, "python": { "module": "aws_cdk.aws_neptune" } } }, "aws-cdk-lib.aws_neptunegraph": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.NeptuneGraph" }, "java": { "package": "software.amazon.awscdk.services.neptunegraph" }, "python": { "module": "aws_cdk.aws_neptunegraph" } } }, "aws-cdk-lib.aws_networkfirewall": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.NetworkFirewall" }, "java": { "package": "software.amazon.awscdk.services.networkfirewall" }, "python": { "module": "aws_cdk.aws_networkfirewall" } } }, "aws-cdk-lib.aws_networkmanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.NetworkManager" }, "java": { "package": "software.amazon.awscdk.services.networkmanager" }, "python": { "module": "aws_cdk.aws_networkmanager" } } }, "aws-cdk-lib.aws_nimblestudio": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.NimbleStudio" }, "java": { "package": "software.amazon.awscdk.services.nimblestudio" }, "python": { "module": "aws_cdk.aws_nimblestudio" } } }, "aws-cdk-lib.aws_notifications": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Notifications" }, "java": { "package": "software.amazon.awscdk.services.notifications" }, "python": { "module": "aws_cdk.aws_notifications" } } }, "aws-cdk-lib.aws_notificationscontacts": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.NotificationsContacts" }, "java": { "package": "software.amazon.awscdk.services.notificationscontacts" }, "python": { "module": "aws_cdk.aws_notificationscontacts" } } }, "aws-cdk-lib.aws_oam": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Oam" }, "java": { "package": "software.amazon.awscdk.services.oam" }, "python": { "module": "aws_cdk.aws_oam" } } }, "aws-cdk-lib.aws_observabilityadmin": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.ObservabilityAdmin" }, "java": { "package": "software.amazon.awscdk.services.observabilityadmin" }, "python": { "module": "aws_cdk.aws_observabilityadmin" } } }, "aws-cdk-lib.aws_odb": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.ODB" }, "java": { "package": "software.amazon.awscdk.services.odb" }, "python": { "module": "aws_cdk.aws_odb" } } }, "aws-cdk-lib.aws_omics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Omics" }, "java": { "package": "software.amazon.awscdk.services.omics" }, "python": { "module": "aws_cdk.aws_omics" } } }, "aws-cdk-lib.aws_opensearchserverless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpenSearchServerless" }, "java": { "package": "software.amazon.awscdk.services.opensearchserverless" }, "python": { "module": "aws_cdk.aws_opensearchserverless" } } }, "aws-cdk-lib.aws_opensearchservice": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpenSearchService" }, "java": { "package": "software.amazon.awscdk.services.opensearchservice" }, "python": { "module": "aws_cdk.aws_opensearchservice" } } }, "aws-cdk-lib.aws_opsworks": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpsWorks" }, "java": { "package": "software.amazon.awscdk.services.opsworks" }, "python": { "module": "aws_cdk.aws_opsworks" } } }, "aws-cdk-lib.aws_opsworkscm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpsWorksCM" }, "java": { "package": "software.amazon.awscdk.services.opsworkscm" }, "python": { "module": "aws_cdk.aws_opsworkscm" } } }, "aws-cdk-lib.aws_organizations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Organizations" }, "java": { "package": "software.amazon.awscdk.services.organizations" }, "python": { "module": "aws_cdk.aws_organizations" } } }, "aws-cdk-lib.aws_osis": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.OSIS" }, "java": { "package": "software.amazon.awscdk.services.osis" }, "python": { "module": "aws_cdk.aws_osis" } } }, "aws-cdk-lib.aws_panorama": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Panorama" }, "java": { "package": "software.amazon.awscdk.services.panorama" }, "python": { "module": "aws_cdk.aws_panorama" } } }, "aws-cdk-lib.aws_paymentcryptography": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.PaymentCryptography" }, "java": { "package": "software.amazon.awscdk.services.paymentcryptography" }, "python": { "module": "aws_cdk.aws_paymentcryptography" } } }, "aws-cdk-lib.aws_pcaconnectorad": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.PCAConnectorAD" }, "java": { "package": "software.amazon.awscdk.services.pcaconnectorad" }, "python": { "module": "aws_cdk.aws_pcaconnectorad" } } }, "aws-cdk-lib.aws_pcaconnectorscep": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.PCAConnectorSCEP" }, "java": { "package": "software.amazon.awscdk.services.pcaconnectorscep" }, "python": { "module": "aws_cdk.aws_pcaconnectorscep" } } }, "aws-cdk-lib.aws_pcs": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.PCS" }, "java": { "package": "software.amazon.awscdk.services.pcs" }, "python": { "module": "aws_cdk.aws_pcs" } } }, "aws-cdk-lib.aws_personalize": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Personalize" }, "java": { "package": "software.amazon.awscdk.services.personalize" }, "python": { "module": "aws_cdk.aws_personalize" } } }, "aws-cdk-lib.aws_pinpoint": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Pinpoint" }, "java": { "package": "software.amazon.awscdk.services.pinpoint" }, "python": { "module": "aws_cdk.aws_pinpoint" } } }, "aws-cdk-lib.aws_pinpointemail": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.PinpointEmail" }, "java": { "package": "software.amazon.awscdk.services.pinpointemail" }, "python": { "module": "aws_cdk.aws_pinpointemail" } } }, "aws-cdk-lib.aws_pipes": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Pipes" }, "java": { "package": "software.amazon.awscdk.services.pipes" }, "python": { "module": "aws_cdk.aws_pipes" } } }, "aws-cdk-lib.aws_proton": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Proton" }, "java": { "package": "software.amazon.awscdk.services.proton" }, "python": { "module": "aws_cdk.aws_proton" } } }, "aws-cdk-lib.aws_qbusiness": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.QBusiness" }, "java": { "package": "software.amazon.awscdk.services.qbusiness" }, "python": { "module": "aws_cdk.aws_qbusiness" } } }, "aws-cdk-lib.aws_qldb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.QLDB" }, "java": { "package": "software.amazon.awscdk.services.qldb" }, "python": { "module": "aws_cdk.aws_qldb" } } }, "aws-cdk-lib.aws_quicksight": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.QuickSight" }, "java": { "package": "software.amazon.awscdk.services.quicksight" }, "python": { "module": "aws_cdk.aws_quicksight" } } }, "aws-cdk-lib.aws_ram": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RAM" }, "java": { "package": "software.amazon.awscdk.services.ram" }, "python": { "module": "aws_cdk.aws_ram" } } }, "aws-cdk-lib.aws_rbin": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Rbin" }, "java": { "package": "software.amazon.awscdk.services.rbin" }, "python": { "module": "aws_cdk.aws_rbin" } } }, "aws-cdk-lib.aws_rds": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RDS" }, "java": { "package": "software.amazon.awscdk.services.rds" }, "python": { "module": "aws_cdk.aws_rds" } } }, "aws-cdk-lib.aws_redshift": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Redshift" }, "java": { "package": "software.amazon.awscdk.services.redshift" }, "python": { "module": "aws_cdk.aws_redshift" } } }, "aws-cdk-lib.aws_redshiftserverless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RedshiftServerless" }, "java": { "package": "software.amazon.awscdk.services.redshiftserverless" }, "python": { "module": "aws_cdk.aws_redshiftserverless" } } }, "aws-cdk-lib.aws_refactorspaces": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RefactorSpaces" }, "java": { "package": "software.amazon.awscdk.services.refactorspaces" }, "python": { "module": "aws_cdk.aws_refactorspaces" } } }, "aws-cdk-lib.aws_rekognition": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Rekognition" }, "java": { "package": "software.amazon.awscdk.services.rekognition" }, "python": { "module": "aws_cdk.aws_rekognition" } } }, "aws-cdk-lib.aws_resiliencehub": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ResilienceHub" }, "java": { "package": "software.amazon.awscdk.services.resiliencehub" }, "python": { "module": "aws_cdk.aws_resiliencehub" } } }, "aws-cdk-lib.aws_resourceexplorer2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ResourceExplorer2" }, "java": { "package": "software.amazon.awscdk.services.resourceexplorer2" }, "python": { "module": "aws_cdk.aws_resourceexplorer2" } } }, "aws-cdk-lib.aws_resourcegroups": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ResourceGroups" }, "java": { "package": "software.amazon.awscdk.services.resourcegroups" }, "python": { "module": "aws_cdk.aws_resourcegroups" } } }, "aws-cdk-lib.aws_robomaker": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RoboMaker" }, "java": { "package": "software.amazon.awscdk.services.robomaker" }, "python": { "module": "aws_cdk.aws_robomaker" } } }, "aws-cdk-lib.aws_rolesanywhere": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RolesAnywhere" }, "java": { "package": "software.amazon.awscdk.services.rolesanywhere" }, "python": { "module": "aws_cdk.aws_rolesanywhere" } } }, "aws-cdk-lib.aws_route53": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53" }, "java": { "package": "software.amazon.awscdk.services.route53" }, "python": { "module": "aws_cdk.aws_route53" } } }, "aws-cdk-lib.aws_route53_patterns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53.Patterns" }, "java": { "package": "software.amazon.awscdk.services.route53.patterns" }, "python": { "module": "aws_cdk.aws_route53_patterns" } } }, "aws-cdk-lib.aws_route53_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53.Targets" }, "java": { "package": "software.amazon.awscdk.services.route53.targets" }, "python": { "module": "aws_cdk.aws_route53_targets" } } }, "aws-cdk-lib.aws_route53profiles": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Route53Profiles" }, "java": { "package": "software.amazon.awscdk.services.route53profiles" }, "python": { "module": "aws_cdk.aws_route53profiles" } } }, "aws-cdk-lib.aws_route53recoverycontrol": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53RecoveryControl" }, "java": { "package": "software.amazon.awscdk.services.route53recoverycontrol" }, "python": { "module": "aws_cdk.aws_route53recoverycontrol" } } }, "aws-cdk-lib.aws_route53recoveryreadiness": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53RecoveryReadiness" }, "java": { "package": "software.amazon.awscdk.services.route53recoveryreadiness" }, "python": { "module": "aws_cdk.aws_route53recoveryreadiness" } } }, "aws-cdk-lib.aws_route53resolver": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53Resolver" }, "java": { "package": "software.amazon.awscdk.services.route53resolver" }, "python": { "module": "aws_cdk.aws_route53resolver" } } }, "aws-cdk-lib.aws_rum": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RUM" }, "java": { "package": "software.amazon.awscdk.services.rum" }, "python": { "module": "aws_cdk.aws_rum" } } }, "aws-cdk-lib.aws_s3": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3" }, "java": { "package": "software.amazon.awscdk.services.s3" }, "python": { "module": "aws_cdk.aws_s3" } } }, "aws-cdk-lib.aws_s3_assets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3.Assets" }, "java": { "package": "software.amazon.awscdk.services.s3.assets" }, "python": { "module": "aws_cdk.aws_s3_assets" } } }, "aws-cdk-lib.aws_s3_deployment": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3.Deployment" }, "java": { "package": "software.amazon.awscdk.services.s3.deployment" }, "python": { "module": "aws_cdk.aws_s3_deployment" } } }, "aws-cdk-lib.aws_s3_notifications": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3.Notifications" }, "java": { "package": "software.amazon.awscdk.services.s3.notifications" }, "python": { "module": "aws_cdk.aws_s3_notifications" } } }, "aws-cdk-lib.aws_s3express": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.S3Express" }, "java": { "package": "software.amazon.awscdk.services.s3express" }, "python": { "module": "aws_cdk.aws_s3express" } } }, "aws-cdk-lib.aws_s3objectlambda": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3ObjectLambda" }, "java": { "package": "software.amazon.awscdk.services.s3objectlambda" }, "python": { "module": "aws_cdk.aws_s3objectlambda" } } }, "aws-cdk-lib.aws_s3outposts": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3Outposts" }, "java": { "package": "software.amazon.awscdk.services.s3outposts" }, "python": { "module": "aws_cdk.aws_s3outposts" } } }, "aws-cdk-lib.aws_s3tables": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.S3Tables" }, "java": { "package": "software.amazon.awscdk.services.s3tables" }, "python": { "module": "aws_cdk.aws_s3tables" } } }, "aws-cdk-lib.aws_sagemaker": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Sagemaker" }, "java": { "package": "software.amazon.awscdk.services.sagemaker" }, "python": { "module": "aws_cdk.aws_sagemaker" } } }, "aws-cdk-lib.aws_sam": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SAM" }, "java": { "package": "software.amazon.awscdk.services.sam" }, "python": { "module": "aws_cdk.aws_sam" } } }, "aws-cdk-lib.aws_scheduler": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Scheduler" }, "java": { "package": "software.amazon.awscdk.services.scheduler" }, "python": { "module": "aws_cdk.aws_scheduler" } } }, "aws-cdk-lib.aws_scheduler_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Scheduler.Targets" }, "java": { "package": "software.amazon.awscdk.services.scheduler.targets" }, "python": { "module": "aws_cdk.aws_scheduler_targets" } } }, "aws-cdk-lib.aws_sdb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SDB" }, "java": { "package": "software.amazon.awscdk.services.sdb" }, "python": { "module": "aws_cdk.aws_sdb" } } }, "aws-cdk-lib.aws_secretsmanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SecretsManager" }, "java": { "package": "software.amazon.awscdk.services.secretsmanager" }, "python": { "module": "aws_cdk.aws_secretsmanager" } } }, "aws-cdk-lib.aws_securityhub": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SecurityHub" }, "java": { "package": "software.amazon.awscdk.services.securityhub" }, "python": { "module": "aws_cdk.aws_securityhub" } } }, "aws-cdk-lib.aws_securitylake": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.SecurityLake" }, "java": { "package": "software.amazon.awscdk.services.securitylake" }, "python": { "module": "aws_cdk.aws_securitylake" } } }, "aws-cdk-lib.aws_servicecatalog": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Servicecatalog" }, "java": { "package": "software.amazon.awscdk.services.servicecatalog" }, "python": { "module": "aws_cdk.aws_servicecatalog" } } }, "aws-cdk-lib.aws_servicecatalogappregistry": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Servicecatalogappregistry" }, "java": { "package": "software.amazon.awscdk.services.servicecatalogappregistry" }, "python": { "module": "aws_cdk.aws_servicecatalogappregistry" } } }, "aws-cdk-lib.aws_servicediscovery": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ServiceDiscovery" }, "java": { "package": "software.amazon.awscdk.services.servicediscovery" }, "python": { "module": "aws_cdk.aws_servicediscovery" } } }, "aws-cdk-lib.aws_ses": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SES" }, "java": { "package": "software.amazon.awscdk.services.ses" }, "python": { "module": "aws_cdk.aws_ses" } } }, "aws-cdk-lib.aws_ses_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SES.Actions" }, "java": { "package": "software.amazon.awscdk.services.ses.actions" }, "python": { "module": "aws_cdk.aws_ses_actions" } } }, "aws-cdk-lib.aws_shield": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Shield" }, "java": { "package": "software.amazon.awscdk.services.shield" }, "python": { "module": "aws_cdk.aws_shield" } } }, "aws-cdk-lib.aws_signer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Signer" }, "java": { "package": "software.amazon.awscdk.services.signer" }, "python": { "module": "aws_cdk.aws_signer" } } }, "aws-cdk-lib.aws_simspaceweaver": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SimSpaceWeaver" }, "java": { "package": "software.amazon.awscdk.services.simspaceweaver" }, "python": { "module": "aws_cdk.aws_simspaceweaver" } } }, "aws-cdk-lib.aws_smsvoice": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.SMSVOICE" }, "java": { "package": "software.amazon.awscdk.services.smsvoice" }, "python": { "module": "aws_cdk.aws_smsvoice" } } }, "aws-cdk-lib.aws_sns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SNS" }, "java": { "package": "software.amazon.awscdk.services.sns" }, "python": { "module": "aws_cdk.aws_sns" } } }, "aws-cdk-lib.aws_sns_subscriptions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SNS.Subscriptions" }, "java": { "package": "software.amazon.awscdk.services.sns.subscriptions" }, "python": { "module": "aws_cdk.aws_sns_subscriptions" } } }, "aws-cdk-lib.aws_sqs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SQS" }, "java": { "package": "software.amazon.awscdk.services.sqs" }, "python": { "module": "aws_cdk.aws_sqs" } } }, "aws-cdk-lib.aws_ssm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSM" }, "java": { "package": "software.amazon.awscdk.services.ssm" }, "python": { "module": "aws_cdk.aws_ssm" } } }, "aws-cdk-lib.aws_ssmcontacts": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSMContacts" }, "java": { "package": "software.amazon.awscdk.services.ssmcontacts" }, "python": { "module": "aws_cdk.aws_ssmcontacts" } } }, "aws-cdk-lib.aws_ssmguiconnect": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.SSMGuiConnect" }, "java": { "package": "software.amazon.awscdk.services.ssmguiconnect" }, "python": { "module": "aws_cdk.aws_ssmguiconnect" } } }, "aws-cdk-lib.aws_ssmincidents": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSMIncidents" }, "java": { "package": "software.amazon.awscdk.services.ssmincidents" }, "python": { "module": "aws_cdk.aws_ssmincidents" } } }, "aws-cdk-lib.aws_ssmquicksetup": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.SSMQuickSetup" }, "java": { "package": "software.amazon.awscdk.services.ssmquicksetup" }, "python": { "module": "aws_cdk.aws_ssmquicksetup" } } }, "aws-cdk-lib.aws_sso": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSO" }, "java": { "package": "software.amazon.awscdk.services.sso" }, "python": { "module": "aws_cdk.aws_sso" } } }, "aws-cdk-lib.aws_stepfunctions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.StepFunctions" }, "java": { "package": "software.amazon.awscdk.services.stepfunctions" }, "python": { "module": "aws_cdk.aws_stepfunctions" } } }, "aws-cdk-lib.aws_stepfunctions_tasks": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.StepFunctions.Tasks" }, "java": { "package": "software.amazon.awscdk.services.stepfunctions.tasks" }, "python": { "module": "aws_cdk.aws_stepfunctions_tasks" } } }, "aws-cdk-lib.aws_supportapp": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SupportApp" }, "java": { "package": "software.amazon.awscdk.services.supportapp" }, "python": { "module": "aws_cdk.aws_supportapp" } } }, "aws-cdk-lib.aws_synthetics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Synthetics" }, "java": { "package": "software.amazon.awscdk.services.synthetics" }, "python": { "module": "aws_cdk.aws_synthetics" } } }, "aws-cdk-lib.aws_systemsmanagersap": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SystemsManagerSAP" }, "java": { "package": "software.amazon.awscdk.services.systemsmanagersap" }, "python": { "module": "aws_cdk.aws_systemsmanagersap" } } }, "aws-cdk-lib.aws_timestream": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Timestream" }, "java": { "package": "software.amazon.awscdk.services.timestream" }, "python": { "module": "aws_cdk.aws_timestream" } } }, "aws-cdk-lib.aws_transfer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Transfer" }, "java": { "package": "software.amazon.awscdk.services.transfer" }, "python": { "module": "aws_cdk.aws_transfer" } } }, "aws-cdk-lib.aws_verifiedpermissions": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.VerifiedPermissions" }, "java": { "package": "software.amazon.awscdk.services.verifiedpermissions" }, "python": { "module": "aws_cdk.aws_verifiedpermissions" } } }, "aws-cdk-lib.aws_voiceid": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.VoiceID" }, "java": { "package": "software.amazon.awscdk.services.voiceid" }, "python": { "module": "aws_cdk.aws_voiceid" } } }, "aws-cdk-lib.aws_vpclattice": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.VpcLattice" }, "java": { "package": "software.amazon.awscdk.services.vpclattice" }, "python": { "module": "aws_cdk.aws_vpclattice" } } }, "aws-cdk-lib.aws_waf": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WAF" }, "java": { "package": "software.amazon.awscdk.services.waf" }, "python": { "module": "aws_cdk.aws_waf" } } }, "aws-cdk-lib.aws_wafregional": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WAFRegional" }, "java": { "package": "software.amazon.awscdk.services.waf.regional" }, "python": { "module": "aws_cdk.aws_wafregional" } } }, "aws-cdk-lib.aws_wafv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WAFv2" }, "java": { "package": "software.amazon.awscdk.services.wafv2" }, "python": { "module": "aws_cdk.aws_wafv2" } } }, "aws-cdk-lib.aws_wisdom": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Wisdom" }, "java": { "package": "software.amazon.awscdk.services.wisdom" }, "python": { "module": "aws_cdk.aws_wisdom" } } }, "aws-cdk-lib.aws_workspaces": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WorkSpaces" }, "java": { "package": "software.amazon.awscdk.services.workspaces" }, "python": { "module": "aws_cdk.aws_workspaces" } } }, "aws-cdk-lib.aws_workspacesinstances": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.WorkspacesInstances" }, "java": { "package": "software.amazon.awscdk.services.workspacesinstances" }, "python": { "module": "aws_cdk.aws_workspacesinstances" } } }, "aws-cdk-lib.aws_workspacesthinclient": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.WorkSpacesThinClient" }, "java": { "package": "software.amazon.awscdk.services.workspacesthinclient" }, "python": { "module": "aws_cdk.aws_workspacesthinclient" } } }, "aws-cdk-lib.aws_workspacesweb": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.WorkSpacesWeb" }, "java": { "package": "software.amazon.awscdk.services.workspacesweb" }, "python": { "module": "aws_cdk.aws_workspacesweb" } } }, "aws-cdk-lib.aws_xray": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.XRay" }, "java": { "package": "software.amazon.awscdk.services.xray" }, "python": { "module": "aws_cdk.aws_xray" } } }, "aws-cdk-lib.cloud_assembly_schema": {}, "aws-cdk-lib.cloudformation_include": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CloudFormation.Include" }, "java": { "package": "software.amazon.awscdk.cloudformation.include" }, "python": { "module": "aws_cdk.cloudformation_include" } } }, "aws-cdk-lib.custom_resources": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CustomResources" }, "java": { "package": "software.amazon.awscdk.customresources" }, "python": { "module": "aws_cdk.custom_resources" } } }, "aws-cdk-lib.cx_api": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CXAPI" }, "java": { "package": "software.amazon.awscdk.cxapi" }, "python": { "module": "aws_cdk.cx_api" } } }, "aws-cdk-lib.lambda_layer_awscli": { "targets": { "dotnet": { "namespace": "Amazon.CDK.LambdaLayer.AwsCli" }, "java": { "package": "software.amazon.awscdk.lambdalayer.awscli" }, "python": { "module": "aws_cdk.lambda_layer_awscli" } } }, "aws-cdk-lib.lambda_layer_node_proxy_agent": { "targets": { "dotnet": { "namespace": "Amazon.CDK.LambdaLayer.NodeProxyAgent" }, "java": { "package": "software.amazon.awscdk.lambda.layer.node.proxy.agent" }, "python": { "module": "aws_cdk.lambda_layer_node_proxy_agent" } } }, "aws-cdk-lib.pipelines": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Pipelines" }, "java": { "package": "software.amazon.awscdk.pipelines" }, "python": { "module": "aws_cdk.pipelines" } } }, "aws-cdk-lib.region_info": { "targets": { "dotnet": { "namespace": "Amazon.CDK.RegionInfo" }, "java": { "package": "software.amazon.awscdk.regioninfo" }, "python": { "module": "aws_cdk.region_info" } } }, "aws-cdk-lib.triggers": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Triggers" }, "java": { "package": "software.amazon.awscdk.triggers" }, "python": { "module": "aws_cdk.triggers" } } } }, "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/main/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK.Lib" }, "go": { "moduleName": "github.com/aws/aws-cdk-go", "packageName": "awscdk" }, "java": { "maven": { "artifactId": "aws-cdk-lib", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "aws-cdk-lib" }, "python": { "distName": "aws-cdk-lib", "module": "aws_cdk" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "Combine the power of AWS CDK & OpenAPI YAML Schema Definitions", "docs": { "stability": "experimental" }, "homepage": "https://github.com/alma-cdk/openapix.git", "jsiiVersion": "5.9.34 (build 8773a22)", "keywords": [ "api-gateway", "aws", "aws-cdk", "awscdk", "cdk", "cloudfront", "open-api", "rest-api", "swagger" ], "license": "Apache-2.0", "metadata": { "jsii": { "pacmak": { "hasDefaultInterfaces": true } }, "tscRootDir": "src" }, "name": "@alma-cdk/openapix", "readme": { "markdown": "
\n\t
\n\t
\n

\n\t\"Alma\n
\n
\n

\n\n ```sh\n npm i -D @alma-cdk/openapix\n ```\n\n
\n\n Generate AWS Api Gateway REST APIs via [OpenAPI](https://www.openapis.org/) (formely known as “Swagger”) Schema Definitions by consuming \"clean\" OpenAPI schemas and inject `x-amazon-apigateway-` extensions _with type-safety_.\n\n
\n
\n
\n\n\n
\n\n
\n\n![diagram](assets/diagram.svg)\n\n
\n\n
\n\n## 🚧   Project Stability\n\n![experimental](https://img.shields.io/badge/stability-experimental-yellow \"Stability: Experimental\")\n\nThis construct is still versioned with `v0` major version and breaking changes might be introduced if necessary (without a major version bump), though we aim to keep the API as stable as possible (even within `v0` development). We aim to publish `v1.0.0` soon and after that breaking changes will be introduced via major version bumps.\n\nThere are also some incomplete or buggy features, such as CORS and `CognitoUserPoolsAuthorizer`.\n\n\n
\n\n## Getting Started\n\n1. Install `npm i -D @alma-cdk/openapix`\n\n2. Define your API OpenApi Schema Definition in a `.yaml` file
_without_ any `x-amazon-apigateway-` extensions\n\n3. Use `openapix` constructs in CDK to consume the `.yaml` file and then assign API Gateway integrations using CDK\n\n\n
\n\n## HTTP Integration\n\nGiven the following [`http-proxy.yaml` OpenApi schema definition](https://github.com/alma-cdk/openapix/blob/main/examples/http-proxy/schema/http-proxy.yaml), _without_ any AWS API Gateway OpenApi extensions:\n```yaml\nopenapi: 3.0.3\ninfo:\n title: HTTP Proxy\n description: Proxies requests to example.com\n version: \"0.0.1\"\npaths:\n \"/\":\n get:\n summary: proxy\n description: Proxies example.com\n```\n\nYou may then define API Gateway HTTP integration (within your stack):\n```ts\nnew openapix.Api(this, 'HttpProxy', {\n source: path.join(__dirname, '../schema/http-proxy.yaml'),\n\n paths: {\n '/': {\n get: new openapix.HttpIntegration(this, 'http://example.com', {\n httpMethod: 'get',\n }),\n },\n },\n});\n```\n\nSee [`/examples/http-proxy`](https://github.com/alma-cdk/openapix/tree/main/examples/http-proxy) for full OpenApi definition (with response models) and an example within a CDK application.\n\n\n
\n\n## Lambda Integration\n\nGiven the following [`hello-api.yaml` OpenApi schema definition](https://github.com/alma-cdk/openapix/blob/main/examples/hello-api/schema/hello-api.yaml), _without_ any AWS API Gateway OpenApi extensions:\n```yaml\nopenapi: 3.0.3\ninfo:\n title: Hello API\n description: Defines an example “Hello World” API\n version: \"0.0.1\"\npaths:\n \"/\":\n get:\n operationId: sayHello\n summary: Say Hello\n description: Prints out a greeting\n parameters:\n - name: name\n in: query\n required: false\n schema:\n type: string\n default: \"World\"\n responses:\n \"200\":\n description: Successful response\n content:\n \"application/json\":\n schema:\n $ref: \"#/components/schemas/HelloResponse\"\n\ncomponents:\n schemas:\n HelloResponse:\n description: Response body\n type: object\n properties:\n message:\n type: string\n description: Greeting\n example: Hello World!\n```\n\nYou may then define API Gateway AWS Lambda integration (within your stack):\n```ts\nconst greetFn = new NodejsFunction(this, 'greet');\n\nnew openapix.Api(this, 'HelloApi', {\n source: path.join(__dirname, '../schema/hello-api.yaml'),\n paths: {\n '/': {\n get: new openapix.LambdaIntegration(this, greetFn),\n },\n },\n})\n```\n\nSee [`/examples/hello-api`](https://github.com/alma-cdk/openapix/tree/main/examples/hello-api) for full OpenApi definition (with response models) and an example within a CDK application.\n\n\n
\n\n\n\n## AWS Service Integration\n\nGiven [`books-api.yaml` OpenApi schema definition](https://github.com/alma-cdk/openapix/blob/main/examples/books-api/schema/books-api.yaml), _without_ any AWS API Gateway OpenApi extensions, You may then define API Gateway AWS service integration such as DynamoDB (within your stack):\n\n```ts\nnew openapix.Api(this, 'BooksApi', {\n source: path.join(__dirname, '../schema/books-api.yaml'),\n paths: {\n '/': {\n get: new openapix.AwsIntegration(this, {\n service: 'dynamodb',\n action: 'Scan',\n options: {\n credentialsRole: role, // role must have access to DynamoDB table\n requestTemplates: {\n 'application/json': JSON.stringify({\n TableName: table.tableName,\n }),\n },\n integrationResponses: [\n {\n statusCode: '200',\n responseTemplates: {\n // See /examples/http-proxy/lib/list-books.vtl\n 'application/json': readFileSync(__dirname+'/list-books.vtl', 'utf-8'),\n },\n }\n ],\n },\n }),\n },\n '/{isbn}': {\n get: new openapix.AwsIntegration(this, {\n service: 'dynamodb',\n action: 'GetItem',\n options: {\n credentialsRole: role, // role must have access to DynamoDB table\n requestTemplates: {\n 'application/json': JSON.stringify({\n TableName: table.tableName,\n Key: {\n item: {\n \"S\": \"$input.params('isbn')\"\n }\n }\n }),\n },\n integrationResponses: [\n {\n statusCode: '200',\n responseTemplates: {\n // See /examples/http-proxy/lib/get-book.vtl\n 'application/json': readFileSync(__dirname+'/get-book.vtl', 'utf-8'),\n },\n }\n ],\n },\n }),\n },\n },\n});\n```\n\nSee [`/examples/books-api`](https://github.com/alma-cdk/openapix/tree/main/examples/books-api) for full OpenApi definition (with response models) and an example within a CDK application.\n\n
\n\n## Mock Integration\n\nGiven the following [`mock-api.yaml` OpenApi schema definition](https://github.com/alma-cdk/openapix/blob/main/examples/mock-api/schema/mock-api.yaml), _without_ any AWS API Gateway OpenApi extensions:\n\n```yaml\nopenapi: 3.0.3\ninfo:\n title: Hello API\n description: Defines an example “Hello World” API\n version: \"0.0.1\"\npaths:\n \"/\":\n get:\n operationId: sayHello\n summary: Say Hello\n description: Prints out a greeting\n parameters:\n - name: name\n in: query\n required: false\n schema:\n type: string\n default: \"World\"\n responses:\n \"200\":\n description: Successful response\n content:\n \"application/json\":\n schema:\n $ref: \"#/components/schemas/HelloResponse\"\n\ncomponents:\n schemas:\n HelloResponse:\n description: Response body\n type: object\n properties:\n message:\n type: string\n description: Greeting\n example: Hello World!\n```\n\nYou may then define API Gateway Mock integration (within your stack):\n```ts\nnew openapix.Api(this, 'MockApi', {\n source: path.join(__dirname, '../schema/mock-api.yaml'),\n paths: {\n '/': {\n get: new openapix.MockIntegration(this, {\n requestTemplates: {\n \"application/json\": JSON.stringify({ statusCode: 200 }),\n },\n passthroughBehavior: apigateway.PassthroughBehavior.NEVER,\n requestParameters: {\n 'integration.request.querystring.name': 'method.request.querystring.name',\n },\n integrationResponses: [\n {\n statusCode: '200',\n responseTemplates: {\n // see /examples/mock-api/lib/greet.vtl\n 'application/json': readFileSync(__dirname+'/greet.vtl', 'utf-8'),\n },\n responseParameters: {},\n },\n ],\n }),\n },\n },\n});\n```\n\nSee [`/examples/mock-api`](https://github.com/alma-cdk/openapix/tree/main/examples/mock-api) for full OpenApi definition (with response models) and an example within a CDK application.\n\n
\n\n## Validators\n\nAPI Gateway REST APIs can perform [request parameter and request body validation](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html). You can provide both default validator and integration specific validator (which will override the default for given integration).\n\nSee [`/examples/todo-api`](https://github.com/alma-cdk/openapix/tree/main/examples/todo-api) for complete example within a CDK application.\n\nGiven [`todo-api.yaml` OpenApi schema definition](https://github.com/alma-cdk/openapix/blob/main/examples/todo-api/schema/todo-api.yaml) you may define the API Gateway validators for your integration in CDK:\n```ts\nnew openapix.Api(this, 'MyApi', {\n source: path.join(__dirname, '../schema/todo-api.yaml'),\n\n validators: {\n 'all': {\n validateRequestBody: true,\n validateRequestParameters: true,\n default: true, // set this as the \"API level\" default validator (there can be only one)\n },\n 'params-only' : {\n validateRequestBody: false,\n validateRequestParameters: true,\n },\n },\n\n paths: {\n '/todos': {\n // this one uses the default 'all' validator\n post: new openapix.HttpIntegration(this, baseUrl, { httpMethod: 'post' }),\n },\n '/todos/{todoId}': {\n // this one has validator override and uses 'params-only' validator\n get: new openapix.HttpIntegration(this, `${baseUrl}/{todoId}`, {\n validator: 'params-only',\n options: {\n requestParameters: {\n 'integration.request.path.todoId': 'method.request.path.todoId',\n },\n },\n }),\n },\n },\n})\n```\n\n
\n\n## Authorizers\n\n🚧 Work-in-Progress\n\nThere are multiple ways to [control & manages access to API Gateway REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-to-api.html) such as [resource policies](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html), [IAM permissions](https://docs.aws.amazon.com/apigateway/latest/developerguide/permissions.html) and [usage plans with API keys](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) but this section focuses on [Cognito User Pools ](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html) and [Lambda authorizers](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html).\n\n
\n\n### Cognito Authorizers\n\nIn this example we're defining a Congito User Pool based authorizer.\n\nGiven the following `schema.yaml` OpenApi definition:\n```yaml\nopenapi: 3.0.3\npaths:\n /:\n get:\n security:\n - MyAuthorizer: [\"test/read\"] # add scope\ncomponents:\n securitySchemes:\n MyCognitoAuthorizer:\n type: apiKey\n name: Authorization\n in: header\n```\n\nYou can define the Cognito Authorizer in CDK with:\n```ts\nconst userPool: cognito.IUserPool;\n\nnew openapix.Api(this, 'MyApi', {\n source: './schema.yaml',\n\n authorizers: [\n new openapix.CognitoUserPoolsAuthorizer(this, 'MyCognitoAuthorizer', {\n cognitoUserPools: [userPool],\n resultsCacheTtl: Duration.minutes(5),\n })\n ],\n})\n```\n\n
\n\n### Lambda Authorizers\n\nIn this example we're defining a custom Lambda authorizer. The authorizer function code is not relevant for the example but the idea in the example is that an API caller sends some \"secret code\" in query parameters (`?code=example123456`) which then the authorizer function somehow evaluates.\n\nGiven the following `schema.yaml` OpenApi definition:\n```yaml\nopenapi: 3.0.3\npaths:\n /:\n get:\n security:\n - MyAuthorizer: [] # note the empty array\ncomponents:\n securitySchemes:\n MyCustomAuthorizer:\n type: apiKey\n name: code\n in: query\n```\n\nYou can define the custom Lambda Authorizer in CDK with:\n```ts\nconst authFn: lambda.IFunction;\n\nnew openapix.Api(this, 'MyApi', {\n source: './schema.yaml',\n\n authorizers: [\n\n new openapix.LambdaAuthorizer(this, 'MyCustomAuthorizer', {\n fn: authFn,\n identitySource: apigateway.IdentitySource.queryString('code'),\n type: 'request',\n authType: 'custom',\n resultsCacheTtl: Duration.minutes(5),\n }),\n ],\n\n\n})\n```\n\n\n
\n\n## Inject/Reject\n\nYou may modify the generated OpenAPI definition (which is used to define API Gateway REST API) by injecting or rejecting values from the source OpenAPI schema definition:\n```ts\nnew openapix.Api(this, 'MyApi', {\n source: './schema.yaml',\n\n // Add any OpenAPI v3 data.\n // Can be useful for passing values from CDK code.\n // See https://swagger.io/specification/\n injections: {\n \"info.title\": \"FancyPantsAPI\"\n },\n\n // Reject fields by absolute object path from generated definition\n rejections: ['info.description'],\n\n // Reject all matching fields from generated definition\n rejectionsDeep: ['example', 'examples'],\n});\n```\n\n
\n\n## CORS\n\n🚧 Work-in-Progress\n\nUsing `openapix.CorsIntegration` creates a Mock integration which responds with correct response headers:\n\n```ts\nnew openapix.Api(this, 'MyApi', {\n source: './schema.yaml',\n\n paths: {\n '/foo': {\n options: new openapix.CorsIntegration(this, {\n // using helper method to define explicit values:\n headers: CorsHeaders.from(this, 'Content-Type', 'X-Amz-Date', 'Authorization'),\n origins: CorsOrigins.from(this, 'https://www.example.com'),\n methods: CorsMethods.from(this, 'options','post','get'),\n }),\n },\n '/bar': {\n options: new openapix.CorsIntegration(this, {\n // using regular string values:\n headers: 'Content-Type,X-Amz-Date,Authorization',\n origins: '*',\n methods: 'options,get',\n }),\n },\n '/baz': {\n options: new openapix.CorsIntegration(this, {\n // using helper constant for wildcard values:\n headers: CorsHeaders.ANY,\n origins: CorsOrigins.ANY,\n methods: CorsMethods.ANY,\n }),\n },\n },\n});\n```\n\nWhen specifying multiple `origins` the mock integration uses [VTL magic](https://medium.com/@srikanth650/use-api-gateway-with-mock-integration-to-allow-cors-from-multiple-origins-bdcb431d07d3) to respond with the correct `Access-Control-Allow-Origin` header.\n\n### Default CORS\n\nIf you wish to define same CORS options to every path, you may do so by providing a default `cors` value:\n```ts\nnew openapix.Api(this, 'MyApi', {\n source: './schema.yaml',\n\n defaultCors: new openapix.CorsIntegration(this, {\n headers: CorsHeaders.ANY,\n origins: CorsOrigins.ANY,\n methods: CorsMethods.ANY,\n }),\n\n paths: {/*...*/},\n});\n```\n\nThis will apply the given `cors` configuration to _every_ path as `options` method. You may still do path specific overrides by adding an `options` method to specific paths.\n\n
\n\n## API Gateway EndpointType\n\nAWS CDK API Gateway constructs default to [_Edge-optimized API endpoints_](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-endpoint-types.html#api-gateway-api-endpoint-types-edge-optimized) by using [`EndpointType.EDGE`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html#endpointtypes) as the default.\n\nThis construct `@alma-cdk/openapix` instead defaults to using [_Regional API endpoints_](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-endpoint-types.html#api-gateway-api-endpoint-types-regional) by setting `EndpointType.REGIONAL` as the default value. This is because we believe that in most cases you're better of by configuring your own CloudFront distribution in front the API. If you do that, you might also be interested in [`@alma-cdk/origin-verify` construct](https://github.com/alma-cdk/origin-verify).\n\nYou MAY override this default in `@alma-cdk/openapix` by providing your preferred endpoint types via `restApiProps`:\n```ts\nnew openapix.Api(this, 'MyApi', {\n source: './schema.yaml',\n\n paths: {/*...*/},\n\n restApiProps: {\n endpointConfiguration: {\n types: [ apigateway.EndpointType.EDGE ],\n },\n },\n});\n```\n\n\n\n\n" }, "repository": { "type": "git", "url": "https://github.com/alma-cdk/openapix.git" }, "schema": "jsii/0.10.0", "targets": { "js": { "npm": "@alma-cdk/openapix" } }, "types": { "@alma-cdk/openapix.Api": { "assembly": "@alma-cdk/openapix", "base": "aws-cdk-lib.aws_apigateway.SpecRestApi", "docs": { "stability": "experimental", "summary": "AWS API Gateway REST API defined with OpenApi v3 schema." }, "fqn": "@alma-cdk/openapix.Api", "initializer": { "docs": { "example": "const fn: IFunction;\n\nnew openapix.Api(this, 'MyApi', {\n source: './schema.yaml',\n paths: {\n '/foo': {\n get: new openapix.MockIntegration(this),\n },\n '/bar': {\n post: new openapix.LambdaIntegration(this, fn),\n },\n }\n})", "stability": "experimental", "summary": "Define a new API Gateway REST API using OpenApi v3 Schema definition." }, "locationInModule": { "filename": "src/api/api.ts", "line": 38 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@alma-cdk/openapix.ApiProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/api/api.ts", "line": 13 }, "name": "Api", "properties": [ { "docs": { "stability": "experimental", "summary": "The final OpenApi v3 document used to generate the AWS API Gateway." }, "immutable": true, "locationInModule": { "filename": "src/api/api.ts", "line": 17 }, "name": "document", "type": { "fqn": "@alma-cdk/openapix.IDocument" } } ], "symbolId": "src/api/api:Api" }, "@alma-cdk/openapix.ApiBaseProps": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "BaseProps for the `Api` construct without `RestApiProps`." }, "fqn": "@alma-cdk/openapix.ApiBaseProps", "kind": "interface", "locationInModule": { "filename": "src/api/props.ts", "line": 9 }, "name": "ApiBaseProps", "properties": [ { "abstract": true, "docs": { "example": "const props: openapix.SchemaProps;\nnew openapix.Schema(props)", "remarks": "Provide either string path to source or an instance of `openapix.Schema`.", "stability": "experimental", "summary": "OpenApi Schema Definition source configuration." }, "immutable": true, "locationInModule": { "filename": "src/api/props.ts", "line": 25 }, "name": "source", "type": { "union": { "types": [ { "primitive": "string" }, { "fqn": "@alma-cdk/openapix.Schema" } ] } } }, { "abstract": true, "docs": { "example": "[\n new openapix.CognitoUserPoolsAuthorizer(this, 'MyCognitoAuthorizer', {\n cognitoUserPools: [userPool],\n resultsCacheTtl: Duration.minutes(5),\n }),\n]", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html", "stability": "experimental", "summary": "Cognito User Pool or Custom Lambda based Authorizer configurations." }, "immutable": true, "locationInModule": { "filename": "src/api/props.ts", "line": 72 }, "name": "authorizers", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.AuthorizerConfig" }, "kind": "array" } } }, { "abstract": true, "docs": { "example": "new openapix.CorsIntegration(this, {\n headers: 'Content-Type,X-Amz-Date,Authorization',\n origins: '*',\n methods: 'options,get',\n}),", "remarks": "You can add path specific overrides by adding an `options` method with\n`new openapix.CorsIntegration(...)` integration.", "stability": "experimental", "summary": "Default CORS configuration. Applied to all path integrations." }, "immutable": true, "locationInModule": { "filename": "src/api/props.ts", "line": 116 }, "name": "defaultCors", "optional": true, "type": { "fqn": "@alma-cdk/openapix.CorsIntegration" } }, { "abstract": true, "docs": { "example": "{\n 'defaultIntegration': new openapix.LambdaIntegration(this, fn),\n}", "stability": "experimental", "summary": "Add a default integration for paths without explicitly defined integrations." }, "immutable": true, "locationInModule": { "filename": "src/api/props.ts", "line": 56 }, "name": "defaultIntegration", "optional": true, "type": { "fqn": "@alma-cdk/openapix.Integration" } }, { "abstract": true, "docs": { "example": "{\n \"info.title\": \"FancyPantsAPI\"\n}", "stability": "experimental", "summary": "Inject any OpenApi v3 data to given schema definition object paths." }, "immutable": true, "locationInModule": { "filename": "src/api/props.ts", "line": 126 }, "name": "injections", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "example": "{\n '/message': {\n post: new openapix.LambdaIntegration(this, fn),\n },\n}", "stability": "experimental", "summary": "Integrations for OpenApi Path definitions." }, "immutable": true, "locationInModule": { "filename": "src/api/props.ts", "line": 47 }, "name": "paths", "optional": true, "type": { "fqn": "@alma-cdk/openapix.Paths" } }, { "abstract": true, "docs": { "example": "['info.description']", "stability": "experimental", "summary": "Reject fields by absolute object path from generated definition." }, "immutable": true, "locationInModule": { "filename": "src/api/props.ts", "line": 134 }, "name": "rejections", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "example": "['example', 'examples']", "stability": "experimental", "summary": "Reject all matching fields from generated definition." }, "immutable": true, "locationInModule": { "filename": "src/api/props.ts", "line": 142 }, "name": "rejectionsDeep", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "false", "remarks": "S3 location).\nSet `true` to upload to S3 or `false` (default) to inline it into resulting\nCloudFormation template.", "stability": "experimental", "summary": "Schema Definition location (inline vs." }, "immutable": true, "locationInModule": { "filename": "src/api/props.ts", "line": 35 }, "name": "upload", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "example": "{\n 'all': {\n validateRequestBody: true,\n validateRequestParameters: true,\n default: true,\n },\n 'params-only' : {\n validateRequestBody: false,\n validateRequestParameters: true,\n },\n}", "remarks": "You can optionally specify one of them with `default: true` to promote it\nas the default validator applied to all integrations.\n\nFor non-default validators, you must specify `validator: ''` prop in\nevery integration you wish to use the given validator.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html", "stability": "experimental", "summary": "Configure availalbe request validators. API Gateway REST APIs can perform request parameter and request body validation." }, "immutable": true, "locationInModule": { "filename": "src/api/props.ts", "line": 100 }, "name": "validators", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.Validator" }, "kind": "map" } } } ], "symbolId": "src/api/props:ApiBaseProps" }, "@alma-cdk/openapix.ApiProps": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Props to configure `new openapix.Api`." }, "fqn": "@alma-cdk/openapix.ApiProps", "interfaces": [ "@alma-cdk/openapix.ApiBaseProps" ], "kind": "interface", "locationInModule": { "filename": "src/api/props.ts", "line": 146 }, "name": "ApiProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Props to configure the underlying CDK `apigateway.RestApi`." }, "immutable": true, "locationInModule": { "filename": "src/api/props.ts", "line": 148 }, "name": "restApiProps", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_apigateway.RestApiProps" } } ], "symbolId": "src/api/props:ApiProps" }, "@alma-cdk/openapix.AuthorizerConfig": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.AuthorizerConfig", "interfaces": [ "@alma-cdk/openapix.AuthorizerExtensions" ], "kind": "interface", "locationInModule": { "filename": "src/authorizers/authorizer.ts", "line": 13 }, "name": "AuthorizerConfig", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/authorizer.ts", "line": 14 }, "name": "id", "type": { "primitive": "string" } } ], "symbolId": "src/authorizers/authorizer:AuthorizerConfig" }, "@alma-cdk/openapix.AuthorizerExtensions": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.AuthorizerExtensions", "kind": "interface", "locationInModule": { "filename": "src/authorizers/authorizer.ts", "line": 17 }, "name": "AuthorizerExtensions", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/authorizer.ts", "line": 19 }, "name": "xAmazonApigatewayAuthorizer", "type": { "fqn": "@alma-cdk/openapix.XAmazonApigatewayAuthorizer" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/authorizer.ts", "line": 18 }, "name": "xAmazonApigatewayAuthtype", "type": { "primitive": "string" } } ], "symbolId": "src/authorizers/authorizer:AuthorizerExtensions" }, "@alma-cdk/openapix.AwsIntegration": { "assembly": "@alma-cdk/openapix", "base": "@alma-cdk/openapix.Integration", "docs": { "stability": "experimental", "summary": "Defines direct AWS service integration." }, "fqn": "@alma-cdk/openapix.AwsIntegration", "initializer": { "docs": { "example": "'/item': {\n 'GET': new openapix.AwsIntegration(this, {\n service: 'dynamodb',\n action: 'GetItem',\n options: {\n credentialsRole: role,\n requestTemplates: {\n 'application/json': JSON.stringify({\n \"TableName\": table.tableName,\n \"Key\": {\n 'PK': {\n \"S\": \"$input.params('item')\"\n }\n }\n }),\n },\n },\n }),\n},", "stability": "experimental", "summary": "Defines direct AWS service integration." }, "locationInModule": { "filename": "src/integration/aws.ts", "line": 53 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "props", "type": { "fqn": "@alma-cdk/openapix.AwsIntegrationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/integration/aws.ts", "line": 19 }, "name": "AwsIntegration", "symbolId": "src/integration/aws:AwsIntegration" }, "@alma-cdk/openapix.AwsIntegrationProps": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.AwsIntegrationProps", "interfaces": [ "aws-cdk-lib.aws_apigateway.AwsIntegrationProps", "@alma-cdk/openapix.ValidatorConfig" ], "kind": "interface", "locationInModule": { "filename": "src/integration/aws.ts", "line": 15 }, "name": "AwsIntegrationProps", "symbolId": "src/integration/aws:AwsIntegrationProps" }, "@alma-cdk/openapix.CallbackObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "Each value in the map is a Path Item Object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the path item object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.", "stability": "experimental", "summary": "A map of possible out-of band callbacks related to the parent operation." }, "fqn": "@alma-cdk/openapix.CallbackObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 350 }, "name": "CallbackObject", "symbolId": "src/schema/props:CallbackObject" }, "@alma-cdk/openapix.CognitoUserPoolsAuthorizer": { "assembly": "@alma-cdk/openapix", "base": "constructs.Construct", "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.CognitoUserPoolsAuthorizer", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "src/authorizers/cognito.ts", "line": 19 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@alma-cdk/openapix.CognitoUserPoolsAuthorizerProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/authorizers/cognito.ts", "line": 14 }, "name": "CognitoUserPoolsAuthorizer", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/cognito.ts", "line": 15 }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/cognito.ts", "line": 17 }, "name": "xAmazonApigatewayAuthorizer", "type": { "fqn": "@alma-cdk/openapix.XAmazonApigatewayAuthorizer" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/cognito.ts", "line": 16 }, "name": "xAmazonApigatewayAuthtype", "type": { "primitive": "string" } } ], "symbolId": "src/authorizers/cognito:CognitoUserPoolsAuthorizer" }, "@alma-cdk/openapix.CognitoUserPoolsAuthorizerProps": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.CognitoUserPoolsAuthorizerProps", "kind": "interface", "locationInModule": { "filename": "src/authorizers/cognito.ts", "line": 8 }, "name": "CognitoUserPoolsAuthorizerProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/cognito.ts", "line": 9 }, "name": "cognitoUserPools", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_cognito.IUserPool" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/cognito.ts", "line": 10 }, "name": "resultsCacheTtl", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } } ], "symbolId": "src/authorizers/cognito:CognitoUserPoolsAuthorizerProps" }, "@alma-cdk/openapix.ComponentsObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.", "stability": "experimental", "summary": "Holds a set of reusable objects for different aspects of the OAS." }, "fqn": "@alma-cdk/openapix.ComponentsObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 362 }, "name": "ComponentsObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Callback Objects." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 391 }, "name": "callbacks", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.CallbackObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Example Objects." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 373 }, "name": "examples", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.ExampleObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Header Objects." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 379 }, "name": "headers", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.HeaderObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Link Objects." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 388 }, "name": "links", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.LinkObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Parameter Objects." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 370 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.ParameterObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Request Body Objects." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 376 }, "name": "requestBodies", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.RequestBodyObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Response Objects." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 367 }, "name": "responses", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.ResponseObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Schema Objects." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 364 }, "name": "schemas", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.SchemaObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Security Scheme Objects." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 382 }, "name": "securitySchemes", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.SecuritySchemeObject" } ] } }, "kind": "map" } } } ], "symbolId": "src/schema/props:ComponentsObject" }, "@alma-cdk/openapix.ContactObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "The contact information for the exposed API." }, "fqn": "@alma-cdk/openapix.ContactObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 72 }, "name": "ContactObject", "properties": [ { "abstract": true, "docs": { "remarks": "MUST be in the format of an email address.", "stability": "experimental", "summary": "The email address of the contact person/organization." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 80 }, "name": "email", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The identifying name of the contact person/organization." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 74 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "MUST be in the format of a URL.", "stability": "experimental", "summary": "The URL pointing to the contact information." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 77 }, "name": "url", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/props:ContactObject" }, "@alma-cdk/openapix.CorsHeaders": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.CorsHeaders", "initializer": { "docs": { "stability": "experimental" } }, "kind": "class", "locationInModule": { "filename": "src/corsvalue/index.ts", "line": 29 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "src/corsvalue/index.ts", "line": 7 }, "name": "from", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "values", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "primitive": "string" } }, "static": true, "variadic": true } ], "name": "CorsHeaders", "properties": [ { "const": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/corsvalue/index.ts", "line": 5 }, "name": "ANY", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "src/corsvalue/index.ts", "line": 30 }, "name": "errorMessage", "protected": true, "static": true, "type": { "primitive": "string" } } ], "symbolId": "src/corsvalue/index:CorsHeaders" }, "@alma-cdk/openapix.CorsIntegration": { "assembly": "@alma-cdk/openapix", "base": "@alma-cdk/openapix.Integration", "docs": { "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/request-response-data-mappings.html#mapping-response-parameters", "stability": "experimental", "summary": "Defines `OPTIONS` integration used in Cross-Origin Resource Sharing (CORS)." }, "fqn": "@alma-cdk/openapix.CorsIntegration", "initializer": { "docs": { "example": "'/bar': {\n 'OPTIONS': new openapix.CorsIntegration(this, {\n headers: 'Content-Type,X-Amz-Date,Authorization',\n origins: '*',\n methods: 'OPTIONS,GET',\n }),\n},", "stability": "experimental", "summary": "Defines `OPTIONS` integration used in Cross-Origin Resource Sharing (CORS)." }, "locationInModule": { "filename": "src/integration/cors.ts", "line": 57 }, "parameters": [ { "name": "_", "type": { "fqn": "constructs.Construct" } }, { "name": "props", "type": { "fqn": "@alma-cdk/openapix.CorsIntegrationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/integration/cors.ts", "line": 34 }, "name": "CorsIntegration", "symbolId": "src/integration/cors:CorsIntegration" }, "@alma-cdk/openapix.CorsIntegrationProps": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.CorsIntegrationProps", "interfaces": [ "@alma-cdk/openapix.ValidatorConfig" ], "kind": "interface", "locationInModule": { "filename": "src/integration/cors.ts", "line": 21 }, "name": "CorsIntegrationProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/integration/cors.ts", "line": 22 }, "name": "headers", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/integration/cors.ts", "line": 24 }, "name": "methods", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/integration/cors.ts", "line": 23 }, "name": "origins", "type": { "primitive": "string" } } ], "symbolId": "src/integration/cors:CorsIntegrationProps" }, "@alma-cdk/openapix.CorsMethods": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.CorsMethods", "initializer": { "docs": { "stability": "experimental" } }, "kind": "class", "locationInModule": { "filename": "src/corsvalue/index.ts", "line": 23 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "src/corsvalue/index.ts", "line": 7 }, "name": "from", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "values", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "primitive": "string" } }, "static": true, "variadic": true } ], "name": "CorsMethods", "properties": [ { "const": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/corsvalue/index.ts", "line": 5 }, "name": "ANY", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "src/corsvalue/index.ts", "line": 24 }, "name": "errorMessage", "protected": true, "static": true, "type": { "primitive": "string" } } ], "symbolId": "src/corsvalue/index:CorsMethods" }, "@alma-cdk/openapix.CorsOrigins": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.CorsOrigins", "initializer": { "docs": { "stability": "experimental" } }, "kind": "class", "locationInModule": { "filename": "src/corsvalue/index.ts", "line": 18 }, "methods": [ { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "src/corsvalue/index.ts", "line": 7 }, "name": "from", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "values", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "primitive": "string" } }, "static": true, "variadic": true } ], "name": "CorsOrigins", "properties": [ { "const": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/corsvalue/index.ts", "line": 5 }, "name": "ANY", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "src/corsvalue/index.ts", "line": 19 }, "name": "errorMessage", "protected": true, "static": true, "type": { "primitive": "string" } } ], "symbolId": "src/corsvalue/index:CorsOrigins" }, "@alma-cdk/openapix.DiscriminatorObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. When using the discriminator, inline schemas will not be considered.", "stability": "experimental", "summary": "When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation." }, "fqn": "@alma-cdk/openapix.DiscriminatorObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 269 }, "name": "DiscriminatorObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The name of the property in the payload that will hold the discriminator value." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 271 }, "name": "propertyName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold mappings between payload values and schema names or references." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 274 }, "name": "mapping", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "src/schema/props:DiscriminatorObject" }, "@alma-cdk/openapix.EncodingObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "A single encoding definition applied to a single schema property." }, "fqn": "@alma-cdk/openapix.EncodingObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 311 }, "name": "EncodingObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 325 }, "name": "allowReserved", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object - application/json; for array – the default is defined based on the inner type. The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types.", "stability": "experimental", "summary": "The Content-Type for encoding a specific property." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 313 }, "name": "contentType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "stability": "experimental", "summary": "When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 322 }, "name": "explode", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a multipart.", "stability": "experimental", "summary": "A map allowing additional information to be provided as headers, for example Content-Disposition." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 316 }, "name": "headers", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.HeaderObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "stability": "experimental", "summary": "Describes how a specific property value will be serialized depending on its type." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 319 }, "name": "style", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/props:EncodingObject" }, "@alma-cdk/openapix.ExampleObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Example Object." }, "fqn": "@alma-cdk/openapix.ExampleObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 296 }, "name": "ExampleObject", "properties": [ { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "Long description for the example." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 301 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive.", "stability": "experimental", "summary": "A URL that points to the literal example." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 307 }, "name": "externalValue", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Short description for the example." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 298 }, "name": "summary", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.", "stability": "experimental", "summary": "Embedded literal example." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 304 }, "name": "value", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "src/schema/props:ExampleObject" }, "@alma-cdk/openapix.Extensible": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Allow Open Api Extensions via `x-` prefixed values." }, "fqn": "@alma-cdk/openapix.Extensible", "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 608 }, "name": "Extensible", "symbolId": "src/schema/props:Extensible" }, "@alma-cdk/openapix.ExternalDocumentationObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Allows referencing an external resource for extended documentation." }, "fqn": "@alma-cdk/openapix.ExternalDocumentationObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 206 }, "name": "ExternalDocumentationObject", "properties": [ { "abstract": true, "docs": { "remarks": "Value MUST be in the format of a URL.", "stability": "experimental", "summary": "The URL for the target documentation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 208 }, "name": "url", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A short description of the target documentation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 211 }, "name": "description", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/props:ExternalDocumentationObject" }, "@alma-cdk/openapix.HeaderObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "1. name MUST NOT be specified, it is given in the corresponding headers map.\n2. in MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).", "stability": "experimental", "summary": "The Header Object follows the structure of the Parameter Object with the following changes:." }, "fqn": "@alma-cdk/openapix.HeaderObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 335 }, "name": "HeaderObject", "properties": [ { "abstract": true, "docs": { "remarks": "This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.", "stability": "experimental", "summary": "Sets the ability to pass empty-valued parameters." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 346 }, "name": "allowEmptyValue", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Default value is false.", "stability": "experimental", "summary": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 343 }, "name": "deprecated", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A brief description of the parameter." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 337 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.", "stability": "experimental", "summary": "Determines whether this parameter is mandatory." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 340 }, "name": "required", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/schema/props:HeaderObject" }, "@alma-cdk/openapix.HttpIntegration": { "assembly": "@alma-cdk/openapix", "base": "@alma-cdk/openapix.Integration", "docs": { "stability": "experimental", "summary": "Defines a HTTP(S) integration." }, "fqn": "@alma-cdk/openapix.HttpIntegration", "initializer": { "docs": { "example": "'/ext': {\n 'ANY': new openapix.HttpIntegration(this, \"https://example.com\"),\n},", "stability": "experimental", "summary": "Defines a HTTP(S) integration." }, "locationInModule": { "filename": "src/integration/http.ts", "line": 49 }, "parameters": [ { "name": "_", "type": { "fqn": "constructs.Construct" } }, { "name": "url", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@alma-cdk/openapix.HttpIntegrationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/integration/http.ts", "line": 15 }, "name": "HttpIntegration", "symbolId": "src/integration/http:HttpIntegration" }, "@alma-cdk/openapix.HttpIntegrationProps": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.HttpIntegrationProps", "interfaces": [ "aws-cdk-lib.aws_apigateway.HttpIntegrationProps", "@alma-cdk/openapix.ValidatorConfig" ], "kind": "interface", "locationInModule": { "filename": "src/integration/http.ts", "line": 11 }, "name": "HttpIntegrationProps", "symbolId": "src/integration/http:HttpIntegrationProps" }, "@alma-cdk/openapix.IBaseIntegration": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "Interface implemented by all integrations." }, "fqn": "@alma-cdk/openapix.IBaseIntegration", "kind": "interface", "locationInModule": { "filename": "src/integration/base.ts", "line": 11 }, "name": "IBaseIntegration", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Identifier to enable internal type checks." }, "immutable": true, "locationInModule": { "filename": "src/integration/base.ts", "line": 13 }, "name": "type", "type": { "fqn": "@alma-cdk/openapix.InternalIntegrationType" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/integration/base.ts", "line": 15 }, "name": "xAmazonApigatewayIntegration", "type": { "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegration" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/integration/base.ts", "line": 16 }, "name": "validator", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/integration/base:IBaseIntegration" }, "@alma-cdk/openapix.ICallbackObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "Each value in the map is a Path Item Object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the path item object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.", "stability": "experimental", "summary": "A map of possible out-of band callbacks related to the parent operation." }, "fqn": "@alma-cdk/openapix.ICallbackObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 350 }, "name": "ICallbackObject", "symbolId": "src/schema/idocument:ICallbackObject" }, "@alma-cdk/openapix.IComponentsObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.", "stability": "experimental", "summary": "Holds a set of reusable objects for different aspects of the OAS." }, "fqn": "@alma-cdk/openapix.IComponentsObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 362 }, "name": "IComponentsObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Callback Objects." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 388 }, "name": "callbacks", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.ICallbackObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Example Objects." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 373 }, "name": "examples", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.IExampleObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Header Objects." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 379 }, "name": "headers", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.IHeaderObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Link Objects." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 385 }, "name": "links", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.ILinkObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Parameter Objects." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 370 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.IParameterObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Request Body Objects." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 376 }, "name": "requestBodies", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.IRequestBodyObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Response Objects." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 367 }, "name": "responses", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.IResponseObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Schema Objects." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 364 }, "name": "schemas", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.ISchemaObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold reusable Security Scheme Objects." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 382 }, "name": "securitySchemes", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.ISecuritySchemeObject" } ] } }, "kind": "map" } } } ], "symbolId": "src/schema/idocument:IComponentsObject" }, "@alma-cdk/openapix.IContactObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "The contact information for the exposed API." }, "fqn": "@alma-cdk/openapix.IContactObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 72 }, "name": "IContactObject", "properties": [ { "abstract": true, "docs": { "remarks": "MUST be in the format of an email address.", "stability": "experimental", "summary": "The email address of the contact person/organization." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 80 }, "name": "email", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The identifying name of the contact person/organization." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 74 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "MUST be in the format of a URL.", "stability": "experimental", "summary": "The URL pointing to the contact information." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 77 }, "name": "url", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/idocument:IContactObject" }, "@alma-cdk/openapix.IDiscriminatorObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. When using the discriminator, inline schemas will not be considered.", "stability": "experimental", "summary": "When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation." }, "fqn": "@alma-cdk/openapix.IDiscriminatorObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 269 }, "name": "IDiscriminatorObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The name of the property in the payload that will hold the discriminator value." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 271 }, "name": "propertyName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An object to hold mappings between payload values and schema names or references." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 274 }, "name": "mapping", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "src/schema/idocument:IDiscriminatorObject" }, "@alma-cdk/openapix.IDocument": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "Essentially the same as `SchemaProps` but without `readonly` definitions.", "stability": "experimental", "summary": "Describes a mutable OpenApi v3 Document." }, "fqn": "@alma-cdk/openapix.IDocument", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 6 }, "name": "IDocument", "properties": [ { "abstract": true, "docs": { "example": "{\n title: \"FancyPants API\",\n version: \"1.23.105\",\n}", "remarks": "The metadata MAY be used by tooling as required.", "stability": "experimental", "summary": "Provides metadata about the API." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 24 }, "name": "info", "type": { "fqn": "@alma-cdk/openapix.IInfoObject" } }, { "abstract": true, "docs": { "example": "'3.0.0'", "remarks": "The openapi field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is not related to the API info.version string.", "stability": "experimental", "summary": "This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 13 }, "name": "openapi", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The available paths and operations for the API." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 30 }, "name": "paths", "type": { "fqn": "@alma-cdk/openapix.IPathsObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An element to hold various schemas for the specification." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 38 }, "name": "components", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IComponentsObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Additional external documentation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 47 }, "name": "externalDocs", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IExternalDocumentationObject" } }, { "abstract": true, "docs": { "remarks": "The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement ({}) can be included in the array.", "stability": "experimental", "summary": "A declaration of which security mechanisms can be used across the API." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 41 }, "name": "security", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.ISecurityRequirementObject" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.", "stability": "experimental", "summary": "An array of Server Objects, which provide connectivity information to a target server." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 35 }, "name": "servers", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.IServerObject" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.", "stability": "experimental", "summary": "A list of tags used by the specification with additional metadata." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 44 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.ITagObject" }, "kind": "array" } } } ], "symbolId": "src/schema/idocument:IDocument" }, "@alma-cdk/openapix.IEncodingObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "A single encoding definition applied to a single schema property." }, "fqn": "@alma-cdk/openapix.IEncodingObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 311 }, "name": "IEncodingObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 325 }, "name": "allowReserved", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object - application/json; for array – the default is defined based on the inner type. The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types.", "stability": "experimental", "summary": "The Content-Type for encoding a specific property." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 313 }, "name": "contentType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "stability": "experimental", "summary": "When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 322 }, "name": "explode", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a multipart.", "stability": "experimental", "summary": "A map allowing additional information to be provided as headers, for example Content-Disposition." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 316 }, "name": "headers", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.IHeaderObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "stability": "experimental", "summary": "Describes how a specific property value will be serialized depending on its type." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 319 }, "name": "style", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/idocument:IEncodingObject" }, "@alma-cdk/openapix.IExampleObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "Example Object." }, "fqn": "@alma-cdk/openapix.IExampleObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 296 }, "name": "IExampleObject", "properties": [ { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "Long description for the example." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 301 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive.", "stability": "experimental", "summary": "A URL that points to the literal example." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 307 }, "name": "externalValue", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Short description for the example." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 298 }, "name": "summary", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.", "stability": "experimental", "summary": "Embedded literal example." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 304 }, "name": "value", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "src/schema/idocument:IExampleObject" }, "@alma-cdk/openapix.IExtensible": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "Allow Open Api Extensions via `x-` prefixed values." }, "fqn": "@alma-cdk/openapix.IExtensible", "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 605 }, "name": "IExtensible", "symbolId": "src/schema/idocument:IExtensible" }, "@alma-cdk/openapix.IExternalDocumentationObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "Allows referencing an external resource for extended documentation." }, "fqn": "@alma-cdk/openapix.IExternalDocumentationObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 206 }, "name": "IExternalDocumentationObject", "properties": [ { "abstract": true, "docs": { "remarks": "Value MUST be in the format of a URL.", "stability": "experimental", "summary": "The URL for the target documentation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 208 }, "name": "url", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A short description of the target documentation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 211 }, "name": "description", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/idocument:IExternalDocumentationObject" }, "@alma-cdk/openapix.IHeaderObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "1. name MUST NOT be specified, it is given in the corresponding headers map.\n2. in MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).", "stability": "experimental", "summary": "The Header Object follows the structure of the Parameter Object with the following changes:." }, "fqn": "@alma-cdk/openapix.IHeaderObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 335 }, "name": "IHeaderObject", "properties": [ { "abstract": true, "docs": { "remarks": "This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.", "stability": "experimental", "summary": "Sets the ability to pass empty-valued parameters." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 346 }, "name": "allowEmptyValue", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Default value is false.", "stability": "experimental", "summary": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 343 }, "name": "deprecated", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A brief description of the parameter." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 337 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.", "stability": "experimental", "summary": "Determines whether this parameter is mandatory." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 340 }, "name": "required", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/schema/idocument:IHeaderObject" }, "@alma-cdk/openapix.IInfoObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.", "stability": "experimental", "summary": "The object provides metadata about the API." }, "fqn": "@alma-cdk/openapix.IInfoObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 51 }, "name": "IInfoObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The title of the API." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 53 }, "name": "title", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version)." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 56 }, "name": "version", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The contact information for the exposed API." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 65 }, "name": "contact", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IContactObject" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A short description of the API." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 59 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The license information for the exposed API." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 68 }, "name": "license", "optional": true, "type": { "fqn": "@alma-cdk/openapix.ILicenseObject" } }, { "abstract": true, "docs": { "remarks": "MUST be in the format of a URL.", "stability": "experimental", "summary": "A URL to the Terms of Service for the API." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 62 }, "name": "termsOfService", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/idocument:IInfoObject" }, "@alma-cdk/openapix.ILicenseObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "The license information for the exposed API." }, "fqn": "@alma-cdk/openapix.ILicenseObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 84 }, "name": "ILicenseObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The license name used for the API." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 86 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "MUST be in the format of a URL.", "stability": "experimental", "summary": "A URL to the license used for the API." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 89 }, "name": "url", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/idocument:ILicenseObject" }, "@alma-cdk/openapix.ILinkObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\nUnlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.\nFor computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.", "stability": "experimental", "summary": "The Link object represents a possible design-time link for a response." }, "fqn": "@alma-cdk/openapix.ILinkObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 489 }, "name": "ILinkObject", "properties": [ { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A description of the link." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 503 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This field is mutually exclusive of the operationRef field.", "stability": "experimental", "summary": "The name of an existing, resolvable OAS operation, as defined with a unique operationId." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 494 }, "name": "operationId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition.", "stability": "experimental", "summary": "A relative or absolute URI reference to an OAS operation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 491 }, "name": "operationRef", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use the same parameter name in different locations (e.g. path.id).", "stability": "experimental", "summary": "A map representing parameters to pass to an operation as specified with operationId or identified via operationRef." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 497 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A literal value or {expression} to use as a request body when calling the target operation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 500 }, "name": "requestBody", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A server object to be used by the target operation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 506 }, "name": "server", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IServerObject" } } ], "symbolId": "src/schema/idocument:ILinkObject" }, "@alma-cdk/openapix.IMediaTypeObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "Each Media Type Object provides schema and examples for the media type identified by its key." }, "fqn": "@alma-cdk/openapix.IMediaTypeObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 227 }, "name": "IMediaTypeObject", "properties": [ { "abstract": true, "docs": { "remarks": "The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded.", "stability": "experimental", "summary": "A map between a property name and its encoding information." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 238 }, "name": "encoding", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.IEncodingObject" }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "The example object SHOULD be in the correct format as specified by the media type. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema.", "stability": "experimental", "summary": "Example of the media type." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 232 }, "name": "example", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "remarks": "Each example object SHOULD match the media type and specified schema if present. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema.", "stability": "experimental", "summary": "Examples of the media type." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 235 }, "name": "examples", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.IExampleObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The schema defining the content of the request, response, or parameter." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 229 }, "name": "schema", "optional": true, "type": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.ISchemaObject" } ] } } } ], "symbolId": "src/schema/idocument:IMediaTypeObject" }, "@alma-cdk/openapix.IOAuthFlowObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "Configuration details for a supported OAuth Flow." }, "fqn": "@alma-cdk/openapix.IOAuthFlowObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 464 }, "name": "IOAuthFlowObject", "properties": [ { "abstract": true, "docs": { "remarks": "A map between the scope name and a short description for it. The map MAY be empty.", "stability": "experimental", "summary": "The available scopes for the OAuth2 security scheme." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 466 }, "name": "scopes", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "This MUST be in the form of a URL.\nREQUIRED for oauth2 (\"implicit\", \"authorizationCode\").", "stability": "experimental", "summary": "The authorization URL to be used for this flow." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 472 }, "name": "authorizationUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This MUST be in the form of a URL.", "stability": "experimental", "summary": "The URL to be used for obtaining refresh tokens." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 481 }, "name": "refreshUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This MUST be in the form of a URL.\nREQUIRED for oauth2 (\"password\", \"clientCredentials\", \"authorizationCode\").", "stability": "experimental", "summary": "The token URL to be used for this flow." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 478 }, "name": "tokenUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/idocument:IOAuthFlowObject" }, "@alma-cdk/openapix.IOAuthFlowsObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "Allows configuration of the supported OAuth Flows." }, "fqn": "@alma-cdk/openapix.IOAuthFlowsObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 449 }, "name": "IOAuthFlowsObject", "properties": [ { "abstract": true, "docs": { "remarks": "Previously called accessCode in OpenAPI 2.0.", "stability": "experimental", "summary": "Configuration for the OAuth Authorization Code flow." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 460 }, "name": "authorizationCode", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOAuthFlowObject" } }, { "abstract": true, "docs": { "remarks": "Previously called application in OpenAPI 2.0.", "stability": "experimental", "summary": "Configuration for the OAuth Client Credentials flow." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 457 }, "name": "clientCredentials", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOAuthFlowObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Configuration for the OAuth Implicit flow." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 451 }, "name": "implicit", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOAuthFlowObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Configuration for the OAuth Resource Owner Password flow." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 454 }, "name": "password", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOAuthFlowObject" } } ], "symbolId": "src/schema/idocument:IOAuthFlowsObject" }, "@alma-cdk/openapix.IOperationObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "Describes a single API operation on a path." }, "fqn": "@alma-cdk/openapix.IOperationObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 142 }, "name": "IOperationObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The list of possible responses as they are returned from executing this operation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 144 }, "name": "responses", "type": { "fqn": "@alma-cdk/openapix.IResponsesObject" } }, { "abstract": true, "docs": { "remarks": "The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses.", "stability": "experimental", "summary": "A map of possible out-of band callbacks related to the parent operation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 168 }, "name": "callbacks", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.ICallbackObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "Consumers SHOULD refrain from usage of the declared operation. Default value is false.", "stability": "experimental", "summary": "Declares this operation to be deprecated." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 171 }, "name": "deprecated", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A verbose explanation of the operation behavior." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 153 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Additional external documentation for this operation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 156 }, "name": "externalDocs", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IExternalDocumentationObject" } }, { "abstract": true, "docs": { "remarks": "The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.", "stability": "experimental", "summary": "Unique string used to identify the operation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 159 }, "name": "operationId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.", "stability": "experimental", "summary": "A list of parameters that are applicable for this operation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 162 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.IParameterObject" } ] } }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers.", "stability": "experimental", "summary": "The request body applicable for this operation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 165 }, "name": "requestBody", "optional": true, "type": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.IRequestBodyObject" } ] } } }, { "abstract": true, "docs": { "remarks": "The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. To make security optional, an empty security requirement ({}) can be included in the array. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.", "stability": "experimental", "summary": "A declaration of which security mechanisms can be used for this operation." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 174 }, "name": "security", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.ISecurityRequirementObject" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A short summary of what the operation does." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 150 }, "name": "summary", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Tags can be used for logical grouping of operations by resources or any other qualifier.", "stability": "experimental", "summary": "A list of tags for API documentation control." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 147 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/schema/idocument:IOperationObject" }, "@alma-cdk/openapix.IParameterObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "A unique parameter is defined by a combination of a name and location.", "stability": "experimental", "summary": "Describes a single operation parameter." }, "fqn": "@alma-cdk/openapix.IParameterObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 524 }, "name": "IParameterObject", "properties": [ { "abstract": true, "docs": { "remarks": "Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "stability": "experimental", "summary": "The location of the parameter." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 535 }, "name": "in", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If in is \"path\", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.\nIf in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored.\nFor all other cases, the name corresponds to the parameter name used by the in property.", "stability": "experimental", "summary": "The name of the parameter. Parameter names are case sensitive." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 532 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.", "stability": "experimental", "summary": "Sets the ability to pass empty-valued parameters." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 547 }, "name": "allowEmptyValue", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Default value is false.", "stability": "experimental", "summary": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 544 }, "name": "deprecated", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A brief description of the parameter." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 538 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.", "stability": "experimental", "summary": "Determines whether this parameter is mandatory." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 541 }, "name": "required", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/schema/idocument:IParameterObject" }, "@alma-cdk/openapix.IPathItemObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.", "stability": "experimental", "summary": "Describes the operations available on a single path." }, "fqn": "@alma-cdk/openapix.IPathItemObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 103 }, "name": "IPathItemObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a DELETE operation on this path." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 120 }, "name": "delete", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOperationObject" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "An optional, string description, intended to apply to all operations in this path." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 108 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a GET operation on this path." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 111 }, "name": "get", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOperationObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a HEAD operation on this path." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 126 }, "name": "head", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOperationObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a OPTIONS operation on this path." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 123 }, "name": "options", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOperationObject" } }, { "abstract": true, "docs": { "remarks": "These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.", "stability": "experimental", "summary": "A list of parameters that are applicable for all the operations described under this path." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 135 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.IParameterObject" } ] } }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a PATCH operation on this path." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 129 }, "name": "patch", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOperationObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a POST operation on this path." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 117 }, "name": "post", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOperationObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a PUT operation on this path." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 114 }, "name": "put", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOperationObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An optional, string summary, intended to apply to all operations in this path." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 105 }, "name": "summary", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a TRACE operation on this path." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 132 }, "name": "trace", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOperationObject" } } ], "symbolId": "src/schema/idocument:IPathItemObject" }, "@alma-cdk/openapix.IPathsObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "The path is appended to the URL from the Server Object in order to construct the full URL. The Paths MAY be empty, due to ACL constraints.", "stability": "experimental", "summary": "Holds the relative paths to the individual endpoints and their operations." }, "fqn": "@alma-cdk/openapix.IPathsObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 93 }, "name": "IPathsObject", "symbolId": "src/schema/idocument:IPathsObject" }, "@alma-cdk/openapix.IReferenceObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "A simple object to allow referencing other components in the specification, internally and externally." }, "fqn": "@alma-cdk/openapix.IReferenceObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 551 }, "name": "IReferenceObject", "symbolId": "src/schema/idocument:IReferenceObject" }, "@alma-cdk/openapix.IRequestBodyObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "Describes a single request body." }, "fqn": "@alma-cdk/openapix.IRequestBodyObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 215 }, "name": "IRequestBodyObject", "properties": [ { "abstract": true, "docs": { "remarks": "The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*", "stability": "experimental", "summary": "The content of the request body." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 217 }, "name": "content", "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.IMediaTypeObject" }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A brief description of the request body." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 220 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Defaults to false.", "stability": "experimental", "summary": "Determines if the request body is required in the request." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 223 }, "name": "required", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/schema/idocument:IRequestBodyObject" }, "@alma-cdk/openapix.IResponseObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "Describes a single response from an API Operation, including design-time, static links to operations based on the response." }, "fqn": "@alma-cdk/openapix.IResponseObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 392 }, "name": "IResponseObject", "properties": [ { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A short description of the response." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 394 }, "name": "description", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*", "stability": "experimental", "summary": "A map containing descriptions of potential response payloads." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 400 }, "name": "content", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.IMediaTypeObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "RFC7230 states header names are case insensitive. If a response header is defined with the name \"Content-Type\", it SHALL be ignored.", "stability": "experimental", "summary": "Maps a header name to its definition." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 397 }, "name": "headers", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.IHeaderObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.", "stability": "experimental", "summary": "A map of operations links that can be followed from the response." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 403 }, "name": "links", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.IReferenceObject" }, { "fqn": "@alma-cdk/openapix.ILinkObject" } ] } }, "kind": "map" } } } ], "symbolId": "src/schema/idocument:IResponseObject" }, "@alma-cdk/openapix.IResponsesObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "The container maps a HTTP response code to the expected response.\nThe documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.\nThe default MAY be used as a default response object for all HTTP codes that are not covered individually by the specification.\nThe Responses Object MUST contain at least one response code, and it SHOULD be the response for a successful operation call.", "stability": "experimental", "summary": "A container for the expected responses of an operation." }, "fqn": "@alma-cdk/openapix.IResponsesObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 186 }, "name": "IResponsesObject", "symbolId": "src/schema/idocument:IResponsesObject" }, "@alma-cdk/openapix.ISchemaObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "These types can be objects, but also primitives and arrays. This object is an extended subset of the JSON Schema Specification Wright Draft 00. For more information about the properties, see JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON Schema.", "stability": "experimental", "summary": "The Schema Object allows the definition of input and output data types." }, "fqn": "@alma-cdk/openapix.ISchemaObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 242 }, "name": "ISchemaObject", "properties": [ { "abstract": true, "docs": { "remarks": "Default value is false.", "stability": "experimental", "summary": "Specifies that a schema is deprecated and SHOULD be transitioned out of usage." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 265 }, "name": "deprecated", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description. See Composition and Inheritance for more details.", "stability": "experimental", "summary": "Adds support for polymorphism." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 247 }, "name": "discriminator", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IDiscriminatorObject" } }, { "abstract": true, "docs": { "remarks": "To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.", "stability": "experimental", "summary": "A free-form property to include an example of an instance for this schema." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 262 }, "name": "example", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Additional external documentation for this schema." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 259 }, "name": "externalDocs", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IExternalDocumentationObject" } }, { "abstract": true, "docs": { "remarks": "Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of null as a value. A false value leaves the specified or default type unmodified. The default value is false.", "stability": "experimental", "summary": "A true value adds \"null\" to the allowed type specified by the type keyword, only if type is explicitly defined within the same Schema Object." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 244 }, "name": "nullable", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Declares the property as \"read only\". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both and writeOnly being true. Default value is false.", "stability": "experimental", "summary": "Relevant only for Schema \"properties\" definitions." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 250 }, "name": "readOnly", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Declares the property as \"write only\". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property MUST NOT be marked as both and writeOnly being true. Default value is false.", "stability": "experimental", "summary": "Relevant only for Schema \"properties\" definitions." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 253 }, "name": "writeOnly", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.", "stability": "experimental", "summary": "This MAY be used only on properties schemas." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 256 }, "name": "xml", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IXmlObject" } } ], "symbolId": "src/schema/idocument:ISchemaObject" }, "@alma-cdk/openapix.ISecurityRequirementObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\nSecurity Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information.\nWhen a list of Security Requirement Objects is defined on the OpenAPI Object or Operation Object, only one of the Security Requirement Objects in the list needs to be satisfied to authorize the request.", "stability": "experimental", "summary": "Lists the required security schemes to execute this operation." }, "fqn": "@alma-cdk/openapix.ISecurityRequirementObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 514 }, "name": "ISecurityRequirementObject", "symbolId": "src/schema/idocument:ISecurityRequirementObject" }, "@alma-cdk/openapix.ISecuritySchemeObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.", "stability": "experimental", "summary": "Defines a security scheme that can be used by the operations." }, "fqn": "@alma-cdk/openapix.ISecuritySchemeObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 407 }, "name": "ISecuritySchemeObject", "properties": [ { "abstract": true, "docs": { "remarks": "Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".", "stability": "experimental", "summary": "The type of the security scheme." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 409 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.", "stability": "experimental", "summary": "A hint to the client to identify how the bearer token is formatted." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 433 }, "name": "bearerFormat", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A short description for security scheme." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 412 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "REQUIRED for oauth2.", "stability": "experimental", "summary": "An object containing configuration information for the flow types supported." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 439 }, "name": "flow", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IOAuthFlowsObject" } }, { "abstract": true, "docs": { "remarks": "Valid values are \"query\", \"header\" or \"cookie\".\nREQUIRED for apiKey.", "stability": "experimental", "summary": "The location of the API key." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 424 }, "name": "in", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "REQUIRED for apiKey.", "stability": "experimental", "summary": "The name of the header, query or cookie parameter to be used." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 418 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This MUST be in the form of a URL.\nREQUIRED for openIdConnect.", "stability": "experimental", "summary": "OpenId Connect URL to discover OAuth2 configuration values." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 445 }, "name": "openIdConnectUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The values used SHOULD be registered in the IANA Authentication Scheme registry.\nREQUIRED for http.", "stability": "experimental", "summary": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 430 }, "name": "scheme", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/idocument:ISecuritySchemeObject" }, "@alma-cdk/openapix.IServerObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "An object representing a Server." }, "fqn": "@alma-cdk/openapix.IServerObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 569 }, "name": "IServerObject", "properties": [ { "abstract": true, "docs": { "remarks": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.", "stability": "experimental", "summary": "REQUIRED." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 571 }, "name": "url", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "An optional string describing the host designated by the URL." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 574 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The value is used for substitution in the server's URL template.", "stability": "experimental", "summary": "A map between a variable name and its value." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 577 }, "name": "variables", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.IServerVariableObject" }, "kind": "map" } } } ], "symbolId": "src/schema/idocument:IServerObject" }, "@alma-cdk/openapix.IServerVariableObject": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "An object representing a Server Variable for server URL template substitution." }, "fqn": "@alma-cdk/openapix.IServerVariableObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 581 }, "name": "IServerVariableObject", "properties": [ { "abstract": true, "docs": { "remarks": "Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "stability": "experimental", "summary": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 583 }, "name": "default", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "An optional description for the server variable." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 589 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The array SHOULD NOT be empty.", "stability": "experimental", "summary": "An enumeration of string values to be used if the substitution options are from a limited set." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 586 }, "name": "enum", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/schema/idocument:IServerVariableObject" }, "@alma-cdk/openapix.ITagObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.", "stability": "experimental", "summary": "Adds metadata to a single tag that is used by the Operation Object." }, "fqn": "@alma-cdk/openapix.ITagObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 593 }, "name": "ITagObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The name of the tag." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 595 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A short description for the tag." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 598 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Additional external documentation for this tag." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 601 }, "name": "externalDocs", "optional": true, "type": { "fqn": "@alma-cdk/openapix.IExternalDocumentationObject" } } ], "symbolId": "src/schema/idocument:ITagObject" }, "@alma-cdk/openapix.IXmlObject": { "assembly": "@alma-cdk/openapix", "docs": { "remarks": "When using arrays, XML element names are not inferred (for singular/plural forms) and the name property SHOULD be used to add that information. See examples for expected behavior.", "stability": "experimental", "summary": "A metadata object that allows for more fine-tuned XML model definitions." }, "fqn": "@alma-cdk/openapix.IXmlObject", "interfaces": [ "@alma-cdk/openapix.IExtensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/idocument.ts", "line": 278 }, "name": "IXmlObject", "properties": [ { "abstract": true, "docs": { "remarks": "Default value is false.", "stability": "experimental", "summary": "Declares whether the property definition translates to an attribute instead of an element." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 289 }, "name": "attribute", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "stability": "experimental", "summary": "Replaces the name of the element/attribute used for the described schema property." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 280 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Value MUST be in the form of an absolute URI.", "stability": "experimental", "summary": "The URI of the namespace definition." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 283 }, "name": "namespace", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The prefix to be used for the name." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 286 }, "name": "prefix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "stability": "experimental", "summary": "MAY be used only for an array definition." }, "locationInModule": { "filename": "src/schema/idocument.ts", "line": 292 }, "name": "wrapped", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/schema/idocument:IXmlObject" }, "@alma-cdk/openapix.InfoObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.", "stability": "experimental", "summary": "The object provides metadata about the API." }, "fqn": "@alma-cdk/openapix.InfoObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 51 }, "name": "InfoObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The title of the API." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 53 }, "name": "title", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version)." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 56 }, "name": "version", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The contact information for the exposed API." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 65 }, "name": "contact", "optional": true, "type": { "fqn": "@alma-cdk/openapix.ContactObject" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A short description of the API." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 59 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The license information for the exposed API." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 68 }, "name": "license", "optional": true, "type": { "fqn": "@alma-cdk/openapix.LicenseObject" } }, { "abstract": true, "docs": { "remarks": "MUST be in the format of a URL.", "stability": "experimental", "summary": "A URL to the Terms of Service for the API." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 62 }, "name": "termsOfService", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/props:InfoObject" }, "@alma-cdk/openapix.Integration": { "abstract": true, "assembly": "@alma-cdk/openapix", "docs": { "remarks": "Also defines few basic methods (`getIntegration` & `getValidatorId`) used\nby derivative classes.", "stability": "experimental", "summary": "Essentially responsible for converting CDK `IntegrationProps` into API Gateway OpenApi integration extension ()`XAmazonApigatewayIntegration`)." }, "fqn": "@alma-cdk/openapix.Integration", "initializer": { "docs": { "stability": "experimental", "summary": "Construc a new integration." }, "locationInModule": { "filename": "src/integration/base.ts", "line": 56 }, "parameters": [ { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_apigateway.IntegrationProps" } }, { "name": "config", "type": { "fqn": "@alma-cdk/openapix.IntegrationConfig" } } ] }, "interfaces": [ "@alma-cdk/openapix.IBaseIntegration" ], "kind": "class", "locationInModule": { "filename": "src/integration/base.ts", "line": 49 }, "name": "Integration", "properties": [ { "docs": { "stability": "experimental", "summary": "Identifier to enable internal type checks." }, "immutable": true, "locationInModule": { "filename": "src/integration/base.ts", "line": 53 }, "name": "type", "overrides": "@alma-cdk/openapix.IBaseIntegration", "type": { "fqn": "@alma-cdk/openapix.InternalIntegrationType" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/integration/base.ts", "line": 50 }, "name": "xAmazonApigatewayIntegration", "overrides": "@alma-cdk/openapix.IBaseIntegration", "type": { "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegration" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/integration/base.ts", "line": 51 }, "name": "validator", "optional": true, "overrides": "@alma-cdk/openapix.IBaseIntegration", "type": { "primitive": "string" } } ], "symbolId": "src/integration/base:Integration" }, "@alma-cdk/openapix.IntegrationConfig": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Base integration config." }, "fqn": "@alma-cdk/openapix.IntegrationConfig", "interfaces": [ "@alma-cdk/openapix.ValidatorConfig" ], "kind": "interface", "locationInModule": { "filename": "src/integration/base.ts", "line": 39 }, "name": "IntegrationConfig", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/integration/base.ts", "line": 40 }, "name": "type", "type": { "fqn": "@alma-cdk/openapix.InternalIntegrationType" } } ], "symbolId": "src/integration/base:IntegrationConfig" }, "@alma-cdk/openapix.InternalIntegrationType": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.InternalIntegrationType", "kind": "enum", "locationInModule": { "filename": "src/integration/base.ts", "line": 19 }, "members": [ { "docs": { "stability": "experimental" }, "name": "AWS" }, { "docs": { "stability": "experimental" }, "name": "CORS" }, { "docs": { "stability": "experimental" }, "name": "HTTP" }, { "docs": { "stability": "experimental" }, "name": "LAMBDA" }, { "docs": { "stability": "experimental" }, "name": "MOCK" } ], "name": "InternalIntegrationType", "symbolId": "src/integration/base:InternalIntegrationType" }, "@alma-cdk/openapix.LambdaAuthorizer": { "assembly": "@alma-cdk/openapix", "base": "constructs.Construct", "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.LambdaAuthorizer", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 33 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@alma-cdk/openapix.LambdaAuthorizerProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 27 }, "methods": [ { "docs": { "remarks": "The ARN format for authorizers is different compared to integrations when granting permissions,\nex. arn:aws:execute-api:us-east-1:123456789012:api-id/authorizers/authorizer-id", "stability": "experimental", "summary": "Allow Lambda invoke action to be performed by given identity." }, "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 65 }, "name": "grantFunctionInvoke", "parameters": [ { "name": "api", "type": { "fqn": "aws-cdk-lib.aws_apigateway.IRestApi" } } ] } ], "name": "LambdaAuthorizer", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 29 }, "name": "fn", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 28 }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 31 }, "name": "xAmazonApigatewayAuthorizer", "type": { "fqn": "@alma-cdk/openapix.XAmazonApigatewayAuthorizer" } }, { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 30 }, "name": "xAmazonApigatewayAuthtype", "type": { "primitive": "string" } } ], "symbolId": "src/authorizers/lambda:LambdaAuthorizer" }, "@alma-cdk/openapix.LambdaAuthorizerProps": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.LambdaAuthorizerProps", "kind": "interface", "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 10 }, "name": "LambdaAuthorizerProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 21 }, "name": "authType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 11 }, "name": "fn", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } }, { "abstract": true, "docs": { "example": "apigateway.IdentitySource.header('Authorization')", "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 17 }, "name": "identitySource", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 19 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/authorizers/lambda.ts", "line": 23 }, "name": "resultsCacheTtl", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } } ], "symbolId": "src/authorizers/lambda:LambdaAuthorizerProps" }, "@alma-cdk/openapix.LambdaIntegration": { "assembly": "@alma-cdk/openapix", "base": "@alma-cdk/openapix.Integration", "docs": { "stability": "experimental", "summary": "Defines an AWS Lambda integration." }, "fqn": "@alma-cdk/openapix.LambdaIntegration", "initializer": { "docs": { "example": "'/message': {\n 'POST': new openapix.LambdaIntegration(this, fn),\n},", "stability": "experimental", "summary": "Defines an AWS Lambda integration." }, "locationInModule": { "filename": "src/integration/lambda.ts", "line": 45 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "fn", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } }, { "name": "props", "optional": true, "type": { "fqn": "@alma-cdk/openapix.LambdaIntegrationOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/integration/lambda.ts", "line": 17 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Allow Lambda invoke action to be performed by given identity." }, "locationInModule": { "filename": "src/integration/lambda.ts", "line": 70 }, "name": "grantFunctionInvoke", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "executeApiArn", "type": { "primitive": "string" } } ] } ], "name": "LambdaIntegration", "properties": [ { "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/integration/lambda.ts", "line": 35 }, "name": "fn", "type": { "fqn": "aws-cdk-lib.aws_lambda.IFunction" } } ], "symbolId": "src/integration/lambda:LambdaIntegration" }, "@alma-cdk/openapix.LambdaIntegrationOptions": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.LambdaIntegrationOptions", "interfaces": [ "aws-cdk-lib.aws_apigateway.LambdaIntegrationOptions", "@alma-cdk/openapix.ValidatorConfig" ], "kind": "interface", "locationInModule": { "filename": "src/integration/lambda.ts", "line": 13 }, "name": "LambdaIntegrationOptions", "symbolId": "src/integration/lambda:LambdaIntegrationOptions" }, "@alma-cdk/openapix.LicenseObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "The license information for the exposed API." }, "fqn": "@alma-cdk/openapix.LicenseObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 84 }, "name": "LicenseObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The license name used for the API." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 86 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "MUST be in the format of a URL.", "stability": "experimental", "summary": "A URL to the license used for the API." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 89 }, "name": "url", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/props:LicenseObject" }, "@alma-cdk/openapix.LinkObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\nUnlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.\nFor computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.", "stability": "experimental", "summary": "The Link object represents a possible design-time link for a response." }, "fqn": "@alma-cdk/openapix.LinkObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 492 }, "name": "LinkObject", "properties": [ { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A description of the link." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 506 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This field is mutually exclusive of the operationRef field.", "stability": "experimental", "summary": "The name of an existing, resolvable OAS operation, as defined with a unique operationId." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 497 }, "name": "operationId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition.", "stability": "experimental", "summary": "A relative or absolute URI reference to an OAS operation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 494 }, "name": "operationRef", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use the same parameter name in different locations (e.g. path.id).", "stability": "experimental", "summary": "A map representing parameters to pass to an operation as specified with operationId or identified via operationRef." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 500 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A literal value or {expression} to use as a request body when calling the target operation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 503 }, "name": "requestBody", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A server object to be used by the target operation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 509 }, "name": "server", "optional": true, "type": { "fqn": "@alma-cdk/openapix.ServerObject" } } ], "symbolId": "src/schema/props:LinkObject" }, "@alma-cdk/openapix.MediaTypeObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Each Media Type Object provides schema and examples for the media type identified by its key." }, "fqn": "@alma-cdk/openapix.MediaTypeObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 227 }, "name": "MediaTypeObject", "properties": [ { "abstract": true, "docs": { "remarks": "The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded.", "stability": "experimental", "summary": "A map between a property name and its encoding information." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 238 }, "name": "encoding", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.EncodingObject" }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "The example object SHOULD be in the correct format as specified by the media type. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema.", "stability": "experimental", "summary": "Example of the media type." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 232 }, "name": "example", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "remarks": "Each example object SHOULD match the media type and specified schema if present. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema.", "stability": "experimental", "summary": "Examples of the media type." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 235 }, "name": "examples", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.ExampleObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The schema defining the content of the request, response, or parameter." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 229 }, "name": "schema", "optional": true, "type": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.SchemaObject" } ] } } } ], "symbolId": "src/schema/props:MediaTypeObject" }, "@alma-cdk/openapix.MockIntegration": { "assembly": "@alma-cdk/openapix", "base": "@alma-cdk/openapix.Integration", "docs": { "stability": "experimental", "summary": "Defines Mock integration." }, "fqn": "@alma-cdk/openapix.MockIntegration", "initializer": { "docs": { "example": "'/mock': {\n 'GET': new openapix.MockIntegration(this),\n},", "stability": "experimental", "summary": "Defines Mock integration." }, "locationInModule": { "filename": "src/integration/mock.ts", "line": 26 }, "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@alma-cdk/openapix.MockIntegrationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/integration/mock.ts", "line": 17 }, "name": "MockIntegration", "symbolId": "src/integration/mock:MockIntegration" }, "@alma-cdk/openapix.MockIntegrationProps": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental" }, "fqn": "@alma-cdk/openapix.MockIntegrationProps", "interfaces": [ "aws-cdk-lib.aws_apigateway.IntegrationOptions", "@alma-cdk/openapix.ValidatorConfig" ], "kind": "interface", "locationInModule": { "filename": "src/integration/mock.ts", "line": 13 }, "name": "MockIntegrationProps", "symbolId": "src/integration/mock:MockIntegrationProps" }, "@alma-cdk/openapix.OAuthFlowObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Configuration details for a supported OAuth Flow." }, "fqn": "@alma-cdk/openapix.OAuthFlowObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 467 }, "name": "OAuthFlowObject", "properties": [ { "abstract": true, "docs": { "remarks": "A map between the scope name and a short description for it. The map MAY be empty.", "stability": "experimental", "summary": "The available scopes for the OAuth2 security scheme." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 469 }, "name": "scopes", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "This MUST be in the form of a URL.\nREQUIRED for oauth2 (\"implicit\", \"authorizationCode\").", "stability": "experimental", "summary": "The authorization URL to be used for this flow." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 475 }, "name": "authorizationUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This MUST be in the form of a URL.", "stability": "experimental", "summary": "The URL to be used for obtaining refresh tokens." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 484 }, "name": "refreshUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This MUST be in the form of a URL.\nREQUIRED for oauth2 (\"password\", \"clientCredentials\", \"authorizationCode\").", "stability": "experimental", "summary": "The token URL to be used for this flow." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 481 }, "name": "tokenUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/props:OAuthFlowObject" }, "@alma-cdk/openapix.OAuthFlowsObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Allows configuration of the supported OAuth Flows." }, "fqn": "@alma-cdk/openapix.OAuthFlowsObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 452 }, "name": "OAuthFlowsObject", "properties": [ { "abstract": true, "docs": { "remarks": "Previously called accessCode in OpenAPI 2.0.", "stability": "experimental", "summary": "Configuration for the OAuth Authorization Code flow." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 463 }, "name": "authorizationCode", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OAuthFlowObject" } }, { "abstract": true, "docs": { "remarks": "Previously called application in OpenAPI 2.0.", "stability": "experimental", "summary": "Configuration for the OAuth Client Credentials flow." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 460 }, "name": "clientCredentials", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OAuthFlowObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Configuration for the OAuth Implicit flow." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 454 }, "name": "implicit", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OAuthFlowObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Configuration for the OAuth Resource Owner Password flow." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 457 }, "name": "password", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OAuthFlowObject" } } ], "symbolId": "src/schema/props:OAuthFlowsObject" }, "@alma-cdk/openapix.OperationObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Describes a single API operation on a path." }, "fqn": "@alma-cdk/openapix.OperationObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 142 }, "name": "OperationObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The list of possible responses as they are returned from executing this operation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 144 }, "name": "responses", "type": { "fqn": "@alma-cdk/openapix.ResponsesObject" } }, { "abstract": true, "docs": { "remarks": "The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses.", "stability": "experimental", "summary": "A map of possible out-of band callbacks related to the parent operation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 168 }, "name": "callbacks", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.CallbackObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "Consumers SHOULD refrain from usage of the declared operation. Default value is false.", "stability": "experimental", "summary": "Declares this operation to be deprecated." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 171 }, "name": "deprecated", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A verbose explanation of the operation behavior." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 153 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Additional external documentation for this operation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 156 }, "name": "externalDocs", "optional": true, "type": { "fqn": "@alma-cdk/openapix.ExternalDocumentationObject" } }, { "abstract": true, "docs": { "remarks": "The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.", "stability": "experimental", "summary": "Unique string used to identify the operation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 159 }, "name": "operationId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.", "stability": "experimental", "summary": "A list of parameters that are applicable for this operation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 162 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.ParameterObject" } ] } }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers.", "stability": "experimental", "summary": "The request body applicable for this operation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 165 }, "name": "requestBody", "optional": true, "type": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.RequestBodyObject" } ] } } }, { "abstract": true, "docs": { "remarks": "The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. To make security optional, an empty security requirement ({}) can be included in the array. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.", "stability": "experimental", "summary": "A declaration of which security mechanisms can be used for this operation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 174 }, "name": "security", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.SecurityRequirementObject" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A short summary of what the operation does." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 150 }, "name": "summary", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Tags can be used for logical grouping of operations by resources or any other qualifier.", "stability": "experimental", "summary": "A list of tags for API documentation control." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 147 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/schema/props:OperationObject" }, "@alma-cdk/openapix.ParameterObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "A unique parameter is defined by a combination of a name and location.", "stability": "experimental", "summary": "Describes a single operation parameter." }, "fqn": "@alma-cdk/openapix.ParameterObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 527 }, "name": "ParameterObject", "properties": [ { "abstract": true, "docs": { "remarks": "Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "stability": "experimental", "summary": "The location of the parameter." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 538 }, "name": "in", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If in is \"path\", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.\nIf in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored.\nFor all other cases, the name corresponds to the parameter name used by the in property.", "stability": "experimental", "summary": "The name of the parameter. Parameter names are case sensitive." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 535 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.", "stability": "experimental", "summary": "Sets the ability to pass empty-valued parameters." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 550 }, "name": "allowEmptyValue", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Default value is false.", "stability": "experimental", "summary": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 547 }, "name": "deprecated", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A brief description of the parameter." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 541 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.", "stability": "experimental", "summary": "Determines whether this parameter is mandatory." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 544 }, "name": "required", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/schema/props:ParameterObject" }, "@alma-cdk/openapix.PathItemObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.", "stability": "experimental", "summary": "Describes the operations available on a single path." }, "fqn": "@alma-cdk/openapix.PathItemObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 103 }, "name": "PathItemObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a DELETE operation on this path." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 120 }, "name": "delete", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OperationObject" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "An optional, string description, intended to apply to all operations in this path." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 108 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a GET operation on this path." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 111 }, "name": "get", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OperationObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a HEAD operation on this path." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 126 }, "name": "head", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OperationObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a OPTIONS operation on this path." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 123 }, "name": "options", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OperationObject" } }, { "abstract": true, "docs": { "remarks": "These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.", "stability": "experimental", "summary": "A list of parameters that are applicable for all the operations described under this path." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 135 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.ParameterObject" } ] } }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a PATCH operation on this path." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 129 }, "name": "patch", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OperationObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a POST operation on this path." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 117 }, "name": "post", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OperationObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a PUT operation on this path." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 114 }, "name": "put", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OperationObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An optional, string summary, intended to apply to all operations in this path." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 105 }, "name": "summary", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A definition of a TRACE operation on this path." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 132 }, "name": "trace", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OperationObject" } } ], "symbolId": "src/schema/props:PathItemObject" }, "@alma-cdk/openapix.Paths": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Paths with methods containing integrations." }, "fqn": "@alma-cdk/openapix.Paths", "kind": "interface", "locationInModule": { "filename": "src/api/props.ts", "line": 152 }, "name": "Paths", "symbolId": "src/api/props:Paths" }, "@alma-cdk/openapix.PathsObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "The path is appended to the URL from the Server Object in order to construct the full URL. The Paths MAY be empty, due to ACL constraints.", "stability": "experimental", "summary": "Holds the relative paths to the individual endpoints and their operations." }, "fqn": "@alma-cdk/openapix.PathsObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 93 }, "name": "PathsObject", "symbolId": "src/schema/props:PathsObject" }, "@alma-cdk/openapix.ReferenceObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "A simple object to allow referencing other components in the specification, internally and externally." }, "fqn": "@alma-cdk/openapix.ReferenceObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 554 }, "name": "ReferenceObject", "symbolId": "src/schema/props:ReferenceObject" }, "@alma-cdk/openapix.RequestBodyObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Describes a single request body." }, "fqn": "@alma-cdk/openapix.RequestBodyObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 215 }, "name": "RequestBodyObject", "properties": [ { "abstract": true, "docs": { "remarks": "The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*", "stability": "experimental", "summary": "The content of the request body." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 217 }, "name": "content", "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.MediaTypeObject" }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A brief description of the request body." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 220 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Defaults to false.", "stability": "experimental", "summary": "Determines if the request body is required in the request." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 223 }, "name": "required", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/schema/props:RequestBodyObject" }, "@alma-cdk/openapix.ResponseObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Describes a single response from an API Operation, including design-time, static links to operations based on the response." }, "fqn": "@alma-cdk/openapix.ResponseObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 395 }, "name": "ResponseObject", "properties": [ { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A short description of the response." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 397 }, "name": "description", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*", "stability": "experimental", "summary": "A map containing descriptions of potential response payloads." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 403 }, "name": "content", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.MediaTypeObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "RFC7230 states header names are case insensitive. If a response header is defined with the name \"Content-Type\", it SHALL be ignored.", "stability": "experimental", "summary": "Maps a header name to its definition." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 400 }, "name": "headers", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.HeaderObject" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.", "stability": "experimental", "summary": "A map of operations links that can be followed from the response." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 406 }, "name": "links", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@alma-cdk/openapix.ReferenceObject" }, { "fqn": "@alma-cdk/openapix.LinkObject" } ] } }, "kind": "map" } } } ], "symbolId": "src/schema/props:ResponseObject" }, "@alma-cdk/openapix.ResponsesObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "The container maps a HTTP response code to the expected response.\nThe documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.\nThe default MAY be used as a default response object for all HTTP codes that are not covered individually by the specification.\nThe Responses Object MUST contain at least one response code, and it SHOULD be the response for a successful operation call.", "stability": "experimental", "summary": "A container for the expected responses of an operation." }, "fqn": "@alma-cdk/openapix.ResponsesObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 186 }, "name": "ResponsesObject", "symbolId": "src/schema/props:ResponsesObject" }, "@alma-cdk/openapix.Schema": { "assembly": "@alma-cdk/openapix", "docs": { "stability": "experimental", "summary": "Represents an OpenApi v3 Schema which can be deserialized from YAML-file, modified and then serialized back to YAML." }, "fqn": "@alma-cdk/openapix.Schema", "initializer": { "docs": { "stability": "experimental", "summary": "Construct a new Schema instance from OpenApi v3 JSON." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 53 }, "parameters": [ { "name": "props", "type": { "fqn": "@alma-cdk/openapix.SchemaProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/schema/schema.ts", "line": 16 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Parse OpenApi v3 schema by loading a YAML file from given path." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 30 }, "name": "fromAsset", "parameters": [ { "name": "path", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@alma-cdk/openapix.Schema" } }, "static": true }, { "docs": { "stability": "experimental", "summary": "Parse OpenApi v3 schema from inline YAML content." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 24 }, "name": "fromInline", "parameters": [ { "name": "content", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@alma-cdk/openapix.Schema" } }, "static": true }, { "docs": { "stability": "experimental", "summary": "Get a value from given object path." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 88 }, "name": "get", "parameters": [ { "name": "path", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "any" } } }, { "docs": { "stability": "experimental", "summary": "Check if definition has a value in given object path." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 83 }, "name": "has", "parameters": [ { "name": "path", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "boolean" } } }, { "docs": { "stability": "experimental", "summary": "Inject multiple values to given paths." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 98 }, "name": "inject", "parameters": [ { "name": "records", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ] }, { "docs": { "stability": "experimental", "summary": "Reject – i.e. remove values – from given object paths." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 105 }, "name": "reject", "parameters": [ { "name": "paths", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ] }, { "docs": { "stability": "experimental", "summary": "Reject deep within object – i.e. remove all nested object paths." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 110 }, "name": "rejectDeep", "parameters": [ { "name": "paths", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ] }, { "docs": { "stability": "experimental", "summary": "Set a value to given object path." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 93 }, "name": "set", "parameters": [ { "name": "path", "type": { "primitive": "string" } }, { "name": "value", "type": { "primitive": "any" } } ] }, { "docs": { "stability": "experimental", "summary": "Return the OpenApi v3 document as an S3 Asset." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 78 }, "name": "toAsset", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_s3_assets.Asset" } } }, { "docs": { "stability": "experimental", "summary": "Return the actual OpenApi v3 document." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 73 }, "name": "toDocument", "returns": { "type": { "fqn": "@alma-cdk/openapix.IDocument" } } }, { "docs": { "stability": "experimental", "summary": "Serialize to JSON string." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 68 }, "name": "toJson", "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "experimental", "summary": "Serialize to YAML string." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 63 }, "name": "toYaml", "returns": { "type": { "primitive": "string" } } } ], "name": "Schema", "properties": [ { "docs": { "see": "https://github.com/npm/node-semver", "stability": "experimental", "summary": "A string representing supported SemVer range." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 21 }, "name": "openApiSupportedVersions", "static": true, "type": { "primitive": "string" } }, { "docs": { "example": "'3.0.3'", "stability": "experimental", "summary": "OpenApi version used by schema document." }, "locationInModule": { "filename": "src/schema/schema.ts", "line": 50 }, "name": "openApiVersion", "type": { "primitive": "string" } } ], "symbolId": "src/schema/schema:Schema" }, "@alma-cdk/openapix.SchemaObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "These types can be objects, but also primitives and arrays. This object is an extended subset of the JSON Schema Specification Wright Draft 00. For more information about the properties, see JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON Schema.", "stability": "experimental", "summary": "The Schema Object allows the definition of input and output data types." }, "fqn": "@alma-cdk/openapix.SchemaObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 242 }, "name": "SchemaObject", "properties": [ { "abstract": true, "docs": { "remarks": "Default value is false.", "stability": "experimental", "summary": "Specifies that a schema is deprecated and SHOULD be transitioned out of usage." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 265 }, "name": "deprecated", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description. See Composition and Inheritance for more details.", "stability": "experimental", "summary": "Adds support for polymorphism." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 247 }, "name": "discriminator", "optional": true, "type": { "fqn": "@alma-cdk/openapix.DiscriminatorObject" } }, { "abstract": true, "docs": { "remarks": "To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.", "stability": "experimental", "summary": "A free-form property to include an example of an instance for this schema." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 262 }, "name": "example", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Additional external documentation for this schema." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 259 }, "name": "externalDocs", "optional": true, "type": { "fqn": "@alma-cdk/openapix.ExternalDocumentationObject" } }, { "abstract": true, "docs": { "remarks": "Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of null as a value. A false value leaves the specified or default type unmodified. The default value is false.", "stability": "experimental", "summary": "A true value adds \"null\" to the allowed type specified by the type keyword, only if type is explicitly defined within the same Schema Object." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 244 }, "name": "nullable", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Declares the property as \"read only\". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false.", "stability": "experimental", "summary": "Relevant only for Schema \"properties\" definitions." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 250 }, "name": "readOnly", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Declares the property as \"write only\". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false.", "stability": "experimental", "summary": "Relevant only for Schema \"properties\" definitions." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 253 }, "name": "writeOnly", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.", "stability": "experimental", "summary": "This MAY be used only on properties schemas." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 256 }, "name": "xml", "optional": true, "type": { "fqn": "@alma-cdk/openapix.XmlObject" } } ], "symbolId": "src/schema/props:SchemaObject" }, "@alma-cdk/openapix.SchemaProps": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "Essentially an OpenApi v3 \"source\" without\n`x-amazon-apigateway-` extensions.", "stability": "experimental", "summary": "Props given to `new Schema`." }, "fqn": "@alma-cdk/openapix.SchemaProps", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 6 }, "name": "SchemaProps", "properties": [ { "abstract": true, "docs": { "example": "{\n title: \"FancyPants API\",\n version: \"1.23.105\",\n}", "remarks": "The metadata MAY be used by tooling as required.", "stability": "experimental", "summary": "Provides metadata about the API." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 24 }, "name": "info", "type": { "fqn": "@alma-cdk/openapix.InfoObject" } }, { "abstract": true, "docs": { "example": "'3.0.0'", "remarks": "The openapi field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is not related to the API info.version string.", "stability": "experimental", "summary": "This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 13 }, "name": "openapi", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The available paths and operations for the API." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 30 }, "name": "paths", "type": { "fqn": "@alma-cdk/openapix.PathsObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An element to hold various schemas for the specification." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 38 }, "name": "components", "optional": true, "type": { "fqn": "@alma-cdk/openapix.ComponentsObject" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Additional external documentation." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 47 }, "name": "externalDocs", "optional": true, "type": { "fqn": "@alma-cdk/openapix.ExternalDocumentationObject" } }, { "abstract": true, "docs": { "remarks": "The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement ({}) can be included in the array.", "stability": "experimental", "summary": "A declaration of which security mechanisms can be used across the API." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 41 }, "name": "security", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.SecurityRequirementObject" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.", "stability": "experimental", "summary": "An array of Server Objects, which provide connectivity information to a target server." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 35 }, "name": "servers", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.ServerObject" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.", "stability": "experimental", "summary": "A list of tags used by the specification with additional metadata." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 44 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.TagObject" }, "kind": "array" } } } ], "symbolId": "src/schema/props:SchemaProps" }, "@alma-cdk/openapix.SecurityRequirementObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\nSecurity Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information.\nWhen a list of Security Requirement Objects is defined on the OpenAPI Object or Operation Object, only one of the Security Requirement Objects in the list needs to be satisfied to authorize the request.", "stability": "experimental", "summary": "Lists the required security schemes to execute this operation." }, "fqn": "@alma-cdk/openapix.SecurityRequirementObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 517 }, "name": "SecurityRequirementObject", "symbolId": "src/schema/props:SecurityRequirementObject" }, "@alma-cdk/openapix.SecuritySchemeObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.", "stability": "experimental", "summary": "Defines a security scheme that can be used by the operations." }, "fqn": "@alma-cdk/openapix.SecuritySchemeObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 410 }, "name": "SecuritySchemeObject", "properties": [ { "abstract": true, "docs": { "remarks": "Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".", "stability": "experimental", "summary": "The type of the security scheme." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 412 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.", "stability": "experimental", "summary": "A hint to the client to identify how the bearer token is formatted." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 436 }, "name": "bearerFormat", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A short description for security scheme." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 415 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "REQUIRED for oauth2.", "stability": "experimental", "summary": "An object containing configuration information for the flow types supported." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 442 }, "name": "flow", "optional": true, "type": { "fqn": "@alma-cdk/openapix.OAuthFlowsObject" } }, { "abstract": true, "docs": { "remarks": "Valid values are \"query\", \"header\" or \"cookie\".\nREQUIRED for apiKey.", "stability": "experimental", "summary": "The location of the API key." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 427 }, "name": "in", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "REQUIRED for apiKey.", "stability": "experimental", "summary": "The name of the header, query or cookie parameter to be used." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 421 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "This MUST be in the form of a URL.\nREQUIRED for openIdConnect.", "stability": "experimental", "summary": "OpenId Connect URL to discover OAuth2 configuration values." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 448 }, "name": "openIdConnectUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The values used SHOULD be registered in the IANA Authentication Scheme registry.\nREQUIRED for http.", "stability": "experimental", "summary": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 433 }, "name": "scheme", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/schema/props:SecuritySchemeObject" }, "@alma-cdk/openapix.ServerObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "An object representing a Server." }, "fqn": "@alma-cdk/openapix.ServerObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 572 }, "name": "ServerObject", "properties": [ { "abstract": true, "docs": { "remarks": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.", "stability": "experimental", "summary": "REQUIRED." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 574 }, "name": "url", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "An optional string describing the host designated by the URL." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 577 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The value is used for substitution in the server's URL template.", "stability": "experimental", "summary": "A map between a variable name and its value." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 580 }, "name": "variables", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@alma-cdk/openapix.ServerVariableObject" }, "kind": "map" } } } ], "symbolId": "src/schema/props:ServerObject" }, "@alma-cdk/openapix.ServerVariableObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "An object representing a Server Variable for server URL template substitution." }, "fqn": "@alma-cdk/openapix.ServerVariableObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 584 }, "name": "ServerVariableObject", "properties": [ { "abstract": true, "docs": { "remarks": "Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "stability": "experimental", "summary": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 586 }, "name": "default", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "An optional description for the server variable." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 592 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The array SHOULD NOT be empty.", "stability": "experimental", "summary": "An enumeration of string values to be used if the substitution options are from a limited set." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 589 }, "name": "enum", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/schema/props:ServerVariableObject" }, "@alma-cdk/openapix.TagObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.", "stability": "experimental", "summary": "Adds metadata to a single tag that is used by the Operation Object." }, "fqn": "@alma-cdk/openapix.TagObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 596 }, "name": "TagObject", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The name of the tag." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 598 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "CommonMark syntax MAY be used for rich text representation.", "stability": "experimental", "summary": "A short description for the tag." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 601 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Additional external documentation for this tag." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 604 }, "name": "externalDocs", "optional": true, "type": { "fqn": "@alma-cdk/openapix.ExternalDocumentationObject" } } ], "symbolId": "src/schema/props:TagObject" }, "@alma-cdk/openapix.Validator": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Validator configuration." }, "fqn": "@alma-cdk/openapix.Validator", "interfaces": [ "@alma-cdk/openapix.XAmazonApigatewayRequestValidator" ], "kind": "interface", "locationInModule": { "filename": "src/api/props.ts", "line": 185 }, "name": "Validator", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/api/props.ts", "line": 186 }, "name": "default", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/api/props:Validator" }, "@alma-cdk/openapix.ValidatorConfig": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Method integration validator configuration." }, "fqn": "@alma-cdk/openapix.ValidatorConfig", "kind": "interface", "locationInModule": { "filename": "src/integration/base.ts", "line": 28 }, "name": "ValidatorConfig", "properties": [ { "abstract": true, "docs": { "remarks": "Should match a key from OpenApi schema `components.securitySchemas`.", "stability": "experimental", "summary": "Validator identifier for method integration. This will override the default validator if one configured." }, "immutable": true, "locationInModule": { "filename": "src/integration/base.ts", "line": 35 }, "name": "validator", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/integration/base:ValidatorConfig" }, "@alma-cdk/openapix.XAmazonApigatewayAuthorizer": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "see": "https://awslabs.github.io/smithy/1.0/spec/aws/amazon-apigateway.html", "stability": "experimental", "summary": "Describes the `x-amazon-apigateway-authorizer` value." }, "fqn": "@alma-cdk/openapix.XAmazonApigatewayAuthorizer", "kind": "interface", "locationInModule": { "filename": "src/x-amazon-apigateway/authorizer.ts", "line": 8 }, "name": "XAmazonApigatewayAuthorizer", "properties": [ { "abstract": true, "docs": { "example": "'token'\n'request'\n'cognito_user_pools'", "remarks": "For REST APIs, specify `token` for an authorizer with the caller identity embedded in an authorization token.\nSpecify `request` for an authorizer with the caller identity contained in request parameters.", "stability": "experimental", "summary": "The type of the authorizer. This is a required property." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/authorizer.ts", "line": 20 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "example": "'arn:aws:iam::123456789012:role/MyRole'", "stability": "experimental", "summary": "The credentials required for invoking the authorizer, if any, in the form of an ARN of an IAM execution role." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/authorizer.ts", "line": 36 }, "name": "authorizerCredentials", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "example": "60", "stability": "experimental", "summary": "The number of seconds during which authorizer result is cached." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/authorizer.ts", "line": 44 }, "name": "authorizerResultTtlInSeconds", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "example": "'arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:account-id:function:auth_function_name/invocations'", "stability": "experimental", "summary": "The Uniform Resource Identifier (URI) of the authorizer Lambda function." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/authorizer.ts", "line": 28 }, "name": "authorizerUri", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "example": "'method.request.header.Authorization'\n'method.request.header.Authorization, context.identity.sourceIp'\n'method.request.header.Auth, method.request.querystring.Name'", "remarks": "Applicable for the authorizer of the `request` and `jwt` type only.", "stability": "experimental", "summary": "A comma-separated list of mapping expressions of the request parameters as the identity source." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/authorizer.ts", "line": 55 }, "name": "identitySource", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "example": "'^x-[a-z]+'", "stability": "experimental", "summary": "A regular expression for validating the token as the incoming identity." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/authorizer.ts", "line": 63 }, "name": "identityValidationExpression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "example": "['arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}]", "remarks": "Applicable for the authorizer of the `cognito_user_pools` type only.", "stability": "experimental", "summary": "List of Cognito User Pool ARNs." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/authorizer.ts", "line": 72 }, "name": "providerARNs", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/x-amazon-apigateway/authorizer:XAmazonApigatewayAuthorizer" }, "@alma-cdk/openapix.XAmazonApigatewayIntegration": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "This extension is an extended property of the OpenAPI Operation object.\nThe result is an API Gateway integration object.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.html", "stability": "experimental", "summary": "Specifies details of the backend integration used for this method." }, "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegration", "kind": "interface", "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 14 }, "name": "XAmazonApigatewayIntegration", "properties": [ { "abstract": true, "docs": { "default": "'POST'", "remarks": "For Lambda function invocations, the value must be POST.", "stability": "experimental", "summary": "The HTTP method used in the integration request." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 71 }, "name": "httpMethod", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Valid values are:\n- `http` or `http_proxy`, for integration with an HTTP backend.\n- `aws_proxy`, for integration with AWS Lambda functions.\n- `aws`, for integration with AWS Lambda functions or other AWS services, such as Amazon DynamoDB, Amazon Simple Notification Service, or Amazon Simple Queue Service.\n- `mock`, for integration with API Gateway without invoking any backend.", "stability": "experimental", "summary": "The type of integration with the specified backend." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 114 }, "name": "type", "type": { "fqn": "aws-cdk-lib.aws_apigateway.IntegrationType" } }, { "abstract": true, "docs": { "remarks": "For integrations of the aws type, this is an ARN value.\nFor the HTTP integration, this is the URL of the HTTP endpoint including the https or http scheme.", "stability": "experimental", "summary": "The endpoint URI of the backend." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 126 }, "name": "uri", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "A list of request parameters whose values are to be cached." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 18 }, "name": "cacheKeyParameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "An API-specific tag group of related cached parameters." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 23 }, "name": "cacheNamespace", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The ID of a VpcLink for the private integration." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 41 }, "name": "connectionId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "example": "'VPC_LINK'", "remarks": "The valid value is \"VPC_LINK\" for private integration\nor \"INTERNET\", otherwise.", "stability": "experimental", "summary": "The integration connection type." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 36 }, "name": "connectionType", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_apigateway.ConnectionType" } }, { "abstract": true, "docs": { "remarks": "Valid values are\n1) CONVERT_TO_TEXT, for converting a binary payload into a base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text payload natively without modification, and\n2) CONVERT_TO_BINARY, for converting a text payload into a base64-decoded blob or passing through a binary payload natively without modification.", "stability": "experimental", "summary": "Response payload encoding conversion types." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 62 }, "name": "contentHandling", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_apigateway.ContentHandling" } }, { "abstract": true, "docs": { "remarks": "If unspecified, credentials default to resource-based permissions\nthat must be added manually to allow the API to access the resource.\nFor more information, see Granting Permissions Using a Resource Policy.\n\nNote: When using IAM credentials, make sure that AWS STS Regional endpoints\nare enabled for the Region where this API is deployed for best performance.", "see": "https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#intro-permission-model-access-policy", "stability": "experimental", "summary": "For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 54 }, "name": "credentials", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Supported values are\nwhen_no_templates, when_no_match, and never", "stability": "experimental", "summary": "Specifies how a request payload of unmapped content type is passed through the integration request without modification." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 78 }, "name": "passthroughBehavior", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_apigateway.PassthroughBehavior" } }, { "abstract": true, "docs": { "remarks": "Supported request parameters are querystring, path, header, and body.", "stability": "experimental", "summary": "Specifies mappings from method request parameters to integration request parameters." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 86 }, "name": "requestParameters", "optional": true, "type": { "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationRequestParameters" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Mapping templates for a request payload of specified MIME types." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 91 }, "name": "requestTemplates", "optional": true, "type": { "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationRequestTemplates" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Defines the method's responses and specifies desired parameter mappings or payload mappings from integration responses to method responses." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 97 }, "name": "responses", "optional": true, "type": { "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationResponses" } }, { "abstract": true, "docs": { "example": "1000", "stability": "experimental", "summary": "Integration timeouts between 50 ms and 29,000 ms." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 105 }, "name": "timeoutInMillis", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "Specifies the TLS configuration for an integration." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration.ts", "line": 119 }, "name": "tlsConfig", "optional": true, "type": { "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationTlsConfig" } } ], "symbolId": "src/x-amazon-apigateway/integration:XAmazonApigatewayIntegration" }, "@alma-cdk/openapix.XAmazonApigatewayIntegrationRequestParameters": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "The method request parameters must be defined before being referenced.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestParameters.html", "stability": "experimental", "summary": "Specifies mappings from named method request parameters to integration request parameters." }, "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationRequestParameters", "kind": "interface", "locationInModule": { "filename": "src/x-amazon-apigateway/integration-request-parameters.ts", "line": 7 }, "name": "XAmazonApigatewayIntegrationRequestParameters", "symbolId": "src/x-amazon-apigateway/integration-request-parameters:XAmazonApigatewayIntegrationRequestParameters" }, "@alma-cdk/openapix.XAmazonApigatewayIntegrationRequestTemplates": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Specifies mapping templates for a request payload of the specified MIME types." }, "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationRequestTemplates", "kind": "interface", "locationInModule": { "filename": "src/x-amazon-apigateway/integration-request-templates.ts", "line": 4 }, "name": "XAmazonApigatewayIntegrationRequestTemplates", "symbolId": "src/x-amazon-apigateway/integration-request-templates:XAmazonApigatewayIntegrationRequestTemplates" }, "@alma-cdk/openapix.XAmazonApigatewayIntegrationResponse": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-response.html", "stability": "experimental", "summary": "Defines a response and specifies parameter mappings or payload mappings from the integration response to the method response." }, "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationResponse", "kind": "interface", "locationInModule": { "filename": "src/x-amazon-apigateway/integration-response.ts", "line": 11 }, "name": "XAmazonApigatewayIntegrationResponse", "properties": [ { "abstract": true, "docs": { "example": "'200'", "remarks": "This must correspond to a matching response in the OpenAPI Operation responses field.", "stability": "experimental", "summary": "HTTP status code for the method response." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration-response.ts", "line": 19 }, "name": "statusCode", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Valid values are\n1) CONVERT_TO_TEXT, for converting a binary payload into a base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text payload natively without modification, and\n2) CONVERT_TO_BINARY, for converting a text payload into a base64-decoded blob or passing through a binary payload natively without modification.", "stability": "experimental", "summary": "Response payload encoding conversion types." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration-response.ts", "line": 44 }, "name": "contentHandling", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_apigateway.ContentHandling" } }, { "abstract": true, "docs": { "remarks": "Only the header and body parameters of the integration response\ncan be mapped to the header parameters of the method.", "stability": "experimental", "summary": "Specifies parameter mappings for the response." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration-response.ts", "line": 36 }, "name": "responseParameters", "optional": true, "type": { "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationResponseParameters" } }, { "abstract": true, "docs": { "example": "{\n 'application/json': '#set ($root=$input.path('$')) { \\\"stage\\\": \\\"$root.name\\\", \\\"user-id\\\": \\\"$root.key\\\" }',\n}", "stability": "experimental", "summary": "Specifies MIME type-specific mapping templates for the response’s payload." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration-response.ts", "line": 29 }, "name": "responseTemplates", "optional": true, "type": { "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationResponseTemplates" } } ], "symbolId": "src/x-amazon-apigateway/integration-response:XAmazonApigatewayIntegrationResponse" }, "@alma-cdk/openapix.XAmazonApigatewayIntegrationResponseParameters": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "example": "{\n 'method.response.header.Location' : 'integration.response.body.redirect.url',\n 'method.response.header.x-user-id' : 'integration.response.header.x-userid'\n}", "remarks": "You can map header, body, or static values to the header type of the method response.", "stability": "experimental", "summary": "Specifies mappings from integration method response parameters to method response parameters." }, "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationResponseParameters", "kind": "interface", "locationInModule": { "filename": "src/x-amazon-apigateway/integration-response-parameters.ts", "line": 11 }, "name": "XAmazonApigatewayIntegrationResponseParameters", "symbolId": "src/x-amazon-apigateway/integration-response-parameters:XAmazonApigatewayIntegrationResponseParameters" }, "@alma-cdk/openapix.XAmazonApigatewayIntegrationResponseTemplates": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "example": "{\n 'application/json': '#set ($root=$input.path('$')) { \\\"stage\\\": \\\"$root.name\\\", \\\"user-id\\\": \\\"$root.key\\\" }',\n}", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html#models-mappings-mappings", "stability": "experimental", "summary": "Specifies a mapping template to transform the integration response body to the method response body for a given MIME type." }, "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationResponseTemplates", "kind": "interface", "locationInModule": { "filename": "src/x-amazon-apigateway/integration-response-templates.ts", "line": 12 }, "name": "XAmazonApigatewayIntegrationResponseTemplates", "symbolId": "src/x-amazon-apigateway/integration-response-templates:XAmazonApigatewayIntegrationResponseTemplates" }, "@alma-cdk/openapix.XAmazonApigatewayIntegrationResponses": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responses.html", "stability": "experimental", "summary": "Defines the method's responses and specifies parameter mappings or payload mappings from integration responses to method responses." }, "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationResponses", "kind": "interface", "locationInModule": { "filename": "src/x-amazon-apigateway/integration-responses.ts", "line": 9 }, "name": "XAmazonApigatewayIntegrationResponses", "symbolId": "src/x-amazon-apigateway/integration-responses:XAmazonApigatewayIntegrationResponses" }, "@alma-cdk/openapix.XAmazonApigatewayIntegrationTlsConfig": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "stability": "experimental", "summary": "Specifies the TLS configuration for an integration." }, "fqn": "@alma-cdk/openapix.XAmazonApigatewayIntegrationTlsConfig", "kind": "interface", "locationInModule": { "filename": "src/x-amazon-apigateway/integration-tls-config.ts", "line": 4 }, "name": "XAmazonApigatewayIntegrationTlsConfig", "properties": [ { "abstract": true, "docs": { "remarks": "This isn’t recommended, but it enables you to\nuse certificates that are signed by private certificate authorities,\nor certificates that are self-signed. If enabled, API Gateway still\nperforms basic certificate validation, which includes checking the\ncertificate's expiration date, hostname, and presence of a root certificate\nauthority. Supported only for HTTP and HTTP_PROXY integrations.", "stability": "experimental", "summary": "Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported c ertificate authority." }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/integration-tls-config.ts", "line": 15 }, "name": "insecureSkipVerification", "type": { "primitive": "boolean" } } ], "symbolId": "src/x-amazon-apigateway/integration-tls-config:XAmazonApigatewayIntegrationTlsConfig" }, "@alma-cdk/openapix.XAmazonApigatewayRequestValidator": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-request-validators.html", "stability": "experimental", "summary": "Request validator configuration." }, "fqn": "@alma-cdk/openapix.XAmazonApigatewayRequestValidator", "kind": "interface", "locationInModule": { "filename": "src/x-amazon-apigateway/request-validator.ts", "line": 5 }, "name": "XAmazonApigatewayRequestValidator", "properties": [ { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/request-validator.ts", "line": 6 }, "name": "validateRequestBody", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "experimental" }, "immutable": true, "locationInModule": { "filename": "src/x-amazon-apigateway/request-validator.ts", "line": 7 }, "name": "validateRequestParameters", "type": { "primitive": "boolean" } } ], "symbolId": "src/x-amazon-apigateway/request-validator:XAmazonApigatewayRequestValidator" }, "@alma-cdk/openapix.XmlObject": { "assembly": "@alma-cdk/openapix", "datatype": true, "docs": { "remarks": "When using arrays, XML element names are not inferred (for singular/plural forms) and the name property SHOULD be used to add that information. See examples for expected behavior.", "stability": "experimental", "summary": "A metadata object that allows for more fine-tuned XML model definitions." }, "fqn": "@alma-cdk/openapix.XmlObject", "interfaces": [ "@alma-cdk/openapix.Extensible" ], "kind": "interface", "locationInModule": { "filename": "src/schema/props.ts", "line": 278 }, "name": "XmlObject", "properties": [ { "abstract": true, "docs": { "remarks": "Default value is false.", "stability": "experimental", "summary": "Declares whether the property definition translates to an attribute instead of an element." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 289 }, "name": "attribute", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "stability": "experimental", "summary": "Replaces the name of the element/attribute used for the described schema property." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 280 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Value MUST be in the form of an absolute URI.", "stability": "experimental", "summary": "The URI of the namespace definition." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 283 }, "name": "namespace", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The prefix to be used for the name." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 286 }, "name": "prefix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "stability": "experimental", "summary": "MAY be used only for an array definition." }, "immutable": true, "locationInModule": { "filename": "src/schema/props.ts", "line": 292 }, "name": "wrapped", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/schema/props:XmlObject" } }, "version": "1.0.3", "fingerprint": "UpriRAR+z19Wn9yJXfOAYwtaujpWsyYP2a7OiPEG7Eo=" }