repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
lalcebo/json-schema | 995b5a9c8edeec38c15d1b00330f08714f82fa55 | 2023-03-06T15:48:38 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"additionalProperties": {},
"type": "object"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | d234ab9859fabf63e1c846ef209be684a8b79523 | 2023-03-06T10:26:55 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"additionalProperties": {},
"type": "object"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsService": {
"description": "**Deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/AwsService"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "Serverless Framework Configuration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | e3382db4f14c92f1ad670a6e2bc3b3b34a489d74 | 2023-03-06T15:48:38 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"additionalProperties": {},
"type": "object"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "Serverless Framework Configuration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 0a07cbf92e5d237a13954b3593150c531c171625 | 2023-03-06T16:50:24 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"additionalProperties": {},
"type": "object"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | dff2dceadc8157ef2a926cf4ecfc254129c42e3d | 2023-03-06T15:48:38 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"additionalProperties": {},
"type": "object"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 4f7ece52f55142f07f165b51bb40cef06bff99ba | 2023-03-04T07:46:50 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"Aws.Authorizers": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/Aws.CognitoAuthorizer"
},
{
"$ref": "#/definitions/Aws.LambdaAuthorizer"
},
{
"$ref": "#/definitions/Aws.OidcAuthorizer"
},
{
"$ref": "#/definitions/Aws.JwtAuthorizer"
}
]
},
"type": "object"
},
"Aws.CloudFormationResource": {
"properties": {
"DeletionPolicy": {
"type": "string"
},
"DependsOn": {
"anyOf": [
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Properties": {
"additionalProperties": {},
"type": "object"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.CloudwatchEvent.InternalEvent": {
"properties": {
"account": {
"type": "string"
},
"detail": {
"type": "object"
},
"detail-type": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"id": {
"type": "string"
},
"region": {
"type": "string"
},
"resources": {
"description": "This is an array of arns",
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"time": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"source"
]
},
"Aws.CognitoAuthorizer": {
"properties": {
"allowUnauthenticated": {
"type": "boolean"
},
"requestExtraParams": {
"properties": {
"prompt": {
"type": "string"
},
"redirect": {
"type": "boolean"
}
},
"type": "object"
},
"scope": {
"type": "string"
},
"sessionCookieName": {
"type": "string"
},
"sessionTimeout": {
"type": [
"string",
"number"
]
},
"type": {
"enum": [
"cognito"
],
"type": "string"
},
"userPoolArn": {
"type": "string"
},
"userPoolClientId": {
"type": "string"
},
"userPoolDomain": {
"type": "string"
}
},
"type": "object"
},
"Aws.Destinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"Aws.Detail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"Aws.Environment": {
"additionalProperties": {},
"type": "object"
},
"Aws.HttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"Aws.HttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/Aws.HttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"Aws.IdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.Input": {
"additionalProperties": {},
"type": "object"
},
"Aws.JwtAuthorizer": {
"properties": {
"audience": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"type": "string"
},
"issuerUrl": {
"type": "string"
}
},
"type": "object"
},
"Aws.LambdaAuthorizer": {
"properties": {
"enableSimpleResponses": {
"description": "Set if authorizer function will return authorization responses in simple format (default: false)",
"type": "boolean"
},
"functionArn": {
"description": "Mutually exclusive with `functionName`",
"type": "string"
},
"functionName": {
"description": "Mutually exclusive with `functionArn`",
"type": "string"
},
"identitySource": {
"description": "Optional. One or more mapping expressions of the request parameters in form of e.g `$request.header.Auth`. Specified values are verified to be non-empty and not null by authorizer. It is a required property when `resultTtlInSeconds` is non-zero as `identitySource` is additionally used as cache key for authorizer responses caching.",
"items": {
"type": "string"
},
"type": "array"
},
"managedExternally": {
"description": "Optional. Applicable only when using externally defined authorizer functions to prevent creation of permission resource",
"type": "boolean"
},
"name": {
"description": "Optional. Custom name for created authorizer",
"type": "string"
},
"payloadVersion": {
"description": "Version of payload that will be sent to authorizer function (default: '2.0')",
"type": "string"
},
"resultTtlInSeconds": {
"description": "Optional. Time to live for cached authorizer results, accepts values from 0 (no caching) to 3600 (1 hour). When set to non-zero value, 'identitySource' must be defined as well",
"type": "number"
},
"type": {
"description": "Should be set to 'request' for custom Lambda authorizers",
"enum": [
"request"
],
"type": "string"
}
},
"type": "object"
},
"Aws.NamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.OidcAuthorizer": {
"properties": {
"allowUnauthenticated": {
"type": "boolean"
},
"authorizationEndpoint": {
"type": "string"
},
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"issuer": {
"type": "string"
},
"requestExtraParams": {
"properties": {
"prompt": {
"type": "string"
},
"redirect": {
"type": "boolean"
}
},
"type": "object"
},
"scope": {
"type": "string"
},
"sessionCookieName": {
"type": "string"
},
"sessionTimeout": {
"type": [
"string",
"number"
]
},
"tokenEndpoint": {
"type": "string"
},
"type": {
"enum": [
"oidc"
],
"type": "string"
},
"useExistingClientSecret": {
"type": "boolean"
},
"userInfoEndpoint": {
"type": "string"
}
},
"type": "object"
},
"Aws.Quota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"Aws.ResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"Aws.RollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/Aws.RollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"Aws.RollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.S3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"Aws.StackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"Aws.Tags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Aws.Throttle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"Aws.Tracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"Aws.UsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/Aws.Quota"
},
"throttle": {
"$ref": "#/definitions/Aws.Throttle"
}
},
"type": "object"
},
"Aws.Vpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"Aws.WebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchEvent": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"event": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Aws.CloudwatchEvent.InternalEvent"
}
]
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "#/definitions/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/Aws.Destinations"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/Serverless.FilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/Aws.HttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/Aws.NamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/Aws.IdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/Aws.Detail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/Aws.RollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/Aws.StackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/Aws.Tags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/Aws.Tracing"
},
"usagePlan": {
"$ref": "#/definitions/Aws.UsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsResources": {
"oneOf": [
{
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"type": "object"
},
{
"$ref": "#/definitions/Serverless.FilePath"
}
]
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/Aws.S3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsService": {
"description": "**Deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/Aws.WebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"Serverless.FilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/AwsResources"
},
{
"items": {
"$ref": "#/definitions/AwsResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/AwsService"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "Serverless Framework Configuration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 34075c408ac445109cbc6fdcfa8fc450350005da | 2023-03-06T04:51:05 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"Aws.CloudwatchEvent.InternalEvent": {
"properties": {
"account": {
"type": "string"
},
"detail": {
"type": "object"
},
"detail-type": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"id": {
"type": "string"
},
"region": {
"type": "string"
},
"resources": {
"description": "This is an array of arns",
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"time": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"source"
]
},
"Aws.Destinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"Aws.Detail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"Aws.Environment": {
"additionalProperties": {},
"type": "object"
},
"Aws.HttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"Aws.HttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/Aws.HttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"Aws.IdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.Input": {
"additionalProperties": {},
"type": "object"
},
"Aws.NamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.Quota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"Aws.ResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"Aws.RollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/Aws.RollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"Aws.RollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.S3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"Aws.StackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"Aws.Tags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Aws.Throttle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"Aws.Tracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"Aws.UsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/Aws.Quota"
},
"throttle": {
"$ref": "#/definitions/Aws.Throttle"
}
},
"type": "object"
},
"Aws.Vpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"Aws.WebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchEvent": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"event": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Aws.CloudwatchEvent.InternalEvent"
}
]
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "#/definitions/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/Aws.Destinations"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/Serverless.FilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/Aws.HttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/Aws.NamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/Aws.IdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/Aws.Detail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/Aws.RollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/Aws.StackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/Aws.Tags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/Aws.Tracing"
},
"usagePlan": {
"$ref": "#/definitions/Aws.UsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsResources": {
"oneOf": [
{
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"type": "object"
},
{
"$ref": "#/definitions/Serverless.FilePath"
}
]
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/Aws.S3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsService": {
"description": "**Deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/Aws.WebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"Serverless.FilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/AwsResources"
},
{
"items": {
"$ref": "#/definitions/AwsResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/AwsService"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "Serverless Framework Configuration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 9ea264970b2ed1e742cb4a291e821e1082ef5823 | 2023-03-04T07:46:50 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"Aws.Alb": {
"properties": {
"authorizers": {
"$ref": "#/definitions/Aws.Authorizers"
},
"targetGroupPrefix": {
"type": "string"
}
},
"type": "object"
},
"Aws.Authorizers": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/Aws.CognitoAuthorizer"
},
{
"$ref": "#/definitions/Aws.LambdaAuthorizer"
},
{
"$ref": "#/definitions/Aws.OidcAuthorizer"
},
{
"$ref": "#/definitions/Aws.JwtAuthorizer"
}
]
},
"type": "object"
},
"Aws.CloudFormationResource": {
"properties": {
"DeletionPolicy": {
"type": "string"
},
"DependsOn": {
"anyOf": [
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Properties": {
"additionalProperties": {},
"type": "object"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.CloudwatchEvent.InternalEvent": {
"properties": {
"account": {
"type": "string"
},
"detail": {
"type": "object"
},
"detail-type": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"id": {
"type": "string"
},
"region": {
"type": "string"
},
"resources": {
"description": "This is an array of arns",
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"time": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"source"
]
},
"Aws.CognitoAuthorizer": {
"properties": {
"allowUnauthenticated": {
"type": "boolean"
},
"requestExtraParams": {
"properties": {
"prompt": {
"type": "string"
},
"redirect": {
"type": "boolean"
}
},
"type": "object"
},
"scope": {
"type": "string"
},
"sessionCookieName": {
"type": "string"
},
"sessionTimeout": {
"type": [
"string",
"number"
]
},
"type": {
"enum": [
"cognito"
],
"type": "string"
},
"userPoolArn": {
"type": "string"
},
"userPoolClientId": {
"type": "string"
},
"userPoolDomain": {
"type": "string"
}
},
"type": "object"
},
"Aws.Destinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"Aws.Detail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"Aws.Environment": {
"additionalProperties": {},
"type": "object"
},
"Aws.HttpApi": {
"properties": {
"authorizers": {
"$ref": "#/definitions/Aws.Authorizers"
},
"cors": {
"anyOf": [
{
"$ref": "#/definitions/Aws.HttpApiCors"
},
{
"type": "boolean"
}
]
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false). Useful when using a custom domain.",
"type": "boolean"
},
"id": {
"type": "string"
},
"metrics": {
"description": "Enable detailed CloudWatch metrics (default: false)",
"type": "boolean"
},
"name": {
"type": "string"
},
"payload": {
"description": "Payload format version (note: use quotes in YAML: '1.0' or '2.0') (default: '2.0')",
"enum": [
"1.0",
"2.0"
],
"type": "string"
}
},
"type": "object"
},
"Aws.HttpApiCors": {
"properties": {
"allowCredentials": {
"type": "boolean"
},
"allowHeaders": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"allowMethods": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"allowOrigins": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"maxAge": {
"type": "number"
}
},
"type": "object"
},
"Aws.HttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"Aws.HttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"Aws.HttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/Aws.HttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"Aws.IdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.Input": {
"additionalProperties": {},
"type": "object"
},
"Aws.JwtAuthorizer": {
"properties": {
"audience": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"type": "string"
},
"issuerUrl": {
"type": "string"
}
},
"type": "object"
},
"Aws.LambdaAuthorizer": {
"properties": {
"enableSimpleResponses": {
"description": "Set if authorizer function will return authorization responses in simple format (default: false)",
"type": "boolean"
},
"functionArn": {
"description": "Mutually exclusive with `functionName`",
"type": "string"
},
"functionName": {
"description": "Mutually exclusive with `functionArn`",
"type": "string"
},
"identitySource": {
"description": "Optional. One or more mapping expressions of the request parameters in form of e.g `$request.header.Auth`. Specified values are verified to be non-empty and not null by authorizer. It is a required property when `resultTtlInSeconds` is non-zero as `identitySource` is additionally used as cache key for authorizer responses caching.",
"items": {
"type": "string"
},
"type": "array"
},
"managedExternally": {
"description": "Optional. Applicable only when using externally defined authorizer functions to prevent creation of permission resource",
"type": "boolean"
},
"name": {
"description": "Optional. Custom name for created authorizer",
"type": "string"
},
"payloadVersion": {
"description": "Version of payload that will be sent to authorizer function (default: '2.0')",
"type": "string"
},
"resultTtlInSeconds": {
"description": "Optional. Time to live for cached authorizer results, accepts values from 0 (no caching) to 3600 (1 hour). When set to non-zero value, 'identitySource' must be defined as well",
"type": "number"
},
"type": {
"description": "Should be set to 'request' for custom Lambda authorizers",
"enum": [
"request"
],
"type": "string"
}
},
"type": "object"
},
"Aws.NamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.OidcAuthorizer": {
"properties": {
"allowUnauthenticated": {
"type": "boolean"
},
"authorizationEndpoint": {
"type": "string"
},
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"issuer": {
"type": "string"
},
"requestExtraParams": {
"properties": {
"prompt": {
"type": "string"
},
"redirect": {
"type": "boolean"
}
},
"type": "object"
},
"scope": {
"type": "string"
},
"sessionCookieName": {
"type": "string"
},
"sessionTimeout": {
"type": [
"string",
"number"
]
},
"tokenEndpoint": {
"type": "string"
},
"type": {
"enum": [
"oidc"
],
"type": "string"
},
"useExistingClientSecret": {
"type": "boolean"
},
"userInfoEndpoint": {
"type": "string"
}
},
"type": "object"
},
"Aws.Origin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"Aws.Quota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"Aws.ResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"Aws.RollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/Aws.RollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"Aws.RollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.S3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"Aws.StackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"Aws.Tags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Aws.Throttle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"Aws.Tracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"Aws.UsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/Aws.Quota"
},
"throttle": {
"$ref": "#/definitions/Aws.Throttle"
}
},
"type": "object"
},
"Aws.Vpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"Aws.WebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"Aws.WebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/Aws.Origin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchEvent": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"event": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Aws.CloudwatchEvent.InternalEvent"
}
]
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "#/definitions/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/Aws.Destinations"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/Serverless.FilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/Aws.HttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/Aws.NamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/Aws.IdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/Aws.HttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/Aws.WebsocketLogs"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/Aws.Detail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "#/definitions/Aws.Alb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"httpApi": {
"$ref": "#/definitions/Aws.HttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/Aws.RollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/Aws.StackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/Aws.Tags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/Aws.Tracing"
},
"usagePlan": {
"$ref": "#/definitions/Aws.UsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsResources": {
"oneOf": [
{
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"type": "object"
},
{
"$ref": "#/definitions/Serverless.FilePath"
}
]
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/Aws.S3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsService": {
"description": "**Deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/Aws.WebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"Serverless.FilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/AwsResources"
},
{
"items": {
"$ref": "#/definitions/AwsResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/AwsService"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "Serverless Framework Configuration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | c28ceac4d513d0b6a84a1508b399cb7a24052907 | 2023-03-06T15:48:38 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"additionalProperties": {},
"type": "object"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 44e40b8eb79c5a31bbbf6a9ecaf87c94347893a5 | 2023-03-15T08:31:33 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"reservedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#/AwsHttpApi"
},
"iam": {
"$ref": "components/iam.json#/AwsIamConfiguration"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "components/iam.json#/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"ssmPublish": {
"$ref": "plugin/ssm_publish.json#/SsmPublishConfiguration"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/AwsStepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 70678b2f84f0abf598ef533c9bbce5bc4f69b509 | 2023-02-01T02:55:56 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"Aws.Alb": {
"properties": {
"authorizers": {
"$ref": "#/definitions/Aws.Authorizers"
},
"targetGroupPrefix": {
"type": "string"
}
},
"type": "object"
},
"Aws.Authorizers": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/Aws.CognitoAuthorizer"
},
{
"$ref": "#/definitions/Aws.LambdaAuthorizer"
},
{
"$ref": "#/definitions/Aws.OidcAuthorizer"
},
{
"$ref": "#/definitions/Aws.JwtAuthorizer"
}
]
},
"type": "object"
},
"Aws.CloudFormationResource": {
"properties": {
"DeletionPolicy": {
"type": "string"
},
"DependsOn": {
"anyOf": [
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Properties": {
"additionalProperties": {},
"type": "object"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.CloudwatchEvent.InternalEvent": {
"properties": {
"account": {
"type": "string"
},
"detail": {
"type": "object"
},
"detail-type": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"id": {
"type": "string"
},
"region": {
"type": "string"
},
"resources": {
"description": "This is an array of arns",
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"time": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"source"
]
},
"Aws.CognitoAuthorizer": {
"properties": {
"allowUnauthenticated": {
"type": "boolean"
},
"requestExtraParams": {
"properties": {
"prompt": {
"type": "string"
},
"redirect": {
"type": "boolean"
}
},
"type": "object"
},
"scope": {
"type": "string"
},
"sessionCookieName": {
"type": "string"
},
"sessionTimeout": {
"type": [
"string",
"number"
]
},
"type": {
"enum": [
"cognito"
],
"type": "string"
},
"userPoolArn": {
"type": "string"
},
"userPoolClientId": {
"type": "string"
},
"userPoolDomain": {
"type": "string"
}
},
"type": "object"
},
"Aws.Destinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"Aws.Detail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"Aws.Environment": {
"additionalProperties": {},
"type": "object"
},
"Aws.HttpApi": {
"properties": {
"authorizers": {
"$ref": "#/definitions/Aws.Authorizers"
},
"cors": {
"anyOf": [
{
"$ref": "#/definitions/Aws.HttpApiCors"
},
{
"type": "boolean"
}
]
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false). Useful when using a custom domain.",
"type": "boolean"
},
"id": {
"type": "string"
},
"metrics": {
"description": "Enable detailed CloudWatch metrics (default: false)",
"type": "boolean"
},
"name": {
"type": "string"
},
"payload": {
"description": "Payload format version (note: use quotes in YAML: '1.0' or '2.0') (default: '2.0')",
"enum": [
"1.0",
"2.0"
],
"type": "string"
}
},
"type": "object"
},
"Aws.HttpApiCors": {
"properties": {
"allowCredentials": {
"type": "boolean"
},
"allowHeaders": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"allowMethods": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"allowOrigins": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"maxAge": {
"type": "number"
}
},
"type": "object"
},
"Aws.HttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"Aws.HttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"Aws.HttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/Aws.HttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"Aws.IdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.Input": {
"additionalProperties": {},
"type": "object"
},
"Aws.JwtAuthorizer": {
"properties": {
"audience": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"type": "string"
},
"issuerUrl": {
"type": "string"
}
},
"type": "object"
},
"Aws.LambdaAuthorizer": {
"properties": {
"enableSimpleResponses": {
"description": "Set if authorizer function will return authorization responses in simple format (default: false)",
"type": "boolean"
},
"functionArn": {
"description": "Mutually exclusive with `functionName`",
"type": "string"
},
"functionName": {
"description": "Mutually exclusive with `functionArn`",
"type": "string"
},
"identitySource": {
"description": "Optional. One or more mapping expressions of the request parameters in form of e.g `$request.header.Auth`. Specified values are verified to be non-empty and not null by authorizer. It is a required property when `resultTtlInSeconds` is non-zero as `identitySource` is additionally used as cache key for authorizer responses caching.",
"items": {
"type": "string"
},
"type": "array"
},
"managedExternally": {
"description": "Optional. Applicable only when using externally defined authorizer functions to prevent creation of permission resource",
"type": "boolean"
},
"name": {
"description": "Optional. Custom name for created authorizer",
"type": "string"
},
"payloadVersion": {
"description": "Version of payload that will be sent to authorizer function (default: '2.0')",
"type": "string"
},
"resultTtlInSeconds": {
"description": "Optional. Time to live for cached authorizer results, accepts values from 0 (no caching) to 3600 (1 hour). When set to non-zero value, 'identitySource' must be defined as well",
"type": "number"
},
"type": {
"description": "Should be set to 'request' for custom Lambda authorizers",
"enum": [
"request"
],
"type": "string"
}
},
"type": "object"
},
"Aws.NamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.OidcAuthorizer": {
"properties": {
"allowUnauthenticated": {
"type": "boolean"
},
"authorizationEndpoint": {
"type": "string"
},
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"issuer": {
"type": "string"
},
"requestExtraParams": {
"properties": {
"prompt": {
"type": "string"
},
"redirect": {
"type": "boolean"
}
},
"type": "object"
},
"scope": {
"type": "string"
},
"sessionCookieName": {
"type": "string"
},
"sessionTimeout": {
"type": [
"string",
"number"
]
},
"tokenEndpoint": {
"type": "string"
},
"type": {
"enum": [
"oidc"
],
"type": "string"
},
"useExistingClientSecret": {
"type": "boolean"
},
"userInfoEndpoint": {
"type": "string"
}
},
"type": "object"
},
"Aws.Origin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"Aws.Quota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"Aws.ResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"Aws.RollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/Aws.RollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"Aws.RollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.S3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"Aws.StackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"Aws.Tags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Aws.Throttle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"Aws.Tracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"Aws.UsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/Aws.Quota"
},
"throttle": {
"$ref": "#/definitions/Aws.Throttle"
}
},
"type": "object"
},
"Aws.Vpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"Aws.WebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"Aws.WebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/Aws.Origin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchEvent": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"event": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Aws.CloudwatchEvent.InternalEvent"
}
]
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "#/definitions/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/Aws.Destinations"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "#/definitions/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/Serverless.FilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/Aws.HttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/Aws.NamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/Aws.IdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "#/definitions/AwsRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/Aws.HttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/Aws.WebsocketLogs"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/Aws.Detail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "#/definitions/Aws.Alb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"httpApi": {
"$ref": "#/definitions/Aws.HttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/Aws.RollbackConfiguration"
},
"runtime": {
"$ref": "#/definitions/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/Aws.StackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/Aws.Tags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/Aws.Tracing"
},
"usagePlan": {
"$ref": "#/definitions/Aws.UsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsResources": {
"oneOf": [
{
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"type": "object"
},
{
"$ref": "#/definitions/Serverless.FilePath"
}
]
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRuntime": {
"description": "https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html",
"enum": [
"nodejs18.x",
"nodejs16.x",
"nodejs14.x",
"nodejs12.x",
"python3.9",
"python3.8",
"python3.7",
"python3.6",
"ruby2.7",
"java11",
"java8.al2",
"java8",
"go1.x",
"dotnet6",
"dotnetcore3.1",
"provided.al2",
"provided"
],
"type": "string"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/Aws.S3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsService": {
"description": "**Deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/Aws.WebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"Serverless.FilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/AwsResources"
},
{
"items": {
"$ref": "#/definitions/AwsResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/AwsService"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "Serverless Framework Configuration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | ac4d514bf4f40b9a70259109cc96a0b52f04b6a2 | 2023-06-13T16:21:44 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"anyOf": [
{
"$ref": "components/events.json#/AwsSqs"
},
{
"type": "string"
}
]
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"reservedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#/AwsHttpApi"
},
"iam": {
"$ref": "components/iam.json#/AwsIamConfiguration"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "components/iam.json#/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"ssmPublish": {
"$ref": "plugin/ssm_publish.json#/SsmPublishConfiguration"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/AwsStepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 414a012bc34a13b2a9b66c5fe2f3288c360099b3 | 2023-03-06T04:51:05 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"Aws.Destinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"Aws.Detail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"Aws.Environment": {
"additionalProperties": {},
"type": "object"
},
"Aws.HttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"Aws.HttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/Aws.HttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"Aws.IdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.Input": {
"additionalProperties": {},
"type": "object"
},
"Aws.NamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.Quota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"Aws.ResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"Aws.RollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/Aws.RollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"Aws.RollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.S3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"Aws.StackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"Aws.Tags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Aws.Throttle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"Aws.Tracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"Aws.UsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/Aws.Quota"
},
"throttle": {
"$ref": "#/definitions/Aws.Throttle"
}
},
"type": "object"
},
"Aws.Vpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"Aws.WebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/Aws.Destinations"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/Serverless.FilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/Aws.HttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/Aws.NamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/Aws.IdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/Aws.Detail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/Aws.RollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/Aws.StackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/Aws.Tags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/Aws.Tracing"
},
"usagePlan": {
"$ref": "#/definitions/Aws.UsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsResources": {
"oneOf": [
{
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"type": "object"
},
{
"$ref": "#/definitions/Serverless.FilePath"
}
]
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/Aws.S3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsService": {
"description": "**Deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/Aws.WebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"Serverless.FilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/AwsResources"
},
{
"items": {
"$ref": "#/definitions/AwsResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/AwsService"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "Serverless Framework Configuration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | db2ad891df367bc3ffe3d8bb2dbb3ad2cf184876 | 2023-03-06T15:48:38 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"additionalProperties": {},
"type": "object"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 66dbb5b1312c078d1ea3565416ad4d150c5e71c5 | 2023-03-04T07:46:50 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"Aws.Alb": {
"properties": {
"authorizers": {
"$ref": "#/definitions/Aws.Authorizers"
},
"targetGroupPrefix": {
"type": "string"
}
},
"type": "object"
},
"Aws.Authorizers": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/Aws.CognitoAuthorizer"
},
{
"$ref": "#/definitions/Aws.LambdaAuthorizer"
},
{
"$ref": "#/definitions/Aws.OidcAuthorizer"
},
{
"$ref": "#/definitions/Aws.JwtAuthorizer"
}
]
},
"type": "object"
},
"Aws.CloudFormationResource": {
"properties": {
"DeletionPolicy": {
"type": "string"
},
"DependsOn": {
"anyOf": [
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Properties": {
"additionalProperties": {},
"type": "object"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.CloudwatchEvent.InternalEvent": {
"properties": {
"account": {
"type": "string"
},
"detail": {
"type": "object"
},
"detail-type": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"id": {
"type": "string"
},
"region": {
"type": "string"
},
"resources": {
"description": "This is an array of arns",
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"time": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"source"
]
},
"Aws.CognitoAuthorizer": {
"properties": {
"allowUnauthenticated": {
"type": "boolean"
},
"requestExtraParams": {
"properties": {
"prompt": {
"type": "string"
},
"redirect": {
"type": "boolean"
}
},
"type": "object"
},
"scope": {
"type": "string"
},
"sessionCookieName": {
"type": "string"
},
"sessionTimeout": {
"type": [
"string",
"number"
]
},
"type": {
"enum": [
"cognito"
],
"type": "string"
},
"userPoolArn": {
"type": "string"
},
"userPoolClientId": {
"type": "string"
},
"userPoolDomain": {
"type": "string"
}
},
"type": "object"
},
"Aws.Destinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"Aws.Detail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"Aws.Environment": {
"additionalProperties": {},
"type": "object"
},
"Aws.HttpApi": {
"properties": {
"authorizers": {
"$ref": "#/definitions/Aws.Authorizers"
},
"cors": {
"anyOf": [
{
"$ref": "#/definitions/Aws.HttpApiCors"
},
{
"type": "boolean"
}
]
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false). Useful when using a custom domain.",
"type": "boolean"
},
"id": {
"type": "string"
},
"metrics": {
"description": "Enable detailed CloudWatch metrics (default: false)",
"type": "boolean"
},
"name": {
"type": "string"
},
"payload": {
"description": "Payload format version (note: use quotes in YAML: '1.0' or '2.0') (default: '2.0')",
"enum": [
"1.0",
"2.0"
],
"type": "string"
}
},
"type": "object"
},
"Aws.HttpApiCors": {
"properties": {
"allowCredentials": {
"type": "boolean"
},
"allowHeaders": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"allowMethods": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"allowOrigins": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"maxAge": {
"type": "number"
}
},
"type": "object"
},
"Aws.HttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"Aws.HttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/Aws.HttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"Aws.IdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.Input": {
"additionalProperties": {},
"type": "object"
},
"Aws.JwtAuthorizer": {
"properties": {
"audience": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"type": "string"
},
"issuerUrl": {
"type": "string"
}
},
"type": "object"
},
"Aws.LambdaAuthorizer": {
"properties": {
"enableSimpleResponses": {
"description": "Set if authorizer function will return authorization responses in simple format (default: false)",
"type": "boolean"
},
"functionArn": {
"description": "Mutually exclusive with `functionName`",
"type": "string"
},
"functionName": {
"description": "Mutually exclusive with `functionArn`",
"type": "string"
},
"identitySource": {
"description": "Optional. One or more mapping expressions of the request parameters in form of e.g `$request.header.Auth`. Specified values are verified to be non-empty and not null by authorizer. It is a required property when `resultTtlInSeconds` is non-zero as `identitySource` is additionally used as cache key for authorizer responses caching.",
"items": {
"type": "string"
},
"type": "array"
},
"managedExternally": {
"description": "Optional. Applicable only when using externally defined authorizer functions to prevent creation of permission resource",
"type": "boolean"
},
"name": {
"description": "Optional. Custom name for created authorizer",
"type": "string"
},
"payloadVersion": {
"description": "Version of payload that will be sent to authorizer function (default: '2.0')",
"type": "string"
},
"resultTtlInSeconds": {
"description": "Optional. Time to live for cached authorizer results, accepts values from 0 (no caching) to 3600 (1 hour). When set to non-zero value, 'identitySource' must be defined as well",
"type": "number"
},
"type": {
"description": "Should be set to 'request' for custom Lambda authorizers",
"enum": [
"request"
],
"type": "string"
}
},
"type": "object"
},
"Aws.NamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.OidcAuthorizer": {
"properties": {
"allowUnauthenticated": {
"type": "boolean"
},
"authorizationEndpoint": {
"type": "string"
},
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"issuer": {
"type": "string"
},
"requestExtraParams": {
"properties": {
"prompt": {
"type": "string"
},
"redirect": {
"type": "boolean"
}
},
"type": "object"
},
"scope": {
"type": "string"
},
"sessionCookieName": {
"type": "string"
},
"sessionTimeout": {
"type": [
"string",
"number"
]
},
"tokenEndpoint": {
"type": "string"
},
"type": {
"enum": [
"oidc"
],
"type": "string"
},
"useExistingClientSecret": {
"type": "boolean"
},
"userInfoEndpoint": {
"type": "string"
}
},
"type": "object"
},
"Aws.Quota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"Aws.ResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"Aws.RollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/Aws.RollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"Aws.RollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.S3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"Aws.StackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"Aws.Tags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Aws.Throttle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"Aws.Tracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"Aws.UsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/Aws.Quota"
},
"throttle": {
"$ref": "#/definitions/Aws.Throttle"
}
},
"type": "object"
},
"Aws.Vpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"Aws.WebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchEvent": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"event": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Aws.CloudwatchEvent.InternalEvent"
}
]
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "#/definitions/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/Aws.Destinations"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/Serverless.FilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/Aws.HttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/Aws.NamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/Aws.IdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/Aws.Detail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "#/definitions/Aws.Alb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"httpApi": {
"$ref": "#/definitions/Aws.HttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/Aws.RollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/Aws.StackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/Aws.Tags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/Aws.Tracing"
},
"usagePlan": {
"$ref": "#/definitions/Aws.UsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsResources": {
"oneOf": [
{
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"type": "object"
},
{
"$ref": "#/definitions/Serverless.FilePath"
}
]
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/Aws.S3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsService": {
"description": "**Deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/Aws.WebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"Serverless.FilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/AwsResources"
},
{
"items": {
"$ref": "#/definitions/AwsResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/AwsService"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "Serverless Framework Configuration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 4c4c3e3a6d6c644a5a4f8b517c2623f88870f3c4 | 2023-03-06T16:50:24 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 04a3bf39118dd0258ab77d6c8678f212f4e5d77a | 2024-02-07T21:00:33 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"anyOf": [
{
"$ref": "components/events.json#/AwsSqs"
},
{
"type": "string"
}
]
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"reservedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"oneOf": [
{
"required": [
"arn"
]
},
{
"required": [
"name"
]
}
],
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#/AwsHttpApi"
},
"iam": {
"$ref": "components/iam.json#/AwsIamConfiguration"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "components/iam.json#/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"anyOf": [
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
{
"type": "string"
}
]
},
"type": "array"
},
"subnetIds": {
"items": {
"anyOf": [
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
{
"type": "string"
}
]
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"ssmPublish": {
"$ref": "plugin/ssm_publish.json#/SsmPublishConfiguration"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/AwsStepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | 28bfc2a1ed454b2dd2e13d5aa5cfcef476335a32 | 2023-03-06T15:48:38 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"additionalProperties": {},
"type": "object"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | d653d1b0bfe0ed926561cfabf2cd8a12c8b3a0f4 | 2023-03-06T16:50:24 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#AwsHttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | b34d4bbd6a5e358211be15651945a26725fe0df0 | 2024-02-07T20:38:36 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsDestinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"AwsDetail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"AwsEnvironment": {
"additionalProperties": {},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "components/events.json#/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "components/events.json#/AwsScheduleEvent"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"anyOf": [
{
"$ref": "components/events.json#/AwsSqs"
},
{
"type": "string"
}
]
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "components/common.json#/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/AwsDestinations"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"description": "Collection of Lambda layers to make it available for this lambda. Can use Cloudformation here as well. Usage on:- https://www.serverless.com/framework/docs/providers/aws/guide/layers#using-your-layers",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"provisionedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"reservedConcurrency": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_FunctionString"
},
{
"$ref": "components/cf.functions.json#/FnIf"
}
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/ServerlessFilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/AwsHttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/AwsNamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/AwsIdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"oneOf": [
{
"required": [
"arn"
]
},
{
"required": [
"name"
]
}
],
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsHttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"AwsHttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/AwsHttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"AwsIdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsNamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/AwsDetail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"description": "Configuration for Serverless AWS ",
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "components/common.json#/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/AwsEnvironment"
},
"httpApi": {
"$ref": "components/api.gateway.v2.json#/AwsHttpApi"
},
"iam": {
"$ref": "components/iam.json#/AwsIamConfiguration"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "components/iam.json#/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/AwsRollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"runtimeManagement": {
"$ref": "components/lambda.json#/AwsLambdaRuntimeManagement"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/AwsStackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/AwsResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/AwsTags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/AwsTags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/AwsTracing"
},
"usagePlan": {
"$ref": "#/definitions/AwsUsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/AwsVpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsProvider",
"type": "object"
},
"AwsQuota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"AwsResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsRollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/AwsRollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"AwsRollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/AwsS3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsS3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"AwsStackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"AwsThrottle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsTracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"AwsUsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/AwsQuota"
},
"throttle": {
"$ref": "#/definitions/AwsThrottle"
}
},
"type": "object"
},
"AwsVpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/AwsWebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"ssmPublish": {
"$ref": "plugin/ssm_publish.json#/SsmPublishConfiguration"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"ServerlessFilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessFrameworkResources": {
"oneOf": [
{
"description": "Serverless Framework Additional Resources Configuration",
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"title": "ServerlessFrameworkResourceConfiguration",
"type": "object"
},
{
"$ref": "#/definitions/ServerlessFilePath"
}
]
},
"ServerlessServiceConfiguration": {
"description": "**@deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "ServerlessServiceConfiguration",
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "components/layers.json#/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "components/common.json#/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "LocalPlugin",
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessFrameworkResources"
},
{
"items": {
"$ref": "#/definitions/ServerlessFrameworkResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/ServerlessServiceConfiguration"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/AwsStepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "ServerlessFrameworkConfiguration",
"type": "object"
} | MIT | en |
lalcebo/json-schema | dc431766497c965e0611a3e85dcfc8fec8545ce9 | 2023-03-04T07:46:50 | serverless/reference.json | 16 | 2024-05-27T05:54:18.298495Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"Aws.Authorizers": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/Aws.CognitoAuthorizer"
},
{
"$ref": "#/definitions/Aws.LambdaAuthorizer"
},
{
"$ref": "#/definitions/Aws.OidcAuthorizer"
},
{
"$ref": "#/definitions/Aws.JwtAuthorizer"
}
]
},
"type": "object"
},
"Aws.CloudFormationResource": {
"properties": {
"DeletionPolicy": {
"type": "string"
},
"DependsOn": {
"anyOf": [
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Properties": {
"additionalProperties": {},
"type": "object"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.CloudwatchEvent.InternalEvent": {
"properties": {
"account": {
"type": "string"
},
"detail": {
"type": "object"
},
"detail-type": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"id": {
"type": "string"
},
"region": {
"type": "string"
},
"resources": {
"description": "This is an array of arns",
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"time": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"source"
]
},
"Aws.CognitoAuthorizer": {
"properties": {
"allowUnauthenticated": {
"type": "boolean"
},
"requestExtraParams": {
"properties": {
"prompt": {
"type": "string"
},
"redirect": {
"type": "boolean"
}
},
"type": "object"
},
"scope": {
"type": "string"
},
"sessionCookieName": {
"type": "string"
},
"sessionTimeout": {
"type": [
"string",
"number"
]
},
"type": {
"enum": [
"cognito"
],
"type": "string"
},
"userPoolArn": {
"type": "string"
},
"userPoolClientId": {
"type": "string"
},
"userPoolDomain": {
"type": "string"
}
},
"type": "object"
},
"Aws.Destinations": {
"properties": {
"onFailure": {
"type": "string"
},
"onSuccess": {
"type": "string"
}
},
"type": "object"
},
"Aws.Detail": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"Aws.Environment": {
"additionalProperties": {},
"type": "object"
},
"Aws.HttpApi": {
"properties": {
"authorizers": {
"$ref": "#/definitions/Aws.Authorizers"
},
"cors": {
"anyOf": [
{
"$ref": "#/definitions/Aws.HttpApiCors"
},
{
"type": "boolean"
}
]
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false). Useful when using a custom domain.",
"type": "boolean"
},
"id": {
"type": "string"
},
"metrics": {
"description": "Enable detailed CloudWatch metrics (default: false)",
"type": "boolean"
},
"name": {
"type": "string"
},
"payload": {
"description": "Payload format version (note: use quotes in YAML: '1.0' or '2.0') (default: '2.0')",
"enum": [
"1.0",
"2.0"
],
"type": "string"
}
},
"type": "object"
},
"Aws.HttpApiCors": {
"properties": {
"allowCredentials": {
"type": "boolean"
},
"allowHeaders": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"allowMethods": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"allowOrigins": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"maxAge": {
"type": "number"
}
},
"type": "object"
},
"Aws.HttpRequestParametersValidation": {
"properties": {
"headers": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"paths": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"querystrings": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"Aws.HttpRequestValidation": {
"properties": {
"parameters": {
"$ref": "#/definitions/Aws.HttpRequestParametersValidation"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"Aws.IdRefHttpApiEventAuthorizer": {
"properties": {
"id": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.Input": {
"additionalProperties": {},
"type": "object"
},
"Aws.JwtAuthorizer": {
"properties": {
"audience": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"type": "string"
},
"issuerUrl": {
"type": "string"
}
},
"type": "object"
},
"Aws.LambdaAuthorizer": {
"properties": {
"enableSimpleResponses": {
"description": "Set if authorizer function will return authorization responses in simple format (default: false)",
"type": "boolean"
},
"functionArn": {
"description": "Mutually exclusive with `functionName`",
"type": "string"
},
"functionName": {
"description": "Mutually exclusive with `functionArn`",
"type": "string"
},
"identitySource": {
"description": "Optional. One or more mapping expressions of the request parameters in form of e.g `$request.header.Auth`. Specified values are verified to be non-empty and not null by authorizer. It is a required property when `resultTtlInSeconds` is non-zero as `identitySource` is additionally used as cache key for authorizer responses caching.",
"items": {
"type": "string"
},
"type": "array"
},
"managedExternally": {
"description": "Optional. Applicable only when using externally defined authorizer functions to prevent creation of permission resource",
"type": "boolean"
},
"name": {
"description": "Optional. Custom name for created authorizer",
"type": "string"
},
"payloadVersion": {
"description": "Version of payload that will be sent to authorizer function (default: '2.0')",
"type": "string"
},
"resultTtlInSeconds": {
"description": "Optional. Time to live for cached authorizer results, accepts values from 0 (no caching) to 3600 (1 hour). When set to non-zero value, 'identitySource' must be defined as well",
"type": "number"
},
"type": {
"description": "Should be set to 'request' for custom Lambda authorizers",
"enum": [
"request"
],
"type": "string"
}
},
"type": "object"
},
"Aws.NamedHttpApiEventAuthorizer": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Aws.OidcAuthorizer": {
"properties": {
"allowUnauthenticated": {
"type": "boolean"
},
"authorizationEndpoint": {
"type": "string"
},
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"issuer": {
"type": "string"
},
"requestExtraParams": {
"properties": {
"prompt": {
"type": "string"
},
"redirect": {
"type": "boolean"
}
},
"type": "object"
},
"scope": {
"type": "string"
},
"sessionCookieName": {
"type": "string"
},
"sessionTimeout": {
"type": [
"string",
"number"
]
},
"tokenEndpoint": {
"type": "string"
},
"type": {
"enum": [
"oidc"
],
"type": "string"
},
"useExistingClientSecret": {
"type": "boolean"
},
"userInfoEndpoint": {
"type": "string"
}
},
"type": "object"
},
"Aws.Quota": {
"properties": {
"limit": {
"type": [
"string",
"number"
]
},
"offset": {
"type": [
"string",
"number"
]
},
"period": {
"type": "string"
}
},
"type": "object"
},
"Aws.ResourcePolicy": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"Principal": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"Aws.RollbackConfiguration": {
"properties": {
"MonitoringTimeInMinutes": {
"type": [
"string",
"number"
]
},
"RollbackTriggers": {
"items": {
"$ref": "#/definitions/Aws.RollbackTrigger"
},
"type": "array"
}
},
"type": "object"
},
"Aws.RollbackTrigger": {
"properties": {
"Arn": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"Aws.S3Rule": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"type": "object"
},
"Aws.StackParameters": {
"properties": {
"ParameterKey": {
"type": "string"
},
"ParameterValue": {
"type": "string"
}
},
"type": "object"
},
"Aws.Tags": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"Aws.Throttle": {
"properties": {
"burstLimit": {
"type": [
"string",
"number"
]
},
"rateLimit": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"Aws.Tracing": {
"properties": {
"apiGateway": {
"type": "boolean"
},
"lambda": {
"type": "boolean"
}
},
"type": "object"
},
"Aws.UsagePlan": {
"properties": {
"quota": {
"$ref": "#/definitions/Aws.Quota"
},
"throttle": {
"$ref": "#/definitions/Aws.Throttle"
}
},
"type": "object"
},
"Aws.Vpc": {
"properties": {
"securityGroupIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
"subnetIds": {
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
}
},
"required": [
"securityGroupIds",
"subnetIds"
],
"type": "object"
},
"Aws.WebsocketAuthorizer": {
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsAlexaSmartHome": {
"properties": {
"appId": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"type": "object"
},
"AwsApiGateway": {
"properties": {
"apiKeySourceType": {
"enum": [
"HEADER",
"AUTHORIZER"
],
"type": "string"
},
"apiKeys": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"customerId": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "Can be used to disable the API key without removing it (default: true)",
"type": "boolean"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"binaryMediaTypes": {
"description": "Optional binary media types the API might return",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"disableDefaultEndpoint": {
"description": "Disable the default 'execute-api' HTTP endpoint (default: false)",
"type": "boolean"
},
"metrics": {
"type": "boolean"
},
"minimumCompressionSize": {
"maximum": 10485760,
"minimum": 0,
"type": "number"
},
"restApiId": {
"type": "string"
},
"restApiResources": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"restApiRootResourceId": {
"type": "string"
},
"shouldStartNameWithService": {
"description": "Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.",
"type": "boolean"
},
"usagePlan": {
"properties": {
"quota": {
"properties": {
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"period": {
"type": "string"
}
},
"type": "object"
},
"throttle": {
"properties": {
"burstLimit": {
"type": "number"
},
"rateLimit": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"websocketApiId": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudFront": {
"properties": {
"eventType": {
"type": "string"
},
"includeBody": {
"type": "boolean"
},
"origin": {
"$ref": "#/definitions/AwsOrigin"
},
"pathPattern": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchEvent": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"event": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/Aws.CloudwatchEvent.InternalEvent"
}
]
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsCloudwatchLog": {
"properties": {
"filter": {
"type": "string"
},
"logGroup": {
"type": "string"
}
},
"type": "object"
},
"AwsCognitoUserPool": {
"properties": {
"existing": {
"type": "boolean"
},
"pool": {
"type": "string"
},
"trigger": {
"type": "string"
}
},
"type": "object"
},
"AwsDeploymentBucket": {
"description": "Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda",
"properties": {
"blockPublicAccess": {
"description": "Prevents public access via ACLs or bucket policies (default: false). Note: the deployment bucket is not public by default. These are additional ACLs.",
"type": "boolean"
},
"maxPreviousDeploymentArtifacts": {
"description": "On deployment, serverless prunes artifacts older than this limit (default: 5)",
"type": [
"string",
"number"
]
},
"name": {
"description": "Name of an existing bucket to use (default: created by serverless)",
"type": "string"
},
"serverSideEncryption": {
"type": "string"
},
"skipPolicySetup": {
"description": "Skip the creation of a default bucket policy when the deployment bucket is created (default: false)",
"type": "boolean"
},
"sseCustomerAlgorithim": {
"type": "string"
},
"sseCustomerKey": {
"type": "string"
},
"sseCustomerKeyMD5": {
"type": "string"
},
"sseKMSKeyId": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"versioning": {
"description": "Enable bucket versioning (default: false)",
"type": "boolean"
}
},
"type": "object"
},
"AwsEvent": {
"properties": {
"activemq": {
"$ref": "components/events.json#/AwsActiveMq"
},
"alb": {
"$ref": "components/events.json#/AwsAlbEvent"
},
"alexaSkill": {
"$ref": "components/events.json#/AwsAlexaSkill"
},
"alexaSmartHome": {
"$ref": "#/definitions/AwsAlexaSmartHome"
},
"cloudFront": {
"$ref": "#/definitions/AwsCloudFront"
},
"cloudwatchEvent": {
"$ref": "#/definitions/AwsCloudwatchEvent"
},
"cloudwatchLog": {
"$ref": "#/definitions/AwsCloudwatchLog"
},
"cognitoUserPool": {
"$ref": "#/definitions/AwsCognitoUserPool"
},
"eventBridge": {
"$ref": "#/definitions/AwsEventBridge"
},
"http": {
"$ref": "#/definitions/AwsHttp"
},
"httpApi": {
"$ref": "#/definitions/AwsHttpApiEvent"
},
"iot": {
"$ref": "#/definitions/AwsIot"
},
"s3": {
"$ref": "#/definitions/AwsS3"
},
"schedule": {
"anyOf": [
{
"$ref": "#/definitions/AwsSchedule"
},
{
"type": "string"
}
]
},
"sns": {
"$ref": "components/events.json#/AwsSns"
},
"sqs": {
"$ref": "components/events.json#/AwsSqs"
},
"stream": {
"$ref": "#/definitions/AwsStream"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocket"
}
},
"type": "object"
},
"AwsEventBridge": {
"anyOf": [
{
"required": [
"pattern"
]
},
{
"required": [
"schedule"
]
}
],
"description": "Aws Lambda function Eventbridge event source",
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"eventBus": {
"minLength": 1,
"type": "string"
},
"input": {
"type": "object"
},
"inputPath": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_.]+",
"type": "string"
},
"pattern": {
"anyOf": [
{
"$ref": "#/definitions/AwsPatternExisting"
},
{
"$ref": "#/definitions/AwsPatternInput"
}
]
},
"retryPolicy": {
"properties": {
"maximumEventAge": {
"maximum": 86400,
"minimum": 60,
"type": "number"
},
"maximumRetryAttempts": {
"maximum": 185,
"minimum": 0,
"type": "number"
}
},
"type": "object"
},
"schedule": {
"pattern": "^(?:cron|rate)\\(.+\\)$",
"type": "string"
}
},
"title": "AwsEventBridge",
"type": "object"
},
"AwsFunction": {
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"condition": {
"type": "string"
},
"dependsOn": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"destinations": {
"$ref": "#/definitions/Aws.Destinations"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"events": {
"items": {
"$ref": "#/definitions/AwsEvent"
},
"type": "array"
},
"handler": {
"type": "string"
},
"image": {
"oneOf": [
{
"type": "string"
},
{
"properties": {
"command": {
"description": "Sometimes it appears that command from the dockerfile is not read and we have to overwrite it manually to make it work. One of my clients faced this recently",
"items": {
"type": "string"
},
"type": "array"
},
"entryPoint": {
"description": "Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"uri": {
"type": "string"
},
"workingDirectory": {
"type": "string"
}
},
"type": "object"
}
]
},
"layers": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "components/cf.functions.json#/FnRef"
},
{
"$ref": "components/cf.functions.json#/FnGetAtt"
},
{
"$ref": "components/cf.functions.json#/FnJoin"
},
{
"$ref": "components/cf.functions.json#/FnTransform"
},
{
"$ref": "components/cf.functions.json#/FnFindInMap"
}
]
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"memorySize": {
"type": [
"string",
"number"
]
},
"name": {
"type": "string"
},
"onError": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"provisionedConcurrency": {
"type": [
"string",
"number"
]
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"role": {
"type": "string"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"snapStart": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart",
"type": "boolean"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"type": "string"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
}
},
"type": "object"
},
"AwsFunctions": {
"oneOf": [
{
"additionalProperties": {
"$ref": "#/definitions/AwsFunction"
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
},
{
"items": {
"$ref": "#/definitions/Serverless.FilePath"
},
"type": "array"
}
]
},
"AwsHttp": {
"oneOf": [
{
"properties": {
"async": {
"type": "boolean"
},
"authorizer": {
"$ref": "#/definitions/AwsHttpAuthorizer"
},
"cors": {
"$ref": "components/api.gateway.v1.json#/AwsHttpCors"
},
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"private": {
"type": "boolean"
},
"request": {
"$ref": "#/definitions/Aws.HttpRequestValidation"
}
},
"type": "object"
},
{
"enum": [
"ANY /",
"GET /",
"POST /",
"PUT /",
"PATCH /",
"OPTIONS /",
"HEAD /",
"DELETE /",
"ANY /{proxy+}",
"GET /{proxy+}",
"POST /{proxy+}",
"PUT /{proxy+}",
"PATCH /{proxy+}",
"OPTIONS /{proxy+}",
"HEAD /{proxy+}",
"DELETE /{proxy+}"
],
"type": "string"
}
]
},
"AwsHttpApiEvent": {
"oneOf": [
{
"properties": {
"authorizer": {
"anyOf": [
{
"$ref": "#/definitions/Aws.NamedHttpApiEventAuthorizer"
},
{
"$ref": "#/definitions/Aws.IdRefHttpApiEventAuthorizer"
}
]
},
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
{
"minLength": 1,
"type": "string"
}
]
},
"AwsHttpApiLogs": {
"properties": {
"format": {
"type": "string"
}
},
"type": "object"
},
"AwsHttpAuthorizer": {
"anyOf": [
{
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"enum": [
"aws_iam"
],
"title": "AwsHttpIamAuthorizerShort",
"type": "string"
},
{
"additionalProperties": false,
"description": "AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers",
"properties": {
"type": {
"enum": [
"aws_iam"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "AwsHttpIamAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"description": "The arn of the cognito user pool",
"type": "string"
},
"claims": {
"items": {
"type": "string"
},
"type": "array"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"COGNITO_USER_POOLS"
],
"type": "string"
}
},
"required": [
"type",
"arn"
],
"title": "AwsHttpCognitoAuthorizer"
},
{
"additionalProperties": false,
"properties": {
"arn": {
"type": "string"
},
"identitySource": {
"default": "method.request.header.Authorization",
"description": "The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`",
"type": "string"
},
"identityValidationExpression": {
"type": "string"
},
"name": {
"type": "string"
},
"resultTtlInSeconds": {
"maximum": 3600,
"minimum": 0,
"type": "number"
},
"type": {
"default": "token",
"enum": [
"request",
"token",
"REQUEST",
"TOKEN"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AwsHttpLambdaAuthorizer",
"type": "object"
},
{
"additionalProperties": false,
"description": "Use an existing Api Gateway Authorizer created outside or in the same stack",
"properties": {
"authorizerId": {
"description": "The Id of the existing authorizer",
"type": "string"
},
"type": {
"enum": [
"CUSTOM"
],
"type": "string"
}
},
"required": [
"type",
"authorizerId"
],
"title": "AwsHttpExistingAuthorizer",
"type": "object"
}
]
},
"AwsIamRoleStatement": {
"properties": {
"Action": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Condition": {
"additionalProperties": {},
"type": "object"
},
"Effect": {
"enum": [
"Allow",
"Deny"
],
"type": "string"
},
"NotAction": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"NotResource": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"additionalProperties": {},
"type": "object"
},
{
"type": "string"
}
]
},
"Resource": {
"anyOf": [
{
"items": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"type": "array"
},
{
"$ref": "components/cf.functions.json#/Aws_CF_Function"
}
]
},
"Sid": {
"type": "string"
}
},
"type": "object"
},
"AwsInputTransformer": {
"properties": {
"inputPathsMap": {
"additionalProperties": {
"minLength": 1,
"type": "string"
},
"type": "object"
},
"inputTemplate": {
"maxLength": 8192,
"minLength": 1,
"type": "string"
}
},
"required": [
"inputTemplate"
],
"type": "object"
},
"AwsIot": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sql": {
"type": "string"
},
"sqlVersion": {
"type": "string"
}
},
"type": "object"
},
"AwsLayer": {
"additionalProperties": false,
"properties": {
"allowedAccounts": {
"description": "**Uncommenting this will give all AWS users access to this layer unconditionally.**",
"items": {
"type": "string"
},
"type": "array"
},
"compatibleArchitectures": {
"items": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"type": "array"
},
"compatibleRuntimes": {
"items": {
"$ref": "components/layers.json#/LayerAwsCompatibleRuntime"
},
"type": "array"
},
"description": {
"type": "string"
},
"licenseInfo": {
"type": "string"
},
"name": {
"description": "Deployed Lambda layer name",
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"path": {
"type": "string"
},
"retain": {
"default": false,
"description": "If true, layer versions are not deleted as new ones are created",
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
},
"AwsLayers": {
"additionalProperties": {
"$ref": "#/definitions/AwsLayer"
},
"description": "Configuration to deploy layers using serverless framework, https://www.serverless.com/framework/docs/providers/aws/guide/layers",
"maxProperties": 5,
"type": "object"
},
"AwsLogs": {
"properties": {
"frameworkLambda": {
"type": "boolean"
},
"httpApi": {
"anyOf": [
{
"$ref": "#/definitions/AwsHttpApiLogs"
},
{
"type": "boolean"
}
]
},
"restApi": {
"$ref": "#/definitions/AwsRestApiLogs"
},
"websocket": {
"$ref": "#/definitions/AwsWebsocketLogs"
}
},
"type": "object"
},
"AwsOrigin": {
"properties": {
"CustomOriginConfig": {
"properties": {
"OriginProtocolPolicy": {
"type": "string"
}
},
"type": "object"
},
"DomainName": {
"type": "string"
},
"OriginPath": {
"type": "string"
}
},
"type": "object"
},
"AwsPackage": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"artifact": {
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#artifact",
"type": "string"
}
},
"title": "AwsPackageArtifact",
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
},
"patterns": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "AwsPackagePattern",
"type": "object"
},
{
"additionalProperties": false,
"description": "@deprecated Please move to patterns as quickly as possible",
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"excludeDevDependencies": {
"default": true,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#development-dependencies",
"type": "boolean"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
},
"individually": {
"default": false,
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging#packaging-functions-separately",
"type": "boolean"
}
},
"title": "AwsPackageExcludeInclude",
"type": "object"
}
],
"description": "https://www.serverless.com/framework/docs/providers/aws/guide/packaging"
},
"AwsPatternExisting": {
"properties": {
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsPatternInput": {
"properties": {
"detail": {
"$ref": "#/definitions/Aws.Detail"
},
"detail-type": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AwsProvider": {
"oneOf": [
{
"properties": {
"alb": {
"$ref": "components/alb.json#/AwsAlb"
},
"apiGateway": {
"$ref": "#/definitions/AwsApiGateway"
},
"apiKeys": {
"items": {
"type": "string"
},
"type": "array"
},
"apiName": {
"description": "Change this to use a custom name for the API Gateway API",
"type": "string"
},
"architecture": {
"$ref": "#/definitions/AwsSupportedArchitecture"
},
"cfnRole": {
"type": "string"
},
"deploymentBucket": {
"$ref": "#/definitions/AwsDeploymentBucket"
},
"deploymentMethod": {
"description": "Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method",
"enum": [
"direct",
"changesets"
],
"type": "string"
},
"deploymentPrefix": {
"type": "string"
},
"disableRollback": {
"description": "Disable automatic rollback by CloudFormation on failure. To be used for non-production environments.",
"type": "boolean"
},
"ecr": {
"properties": {
"images": {
"additionalProperties": {
"oneOf": [
{
"properties": {
"uri": {
"description": "URI of an existing Docker image in ECR",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"buildArgs": {
"type": "object"
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array"
},
"file": {
"description": "Dockerfile that will be used when building the image locally (default: 'Dockerfile')",
"type": "string"
},
"path": {
"description": "Path to the Docker context that will be used when building that image locally (default: '.')",
"type": "string"
}
},
"type": "object"
}
]
},
"type": "object"
},
"scanOnPush": {
"description": "Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures)",
"type": "boolean"
}
},
"type": "object"
},
"endpointType": {
"enum": [
"EDGE",
"PRIVATE",
"REGIONAL"
],
"type": "string"
},
"environment": {
"$ref": "#/definitions/Aws.Environment"
},
"httpApi": {
"$ref": "#/definitions/Aws.HttpApi"
},
"iamManagedPolicies": {
"items": {
"type": "string"
},
"type": "array"
},
"iamRoleStatements": {
"items": {
"$ref": "#/definitions/AwsIamRoleStatement"
},
"type": "array"
},
"logDataProtectionPolicy": {
"$ref": "components/cloudwatch.json#/LogDataProtectionPolicy"
},
"logRetentionInDays": {
"type": [
"string",
"number"
]
},
"logs": {
"$ref": "#/definitions/AwsLogs"
},
"memorySize": {
"oneOf": [
{
"type": "string"
},
{
"description": "Note: API Gateway has a maximum timeout of 30 seconds",
"maximum": 10240,
"minimum": 128,
"type": "number"
}
],
"type": [
"string",
"number"
]
},
"name": {
"enum": [
"aws"
],
"type": "string"
},
"notificationArns": {
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"type": "string"
},
"region": {
"$ref": "components/common.json#/AwsRegion"
},
"reservedConcurrency": {
"type": [
"string",
"number"
]
},
"resourcePolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"role": {
"type": "string"
},
"rolePermissionsBoundary": {
"type": "string"
},
"rollbackConfiguration": {
"$ref": "#/definitions/Aws.RollbackConfiguration"
},
"runtime": {
"$ref": "components/lambda.json#/AwsRuntime"
},
"stackName": {
"type": "string"
},
"stackParameters": {
"items": {
"$ref": "#/definitions/Aws.StackParameters"
},
"type": "array"
},
"stackPolicy": {
"items": {
"$ref": "#/definitions/Aws.ResourcePolicy"
},
"type": "array"
},
"stackTags": {
"$ref": "#/definitions/Aws.Tags"
},
"stage": {
"type": "string"
},
"tags": {
"$ref": "#/definitions/Aws.Tags"
},
"timeout": {
"type": [
"string",
"number"
]
},
"tracing": {
"$ref": "#/definitions/Aws.Tracing"
},
"usagePlan": {
"$ref": "#/definitions/Aws.UsagePlan"
},
"versionFunctions": {
"description": "Use function versioning (enabled by default)",
"type": "boolean"
},
"vpc": {
"$ref": "#/definitions/Aws.Vpc"
},
"websocketsApiName": {
"type": "string"
},
"websocketsApiRouteSelectionExpression": {
"type": "string"
},
"websocketsDescription": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"AwsResources": {
"oneOf": [
{
"properties": {
"AWSTemplateFormatVersion": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html",
"enum": [
"2010-09-09"
],
"type": "string"
},
"Conditions": {
"$ref": "components/conditions.json#/properties/Conditions",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html"
},
"Description": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html",
"maxLength": 1024,
"type": "string"
},
"Hooks": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html",
"type": "object"
},
"Mappings": {
"additionalProperties": false,
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html",
"patternProperties": {
"^[a-zA-Z0-9._-]{1,255}$": {
"$ref": "components/mappings.json#/properties/Mappings"
}
},
"type": "object"
},
"Metadata": {
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html",
"type": "object"
},
"Outputs": {
"$ref": "components/outputs.json#/AwsOutputs"
},
"Parameters": {
"$ref": "components/parameters.json#/properties/Parameters",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html"
},
"Resources": {
"$ref": "resources/resources.schema.json#/properties/Resources"
},
"Rules": {
"description": "https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html",
"type": "object"
},
"Transform": {
"$ref": "#/definitions/Transform",
"description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html"
}
},
"type": "object"
},
{
"$ref": "#/definitions/Serverless.FilePath"
}
]
},
"AwsRestApiLogs": {
"properties": {
"accessLogging": {
"type": "boolean"
},
"executionLogging": {
"type": "boolean"
},
"format": {
"type": "string"
},
"fullExecutionData": {
"type": "boolean"
},
"level": {
"type": "string"
},
"role": {
"type": "string"
},
"roleManagedExternally": {
"type": "boolean"
}
},
"title": "AwsRestApiLogs",
"type": "object"
},
"AwsS3": {
"oneOf": [
{
"properties": {
"bucket": {
"type": "string"
},
"event": {
"type": "string"
},
"existing": {
"type": "boolean"
},
"rules": {
"items": {
"$ref": "#/definitions/Aws.S3Rule"
},
"type": "array"
}
},
"type": "object"
},
{
"description": "This will create a new bucket and trigger the lambda when an object is added or modified inside the bucket. More details :- https://www.serverless.com/framework/docs/providers/aws/events/s3#simple-event-definition",
"maxLength": 63,
"minLength": 3,
"pattern": "(?!(^((2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})\\.){3}(2(5[0-5]|[0-4][0-9])|[01]?[0-9]{1,2})$|^xn--|-s3alias$))^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$",
"type": "string"
}
]
},
"AwsSchedule": {
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"input": {
"$ref": "#/definitions/Aws.Input"
},
"inputPath": {
"type": "string"
},
"inputTransformer": {
"$ref": "#/definitions/AwsInputTransformer"
},
"name": {
"type": "string"
},
"rate": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"AwsService": {
"description": "**Deprecated and doesn't work in serverless framework v3**",
"properties": {
"awsKmsKeyArn": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"AwsStream": {
"properties": {
"arn": {
"$ref": "components/cf.functions.json#/Aws_CF_Function"
},
"batchSize": {
"type": [
"string",
"number"
]
},
"enabled": {
"type": "boolean"
},
"startingPosition": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"AwsSupportedArchitecture": {
"default": "x86_64",
"description": "Processor architecture: 'x86_64' or 'arm64' via Graviton2 (default: x86_64)",
"enum": [
"x86_64",
"arm64"
],
"type": "string"
},
"AwsWebsocket": {
"properties": {
"authorizer": {
"$ref": "#/definitions/Aws.WebsocketAuthorizer"
},
"route": {
"type": "string"
},
"routeResponseSelectionExpression": {
"type": "string"
}
},
"type": "object"
},
"AwsWebsocketLogs": {
"properties": {
"accessLogging": {
"description": "Enables HTTP access logs (default: true)",
"type": "boolean"
},
"executionLogging": {
"description": "Enable execution logging (default: true)",
"type": "boolean"
},
"format": {
"description": "Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html",
"type": "string"
},
"fullExecutionData": {
"description": "Log full requests/responses for execution logging (default: true)",
"type": "boolean"
},
"level": {
"enum": [
"INFO",
"ERROR"
],
"type": "string"
}
},
"type": "object"
},
"Serverless.FilePath": {
"minLength": 1,
"pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}",
"type": "string"
},
"ServerlessCustom": {
"additionalProperties": true,
"properties": {
"esbuild": {
"$ref": "plugin/esbuild.json#/Esbuild"
},
"prune": {
"$ref": "plugin/prune.json#/Prune"
},
"pythonRequirements": {
"$ref": "plugin/python_requirements.json#/PythonRequirements"
},
"splitStacks": {
"$ref": "plugin/split_stacks.json#/SplitStacks"
},
"webpack": {
"$ref": "plugin/webpack.json#/WebpackConfiguration"
},
"wsgi": {
"$ref": "plugin/python_wsgi.json#/PythonWsgi"
}
},
"type": "object"
},
"Transform": {
"oneOf": [
{
"$comment": "You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.",
"additionalProperties": false,
"properties": {
"Name": {
"enum": [
"AWS::Include"
],
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"properties": {
"Location": {
"$comment": "The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
}
},
{
"$comment": "Use a transform to simplify template authoring for serverless applications. ",
"enum": [
"AWS::CodeDeployBlueGreen",
"AWS::CodeStar",
"AWS::SecretsManager-2020-07-23",
"AWS::Serverless-2016-10-31"
],
"type": "string"
}
],
"type": "object"
}
},
"description": "Schema for serverless framework configuration files",
"fileMatch": [
"serverless.yml",
"serverless.yaml"
],
"properties": {
"app": {
"type": "string"
},
"custom": {
"$ref": "#/definitions/ServerlessCustom"
},
"frameworkVersion": {
"type": "string"
},
"functions": {
"$ref": "#/definitions/AwsFunctions"
},
"layers": {
"$ref": "#/definitions/AwsLayers"
},
"org": {
"type": "string"
},
"package": {
"$ref": "#/definitions/AwsPackage"
},
"plugins": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"properties": {
"localPath": {
"description": "The path to the local .js file that contains the plugin",
"type": "string"
},
"modules": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
]
},
"provider": {
"$ref": "#/definitions/AwsProvider"
},
"resources": {
"oneOf": [
{
"$ref": "#/definitions/AwsResources"
},
{
"items": {
"$ref": "#/definitions/AwsResources"
},
"type": "array"
}
]
},
"service": {
"oneOf": [
{
"$ref": "#/definitions/AwsService"
},
{
"type": "string"
}
]
},
"stepFunctions": {
"$ref": "plugin/step_functions.json#/Aws_StepFunctions"
},
"tenant": {
"type": "string"
}
},
"required": [
"provider",
"service"
],
"title": "Serverless Framework Configuration",
"type": "object"
} | MIT | en |
dineug/erd-editor | 5439d66c1709e404135c0708f83c4c2a84ab14d5 | 2024-04-13T06:54:25 | json-schema/schema.json | 723 | 2024-05-29T14:56:17.517853Z | {
"$id": "https://raw.githubusercontent.com/dineug/erd-editor/main/json-schema/schema.json",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"EntityMeta": {
"properties": {
"createAt": {
"type": "integer"
},
"updateAt": {
"type": "integer"
}
},
"required": [
"updateAt",
"createAt"
],
"type": "object"
},
"RelationshipPoint": {
"properties": {
"columnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"direction": {
"description": "bit value (left: 1) | (right: 2) | (top: 4) | (bottom: 8)",
"type": "integer"
},
"tableId": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"tableId",
"columnIds",
"x",
"y",
"direction"
],
"type": "object"
},
"doc": {
"properties": {
"indexIds": {
"items": {
"type": "string"
},
"type": "array"
},
"memoIds": {
"items": {
"type": "string"
},
"type": "array"
},
"relationshipIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableIds": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"indexColumnEntities": {
"additionalProperties": {
"properties": {
"columnId": {
"type": "string"
},
"id": {
"type": "string"
},
"indexId": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"orderType": {
"description": "bit value (ASC: 1) | (DESC: 2)",
"type": "integer"
}
},
"required": [
"id",
"indexId",
"columnId",
"orderType",
"meta"
],
"type": "object"
},
"type": "object"
},
"indexEntities": {
"additionalProperties": {
"properties": {
"id": {
"type": "string"
},
"indexColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"seqIndexColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableId": {
"type": "string"
},
"unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"tableId",
"indexColumnIds",
"seqIndexColumnIds",
"unique",
"meta"
],
"type": "object"
},
"type": "object"
},
"lww": {
"additionalProperties": {
"prefixItems": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"additionalProperties": {
"type": "integer"
},
"type": "object"
}
],
"type": "array"
},
"type": "object"
},
"memoEntities": {
"additionalProperties": {
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"ui": {
"properties": {
"color": {
"type": "string"
},
"height": {
"type": "number"
},
"width": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"zIndex": {
"type": "number"
}
},
"required": [
"x",
"y",
"zIndex",
"width",
"height",
"color"
],
"type": "object"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"value",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
},
"relationshipEntities": {
"additionalProperties": {
"properties": {
"end": {
"$ref": "#/definitions/RelationshipPoint"
},
"id": {
"type": "string"
},
"identification": {
"type": "boolean"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"relationshipType": {
"description": "bit value (ZeroOne: 2) | (ZeroN: 4) | (OneOnly: 8) | (OneN: 16)",
"type": "integer"
},
"start": {
"$ref": "#/definitions/RelationshipPoint"
},
"startRelationshipType": {
"description": "bit value (ring: 1) | (dash: 2)",
"type": "integer"
}
},
"required": [
"id",
"identification",
"relationshipType",
"startRelationshipType",
"start",
"end",
"meta"
],
"type": "object"
},
"type": "object"
},
"settings": {
"properties": {
"bracketType": {
"description": "bit value (none: 1) | (doubleQuote: 2) | (singleQuote: 4) | (backtick: 8)",
"type": "integer"
},
"canvasType": {
"enum": [
"ERD",
"@dineug/erd-editor/builtin-visualization",
"@dineug/erd-editor/builtin-schema-sql",
"@dineug/erd-editor/builtin-generator-code",
"settings"
]
},
"columnNameCase": {
"description": "bit value (none: 1) | (camelCase: 2) | (pascalCase: 4) | (snakeCase: 8)",
"type": "integer"
},
"columnOrder": {
"description": "bit value (columnName: 1) | (columnDataType: 2) | (columnNotNull: 4) | (columnUnique: 8) | (columnAutoIncrement: 16) | (columnDefault: 32) | (columnComment: 64)",
"maxItems": 7,
"minItems": 7,
"prefixItems": [
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
}
],
"type": "array"
},
"database": {
"description": "bit value (MariaDB: 1) | (MSSQL: 2) | (MySQL: 4) | (Oracle: 8) | (PostgreSQL: 16) | (SQLite: 32)",
"type": "integer"
},
"databaseName": {
"type": "string"
},
"height": {
"maximum": 20000,
"minimum": 2000,
"type": "number"
},
"ignoreSaveSettings": {
"description": "bit value (scroll: 1) | (zoomLevel: 2)",
"type": "integer"
},
"language": {
"description": "bit value (GraphQL: 1) | (csharp: 2) | (Java: 4) | (Kotlin: 8) | (TypeScript: 16) | (JPA: 32) | (Scala: 64)",
"type": "integer"
},
"maxWidthComment": {
"type": "integer"
},
"relationshipDataTypeSync": {
"type": "boolean"
},
"relationshipOptimization": {
"type": "boolean"
},
"scrollLeft": {
"type": "number"
},
"scrollTop": {
"type": "number"
},
"show": {
"description": "bit value (tableComment: 1) | (columnComment: 2) | (columnDataType: 4) | (columnDefault: 8) | (columnAutoIncrement: 16) | (columnPrimaryKey: 32) | (columnUnique: 64) | (columnNotNull: 128) | (relationship: 256)",
"type": "integer"
},
"tableNameCase": {
"description": "bit value (none: 1) | (camelCase: 2) | (pascalCase: 4) | (snakeCase: 8)",
"type": "integer"
},
"width": {
"maximum": 20000,
"minimum": 2000,
"type": "number"
},
"zoomLevel": {
"maximum": 1,
"minimum": 0.1,
"type": "number"
}
},
"required": [
"width",
"height",
"scrollTop",
"scrollLeft",
"zoomLevel",
"show",
"canvasType",
"language",
"tableNameCase",
"columnNameCase",
"bracketType",
"relationshipDataTypeSync",
"relationshipOptimization",
"columnOrder",
"maxWidthComment"
],
"type": "object"
},
"tableColumnEntities": {
"additionalProperties": {
"properties": {
"comment": {
"type": "string"
},
"dataType": {
"type": "string"
},
"default": {
"type": "string"
},
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"options": {
"description": "bit value (autoIncrement: 1) | (primaryKey: 2) | (unique: 4) | (notNull: 8)",
"type": "integer"
},
"tableId": {
"type": "string"
},
"ui": {
"properties": {
"keys": {
"description": "bit value (primaryKey: 1) | (foreignKey: 2)",
"type": "integer"
},
"widthComment": {
"type": "number"
},
"widthDataType": {
"type": "number"
},
"widthDefault": {
"type": "number"
},
"widthName": {
"type": "number"
}
},
"required": [
"keys",
"widthName",
"widthComment",
"widthDataType",
"widthDefault"
],
"type": "object"
}
},
"required": [
"id",
"tableId",
"name",
"comment",
"dataType",
"default",
"options",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
},
"tableEntities": {
"additionalProperties": {
"properties": {
"columnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"comment": {
"type": "string"
},
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"seqColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"ui": {
"properties": {
"color": {
"type": "string"
},
"widthComment": {
"type": "number"
},
"widthName": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"zIndex": {
"type": "number"
}
},
"required": [
"x",
"y",
"zIndex",
"widthName",
"widthComment",
"color"
],
"type": "object"
}
},
"required": [
"id",
"name",
"comment",
"columnIds",
"seqColumnIds",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
}
},
"description": "Entity-Relationship Diagram Editor Schema",
"properties": {
"$schema": {
"type": "string"
},
"collections": {
"properties": {
"indexColumnEntities": {
"$ref": "#/definitions/indexColumnEntities"
},
"indexEntities": {
"$ref": "#/definitions/indexEntities"
},
"memoEntities": {
"$ref": "#/definitions/memoEntities"
},
"relationshipEntities": {
"$ref": "#/definitions/relationshipEntities"
},
"tableColumnEntities": {
"$ref": "#/definitions/tableColumnEntities"
},
"tableEntities": {
"$ref": "#/definitions/tableEntities"
}
},
"required": [
"tableEntities",
"tableColumnEntities",
"relationshipEntities",
"indexEntities",
"indexColumnEntities",
"memoEntities"
],
"type": "object"
},
"doc": {
"$ref": "#/definitions/doc"
},
"lww": {
"$ref": "#/definitions/lww"
},
"settings": {
"$ref": "#/definitions/settings"
},
"version": {
"const": "3.0.0",
"description": "Version of the schema"
}
},
"required": [
"version",
"settings",
"doc",
"lww",
"collections"
],
"title": "erd-editor schema",
"type": "object"
} | MIT | en |
dineug/erd-editor | ce34a49f34050acdf5b7b6843230e079c2fc1693 | 2024-01-11T15:07:50 | json-schema/schema.json | 723 | 2024-05-29T14:56:17.517853Z | {
"$id": "https://raw.githubusercontent.com/dineug/erd-editor/main/json-schema/schema.json",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"EntityMeta": {
"properties": {
"createAt": {
"type": "integer"
},
"updateAt": {
"type": "integer"
}
},
"required": [
"updateAt",
"createAt"
],
"type": "object"
},
"RelationshipPoint": {
"properties": {
"columnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableId": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"tableId",
"columnIds",
"x",
"y"
],
"type": "object"
},
"doc": {
"properties": {
"indexIds": {
"items": {
"type": "string"
},
"type": "array"
},
"memoIds": {
"items": {
"type": "string"
},
"type": "array"
},
"relationshipIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableIds": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"indexColumnEntities": {
"additionalProperties": {
"properties": {
"columnId": {
"type": "string"
},
"id": {
"type": "string"
},
"indexId": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"orderType": {
"description": "bit value (ASC: 1) | (DESC: 2)",
"type": "integer"
}
},
"required": [
"id",
"indexId",
"columnId",
"orderType",
"meta"
],
"type": "object"
},
"type": "object"
},
"indexEntities": {
"additionalProperties": {
"properties": {
"id": {
"type": "string"
},
"indexColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"seqIndexColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableId": {
"type": "string"
},
"unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"tableId",
"indexColumnIds",
"seqIndexColumnIds",
"unique",
"meta"
],
"type": "object"
},
"type": "object"
},
"lww": {
"additionalProperties": {
"prefixItems": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"additionalProperties": {
"type": "integer"
},
"type": "object"
}
],
"type": "array"
},
"type": "object"
},
"memoEntities": {
"additionalProperties": {
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"ui": {
"properties": {
"color": {
"type": "string"
},
"height": {
"type": "number"
},
"width": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"zIndex": {
"type": "number"
}
},
"required": [
"x",
"y",
"zIndex",
"width",
"height",
"color"
],
"type": "object"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"value",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
},
"relationshipEntities": {
"additionalProperties": {
"properties": {
"end": {
"$ref": "#/definitions/RelationshipPoint"
},
"id": {
"type": "string"
},
"identification": {
"type": "boolean"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"relationshipType": {
"description": "bit value (ZeroOne: 2) | (ZeroN: 4) | (OneOnly: 8) | (OneN: 16)",
"type": "integer"
},
"start": {
"$ref": "#/definitions/RelationshipPoint"
},
"startRelationshipType": {
"description": "bit value (ring: 1) | (dash: 2)",
"type": "integer"
}
},
"required": [
"id",
"identification",
"relationshipType",
"startRelationshipType",
"start",
"end",
"meta"
],
"type": "object"
},
"type": "object"
},
"settings": {
"properties": {
"bracketType": {
"description": "bit value (none: 1) | (doubleQuote: 2) | (singleQuote: 4) | (backtick: 8)",
"type": "integer"
},
"canvasType": {
"enum": [
"ERD",
"@dineug/erd-editor/builtin-visualization",
"@dineug/erd-editor/builtin-schema-sql",
"@dineug/erd-editor/builtin-generator-code",
"settings"
]
},
"columnNameCase": {
"description": "bit value (none: 1) | (camelCase: 2) | (pascalCase: 4) | (snakeCase: 8)",
"type": "integer"
},
"columnOrder": {
"description": "bit value (columnName: 1) | (columnDataType: 2) | (columnNotNull: 4) | (columnUnique: 8) | (columnAutoIncrement: 16) | (columnDefault: 32) | (columnComment: 64)",
"maxItems": 7,
"minItems": 7,
"prefixItems": [
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
}
],
"type": "array"
},
"database": {
"description": "bit value (MariaDB: 1) | (MSSQL: 2) | (MySQL: 4) | (Oracle: 8) | (PostgreSQL: 16) | (SQLite: 32)",
"type": "integer"
},
"databaseName": {
"type": "string"
},
"height": {
"maximum": 20000,
"minimum": 2000,
"type": "number"
},
"language": {
"description": "bit value (GraphQL: 1) | (csharp: 2) | (Java: 4) | (Kotlin: 8) | (TypeScript: 16) | (JPA: 32) | (Scala: 64)",
"type": "integer"
},
"maxWidthComment": {
"type": "integer"
},
"relationshipDataTypeSync": {
"type": "boolean"
},
"relationshipOptimization": {
"type": "boolean"
},
"scrollLeft": {
"type": "number"
},
"scrollTop": {
"type": "number"
},
"show": {
"description": "bit value (tableComment: 1) | (columnComment: 2) | (columnDataType: 4) | (columnDefault: 8) | (columnAutoIncrement: 16) | (columnPrimaryKey: 32) | (columnUnique: 64) | (columnNotNull: 128) | (relationship: 256)",
"type": "integer"
},
"tableNameCase": {
"description": "bit value (none: 1) | (camelCase: 2) | (pascalCase: 4) | (snakeCase: 8)",
"type": "integer"
},
"width": {
"maximum": 20000,
"minimum": 2000,
"type": "number"
},
"zoomLevel": {
"maximum": 1,
"minimum": 0.1,
"type": "number"
}
},
"required": [
"width",
"height",
"scrollTop",
"scrollLeft",
"zoomLevel",
"show",
"canvasType",
"language",
"tableNameCase",
"columnNameCase",
"bracketType",
"relationshipDataTypeSync",
"relationshipOptimization",
"columnOrder",
"maxWidthComment"
],
"type": "object"
},
"tableColumnEntities": {
"additionalProperties": {
"properties": {
"comment": {
"type": "string"
},
"dataType": {
"type": "string"
},
"default": {
"type": "string"
},
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"options": {
"description": "bit value (autoIncrement: 1) | (primaryKey: 2) | (unique: 4) | (notNull: 8)",
"type": "integer"
},
"tableId": {
"type": "string"
},
"ui": {
"properties": {
"keys": {
"description": "bit value (primaryKey: 1) | (foreignKey: 2)",
"type": "integer"
},
"widthComment": {
"type": "number"
},
"widthDataType": {
"type": "number"
},
"widthDefault": {
"type": "number"
},
"widthName": {
"type": "number"
}
},
"required": [
"keys",
"widthName",
"widthComment",
"widthDataType",
"widthDefault"
],
"type": "object"
}
},
"required": [
"id",
"tableId",
"name",
"comment",
"dataType",
"default",
"options",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
},
"tableEntities": {
"additionalProperties": {
"properties": {
"columnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"comment": {
"type": "string"
},
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"seqColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"ui": {
"properties": {
"color": {
"type": "string"
},
"widthComment": {
"type": "number"
},
"widthName": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"zIndex": {
"type": "number"
}
},
"required": [
"x",
"y",
"zIndex",
"widthName",
"widthComment",
"color"
],
"type": "object"
}
},
"required": [
"id",
"name",
"comment",
"columnIds",
"seqColumnIds",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
}
},
"description": "Entity-Relationship Diagram Editor Schema",
"properties": {
"$schema": {
"type": "string"
},
"collections": {
"properties": {
"indexColumnEntities": {
"$ref": "#/definitions/indexColumnEntities"
},
"indexEntities": {
"$ref": "#/definitions/indexEntities"
},
"memoEntities": {
"$ref": "#/definitions/memoEntities"
},
"relationshipEntities": {
"$ref": "#/definitions/relationshipEntities"
},
"tableColumnEntities": {
"$ref": "#/definitions/tableColumnEntities"
},
"tableEntities": {
"$ref": "#/definitions/tableEntities"
}
},
"required": [
"tableEntities",
"tableColumnEntities",
"relationshipEntities",
"indexEntities",
"indexColumnEntities",
"memoEntities"
],
"type": "object"
},
"doc": {
"$ref": "#/definitions/doc"
},
"lww": {
"$ref": "#/definitions/lww"
},
"settings": {
"$ref": "#/definitions/settings"
},
"version": {
"const": "3.0.0",
"description": "Version of the schema"
}
},
"required": [
"version",
"settings",
"doc",
"lww",
"collections"
],
"title": "erd-editor schema",
"type": "object"
} | MIT | en |
dineug/erd-editor | d2b5c73f3a6ae5a7b5be2b1a8f7427a62fa17b3a | 2024-01-11T14:41:44 | json-schema/schema.json | 723 | 2024-05-29T14:56:17.517853Z | {
"$id": "https://raw.githubusercontent.com/dineug/erd-editor/main/json-schema/schema.json",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"EntityMeta": {
"properties": {
"createAt": {
"type": "integer"
},
"updateAt": {
"type": "integer"
}
},
"required": [
"updateAt",
"createAt"
],
"type": "object"
},
"RelationshipPoint": {
"properties": {
"columnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableId": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"tableId",
"columnIds",
"x",
"y"
],
"type": "object"
},
"doc": {
"properties": {
"indexIds": {
"items": {
"type": "string"
},
"type": "array"
},
"memoIds": {
"items": {
"type": "string"
},
"type": "array"
},
"relationshipIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableIds": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"indexColumnEntities": {
"additionalProperties": {
"properties": {
"columnId": {
"type": "string"
},
"id": {
"type": "string"
},
"indexId": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"orderType": {
"description": "bit value (ASC: 1) | (DESC: 2)",
"type": "integer"
}
},
"required": [
"id",
"indexId",
"columnId",
"orderType",
"meta"
],
"type": "object"
},
"type": "object"
},
"indexEntities": {
"additionalProperties": {
"properties": {
"id": {
"type": "string"
},
"indexColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"seqIndexColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableId": {
"type": "string"
},
"unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"tableId",
"indexColumnIds",
"seqIndexColumnIds",
"unique",
"meta"
],
"type": "object"
},
"type": "object"
},
"lww": {
"additionalProperties": {
"prefixItems": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"additionalProperties": {
"type": "integer"
},
"type": "object"
}
],
"type": "array"
},
"type": "object"
},
"memoEntities": {
"additionalProperties": {
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"ui": {
"properties": {
"color": {
"type": "string"
},
"height": {
"type": "number"
},
"width": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"zIndex": {
"type": "number"
}
},
"required": [
"x",
"y",
"zIndex",
"width",
"height",
"color"
],
"type": "object"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"value",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
},
"relationshipEntities": {
"additionalProperties": {
"properties": {
"end": {
"$ref": "#/definitions/RelationshipPoint"
},
"id": {
"type": "string"
},
"identification": {
"type": "boolean"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"relationshipType": {
"description": "bit value (ZeroOne: 2) | (ZeroN: 4) | (OneOnly: 8) | (OneN: 16)",
"type": "integer"
},
"start": {
"$ref": "#/definitions/RelationshipPoint"
},
"startRelationshipType": {
"description": "bit value (ring: 1) | (dash: 2)",
"type": "integer"
}
},
"required": [
"id",
"identification",
"relationshipType",
"startRelationshipType",
"start",
"end",
"meta"
],
"type": "object"
},
"type": "object"
},
"settings": {
"properties": {
"bracketType": {
"description": "bit value (none: 1) | (doubleQuote: 2) | (singleQuote: 4) | (backtick: 8)",
"type": "integer"
},
"canvasType": {
"enum": [
"ERD",
"@dineug/erd-editor/builtin-visualization",
"@dineug/erd-editor/builtin-schema-sql",
"@dineug/erd-editor/builtin-generator-code",
"settings"
]
},
"columnNameCase": {
"description": "bit value (none: 1) | (camelCase: 2) | (pascalCase: 4) | (snakeCase: 8)",
"type": "integer"
},
"columnOrder": {
"prefixItems": [
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
}
],
"type": "array"
},
"database": {
"description": "bit value (MariaDB: 1) | (MSSQL: 2) | (MySQL: 4) | (Oracle: 8) | (PostgreSQL: 16) | (SQLite: 32)",
"type": "integer"
},
"databaseName": {
"type": "string"
},
"height": {
"maximum": 20000,
"minimum": 2000,
"type": "number"
},
"language": {
"description": "bit value (GraphQL: 1) | (csharp: 2) | (Java: 4) | (Kotlin: 8) | (TypeScript: 16) | (JPA: 32) | (Scala: 64)",
"type": "integer"
},
"maxWidthComment": {
"type": "integer"
},
"relationshipDataTypeSync": {
"type": "boolean"
},
"relationshipOptimization": {
"type": "boolean"
},
"scrollLeft": {
"type": "number"
},
"scrollTop": {
"type": "number"
},
"show": {
"description": "bit value (tableComment: 1) | (columnComment: 2) | (columnDataType: 4) | (columnDefault: 8) | (columnAutoIncrement: 16) | (columnPrimaryKey: 32) | (columnUnique: 64) | (columnNotNull: 128) | (relationship: 256)",
"type": "integer"
},
"tableNameCase": {
"description": "bit value (none: 1) | (camelCase: 2) | (pascalCase: 4) | (snakeCase: 8)",
"type": "integer"
},
"width": {
"maximum": 20000,
"minimum": 2000,
"type": "number"
},
"zoomLevel": {
"maximum": 1,
"minimum": 0.1,
"type": "number"
}
},
"required": [
"width",
"height",
"scrollTop",
"scrollLeft",
"zoomLevel",
"show",
"canvasType",
"language",
"tableNameCase",
"columnNameCase",
"bracketType",
"relationshipDataTypeSync",
"relationshipOptimization",
"columnOrder",
"maxWidthComment"
],
"type": "object"
},
"tableColumnEntities": {
"additionalProperties": {
"properties": {
"comment": {
"type": "string"
},
"dataType": {
"type": "string"
},
"default": {
"type": "string"
},
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"options": {
"description": "bit value (autoIncrement: 1) | (primaryKey: 2) | (unique: 4) | (notNull: 8)",
"type": "integer"
},
"tableId": {
"type": "string"
},
"ui": {
"properties": {
"keys": {
"description": "bit value (primaryKey: 1) | (foreignKey: 2)",
"type": "integer"
},
"widthComment": {
"type": "number"
},
"widthDataType": {
"type": "number"
},
"widthDefault": {
"type": "number"
},
"widthName": {
"type": "number"
}
},
"required": [
"keys",
"widthName",
"widthComment",
"widthDataType",
"widthDefault"
],
"type": "object"
}
},
"required": [
"id",
"tableId",
"name",
"comment",
"dataType",
"default",
"options",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
},
"tableEntities": {
"additionalProperties": {
"properties": {
"columnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"comment": {
"type": "string"
},
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"seqColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"ui": {
"properties": {
"color": {
"type": "string"
},
"widthComment": {
"type": "number"
},
"widthName": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"zIndex": {
"type": "number"
}
},
"required": [
"x",
"y",
"zIndex",
"widthName",
"widthComment",
"color"
],
"type": "object"
}
},
"required": [
"id",
"name",
"comment",
"columnIds",
"seqColumnIds",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
}
},
"description": "Entity-Relationship Diagram Editor Schema",
"properties": {
"collections": {
"properties": {
"indexColumnEntities": {
"$ref": "#/definitions/indexColumnEntities"
},
"indexEntities": {
"$ref": "#/definitions/indexEntities"
},
"memoEntities": {
"$ref": "#/definitions/memoEntities"
},
"relationshipEntities": {
"$ref": "#/definitions/relationshipEntities"
},
"tableColumnEntities": {
"$ref": "#/definitions/tableColumnEntities"
},
"tableEntities": {
"$ref": "#/definitions/tableEntities"
}
},
"required": [
"tableEntities",
"tableColumnEntities",
"relationshipEntities",
"indexEntities",
"indexColumnEntities",
"memoEntities"
],
"type": "object"
},
"doc": {
"$ref": "#/definitions/doc"
},
"lww": {
"$ref": "#/definitions/lww"
},
"settings": {
"$ref": "#/definitions/settings"
},
"version": {
"const": "3.0.0",
"description": "Version of the schema"
}
},
"required": [
"version",
"settings",
"doc",
"lww",
"collections"
],
"title": "erd-editor schema",
"type": "object"
} | MIT | en |
dineug/erd-editor | 970e17c4a836979f2e5475e38d3b2ca0784f1eaf | 2024-01-11T15:29:51 | json-schema/schema.json | 723 | 2024-05-29T14:56:17.517853Z | {
"$id": "https://raw.githubusercontent.com/dineug/erd-editor/main/json-schema/schema.json",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"EntityMeta": {
"properties": {
"createAt": {
"type": "integer"
},
"updateAt": {
"type": "integer"
}
},
"required": [
"updateAt",
"createAt"
],
"type": "object"
},
"RelationshipPoint": {
"properties": {
"columnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"direction": {
"description": "bit value (left: 1) | (right: 2) | (top: 4) | (bottom: 8)",
"type": "integer"
},
"tableId": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"tableId",
"columnIds",
"x",
"y",
"direction"
],
"type": "object"
},
"doc": {
"properties": {
"indexIds": {
"items": {
"type": "string"
},
"type": "array"
},
"memoIds": {
"items": {
"type": "string"
},
"type": "array"
},
"relationshipIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableIds": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"indexColumnEntities": {
"additionalProperties": {
"properties": {
"columnId": {
"type": "string"
},
"id": {
"type": "string"
},
"indexId": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"orderType": {
"description": "bit value (ASC: 1) | (DESC: 2)",
"type": "integer"
}
},
"required": [
"id",
"indexId",
"columnId",
"orderType",
"meta"
],
"type": "object"
},
"type": "object"
},
"indexEntities": {
"additionalProperties": {
"properties": {
"id": {
"type": "string"
},
"indexColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"seqIndexColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableId": {
"type": "string"
},
"unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"tableId",
"indexColumnIds",
"seqIndexColumnIds",
"unique",
"meta"
],
"type": "object"
},
"type": "object"
},
"lww": {
"additionalProperties": {
"prefixItems": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"additionalProperties": {
"type": "integer"
},
"type": "object"
}
],
"type": "array"
},
"type": "object"
},
"memoEntities": {
"additionalProperties": {
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"ui": {
"properties": {
"color": {
"type": "string"
},
"height": {
"type": "number"
},
"width": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"zIndex": {
"type": "number"
}
},
"required": [
"x",
"y",
"zIndex",
"width",
"height",
"color"
],
"type": "object"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"value",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
},
"relationshipEntities": {
"additionalProperties": {
"properties": {
"end": {
"$ref": "#/definitions/RelationshipPoint"
},
"id": {
"type": "string"
},
"identification": {
"type": "boolean"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"relationshipType": {
"description": "bit value (ZeroOne: 2) | (ZeroN: 4) | (OneOnly: 8) | (OneN: 16)",
"type": "integer"
},
"start": {
"$ref": "#/definitions/RelationshipPoint"
},
"startRelationshipType": {
"description": "bit value (ring: 1) | (dash: 2)",
"type": "integer"
}
},
"required": [
"id",
"identification",
"relationshipType",
"startRelationshipType",
"start",
"end",
"meta"
],
"type": "object"
},
"type": "object"
},
"settings": {
"properties": {
"bracketType": {
"description": "bit value (none: 1) | (doubleQuote: 2) | (singleQuote: 4) | (backtick: 8)",
"type": "integer"
},
"canvasType": {
"enum": [
"ERD",
"@dineug/erd-editor/builtin-visualization",
"@dineug/erd-editor/builtin-schema-sql",
"@dineug/erd-editor/builtin-generator-code",
"settings"
]
},
"columnNameCase": {
"description": "bit value (none: 1) | (camelCase: 2) | (pascalCase: 4) | (snakeCase: 8)",
"type": "integer"
},
"columnOrder": {
"description": "bit value (columnName: 1) | (columnDataType: 2) | (columnNotNull: 4) | (columnUnique: 8) | (columnAutoIncrement: 16) | (columnDefault: 32) | (columnComment: 64)",
"maxItems": 7,
"minItems": 7,
"prefixItems": [
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
}
],
"type": "array"
},
"database": {
"description": "bit value (MariaDB: 1) | (MSSQL: 2) | (MySQL: 4) | (Oracle: 8) | (PostgreSQL: 16) | (SQLite: 32)",
"type": "integer"
},
"databaseName": {
"type": "string"
},
"height": {
"maximum": 20000,
"minimum": 2000,
"type": "number"
},
"language": {
"description": "bit value (GraphQL: 1) | (csharp: 2) | (Java: 4) | (Kotlin: 8) | (TypeScript: 16) | (JPA: 32) | (Scala: 64)",
"type": "integer"
},
"maxWidthComment": {
"type": "integer"
},
"relationshipDataTypeSync": {
"type": "boolean"
},
"relationshipOptimization": {
"type": "boolean"
},
"scrollLeft": {
"type": "number"
},
"scrollTop": {
"type": "number"
},
"show": {
"description": "bit value (tableComment: 1) | (columnComment: 2) | (columnDataType: 4) | (columnDefault: 8) | (columnAutoIncrement: 16) | (columnPrimaryKey: 32) | (columnUnique: 64) | (columnNotNull: 128) | (relationship: 256)",
"type": "integer"
},
"tableNameCase": {
"description": "bit value (none: 1) | (camelCase: 2) | (pascalCase: 4) | (snakeCase: 8)",
"type": "integer"
},
"width": {
"maximum": 20000,
"minimum": 2000,
"type": "number"
},
"zoomLevel": {
"maximum": 1,
"minimum": 0.1,
"type": "number"
}
},
"required": [
"width",
"height",
"scrollTop",
"scrollLeft",
"zoomLevel",
"show",
"canvasType",
"language",
"tableNameCase",
"columnNameCase",
"bracketType",
"relationshipDataTypeSync",
"relationshipOptimization",
"columnOrder",
"maxWidthComment"
],
"type": "object"
},
"tableColumnEntities": {
"additionalProperties": {
"properties": {
"comment": {
"type": "string"
},
"dataType": {
"type": "string"
},
"default": {
"type": "string"
},
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"options": {
"description": "bit value (autoIncrement: 1) | (primaryKey: 2) | (unique: 4) | (notNull: 8)",
"type": "integer"
},
"tableId": {
"type": "string"
},
"ui": {
"properties": {
"keys": {
"description": "bit value (primaryKey: 1) | (foreignKey: 2)",
"type": "integer"
},
"widthComment": {
"type": "number"
},
"widthDataType": {
"type": "number"
},
"widthDefault": {
"type": "number"
},
"widthName": {
"type": "number"
}
},
"required": [
"keys",
"widthName",
"widthComment",
"widthDataType",
"widthDefault"
],
"type": "object"
}
},
"required": [
"id",
"tableId",
"name",
"comment",
"dataType",
"default",
"options",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
},
"tableEntities": {
"additionalProperties": {
"properties": {
"columnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"comment": {
"type": "string"
},
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"seqColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"ui": {
"properties": {
"color": {
"type": "string"
},
"widthComment": {
"type": "number"
},
"widthName": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"zIndex": {
"type": "number"
}
},
"required": [
"x",
"y",
"zIndex",
"widthName",
"widthComment",
"color"
],
"type": "object"
}
},
"required": [
"id",
"name",
"comment",
"columnIds",
"seqColumnIds",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
}
},
"description": "Entity-Relationship Diagram Editor Schema",
"properties": {
"$schema": {
"type": "string"
},
"collections": {
"properties": {
"indexColumnEntities": {
"$ref": "#/definitions/indexColumnEntities"
},
"indexEntities": {
"$ref": "#/definitions/indexEntities"
},
"memoEntities": {
"$ref": "#/definitions/memoEntities"
},
"relationshipEntities": {
"$ref": "#/definitions/relationshipEntities"
},
"tableColumnEntities": {
"$ref": "#/definitions/tableColumnEntities"
},
"tableEntities": {
"$ref": "#/definitions/tableEntities"
}
},
"required": [
"tableEntities",
"tableColumnEntities",
"relationshipEntities",
"indexEntities",
"indexColumnEntities",
"memoEntities"
],
"type": "object"
},
"doc": {
"$ref": "#/definitions/doc"
},
"lww": {
"$ref": "#/definitions/lww"
},
"settings": {
"$ref": "#/definitions/settings"
},
"version": {
"const": "3.0.0",
"description": "Version of the schema"
}
},
"required": [
"version",
"settings",
"doc",
"lww",
"collections"
],
"title": "erd-editor schema",
"type": "object"
} | MIT | en |
dineug/erd-editor | 20b64d690aa9cee76bce730bb9c80cc9d42e18f5 | 2024-01-11T14:58:09 | json-schema/schema.json | 723 | 2024-05-29T14:56:17.517853Z | {
"$id": "https://raw.githubusercontent.com/dineug/erd-editor/main/json-schema/schema.json",
"$schema": "https://json-schema.org/draft-07/schema#",
"definitions": {
"EntityMeta": {
"properties": {
"createAt": {
"type": "integer"
},
"updateAt": {
"type": "integer"
}
},
"required": [
"updateAt",
"createAt"
],
"type": "object"
},
"RelationshipPoint": {
"properties": {
"columnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableId": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"tableId",
"columnIds",
"x",
"y"
],
"type": "object"
},
"doc": {
"properties": {
"indexIds": {
"items": {
"type": "string"
},
"type": "array"
},
"memoIds": {
"items": {
"type": "string"
},
"type": "array"
},
"relationshipIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableIds": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"indexColumnEntities": {
"additionalProperties": {
"properties": {
"columnId": {
"type": "string"
},
"id": {
"type": "string"
},
"indexId": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"orderType": {
"description": "bit value (ASC: 1) | (DESC: 2)",
"type": "integer"
}
},
"required": [
"id",
"indexId",
"columnId",
"orderType",
"meta"
],
"type": "object"
},
"type": "object"
},
"indexEntities": {
"additionalProperties": {
"properties": {
"id": {
"type": "string"
},
"indexColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"seqIndexColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"tableId": {
"type": "string"
},
"unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"tableId",
"indexColumnIds",
"seqIndexColumnIds",
"unique",
"meta"
],
"type": "object"
},
"type": "object"
},
"lww": {
"additionalProperties": {
"prefixItems": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"additionalProperties": {
"type": "integer"
},
"type": "object"
}
],
"type": "array"
},
"type": "object"
},
"memoEntities": {
"additionalProperties": {
"properties": {
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"ui": {
"properties": {
"color": {
"type": "string"
},
"height": {
"type": "number"
},
"width": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"zIndex": {
"type": "number"
}
},
"required": [
"x",
"y",
"zIndex",
"width",
"height",
"color"
],
"type": "object"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"value",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
},
"relationshipEntities": {
"additionalProperties": {
"properties": {
"end": {
"$ref": "#/definitions/RelationshipPoint"
},
"id": {
"type": "string"
},
"identification": {
"type": "boolean"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"relationshipType": {
"description": "bit value (ZeroOne: 2) | (ZeroN: 4) | (OneOnly: 8) | (OneN: 16)",
"type": "integer"
},
"start": {
"$ref": "#/definitions/RelationshipPoint"
},
"startRelationshipType": {
"description": "bit value (ring: 1) | (dash: 2)",
"type": "integer"
}
},
"required": [
"id",
"identification",
"relationshipType",
"startRelationshipType",
"start",
"end",
"meta"
],
"type": "object"
},
"type": "object"
},
"settings": {
"properties": {
"bracketType": {
"description": "bit value (none: 1) | (doubleQuote: 2) | (singleQuote: 4) | (backtick: 8)",
"type": "integer"
},
"canvasType": {
"enum": [
"ERD",
"@dineug/erd-editor/builtin-visualization",
"@dineug/erd-editor/builtin-schema-sql",
"@dineug/erd-editor/builtin-generator-code",
"settings"
]
},
"columnNameCase": {
"description": "bit value (none: 1) | (camelCase: 2) | (pascalCase: 4) | (snakeCase: 8)",
"type": "integer"
},
"columnOrder": {
"description": "bit value (columnName: 1) | (columnDataType: 2) | (columnNotNull: 4) | (columnUnique: 8) | (columnAutoIncrement: 16) | (columnDefault: 32) | (columnComment: 64)",
"maxItems": 7,
"minItems": 7,
"prefixItems": [
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
},
{
"type": "integer"
}
],
"type": "array"
},
"database": {
"description": "bit value (MariaDB: 1) | (MSSQL: 2) | (MySQL: 4) | (Oracle: 8) | (PostgreSQL: 16) | (SQLite: 32)",
"type": "integer"
},
"databaseName": {
"type": "string"
},
"height": {
"maximum": 20000,
"minimum": 2000,
"type": "number"
},
"language": {
"description": "bit value (GraphQL: 1) | (csharp: 2) | (Java: 4) | (Kotlin: 8) | (TypeScript: 16) | (JPA: 32) | (Scala: 64)",
"type": "integer"
},
"maxWidthComment": {
"type": "integer"
},
"relationshipDataTypeSync": {
"type": "boolean"
},
"relationshipOptimization": {
"type": "boolean"
},
"scrollLeft": {
"type": "number"
},
"scrollTop": {
"type": "number"
},
"show": {
"description": "bit value (tableComment: 1) | (columnComment: 2) | (columnDataType: 4) | (columnDefault: 8) | (columnAutoIncrement: 16) | (columnPrimaryKey: 32) | (columnUnique: 64) | (columnNotNull: 128) | (relationship: 256)",
"type": "integer"
},
"tableNameCase": {
"description": "bit value (none: 1) | (camelCase: 2) | (pascalCase: 4) | (snakeCase: 8)",
"type": "integer"
},
"width": {
"maximum": 20000,
"minimum": 2000,
"type": "number"
},
"zoomLevel": {
"maximum": 1,
"minimum": 0.1,
"type": "number"
}
},
"required": [
"width",
"height",
"scrollTop",
"scrollLeft",
"zoomLevel",
"show",
"canvasType",
"language",
"tableNameCase",
"columnNameCase",
"bracketType",
"relationshipDataTypeSync",
"relationshipOptimization",
"columnOrder",
"maxWidthComment"
],
"type": "object"
},
"tableColumnEntities": {
"additionalProperties": {
"properties": {
"comment": {
"type": "string"
},
"dataType": {
"type": "string"
},
"default": {
"type": "string"
},
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"options": {
"description": "bit value (autoIncrement: 1) | (primaryKey: 2) | (unique: 4) | (notNull: 8)",
"type": "integer"
},
"tableId": {
"type": "string"
},
"ui": {
"properties": {
"keys": {
"description": "bit value (primaryKey: 1) | (foreignKey: 2)",
"type": "integer"
},
"widthComment": {
"type": "number"
},
"widthDataType": {
"type": "number"
},
"widthDefault": {
"type": "number"
},
"widthName": {
"type": "number"
}
},
"required": [
"keys",
"widthName",
"widthComment",
"widthDataType",
"widthDefault"
],
"type": "object"
}
},
"required": [
"id",
"tableId",
"name",
"comment",
"dataType",
"default",
"options",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
},
"tableEntities": {
"additionalProperties": {
"properties": {
"columnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"comment": {
"type": "string"
},
"id": {
"type": "string"
},
"meta": {
"$ref": "#/definitions/EntityMeta"
},
"name": {
"type": "string"
},
"seqColumnIds": {
"items": {
"type": "string"
},
"type": "array"
},
"ui": {
"properties": {
"color": {
"type": "string"
},
"widthComment": {
"type": "number"
},
"widthName": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"zIndex": {
"type": "number"
}
},
"required": [
"x",
"y",
"zIndex",
"widthName",
"widthComment",
"color"
],
"type": "object"
}
},
"required": [
"id",
"name",
"comment",
"columnIds",
"seqColumnIds",
"ui",
"meta"
],
"type": "object"
},
"type": "object"
}
},
"description": "Entity-Relationship Diagram Editor Schema",
"properties": {
"collections": {
"properties": {
"indexColumnEntities": {
"$ref": "#/definitions/indexColumnEntities"
},
"indexEntities": {
"$ref": "#/definitions/indexEntities"
},
"memoEntities": {
"$ref": "#/definitions/memoEntities"
},
"relationshipEntities": {
"$ref": "#/definitions/relationshipEntities"
},
"tableColumnEntities": {
"$ref": "#/definitions/tableColumnEntities"
},
"tableEntities": {
"$ref": "#/definitions/tableEntities"
}
},
"required": [
"tableEntities",
"tableColumnEntities",
"relationshipEntities",
"indexEntities",
"indexColumnEntities",
"memoEntities"
],
"type": "object"
},
"doc": {
"$ref": "#/definitions/doc"
},
"lww": {
"$ref": "#/definitions/lww"
},
"settings": {
"$ref": "#/definitions/settings"
},
"version": {
"const": "3.0.0",
"description": "Version of the schema"
}
},
"required": [
"version",
"settings",
"doc",
"lww",
"collections"
],
"title": "erd-editor schema",
"type": "object"
} | MIT | en |
HugeSpaceship/HugeSpaceship | e2e6da7c8d2dd7915c7c5a4b037282dc2b27d8ef | 2024-04-03T19:28:17 | internal/http/website/theming/theme-schema.json | 8 | 2024-05-27T04:18:43.143444Z | {
"$id": "https://zaprit.github.io/hs-theme-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A HugeSpaceship Theme",
"properties": {
"author": {
"description": "Who made the theme",
"type": "string"
},
"description": {
"description": "A description of a theme",
"type": "string"
},
"id": {
"description": "ID is a unique identifier for a theme",
"type": "string"
},
"name": {
"description": "The name of a theme",
"type": "string"
},
"stylesheets": {
"description": "A list of stylesheets that will be loaded by clients, paths are relative to the theme's css folder",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"theme-version": {
"description": "What is the version of the theme",
"type": "string"
},
"version": {
"description": "Version is used to check if a theme is outdated and will likely not work with the current server version",
"exclusiveMinimum": 0,
"type": "integer"
}
},
"required": [
"version",
"id",
"name",
"stylesheets"
],
"title": "Theme",
"type": "object"
} | Apache-2.0 | en |
aws-amplify/amplify-backend | dc193cd73b89c831a5fbde7d6f772f8e0cec42d7 | 2024-05-01T16:21:46 | packages/client-config/src/client-config-schema/schema_v1.json | 121 | 2024-05-27T04:36:13.645656Z | {
"$defs": {
"amazon_cognito_standard_attributes": {
"description": "Amazon Cognito standard attributes for users -- https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html",
"enum": [
"address",
"birthdate",
"email",
"family_name",
"gender",
"given_name",
"locale",
"middle_name",
"name",
"nickname",
"phone_number",
"picture",
"preferred_username",
"profile",
"sub",
"updated_at",
"website",
"zoneinfo"
],
"type": "string"
},
"amazon_location_service_config": {
"additionalProperties": false,
"properties": {
"style": {
"description": "Map style",
"type": "string"
}
},
"type": "object"
},
"amazon_pinpoint_channels": {
"description": "supported channels for Amazon Pinpoint",
"enum": [
"IN_APP_MESSAGING",
"FCM",
"APNS",
"EMAIL",
"SMS"
],
"type": "string"
},
"aws_appsync_authorization_type": {
"description": "List of supported auth types for AWS AppSync",
"enum": [
"AMAZON_COGNITO_USER_POOLS",
"API_KEY",
"AWS_IAM",
"AWS_LAMBDA",
"OPENID_CONNECT"
],
"type": "string"
},
"aws_region": {
"type": "string"
}
},
"$id": "https://amplify.aws/2024-02/outputs-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config format for Amplify Gen 2 client libraries to communicate with backend services.",
"properties": {
"$schema": {
"description": "JSON schema",
"type": "string"
},
"analytics": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"amazon_pinpoint": {
"additionalProperties": false,
"properties": {
"app_id": {
"type": "string"
},
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Pinpoint resources"
}
},
"required": [
"aws_region",
"app_id"
],
"type": "object"
}
},
"type": "object"
},
"auth": {
"additionalProperties": false,
"description": "Outputs generated from defineAuth",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Cognito resources"
},
"identity_pool_id": {
"description": "Cognito Identity Pool ID",
"type": "string"
},
"mfa_configuration": {
"enum": [
"NONE",
"OPTIONAL",
"REQUIRED"
],
"type": "string"
},
"mfa_methods": {
"items": {
"enum": [
"SMS",
"TOTP"
]
},
"type": "array"
},
"oauth": {
"additionalProperties": false,
"properties": {
"domain": {
"description": "Domain used for identity providers",
"type": "string"
},
"identity_providers": {
"description": "Identity providers set on Cognito User Pool",
"items": {
"enum": [
"GOOGLE",
"FACEBOOK",
"LOGIN_WITH_AMAZON",
"SIGN_IN_WITH_APPLE"
],
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"redirect_sign_in_uri": {
"description": "URIs used to redirect after signing in using an identity provider",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"redirect_sign_out_uri": {
"description": "URIs used to redirect after signing out",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"response_type": {
"enum": [
"code",
"token"
],
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
}
},
"required": [
"identity_providers",
"domain",
"scopes",
"redirect_sign_in_uri",
"redirect_sign_out_uri",
"response_type"
],
"type": "object"
},
"password_policy": {
"additionalProperties": false,
"description": "Cognito User Pool password policy",
"properties": {
"min_length": {
"maximum": 99,
"minimum": 6,
"type": "integer"
},
"require_lowercase": {
"type": "boolean"
},
"require_numbers": {
"type": "boolean"
},
"require_symbols": {
"type": "boolean"
},
"require_uppercase": {
"type": "boolean"
}
},
"type": "object"
},
"standard_required_attributes": {
"description": "Cognito User Pool standard attributes required for signup",
"items": {
"$ref": "#/$defs/amazon_cognito_standard_attributes"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"unauthenticated_identities_enabled": {
"default": true,
"type": "boolean"
},
"user_pool_client_id": {
"description": "Cognito User Pool Client ID",
"type": "string"
},
"user_pool_id": {
"description": "Cognito User Pool ID",
"type": "string"
},
"user_verification_types": {
"items": {
"enum": [
"email",
"phone_number"
],
"type": "string"
},
"type": "array"
},
"username_attributes": {
"description": "Cognito User Pool username attributes",
"items": {
"enum": [
"email",
"phone_number",
"username"
],
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"aws_region",
"user_pool_id",
"user_pool_client_id"
],
"type": "object"
},
"custom": {
"description": "Outputs generated from backend.addOutput({ custom: <config> })",
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "Outputs generated from defineData",
"properties": {
"api_key": {
"type": "string"
},
"authorization_types": {
"items": {
"$ref": "#/$defs/aws_appsync_authorization_type"
},
"type": "array"
},
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"default_authorization_type": {
"$ref": "#/$defs/aws_appsync_authorization_type"
},
"model_introspection": {
"description": "generated model introspection schema for use with generateClient",
"type": "object"
},
"url": {
"description": "AppSync endpoint URL",
"type": "string"
}
},
"required": [
"aws_region",
"url",
"default_authorization_type",
"authorization_types"
],
"type": "object"
},
"geo": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Location Service resources"
},
"geofence_collections": {
"additionalProperties": false,
"description": "Geofencing (visualize virtual perimeters)",
"properties": {
"default": {
"type": "string"
},
"items": {
"items": {
"description": "Geofence name",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"items",
"default"
],
"type": "object"
},
"maps": {
"additionalProperties": false,
"description": "Maps from Amazon Location Service",
"properties": {
"default": {
"type": "string"
},
"items": {
"additionalProperties": false,
"patternProperties": {
".*": {
"$ref": "#/$defs/amazon_location_service_config"
}
},
"propertyNames": {
"description": "Amazon Location Service Map name",
"type": "string"
},
"type": "object"
}
},
"required": [
"items",
"default"
],
"type": "object"
},
"search_indices": {
"additionalProperties": false,
"description": "Location search (search by places, addresses, coordinates)",
"properties": {
"default": {
"type": "string"
},
"items": {
"items": {
"description": "Actual search name",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"items",
"default"
],
"type": "object"
}
},
"required": [
"aws_region"
],
"type": "object"
},
"notifications": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"amazon_pinpoint_app_id": {
"type": "string"
},
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"channels": {
"items": {
"$ref": "#/$defs/amazon_pinpoint_channels"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"aws_region",
"amazon_pinpoint_app_id",
"channels"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"description": "Outputs generated from defineStorage",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"bucket_name": {
"type": "string"
}
},
"required": [
"aws_region",
"bucket_name"
],
"type": "object"
},
"version": {
"const": "1",
"description": "Version of this schema"
}
},
"required": [
"version"
],
"title": "AWS Amplify Backend Outputs",
"type": "object"
} | Apache-2.0 | en |
aws-amplify/amplify-backend | 5e12247bf72bbe636383fffca5fb4e8f69a465ea | 2024-03-18T16:27:59 | packages/client-config/src/client-config-schema/schema_v1.json | 121 | 2024-05-27T04:36:13.645656Z | {
"$defs": {
"amazon_api_gateway_authorization_type": {
"$ref": "#/$defs/aws_appsync_authorization_type"
},
"amazon_cognito_standard_attributes": {
"description": "Amazon Cognito standard attributes for users -- https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html",
"enum": [
"address",
"birthdate",
"email",
"family_name",
"gender",
"given_name",
"locale",
"middle_name",
"name",
"nickname",
"phone_number",
"picture",
"preferred_username",
"profile",
"sub",
"updated_at",
"website",
"zoneinfo"
],
"type": "string"
},
"amazon_cognito_standard_attributes_config": {
"additionalProperties": false,
"properties": {
"required": {
"type": "boolean"
}
},
"type": "object"
},
"amazon_location_service_config": {
"additionalProperties": false,
"properties": {
"name": {
"description": "Map resource name",
"type": "string"
},
"style": {
"description": "Map style",
"type": "string"
}
},
"type": "object"
},
"aws_appsync_authorization_type": {
"enum": [
"AMAZON_COGNITO_USER_POOLS",
"API_KEY",
"AWS_IAM",
"AWS_LAMBDA",
"OPENID_CONNECT"
],
"type": "string"
},
"aws_region": {
"type": "string"
}
},
"$id": "https://amplify.aws/2024-02/outputs-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config format for Amplify Gen 2 client libraries to communicate with backend services.",
"properties": {
"$schema": {
"description": "JSON schema",
"type": "string"
},
"analytics": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Pinpoint resources"
},
"pinpoint_app_id": {
"description": "Amazon Pinpoint App ID",
"type": "string"
}
},
"required": [
"aws_region",
"pinpoint_app_id"
],
"type": "object"
},
"api": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"endpoints": {
"items": {
"additionalProperties": false,
"description": "API Gateway, HTTP API, or Function URLs",
"properties": {
"authorization_types": {
"items": {
"$ref": "#/$defs/amazon_api_gateway_authorization_type"
},
"type": "array"
},
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of the API resource"
},
"default_authorization_type": {
"$ref": "#/$defs/amazon_api_gateway_authorization_type"
},
"name": {
"description": "API resource name",
"type": "string"
},
"url": {
"description": "Invoke endpoint of the API resource",
"type": "string"
}
},
"required": [
"name",
"url",
"aws_region",
"authorization_types",
"default_authorization_type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"endpoints"
],
"type": "object"
},
"auth": {
"additionalProperties": false,
"description": "Outputs generated from defineAuth",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Cognito resources"
},
"identity_pool_id": {
"description": "Cognito Identity Pool ID",
"type": "string"
},
"identity_providers": {
"description": "Identity providers set on Cognito User Pool",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"mfa_configuration": {
"enum": [
"NONE",
"OPTIONAL",
"REQUIRED"
],
"type": "string"
},
"mfa_methods": {
"items": {
"enum": [
"SMS",
"TOTP"
]
},
"type": "array"
},
"oauth_domain": {
"description": "Cognito Domain used for identity providers",
"type": "string"
},
"oauth_redirect_sign_in": {
"description": "URIs used to redirect after signing in using an identity provider",
"items": {
"type": "string"
},
"type": "array"
},
"oauth_redirect_sign_out": {
"description": "URIs used to redirect after signing out",
"items": {
"type": "string"
},
"type": "array"
},
"oauth_response_type": {
"enum": [
"code",
"token"
],
"type": "string"
},
"oauth_scope": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"password_policy": {
"additionalProperties": false,
"description": "Cognito User Pool password policy",
"properties": {
"min_length": {
"maximum": 99,
"minimum": 6,
"type": "number"
},
"require_lowercase": {
"type": "boolean"
},
"require_numbers": {
"type": "boolean"
},
"require_symbols": {
"type": "boolean"
},
"require_uppercase": {
"type": "boolean"
}
},
"type": "object"
},
"standard_attributes": {
"additionalProperties": false,
"description": "Cognito User Pool standard attributes",
"patternProperties": {
".*": {
"$ref": "#/$defs/amazon_cognito_standard_attributes_config"
}
},
"propertyNames": {
"$ref": "#/$defs/amazon_cognito_standard_attributes"
},
"type": "object"
},
"unauthenticated_identities_enabled": {
"default": true,
"type": "boolean"
},
"user_pool_client_id": {
"description": "Cognito User Pool Client ID",
"type": "string"
},
"user_pool_id": {
"description": "Cognito User Pool ID",
"type": "string"
},
"user_verification_mechanisms": {
"items": {
"enum": [
"EMAIL",
"PHONE"
],
"type": "string"
},
"type": "array"
},
"username_attributes": {
"description": "Cognito User Pool username attributes",
"items": {
"enum": [
"EMAIL",
"PHONE"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"aws_region",
"user_pool_id",
"user_pool_client_id",
"identity_pool_id"
],
"type": "object"
},
"custom": {
"description": "Outputs generated from backend.addOutput({ custom: <config> })",
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "Outputs generated from defineData",
"properties": {
"api_key": {
"type": "string"
},
"authorization_types": {
"items": {
"$ref": "#/$defs/aws_appsync_authorization_type"
},
"type": "array"
},
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"conflict_resolution_mode": {
"enum": [
"AUTO_MERGE",
"OPTIMISTIC_CONCURRENCY",
"LAMBDA"
],
"type": "string"
},
"default_authorization_type": {
"$ref": "#/$defs/aws_appsync_authorization_type"
},
"model_introspection": {
"description": "generated model introspection schema for use with generateClient",
"type": "object"
},
"url": {
"description": "AppSync endpoint URL",
"type": "string"
}
},
"required": [
"aws_region",
"url",
"default_authorization_type",
"authorization_types"
],
"type": "object"
},
"geo": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Location Service resources"
},
"geofence_collections": {
"additionalProperties": false,
"description": "Geofencing (visualize virtual perimeters)",
"properties": {
"default": {
"type": "string"
},
"items": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"items",
"default"
],
"type": "object"
},
"maps": {
"additionalProperties": false,
"description": "Maps from Amazon Location Service",
"properties": {
"default": {
"type": "string"
},
"items": {
"items": {
"$ref": "#/$defs/amazon_location_service_config"
},
"type": "array"
}
},
"required": [
"items",
"default"
],
"type": "object"
},
"search_indices": {
"additionalProperties": false,
"description": "Location search (search by places, addresses, coordinates)",
"properties": {
"default": {
"type": "string"
},
"items": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"items",
"default"
],
"type": "object"
}
},
"required": [
"aws_region"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"description": "Outputs generated from defineStorage",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"bucket_name": {
"type": "string"
}
},
"required": [
"aws_region",
"bucket_name"
],
"type": "object"
},
"version": {
"const": "1",
"description": "Version of this schema"
}
},
"required": [
"version"
],
"title": "AWS Amplify Backend Outputs",
"type": "object"
} | Apache-2.0 | en |
aws-amplify/amplify-backend | 1e93535be2d46112a23d0f2cd8736de1238a3795 | 2024-04-12T20:13:36 | packages/client-config/src/client-config-schema/schema_v1.json | 121 | 2024-05-27T04:36:13.645656Z | {
"$defs": {
"amazon_cognito_standard_attributes": {
"description": "Amazon Cognito standard attributes for users -- https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html",
"enum": [
"address",
"birthdate",
"email",
"family_name",
"gender",
"given_name",
"locale",
"middle_name",
"name",
"nickname",
"phone_number",
"picture",
"preferred_username",
"profile",
"sub",
"updated_at",
"website",
"zoneinfo"
],
"type": "string"
},
"amazon_location_service_config": {
"additionalProperties": false,
"properties": {
"style": {
"description": "Map style",
"type": "string"
}
},
"type": "object"
},
"amazon_pinpoint_channels": {
"description": "supported channels for Amazon Pinpoint",
"enum": [
"IN_APP_MESSAGING",
"FCM",
"APNS",
"EMAIL",
"SMS"
],
"type": "string"
},
"aws_appsync_authorization_type": {
"description": "List of supported auth types for AWS AppSync",
"enum": [
"AMAZON_COGNITO_USER_POOLS",
"API_KEY",
"AWS_IAM",
"AWS_LAMBDA",
"OPENID_CONNECT"
],
"type": "string"
},
"aws_region": {
"type": "string"
}
},
"$id": "https://amplify.aws/2024-02/outputs-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config format for Amplify Gen 2 client libraries to communicate with backend services.",
"properties": {
"$schema": {
"description": "JSON schema",
"type": "string"
},
"analytics": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"amazon_pinpoint": {
"additionalProperties": false,
"properties": {
"app_id": {
"type": "string"
},
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Pinpoint resources"
}
},
"required": [
"aws_region",
"app_id"
],
"type": "object"
}
},
"type": "object"
},
"auth": {
"additionalProperties": false,
"description": "Outputs generated from defineAuth",
"properties": {
"authentication_flow_type": {
"default": "USER_SRP_AUTH",
"description": "Authentication flow types",
"enum": [
"USER_SRP_AUTH",
"CUSTOM_AUTH"
],
"type": "string"
},
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Cognito resources"
},
"identity_pool_id": {
"description": "Cognito Identity Pool ID",
"type": "string"
},
"mfa_configuration": {
"enum": [
"NONE",
"OPTIONAL",
"REQUIRED"
],
"type": "string"
},
"mfa_methods": {
"items": {
"enum": [
"SMS",
"TOTP"
]
},
"type": "array"
},
"oauth": {
"additionalProperties": false,
"properties": {
"cognito_domain": {
"description": "Auto generated cognito domain used for identity providers",
"type": "string"
},
"custom_domain": {
"description": "Custom Domain used for identity providers",
"type": "string"
},
"identity_providers": {
"description": "Identity providers set on Cognito User Pool",
"items": {
"enum": [
"GOOGLE",
"FACEBOOK",
"LOGIN_WITH_AMAZON",
"SIGN_IN_WITH_APPLE"
],
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"redirect_sign_in_uri": {
"description": "URIs used to redirect after signing in using an identity provider",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"redirect_sign_out_uri": {
"description": "URIs used to redirect after signing out",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"response_type": {
"enum": [
"code",
"token"
],
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
}
},
"required": [
"identity_providers",
"cognito_domain",
"scopes",
"redirect_sign_in_uri",
"redirect_sign_out_uri",
"response_type"
],
"type": "object"
},
"password_policy": {
"additionalProperties": false,
"description": "Cognito User Pool password policy",
"properties": {
"min_length": {
"maximum": 99,
"minimum": 6,
"type": "integer"
},
"require_lowercase": {
"type": "boolean"
},
"require_numbers": {
"type": "boolean"
},
"require_symbols": {
"type": "boolean"
},
"require_uppercase": {
"type": "boolean"
}
},
"type": "object"
},
"standard_required_attributes": {
"description": "Cognito User Pool standard attributes required for signup",
"items": {
"$ref": "#/$defs/amazon_cognito_standard_attributes"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"unauthenticated_identities_enabled": {
"default": true,
"type": "boolean"
},
"user_pool_client_id": {
"description": "Cognito User Pool Client ID",
"type": "string"
},
"user_pool_id": {
"description": "Cognito User Pool ID",
"type": "string"
},
"user_verification_types": {
"items": {
"enum": [
"email",
"phone_number"
],
"type": "string"
},
"type": "array"
},
"username_attributes": {
"description": "Cognito User Pool username attributes",
"items": {
"enum": [
"email",
"phone_number",
"username"
],
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"aws_region",
"user_pool_id",
"user_pool_client_id"
],
"type": "object"
},
"custom": {
"description": "Outputs generated from backend.addOutput({ custom: <config> })",
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "Outputs generated from defineData",
"properties": {
"api_key": {
"type": "string"
},
"authorization_types": {
"items": {
"$ref": "#/$defs/aws_appsync_authorization_type"
},
"type": "array"
},
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"default_authorization_type": {
"$ref": "#/$defs/aws_appsync_authorization_type"
},
"model_introspection": {
"description": "generated model introspection schema for use with generateClient",
"type": "object"
},
"url": {
"description": "AppSync endpoint URL",
"type": "string"
}
},
"required": [
"aws_region",
"url",
"default_authorization_type",
"authorization_types"
],
"type": "object"
},
"geo": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Location Service resources"
},
"geofence_collections": {
"additionalProperties": false,
"description": "Geofencing (visualize virtual perimeters)",
"properties": {
"default": {
"type": "string"
},
"items": {
"items": {
"description": "Geofence name",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"items",
"default"
],
"type": "object"
},
"maps": {
"additionalProperties": false,
"description": "Maps from Amazon Location Service",
"properties": {
"default": {
"type": "string"
},
"items": {
"additionalProperties": false,
"patternProperties": {
".*": {
"$ref": "#/$defs/amazon_location_service_config"
}
},
"propertyNames": {
"description": "Amazon Location Service Map name",
"type": "string"
},
"type": "object"
}
},
"required": [
"items",
"default"
],
"type": "object"
},
"search_indices": {
"additionalProperties": false,
"description": "Location search (search by places, addresses, coordinates)",
"properties": {
"default": {
"type": "string"
},
"items": {
"items": {
"description": "Actual search name",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"items",
"default"
],
"type": "object"
}
},
"required": [
"aws_region"
],
"type": "object"
},
"notifications": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"amazon_pinpoint_app_id": {
"type": "string"
},
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"channels": {
"items": {
"$ref": "#/$defs/amazon_pinpoint_channels"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"aws_region",
"amazon_pinpoint_app_id",
"channels"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"description": "Outputs generated from defineStorage",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"bucket_name": {
"type": "string"
}
},
"required": [
"aws_region",
"bucket_name"
],
"type": "object"
},
"version": {
"const": "1",
"description": "Version of this schema"
}
},
"required": [
"version"
],
"title": "AWS Amplify Backend Outputs",
"type": "object"
} | Apache-2.0 | en |
aws-amplify/amplify-backend | dca2a0047c73ce3fae4023b29ec361512dc85635 | 2024-04-22T17:05:52 | packages/client-config/src/client-config-schema/schema_v1.json | 121 | 2024-05-27T04:36:13.645656Z | {
"$defs": {
"amazon_cognito_standard_attributes": {
"description": "Amazon Cognito standard attributes for users -- https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html",
"enum": [
"address",
"birthdate",
"email",
"family_name",
"gender",
"given_name",
"locale",
"middle_name",
"name",
"nickname",
"phone_number",
"picture",
"preferred_username",
"profile",
"sub",
"updated_at",
"website",
"zoneinfo"
],
"type": "string"
},
"amazon_location_service_config": {
"additionalProperties": false,
"properties": {
"style": {
"description": "Map style",
"type": "string"
}
},
"type": "object"
},
"amazon_pinpoint_channels": {
"description": "supported channels for Amazon Pinpoint",
"enum": [
"IN_APP_MESSAGING",
"FCM",
"APNS",
"EMAIL",
"SMS"
],
"type": "string"
},
"aws_appsync_authorization_type": {
"description": "List of supported auth types for AWS AppSync",
"enum": [
"AMAZON_COGNITO_USER_POOLS",
"API_KEY",
"AWS_IAM",
"AWS_LAMBDA",
"OPENID_CONNECT"
],
"type": "string"
},
"aws_region": {
"type": "string"
}
},
"$id": "https://amplify.aws/2024-02/outputs-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config format for Amplify Gen 2 client libraries to communicate with backend services.",
"properties": {
"$schema": {
"description": "JSON schema",
"type": "string"
},
"analytics": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"amazon_pinpoint": {
"additionalProperties": false,
"properties": {
"app_id": {
"type": "string"
},
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Pinpoint resources"
}
},
"required": [
"aws_region",
"app_id"
],
"type": "object"
}
},
"type": "object"
},
"auth": {
"additionalProperties": false,
"description": "Outputs generated from defineAuth",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Cognito resources"
},
"identity_pool_id": {
"description": "Cognito Identity Pool ID",
"type": "string"
},
"mfa_configuration": {
"enum": [
"NONE",
"OPTIONAL",
"REQUIRED"
],
"type": "string"
},
"mfa_methods": {
"items": {
"enum": [
"SMS",
"TOTP"
]
},
"type": "array"
},
"oauth": {
"additionalProperties": false,
"properties": {
"domain": {
"description": "Domain used for identity providers",
"type": "string"
},
"identity_providers": {
"description": "Identity providers set on Cognito User Pool",
"items": {
"enum": [
"GOOGLE",
"FACEBOOK",
"LOGIN_WITH_AMAZON",
"SIGN_IN_WITH_APPLE"
],
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"redirect_sign_in_uri": {
"description": "URIs used to redirect after signing in using an identity provider",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"redirect_sign_out_uri": {
"description": "URIs used to redirect after signing out",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"response_type": {
"enum": [
"code",
"token"
],
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
}
},
"required": [
"identity_providers",
"cognito_domain",
"scopes",
"redirect_sign_in_uri",
"redirect_sign_out_uri",
"response_type"
],
"type": "object"
},
"password_policy": {
"additionalProperties": false,
"description": "Cognito User Pool password policy",
"properties": {
"min_length": {
"maximum": 99,
"minimum": 6,
"type": "integer"
},
"require_lowercase": {
"type": "boolean"
},
"require_numbers": {
"type": "boolean"
},
"require_symbols": {
"type": "boolean"
},
"require_uppercase": {
"type": "boolean"
}
},
"type": "object"
},
"standard_required_attributes": {
"description": "Cognito User Pool standard attributes required for signup",
"items": {
"$ref": "#/$defs/amazon_cognito_standard_attributes"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"unauthenticated_identities_enabled": {
"default": true,
"type": "boolean"
},
"user_pool_client_id": {
"description": "Cognito User Pool Client ID",
"type": "string"
},
"user_pool_id": {
"description": "Cognito User Pool ID",
"type": "string"
},
"user_verification_types": {
"items": {
"enum": [
"email",
"phone_number"
],
"type": "string"
},
"type": "array"
},
"username_attributes": {
"description": "Cognito User Pool username attributes",
"items": {
"enum": [
"email",
"phone_number",
"username"
],
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"aws_region",
"user_pool_id",
"user_pool_client_id"
],
"type": "object"
},
"custom": {
"description": "Outputs generated from backend.addOutput({ custom: <config> })",
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "Outputs generated from defineData",
"properties": {
"api_key": {
"type": "string"
},
"authorization_types": {
"items": {
"$ref": "#/$defs/aws_appsync_authorization_type"
},
"type": "array"
},
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"default_authorization_type": {
"$ref": "#/$defs/aws_appsync_authorization_type"
},
"model_introspection": {
"description": "generated model introspection schema for use with generateClient",
"type": "object"
},
"url": {
"description": "AppSync endpoint URL",
"type": "string"
}
},
"required": [
"aws_region",
"url",
"default_authorization_type",
"authorization_types"
],
"type": "object"
},
"geo": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Location Service resources"
},
"geofence_collections": {
"additionalProperties": false,
"description": "Geofencing (visualize virtual perimeters)",
"properties": {
"default": {
"type": "string"
},
"items": {
"items": {
"description": "Geofence name",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"items",
"default"
],
"type": "object"
},
"maps": {
"additionalProperties": false,
"description": "Maps from Amazon Location Service",
"properties": {
"default": {
"type": "string"
},
"items": {
"additionalProperties": false,
"patternProperties": {
".*": {
"$ref": "#/$defs/amazon_location_service_config"
}
},
"propertyNames": {
"description": "Amazon Location Service Map name",
"type": "string"
},
"type": "object"
}
},
"required": [
"items",
"default"
],
"type": "object"
},
"search_indices": {
"additionalProperties": false,
"description": "Location search (search by places, addresses, coordinates)",
"properties": {
"default": {
"type": "string"
},
"items": {
"items": {
"description": "Actual search name",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"items",
"default"
],
"type": "object"
}
},
"required": [
"aws_region"
],
"type": "object"
},
"notifications": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"amazon_pinpoint_app_id": {
"type": "string"
},
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"channels": {
"items": {
"$ref": "#/$defs/amazon_pinpoint_channels"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"aws_region",
"amazon_pinpoint_app_id",
"channels"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"description": "Outputs generated from defineStorage",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"bucket_name": {
"type": "string"
}
},
"required": [
"aws_region",
"bucket_name"
],
"type": "object"
},
"version": {
"const": "1",
"description": "Version of this schema"
}
},
"required": [
"version"
],
"title": "AWS Amplify Backend Outputs",
"type": "object"
} | Apache-2.0 | en |
aws-amplify/amplify-backend | 394b72e34afc1b558cf65762d3d4b4800ce61fa1 | 2024-03-28T19:32:51 | packages/client-config/src/client-config-schema/schema_v1.json | 121 | 2024-05-27T04:36:13.645656Z | {
"$defs": {
"amazon_cognito_standard_attributes": {
"description": "Amazon Cognito standard attributes for users -- https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html",
"enum": [
"address",
"birthdate",
"email",
"family_name",
"gender",
"given_name",
"locale",
"middle_name",
"name",
"nickname",
"phone_number",
"picture",
"preferred_username",
"profile",
"sub",
"updated_at",
"website",
"zoneinfo"
],
"type": "string"
},
"amazon_location_service_config": {
"additionalProperties": false,
"properties": {
"style": {
"description": "Map style",
"type": "string"
}
},
"type": "object"
},
"amazon_pinpoint_channels": {
"description": "supported channels for Amazon Pinpoint",
"enum": [
"IN_APP_MESSAGING",
"FCM",
"APNS",
"EMAIL",
"SMS"
],
"type": "string"
},
"aws_appsync_authorization_type": {
"description": "List of supported auth types for AWS AppSync",
"enum": [
"AMAZON_COGNITO_USER_POOLS",
"API_KEY",
"AWS_IAM",
"AWS_LAMBDA",
"OPENID_CONNECT"
],
"type": "string"
},
"aws_region": {
"type": "string"
}
},
"$id": "https://amplify.aws/2024-02/outputs-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Config format for Amplify Gen 2 client libraries to communicate with backend services.",
"properties": {
"$schema": {
"description": "JSON schema",
"type": "string"
},
"analytics": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"amazon_pinpoint": {
"additionalProperties": false,
"properties": {
"app_id": {
"type": "string"
},
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Pinpoint resources"
}
},
"required": [
"aws_region",
"app_id"
],
"type": "object"
}
},
"type": "object"
},
"auth": {
"additionalProperties": false,
"description": "Outputs generated from defineAuth",
"properties": {
"authentication_flow_type": {
"default": "USER_SRP_AUTH",
"description": "Authentication flow types",
"enum": [
"USER_SRP_AUTH",
"CUSTOM_AUTH"
],
"type": "string"
},
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Cognito resources"
},
"identity_pool_id": {
"description": "Cognito Identity Pool ID",
"type": "string"
},
"mfa_configuration": {
"enum": [
"NONE",
"OPTIONAL",
"REQUIRED"
],
"type": "string"
},
"mfa_methods": {
"items": {
"enum": [
"SMS",
"TOTP"
]
},
"type": "array"
},
"oauth": {
"additionalProperties": false,
"properties": {
"domain": {
"description": "Cognito Domain used for identity providers",
"type": "string"
},
"identity_providers": {
"description": "Identity providers set on Cognito User Pool",
"items": {
"enum": [
"GOOGLE",
"FACEBOOK",
"LOGIN_WITH_AMAZON",
"SIGN_IN_WITH_APPLE"
],
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"redirect_sign_in_uri": {
"description": "URIs used to redirect after signing in using an identity provider",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"redirect_sign_out_uri": {
"description": "URIs used to redirect after signing out",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"response_type": {
"enum": [
"code",
"token"
],
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
}
},
"required": [
"identity_providers",
"scopes",
"redirect_sign_in_uri",
"redirect_sign_out_uri",
"response_type"
],
"type": "object"
},
"password_policy": {
"additionalProperties": false,
"description": "Cognito User Pool password policy",
"properties": {
"min_length": {
"maximum": 99,
"minimum": 6,
"type": "integer"
},
"require_lowercase": {
"type": "boolean"
},
"require_numbers": {
"type": "boolean"
},
"require_symbols": {
"type": "boolean"
},
"require_uppercase": {
"type": "boolean"
}
},
"type": "object"
},
"standard_required_attributes": {
"description": "Cognito User Pool standard attributes required for signup",
"items": {
"$ref": "#/$defs/amazon_cognito_standard_attributes"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"unauthenticated_identities_enabled": {
"default": true,
"type": "boolean"
},
"user_pool_client_id": {
"description": "Cognito User Pool Client ID",
"type": "string"
},
"user_pool_id": {
"description": "Cognito User Pool ID",
"type": "string"
},
"user_verification_types": {
"items": {
"enum": [
"email",
"phone_number"
],
"type": "string"
},
"type": "array"
},
"username_attributes": {
"description": "Cognito User Pool username attributes",
"items": {
"enum": [
"email",
"phone_number",
"username"
],
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"aws_region",
"user_pool_id",
"user_pool_client_id"
],
"type": "object"
},
"custom": {
"description": "Outputs generated from backend.addOutput({ custom: <config> })",
"type": "object"
},
"data": {
"additionalProperties": false,
"description": "Outputs generated from defineData",
"properties": {
"api_key": {
"type": "string"
},
"authorization_types": {
"items": {
"$ref": "#/$defs/aws_appsync_authorization_type"
},
"type": "array"
},
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"default_authorization_type": {
"$ref": "#/$defs/aws_appsync_authorization_type"
},
"model_introspection": {
"description": "generated model introspection schema for use with generateClient",
"type": "object"
},
"url": {
"description": "AppSync endpoint URL",
"type": "string"
}
},
"required": [
"aws_region",
"url",
"default_authorization_type",
"authorization_types"
],
"type": "object"
},
"geo": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region",
"description": "AWS Region of Amazon Location Service resources"
},
"geofence_collections": {
"additionalProperties": false,
"description": "Geofencing (visualize virtual perimeters)",
"properties": {
"default": {
"type": "string"
},
"items": {
"items": {
"description": "Geofence name",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"items",
"default"
],
"type": "object"
},
"maps": {
"additionalProperties": false,
"description": "Maps from Amazon Location Service",
"properties": {
"default": {
"type": "string"
},
"items": {
"additionalProperties": false,
"patternProperties": {
".*": {
"$ref": "#/$defs/amazon_location_service_config"
}
},
"propertyNames": {
"description": "Amazon Location Service Map name",
"type": "string"
},
"type": "object"
}
},
"required": [
"items",
"default"
],
"type": "object"
},
"search_indices": {
"additionalProperties": false,
"description": "Location search (search by places, addresses, coordinates)",
"properties": {
"default": {
"type": "string"
},
"items": {
"items": {
"description": "Actual search name",
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"items",
"default"
],
"type": "object"
}
},
"required": [
"aws_region"
],
"type": "object"
},
"notifications": {
"additionalProperties": false,
"description": "Outputs manually specified by developers for use with frontend library",
"properties": {
"amazon_pinpoint_app_id": {
"type": "string"
},
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"channels": {
"items": {
"$ref": "#/$defs/amazon_pinpoint_channels"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"aws_region",
"amazon_pinpoint_app_id",
"channels"
],
"type": "object"
},
"storage": {
"additionalProperties": false,
"description": "Outputs generated from defineStorage",
"properties": {
"aws_region": {
"$ref": "#/$defs/aws_region"
},
"bucket_name": {
"type": "string"
}
},
"required": [
"aws_region",
"bucket_name"
],
"type": "object"
},
"version": {
"const": "1",
"description": "Version of this schema"
}
},
"required": [
"version"
],
"title": "AWS Amplify Backend Outputs",
"type": "object"
} | Apache-2.0 | en |
es-tooling/module-replacements | 8de94132bc652fc18430afaf3f75af57a1160ac0 | 2024-02-03T14:55:39 | manifest-schema.json | 5 | 2024-05-27T09:13:38.291611Z | {
"$id": "https://github.com/es-tooling/module-replacements/blob/main/manifest-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A schema for the structure used when defining JS module replacements",
"properties": {
"modules": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"replacements": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"replacements"
],
"type": "object"
},
"type": "array"
},
"replacements": {
"items": {
"additionalProperties": false,
"properties": {
"example": {
"type": "string"
},
"id": {
"type": "string"
},
"native": {
"type": "boolean"
},
"url": {
"type": "string"
}
},
"required": [
"id",
"example",
"url"
],
"type": "object"
},
"type": "array"
}
},
"title": "Module replacements manifest schema",
"type": "object"
} | MIT | en |
carbon-design-system/carbon-platform | 51864106c052de0c9e2f3631ab917c3c3f5209c8 | 2022-06-01T20:47:15 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "determines which supporting documentation is available to fetch and render as page tabs in asset details",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"description": "[TODO]",
"type": "string"
},
"codePath": {
"description": "[TODO]",
"type": "string"
},
"stylePath": {
"description": "[TODO]",
"type": "string"
},
"usagePath": {
"description": "[TODO]",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 4b6fc1a316824f90972a3f14a1c68f98c5544882 | 2022-06-03T16:31:19 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "determines which supporting documentation is available to fetch and render as page tabs in asset details",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"codePath": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | dbe821cdd3bb030951775cda2649668d0003759e | 2022-08-23T17:29:04 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets, Design Kits, and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook",
"other"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "Determines which supporting documentation is available to fetch and render as page tabs in asset details.",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"default": "./accessibility.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"codePath": {
"default": "./code.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"default": "./style.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"default": "./usage.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"designKits": {
"description": "Object containing all design kits",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Design kits contain elements, guidelines, user interface components and patterns, and wireframes for various design tools as the design counterpart to coded assets.",
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"description": {
"description": "Design kit description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"license": {
"description": "Design kit license.",
"enum": [
"apache-2.0",
"ibm-internal",
"mit"
],
"type": "string"
},
"name": {
"description": "Design kit display name (often includes the tool and color theme.) Use title-case capitalization.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the kit.",
"type": "boolean"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tool": {
"description": "Design kit's compatible tool.",
"enum": [
"adobe-ase",
"adobe-xd",
"axure",
"figma",
"invision-freehand",
"sketch"
],
"type": "string"
},
"type": {
"description": "Design kit primary categorization.",
"enum": [
"elements",
"guidelines",
"ui",
"wireframes"
],
"type": "string"
},
"url": {
"description": "Design kit URL.",
"type": "string"
}
},
"required": [
"name",
"tool",
"type",
"status",
"url"
],
"type": "object"
}
},
"title": "Carbon Design Kit",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook",
"other"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"designKits": {
"description": "Object containing design kits",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"description": "Design kits contain elements, guidelines, user interface components and patterns, and wireframes for various design tools as the design counterpart to coded assets.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"description": {
"description": "Design kit description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"license": {
"description": "Design kit license.",
"enum": [
"apache-2.0",
"ibm-internal",
"mit"
],
"type": "string"
},
"name": {
"description": "Design kit display name (often includes the tool and color theme.) Use title-case capitalization.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the kit.",
"type": "boolean"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tool": {
"description": "Design kit's compatible tool.",
"enum": [
"adobe-ase",
"adobe-xd",
"axure",
"figma",
"invision-freehand",
"sketch"
],
"type": "string"
},
"type": {
"description": "Design kit primary categorization.",
"enum": [
"elements",
"guidelines",
"ui",
"wireframes"
],
"type": "string"
},
"url": {
"description": "Design kit URL.",
"type": "string"
}
},
"required": [
"name",
"tool",
"type",
"status",
"url"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"$ref": {
"description": "Reference to a design kit.",
"type": "string"
}
},
"required": [
"$ref"
],
"type": "object"
}
]
}
},
"title": "Carbon Design Kit",
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"title",
"path"
]
},
{
"required": [
"title",
"items"
]
}
],
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 322ae033f9d6dff756154e9459db31452a4d6c1d | 2022-05-24T15:03:07 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"navData": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | ff8079a7d88bace45f8500610458089206d1cc42 | 2022-05-27T15:04:48 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"navData": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | ca28db7790cd79d0551d9d3afb837b6f22830b66 | 2022-06-02T20:58:34 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "determines which supporting documentation is available to fetch and render as page tabs in asset details",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"description": "Path to the file, Github url or path relative to carbon.yml.",
"type": "string"
},
"codePath": {
"description": "Path to the file, Github url or path relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"description": "Path to the file, Github url or path relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"description": "Path to the file, Github url or path relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 48d8cfca87c870660f9f01aee4985c5ecbf68c58 | 2022-08-31T14:35:29 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets, Design Kits, and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook",
"other"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "Determines which supporting documentation is available to fetch and render as page tabs in asset details.",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"default": "./accessibility.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"codePath": {
"default": "./code.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"overviewPath": {
"default": "./overview.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"default": "./style.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"default": "./usage.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 0,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"designKits": {
"description": "Object containing all design kits",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Design kits contain elements, guidelines, user interface components and patterns, and wireframes for various design tools as the design counterpart to coded assets.",
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"description": {
"description": "Design kit description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"license": {
"description": "Design kit license.",
"enum": [
"apache-2.0",
"ibm-internal",
"mit"
],
"type": "string"
},
"name": {
"description": "Design kit display name (often includes the tool and color theme.) Use title-case capitalization.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the kit.",
"type": "boolean"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tool": {
"description": "Design kit's compatible tool.",
"enum": [
"adobe-ase",
"adobe-xd",
"axure",
"figma",
"invision-freehand",
"sketch"
],
"type": "string"
},
"type": {
"description": "Design kit primary categorization.",
"enum": [
"elements",
"guidelines",
"ui",
"wireframes"
],
"type": "string"
},
"url": {
"description": "Design kit URL.",
"type": "string"
}
},
"required": [
"name",
"tool",
"type",
"status",
"url"
],
"type": "object"
}
},
"title": "Carbon Design Kit",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook",
"other"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"designKits": {
"description": "Object containing design kits",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"description": "Design kits contain elements, guidelines, user interface components and patterns, and wireframes for various design tools as the design counterpart to coded assets.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"description": {
"description": "Design kit description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"license": {
"description": "Design kit license.",
"enum": [
"apache-2.0",
"ibm-internal",
"mit"
],
"type": "string"
},
"name": {
"description": "Design kit display name (often includes the tool and color theme.) Use title-case capitalization.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the kit.",
"type": "boolean"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tool": {
"description": "Design kit's compatible tool.",
"enum": [
"adobe-ase",
"adobe-xd",
"axure",
"figma",
"invision-freehand",
"sketch"
],
"type": "string"
},
"type": {
"description": "Design kit primary categorization.",
"enum": [
"elements",
"guidelines",
"ui",
"wireframes"
],
"type": "string"
},
"url": {
"description": "Design kit URL.",
"type": "string"
}
},
"required": [
"name",
"tool",
"type",
"status",
"url"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"$ref": {
"description": "Reference to a design kit.",
"type": "string"
}
},
"required": [
"$ref"
],
"type": "object"
}
]
}
},
"title": "Carbon Design Kit",
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"title",
"path"
]
},
{
"required": [
"title",
"items"
]
}
],
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 1fdc597018525a79c04192f1a99df8d18f3acecf | 2022-06-01T20:21:54 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "determines which supporting documentation is available to fetch and render as page tabs in asset details",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"description": "[TODO]",
"type": "string"
},
"codePath": {
"description": "[TODO]",
"type": "string"
},
"stylePath": {
"description": "[TODO]",
"type": "string"
},
"usagePath": {
"description": "[TODO]",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 0a160f098e4ea7b0a56ae5e08cf4b7dc1189cb4f | 2022-06-09T17:56:36 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "Determines which supporting documentation is available to fetch and render as page tabs in asset details.",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"default": "./accessibility.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"codePath": {
"default": "./code.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"default": "./style.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"default": "./usage.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"title",
"path"
]
},
{
"required": [
"title",
"items"
]
}
],
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 73ef175470aeca6a7599831caeb7f1e3f3401447 | 2022-06-03T16:29:16 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "Determines which supporting documentation is available to fetch and render as page tabs in asset details.",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"description": "Path to the file, Github url or path relative to carbon.yml.",
"type": "string"
},
"codePath": {
"description": "Path to the file, Github url or path relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"description": "Path to the file, Github url or path relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"description": "Path to the file, Github url or path relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 0261a62857b6a8523adff9a5115bfb56de134c0f | 2022-06-07T14:37:29 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "Determines which supporting documentation is available to fetch and render as page tabs in asset details.",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"codePath": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"title",
"path"
]
},
{
"required": [
"title",
"items"
]
}
],
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 49576533550f81ec0b6a3f9d5274cce7a21b8b4c | 2022-08-25T19:06:40 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets, Design Kits, and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook",
"other"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "Determines which supporting documentation is available to fetch and render as page tabs in asset details.",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"default": "./accessibility.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"codePath": {
"default": "./code.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"overviewPath": {
"default": "./overview.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"default": "./style.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"default": "./usage.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"designKits": {
"description": "Object containing all design kits",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Design kits contain elements, guidelines, user interface components and patterns, and wireframes for various design tools as the design counterpart to coded assets.",
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"description": {
"description": "Design kit description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"license": {
"description": "Design kit license.",
"enum": [
"apache-2.0",
"ibm-internal",
"mit"
],
"type": "string"
},
"name": {
"description": "Design kit display name (often includes the tool and color theme.) Use title-case capitalization.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the kit.",
"type": "boolean"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tool": {
"description": "Design kit's compatible tool.",
"enum": [
"adobe-ase",
"adobe-xd",
"axure",
"figma",
"invision-freehand",
"sketch"
],
"type": "string"
},
"type": {
"description": "Design kit primary categorization.",
"enum": [
"elements",
"guidelines",
"ui",
"wireframes"
],
"type": "string"
},
"url": {
"description": "Design kit URL.",
"type": "string"
}
},
"required": [
"name",
"tool",
"type",
"status",
"url"
],
"type": "object"
}
},
"title": "Carbon Design Kit",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook",
"other"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"designKits": {
"description": "Object containing design kits",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"description": "Design kits contain elements, guidelines, user interface components and patterns, and wireframes for various design tools as the design counterpart to coded assets.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"description": {
"description": "Design kit description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"license": {
"description": "Design kit license.",
"enum": [
"apache-2.0",
"ibm-internal",
"mit"
],
"type": "string"
},
"name": {
"description": "Design kit display name (often includes the tool and color theme.) Use title-case capitalization.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the kit.",
"type": "boolean"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tool": {
"description": "Design kit's compatible tool.",
"enum": [
"adobe-ase",
"adobe-xd",
"axure",
"figma",
"invision-freehand",
"sketch"
],
"type": "string"
},
"type": {
"description": "Design kit primary categorization.",
"enum": [
"elements",
"guidelines",
"ui",
"wireframes"
],
"type": "string"
},
"url": {
"description": "Design kit URL.",
"type": "string"
}
},
"required": [
"name",
"tool",
"type",
"status",
"url"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"$ref": {
"description": "Reference to a design kit.",
"type": "string"
}
},
"required": [
"$ref"
],
"type": "object"
}
]
}
},
"title": "Carbon Design Kit",
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"title",
"path"
]
},
{
"required": [
"title",
"items"
]
}
],
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 3cc81da3266f49c5c568b628510488b043018857 | 2022-05-27T15:05:06 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | d7c81c1e85f7f9e318ade132af129af061ab5bf7 | 2022-05-31T19:38:55 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 7f01471210ab94d36bb13005060a7c24704efeb0 | 2022-06-15T18:41:49 | packages/api/src/dev/data-graph/dev-dataset.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Schema governing the definition of a file containing dev-mode graphql responses",
"properties": {
"queries": {
"items": {
"properties": {
"name": {
"type": "string"
},
"response": {
"type": "object"
},
"variables": {
"type": "object"
}
},
"required": [
"name",
"response"
],
"type": "object"
},
"type": "array"
}
},
"title": "Dev Dataset Schema",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 7cce0a9a728515976d5abd34caf854993b09e745 | 2022-05-27T15:02:19 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"navData": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 1f73e0c59fee034c62ffbac017ba5c0eb5a38fbf | 2022-06-21T16:17:36 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "Determines which supporting documentation is available to fetch and render as page tabs in asset details.",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"default": "./accessibility.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"codePath": {
"default": "./code.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"default": "./style.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"default": "./usage.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"title",
"path"
]
},
{
"required": [
"title",
"items"
]
}
],
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | c77e8145b3f8e7c095777b7819d8177fd5a86434 | 2022-06-02T17:17:12 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "determines which supporting documentation is available to fetch and render as page tabs in asset details",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"codePath": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 9e62b9af9831622eb4b2ab3467b13539829ce2cb | 2022-05-27T15:05:22 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 1909006fbfa266d77f0d8980c61b8787116eacef | 2022-06-02T20:44:44 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"title",
"path"
]
},
{
"required": [
"title",
"items"
]
}
],
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 40e30a98332aae83fa048bff8f5aee944c300f2b | 2022-05-27T15:02:26 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"navData": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 8d7164c1e01ce2927eeb3afe748f2aea2026d327 | 2022-05-27T15:04:54 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 5311520614705af16742bb186a88ac6811d29333 | 2022-05-27T15:05:14 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | e3693efcbd2a020c1706a5891d95872f8b3d5003 | 2022-06-02T20:45:25 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"title",
"path"
]
},
{
"required": [
"title",
"items"
]
}
],
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 928113dbe286e2a178127fb5f78350755c519c03 | 2022-07-13T16:47:02 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets, Design Kits, and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "Determines which supporting documentation is available to fetch and render as page tabs in asset details.",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"default": "./accessibility.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"codePath": {
"default": "./code.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"default": "./style.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"default": "./usage.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"designKits": {
"description": "Object containing all design kits",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Design kits contain elements, guidelines, user interface components and patterns, and wireframes for various design tools as the design counterpart to coded assets.",
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"description": {
"description": "Design kit description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"license": {
"description": "Design kit license.",
"enum": [
"apache-2.0",
"ibm-internal",
"mit"
],
"type": "string"
},
"name": {
"description": "Design kit display name (often includes the tool and color theme.) Use title-case capitalization.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the kit.",
"type": "boolean"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tool": {
"description": "Design kit's compatible tool.",
"enum": [
"adobe-ase",
"adobe-xd",
"axure",
"figma",
"invision-freehand",
"sketch"
],
"type": "string"
},
"type": {
"description": "Design kit primary categorization.",
"enum": [
"elements",
"guidelines",
"ui",
"wireframes"
],
"type": "string"
},
"url": {
"description": "Design kit URL.",
"type": "string"
}
},
"required": [
"name",
"tool",
"type",
"status",
"url"
],
"type": "object"
}
},
"title": "Carbon Design Kit",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"designKits": {
"description": "Object containing design kits",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"description": "Design kits contain elements, guidelines, user interface components and patterns, and wireframes for various design tools as the design counterpart to coded assets.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"description": {
"description": "Design kit description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"license": {
"description": "Design kit license.",
"enum": [
"apache-2.0",
"ibm-internal",
"mit"
],
"type": "string"
},
"name": {
"description": "Design kit display name (often includes the tool and color theme.) Use title-case capitalization.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the kit.",
"type": "boolean"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tool": {
"description": "Design kit's compatible tool.",
"enum": [
"adobe-ase",
"adobe-xd",
"axure",
"figma",
"invision-freehand",
"sketch"
],
"type": "string"
},
"type": {
"description": "Design kit primary categorization.",
"enum": [
"elements",
"guidelines",
"ui",
"wireframes"
],
"type": "string"
},
"url": {
"description": "Design kit URL.",
"type": "string"
}
},
"required": [
"name",
"tool",
"type",
"status",
"url"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"$ref": {
"description": "Reference to a design kit.",
"type": "string"
}
},
"required": [
"$ref"
],
"type": "object"
}
]
}
},
"title": "Carbon Design Kit",
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"title",
"path"
]
},
{
"required": [
"title",
"items"
]
}
],
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | c06ced03452deca245259c6318e3391eb51e783c | 2022-06-03T16:31:27 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "Determines which supporting documentation is available to fetch and render as page tabs in asset details.",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"codePath": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | a49efdfe90de343e125e816c0a5b913280fe2e71 | 2022-08-29T21:33:11 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets, Design Kits, and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook",
"other"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"docs": {
"description": "Determines which supporting documentation is available to fetch and render as page tabs in asset details.",
"minProperties": 1,
"properties": {
"accessibilityPath": {
"default": "./accessibility.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"codePath": {
"default": "./code.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"stylePath": {
"default": "./style.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"usagePath": {
"default": "./usage.mdx",
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
}
},
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 0,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"designKits": {
"description": "Object containing all design kits",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Design kits contain elements, guidelines, user interface components and patterns, and wireframes for various design tools as the design counterpart to coded assets.",
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"description": {
"description": "Design kit description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"license": {
"description": "Design kit license.",
"enum": [
"apache-2.0",
"ibm-internal",
"mit"
],
"type": "string"
},
"name": {
"description": "Design kit display name (often includes the tool and color theme.) Use title-case capitalization.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the kit.",
"type": "boolean"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tool": {
"description": "Design kit's compatible tool.",
"enum": [
"adobe-ase",
"adobe-xd",
"axure",
"figma",
"invision-freehand",
"sketch"
],
"type": "string"
},
"type": {
"description": "Design kit primary categorization.",
"enum": [
"elements",
"guidelines",
"ui",
"wireframes"
],
"type": "string"
},
"url": {
"description": "Design kit URL.",
"type": "string"
}
},
"required": [
"name",
"tool",
"type",
"status",
"url"
],
"type": "object"
}
},
"title": "Carbon Design Kit",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook",
"other"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"designKits": {
"description": "Object containing design kits",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"description": "Design kits contain elements, guidelines, user interface components and patterns, and wireframes for various design tools as the design counterpart to coded assets.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"description": {
"description": "Design kit description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"license": {
"description": "Design kit license.",
"enum": [
"apache-2.0",
"ibm-internal",
"mit"
],
"type": "string"
},
"name": {
"description": "Design kit display name (often includes the tool and color theme.) Use title-case capitalization.",
"type": "string"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the kit.",
"type": "boolean"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tool": {
"description": "Design kit's compatible tool.",
"enum": [
"adobe-ase",
"adobe-xd",
"axure",
"figma",
"invision-freehand",
"sketch"
],
"type": "string"
},
"type": {
"description": "Design kit primary categorization.",
"enum": [
"elements",
"guidelines",
"ui",
"wireframes"
],
"type": "string"
},
"url": {
"description": "Design kit URL.",
"type": "string"
}
},
"required": [
"name",
"tool",
"type",
"status",
"url"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"$ref": {
"description": "Reference to a design kit.",
"type": "string"
}
},
"required": [
"$ref"
],
"type": "object"
}
]
}
},
"title": "Carbon Design Kit",
"type": "object"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"title",
"path"
]
},
{
"required": [
"title",
"items"
]
}
],
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, Github URL or path relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
carbon-design-system/carbon-platform | 10e629b9b1f98f5a02c60af31681cdbfa258b6cf | 2022-05-27T15:04:42 | packages/schemas/carbon-resources.schema.json | 22 | 2024-05-27T05:20:45.097582Z | {
"$id": "https://carbondesignsystem.com/schemas/carbon-resources.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Defines Assets and Libraries",
"minProperties": 1,
"properties": {
"assets": {
"description": "Object containing all assets",
"minProperties": 1,
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"description": "Assets are reusable units of work that are used in products and digital experiences. Every asset belongs to a library.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Asset description ideally between 50-160 characters in length. Use sentence-case capitalization.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"framework": {
"description": "Asset frontend framework.",
"enum": [
"angular",
"react",
"react-native",
"svelte",
"vanilla",
"vue",
"web-component",
"design-only"
],
"type": "string"
},
"name": {
"description": "Asset display name. Use sentence-case capitalization. All asset names in a library should be unique to prevent page collisions.",
"type": "string"
},
"navData": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the catalogs will exclude the asset.",
"type": "boolean"
},
"platform": {
"default": "web",
"description": "Asset environment.",
"enum": [
"cross-platform",
"web"
],
"type": "string"
},
"status": {
"description": "Used to set consumption expectations and the likelihood of future changes.",
"oneOf": [
{
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": "draft",
"enum": [
"deprecated",
"draft",
"experimental",
"stable"
],
"type": "string"
},
"note": {
"description": "Explains the key. This is often used to communicate the remaining effort to get something from draft or experimental to stable, estimated stability dates, and alternative assets to use when the asset has been deprecated.",
"type": "string"
}
},
"required": [
"key",
"note"
],
"type": "object"
}
]
},
"tags": {
"description": "Asset secondary categorizations.",
"items": {
"enum": [
"content-block",
"content-element",
"contextual-navigation",
"data-display",
"data-visualization",
"form",
"input-control",
"media",
"shell",
"structural-navigation",
"system-feedback",
"comparison",
"connection",
"correlation",
"geographic-overlay",
"geospatial-distortion",
"part-to-whole",
"trend",
"hook",
"service",
"utility"
]
},
"minItems": 1,
"type": "array"
},
"thumbnailPath": {
"description": "Relative location of the asset's thumbnail image.",
"type": "string"
},
"type": {
"description": "Asset categorization.",
"enum": [
"component",
"element",
"function",
"template",
"pattern"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
},
"title": "Carbon Asset",
"type": "object"
},
"library": {
"additionalProperties": false,
"description": "Libraries are the means to contribute, install, and use one or many assets in products and digital experiences.",
"properties": {
"demoLinks": {
"description": "Libraries and assets can specify links to demo sites.",
"items": {
"additionalProperties": false,
"properties": {
"action": {
"default": "link",
"description": "Determines the action icon.",
"enum": [
"download",
"link"
],
"type": "string"
},
"name": {
"description": "Display name.",
"type": "string"
},
"type": {
"description": "Determines the display icon.",
"enum": [
"codesandbox",
"github",
"storybook"
],
"type": "string"
},
"url": {
"description": "Link to the resource.",
"type": "string"
}
},
"required": [
"type",
"name",
"url"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"description": {
"description": "Library description ideally between 50-160 characters in length. Use sentence-case capitalization. Defaults to the package.json description if not set here.",
"type": "string"
},
"externalDocsUrl": {
"description": "Absolute URL to externally-hosted documentation.",
"type": "string"
},
"id": {
"description": "Every library needs an identifier unique to the platform. Contact the Carbon Platform Devs to receive an id when registering a new library.",
"type": "string"
},
"inherits": {
"description": "Inherit properties from another library on a per-asset basis by specifying a library id optionally followed by @ and a version number.",
"type": "string"
},
"name": {
"description": "Library display name. Use title-case capitalization.",
"type": "string"
},
"navData": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"items": {
"description": "Libraries and assets have documentation pages that are specific to their library.",
"items": {
"additionalProperties": false,
"properties": {
"hidden": {
"default": false,
"description": "If set to true, the item will be hidden from the navigation.",
"type": "boolean"
},
"path": {
"description": "Path to the file, relative to carbon.yml.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"path": {
"description": "Relative path to the file.",
"type": "string"
},
"title": {
"description": "Navigation title.",
"type": "string"
}
},
"required": [
"title",
"path"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"noIndex": {
"default": false,
"description": "If set to true, the global catalogs will exclude the library.",
"type": "boolean"
},
"packageJsonPath": {
"default": "/package.json",
"description": "Relative location of the library's package.json. This is used to reference the library's license, version, code package, and other information.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Carbon Library",
"type": "object"
}
},
"title": "Carbon Resources",
"type": "object"
} | Apache-2.0 | en |
Burningstone91/smart-home-setup | 0a13dc4c7d2cde32a71a6cc348dcd4e436d4fde4 | 2021-09-07T16:18:43 | home-assistant/custom_components/powercalc/data/model_schema.json | 533 | 2024-05-28T04:07:15.100368Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "model.json described a light model",
"properties": {
"fixed_config": {
"description": "Configuration for fixed calculation mode",
"properties": {
"watt": {
"type": "number"
}
},
"type": "object"
},
"linear_config": {
"description": "Configuration for linear calculation mode",
"properties": {
"max_watt": {
"type": "number"
},
"min_watt": {
"type": "number"
}
},
"type": "object"
},
"measure_description": {
"description": "Add more information about how you measured the light or any remarks",
"type": "string"
},
"measure_device": {
"description": "Device which was used to measure",
"type": "string"
},
"measure_method": {
"description": "How the light was measured",
"enum": [
"manual",
"script"
],
"type": "string"
},
"name": {
"description": "The full name",
"type": "string"
},
"standby_usage": {
"description": "Power draw when the light is turned of. When you are not able to measure set to 0.4",
"type": "number"
},
"supported_modes": {
"description": "Supported calculation modes",
"items": {
"enum": [
"lut",
"linear",
"fixed"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"standby_usage",
"supported_modes",
"measure_method",
"measure_device"
],
"type": "object"
} | MIT | en |
lmstudio-ai/lmstudio.js | 27c62516c83bca6c85e6676fdfff7f5edd372786 | 2024-04-25T19:11:47 | scaffolds/scaffold-json-schema-v1.json | 183 | 2024-05-27T06:04:37.987716Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"args": {
"items": {
"properties": {
"default": {
"type": "string"
},
"isProjectName": {
"type": "boolean"
},
"name": {
"type": "string"
},
"replaceFrom": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"default"
],
"type": "object"
},
"type": "array"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"motd": {
"items": {
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"regular",
"title",
"command",
"hint"
],
"type": "string"
}
},
"required": [
"type",
"text"
],
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"renames": {
"items": {
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"required": [
"from",
"to"
],
"type": "object"
},
"type": "array"
},
"scaffoldVersion": {
"type": "number"
}
},
"required": [
"scaffoldVersion",
"name",
"displayName",
"description",
"args",
"motd"
],
"type": "object"
} | Apache-2.0 | null |
lmstudio-ai/lmstudio.js | ed12566ac918eec0e8f10583d1ee8f813306ea45 | 2024-04-25T14:27:00 | scaffolds/scaffold-json-schema-v1.json | 183 | 2024-05-27T06:04:37.987716Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"args": {
"items": {
"properties": {
"default": {
"type": "string"
},
"isProjectName": {
"type": "boolean"
},
"name": {
"type": "string"
},
"replaceFrom": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"default"
],
"type": "object"
},
"type": "array"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"name": {
"type": "string"
},
"scaffoldVersion": {
"type": "number"
}
},
"required": [
"scaffoldVersion",
"name",
"displayName",
"description",
"args"
],
"type": "object"
} | Apache-2.0 | null |
lmstudio-ai/lmstudio.js | 0c1fa3317961e31caa8240377fd14dfceb001ba5 | 2024-04-25T18:44:19 | scaffolds/scaffold-json-schema-v1.json | 183 | 2024-05-27T06:04:37.987716Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"args": {
"items": {
"properties": {
"default": {
"type": "string"
},
"isProjectName": {
"type": "boolean"
},
"name": {
"type": "string"
},
"replaceFrom": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"default"
],
"type": "object"
},
"type": "array"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"motd": {
"items": {
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"regular",
"title",
"command",
"hint"
],
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"renames": {
"items": {
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"required": [
"from",
"to"
],
"type": "object"
},
"type": "array"
},
"scaffoldVersion": {
"type": "number"
}
},
"required": [
"scaffoldVersion",
"name",
"displayName",
"description",
"args",
"motd"
],
"type": "object"
} | Apache-2.0 | null |
PostHog/posthog-foss | 961e23e6d35be8b7967288e2557d783e5629ae83 | 2022-07-30T16:15:30 | posthog/idl/plugin_log_entries.json | 216 | 2024-05-28T06:08:40.898263Z | {
"$id": "file://posthog/idl/plugin_log_entries.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Plugin log entries that are destined for ClickHouse",
"properties": {
"id": {
"description": "UUID for the log entry",
"type": "string"
},
"instance_id": {
"description": "UUID of the instance that generated the log entry",
"type": "string"
},
"message": {
"description": "Log entry body",
"type": "string"
},
"plugin_config_id": {
"description": "Plugin Config ID associated with the log entry",
"type": "number"
},
"plugin_id": {
"description": "Plugin ID associated with the log entry",
"type": "number"
},
"source": {
"description": "Source of the log entry",
"type": "string"
},
"team_id": {
"description": "Team ID associated with person_distinct_id",
"type": "number"
},
"timestamp": {
"description": "Timestamp for when the log entry was created",
"type": "number"
},
"type": {
"description": "Log entry type",
"type": "string"
}
},
"required": [
"id",
"team_id",
"plugin_id",
"plugin_config_id",
"timestamp",
"source",
"type",
"message",
"instance_id"
],
"title": "plugin_log_entries",
"type": "object"
} | MIT | en |
PostHog/posthog-foss | 961e23e6d35be8b7967288e2557d783e5629ae83 | 2022-07-30T16:15:30 | posthog/idl/events_json.json | 216 | 2024-05-28T06:08:40.898263Z | {
"$id": "file://posthog/idl/events_json.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Event schema that is destined for ClickHouse",
"properties": {
"created_at": {
"description": "Timestamp when event was created",
"type": "number"
},
"distinct_id": {
"description": "PostHog distinct_id",
"type": "string"
},
"elements_chain": {
"description": "Used for autocapture. DOM element hierarchy",
"type": "string"
},
"event": {
"description": "event type",
"type": "string"
},
"group0_created_at": {
"description": "Group's creation timestamp",
"type": "number"
},
"group0_properties": {
"description": "String representation of a group's properties",
"type": "string"
},
"group1_created_at": {
"description": "Group's creation timestamp",
"type": "number"
},
"group1_properties": {
"description": "String representation of a group's properties",
"type": "string"
},
"group2_created_at": {
"description": "Group's creation timestamp",
"type": "number"
},
"group2_properties": {
"description": "String representation of a group's properties",
"type": "string"
},
"group3_created_at": {
"description": "Group's creation timestamp",
"type": "number"
},
"group3_properties": {
"description": "String representation of a group's properties",
"type": "string"
},
"group4_created_at": {
"description": "Group's creation timestamp",
"type": "number"
},
"group4_properties": {
"description": "String representation of a group's properties",
"type": "string"
},
"person_created_at": {
"description": "Timestamp for when the associated person was created",
"type": "number"
},
"person_id": {
"description": "UUID for the associated person if available",
"type": "string"
},
"person_properties": {
"description": "String representation of the person JSON object",
"type": "string"
},
"properties": {
"description": "String representation of the properties json object",
"type": "string"
},
"team_id": {
"description": "team_id (maps to the project under the organization)",
"type": "number"
},
"timestamp": {
"description": "Timestamp that the event occurred",
"type": "number"
},
"uuid": {
"description": "uuid for the event",
"type": "string"
}
},
"required": [
"uuid",
"event",
"properties",
"timestamp",
"team_id"
],
"title": "events_json",
"type": "object"
} | MIT | en |
PostHog/posthog-foss | 961e23e6d35be8b7967288e2557d783e5629ae83 | 2022-07-30T16:15:30 | posthog/idl/person.json | 216 | 2024-05-28T06:08:40.898263Z | {
"$id": "file://posthog/idl/person.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Person schema that is destined for ClickHouse",
"properties": {
"created_at": {
"description": "Person creation timestamp",
"type": "number"
},
"id": {
"description": "UUID for the person",
"type": "string"
},
"is_deleted": {
"description": "Boolean is the person deleted?",
"type": "boolean"
},
"is_identified": {
"description": "Boolean is the person identified?",
"type": "boolean"
},
"properties": {
"description": "String representation of person JSON properties object",
"type": "string"
},
"team_id": {
"description": "Team ID associated with person",
"type": "number"
},
"version": {
"description": "Version field for collapsing later (psuedo-tombstone)",
"type": "number"
}
},
"required": [
"id",
"created_at",
"team_id",
"properties",
"is_identified",
"is_deleted",
"version"
],
"title": "person",
"type": "object"
} | MIT | en |
PostHog/posthog-foss | 961e23e6d35be8b7967288e2557d783e5629ae83 | 2022-07-30T16:15:30 | posthog/idl/person_distinct_id.json | 216 | 2024-05-28T06:08:40.898263Z | {
"$id": "file://posthog/idl/person_distinct_id.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Person distinct id schema that is destined for ClickHouse",
"properties": {
"_sign": {
"description": "Used for collapsing later different versions of a distinct id (psuedo-tombstone)",
"type": "number"
},
"distinct_id": {
"description": "User provided ID for the distinct user",
"type": "string"
},
"is_deleted": {
"description": "Boolean is the person distinct_id deleted?",
"type": "boolean"
},
"person_id": {
"description": "UUID of the person",
"type": "string"
},
"team_id": {
"description": "Team ID associated with person_distinct_id",
"type": "number"
}
},
"required": [
"distinct_id",
"person_id",
"team_id",
"_sign",
"is_deleted"
],
"title": "person_distinct_id",
"type": "object"
} | MIT | en |
PostHog/posthog-foss | 961e23e6d35be8b7967288e2557d783e5629ae83 | 2022-07-30T16:15:30 | posthog/idl/events_dead_letter_queue.json | 216 | 2024-05-28T06:08:40.898263Z | {
"$id": "file://posthog/idl/events_dead_letter_queue.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Events that failed to be validated or processed and are sent to the DLQ",
"properties": {
"created_at": {
"description": "Used for autocapture. DOM element hierarchy",
"type": "number"
},
"distinct_id": {
"description": "PostHog distinct_id",
"type": "string"
},
"elements_chain": {
"description": "Used for autocapture. DOM element hierarchy",
"type": "string"
},
"error": {
"description": "Error if known",
"type": "string"
},
"error_location": {
"description": "Source of error if known",
"type": "string"
},
"error_timestamp": {
"description": "Timestamp that the error of ingestion occurred",
"type": "number"
},
"event": {
"description": "event type",
"type": "string"
},
"event_uuid": {
"description": "uuid for the event",
"type": "string"
},
"id": {
"description": "uuid for the submission",
"type": "string"
},
"ip": {
"description": "IP Address of the associated with the event",
"type": "string"
},
"now": {
"description": "Timestamp of the DLQ event",
"type": "number"
},
"properties": {
"description": "String representation of the properties json object",
"type": "string"
},
"raw_payload": {
"description": "Raw payload of the event that failed to be consumed",
"type": "string"
},
"site_url": {
"description": "Site URL associated with the event the event",
"type": "string"
},
"tags": {
"description": "Tags associated with the error or event",
"items": {
"type": "string"
},
"type": "array"
},
"team_id": {
"description": "team_id (maps to the project under the organization)",
"type": "number"
}
},
"required": [
"raw_payload"
],
"title": "events_dead_letter_queue",
"type": "object"
} | MIT | en |
PostHog/posthog-foss | 961e23e6d35be8b7967288e2557d783e5629ae83 | 2022-07-30T16:15:30 | posthog/idl/person_distinct_id2.json | 216 | 2024-05-28T06:08:40.898263Z | {
"$id": "file://posthog/idl/person_distinct_id2.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Person distinct id2 schema that is destined for ClickHouse",
"properties": {
"distinct_id": {
"description": "User provided ID for the distinct user",
"type": "string"
},
"is_deleted": {
"description": "Boolean is the person distinct_id deleted?",
"type": "boolean"
},
"person_id": {
"description": "UUID of the person",
"type": "string"
},
"team_id": {
"description": "Team ID associated with person_distinct_id",
"type": "number"
},
"version": {
"description": "Used for collapsing later different versions of a distinct id (psuedo-tombstone)",
"type": "number"
}
},
"required": [
"distinct_id",
"person_id",
"team_id",
"version",
"is_deleted"
],
"title": "person_distinct_id2",
"type": "object"
} | MIT | en |
PostHog/posthog-foss | 961e23e6d35be8b7967288e2557d783e5629ae83 | 2022-07-30T16:15:30 | posthog/idl/groups.json | 216 | 2024-05-28T06:08:40.898263Z | {
"$id": "file://posthog/idl/groups.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Groups schema that is destined for ClickHouse",
"properties": {
"created_at": {
"description": "Group creation timestamp",
"type": "number"
},
"group_key": {
"description": "Group Key",
"type": "string"
},
"group_properties": {
"description": "String representation of group JSON properties object",
"type": "string"
},
"group_type_index": {
"description": "Group type index",
"type": "number"
},
"team_id": {
"description": "Team ID associated with group",
"type": "number"
}
},
"required": [
"group_type_index",
"group_key",
"created_at",
"team_id",
"group_properties"
],
"title": "groups",
"type": "object"
} | MIT | en |
heutelbeck/sapl-policy-engine | 7bd608d054a9f3183b4a2d368ac0242df1401662 | 2023-05-31T12:46:36 | sapl-lang/src/test/resources/schemas/person_schema.json | 39 | 2024-05-28T06:01:49.183322Z | {
"$id": "https://example.com/schemas/regions",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
heutelbeck/sapl-policy-engine | 29f7419cf1aee22ea95b17805ec16fca7cd4dcd7 | 2023-05-14T13:43:32 | sapl-lang/src/test/resources/schemas/person_schema.json | 39 | 2024-05-28T06:01:49.183322Z | {
"$id": "https://example.com/schemas/regions",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"age": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
quarkiverse/quarkus-operator-sdk | 40d04a723c9d2d6f75b24d2dd6cfd7b5b93a5235 | 2024-02-08T16:32:45 | core/deployment/src/main/resources/helm/static/values.schema.json | 115 | 2024-05-28T01:22:01.28861Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"watchNamespaces": {
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | null |
quarkiverse/quarkus-operator-sdk | b3a9aa42dfcc96d0687bca90822ea7e06e58a475 | 2023-08-29T12:56:53 | core/deployment/src/main/resources/helm/static/values.schema.json | 115 | 2024-05-28T01:22:01.28861Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"version": {
"type": "string"
},
"watchNamespaces": {
"type": "string"
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | null |
oku-ui/pergel | 9aec01f0bb887d41c949d9c425e7793d9da9dcae | 2024-01-02T15:03:08 | packages/nuxt/scripts/compose-spec.json | 109 | 2024-05-27T05:37:15.164152Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"additionalProperties": false,
"definitions": {
"blkio_limit": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"rate": {
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"blkio_weight": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"weight": {
"type": "integer"
}
},
"type": "object"
},
"command": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"config": {
"additionalProperties": false,
"id": "#/definitions/config",
"patternProperties": {
"^x-": {}
},
"properties": {
"content": {
"type": "string"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"constraints": {
"service": {
"anyOf": [
{
"required": [
"build"
]
},
{
"required": [
"image"
]
}
],
"id": "#/definitions/constraints/service",
"properties": {
"build": {
"required": [
"context"
]
}
}
}
},
"deployment": {
"additionalProperties": false,
"id": "#/definitions/deployment",
"patternProperties": {
"^x-": {}
},
"properties": {
"endpoint_mode": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"mode": {
"type": "string"
},
"placement": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"constraints": {
"items": {
"type": "string"
},
"type": "array"
},
"max_replicas_per_node": {
"type": "integer"
},
"preferences": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"spread": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"replicas": {
"type": "integer"
},
"resources": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"limits": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"memory": {
"type": "string"
},
"pids": {
"type": "integer"
}
},
"type": "object"
},
"reservations": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cpus": {
"type": [
"number",
"string"
]
},
"devices": {
"$ref": "#/definitions/devices"
},
"generic_resources": {
"$ref": "#/definitions/generic_resources"
},
"memory": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"restart_policy": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"type": "string"
},
"delay": {
"format": "duration",
"type": "string"
},
"max_attempts": {
"type": "integer"
},
"window": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"rollback_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
},
"update_config": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"delay": {
"format": "duration",
"type": "string"
},
"failure_action": {
"type": "string"
},
"max_failure_ratio": {
"type": "number"
},
"monitor": {
"format": "duration",
"type": "string"
},
"order": {
"enum": [
"start-first",
"stop-first"
],
"type": "string"
},
"parallelism": {
"type": "integer"
}
},
"type": "object"
}
},
"type": [
"object",
"null"
]
},
"development": {
"id": "#/definitions/development",
"properties": {
"watch": {
"additionalProperties": false,
"items": {
"properties": {
"action": {
"enum": [
"rebuild",
"sync",
"sync+restart"
],
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"patternProperties": {
"^x-": {}
},
"required": [
"path",
"action"
],
"type": "array"
}
},
"type": [
"object",
"null"
]
},
"devices": {
"id": "#/definitions/devices",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"capabilities": {
"$ref": "#/definitions/list_of_strings"
},
"count": {
"type": [
"string",
"integer"
]
},
"device_ids": {
"$ref": "#/definitions/list_of_strings"
},
"driver": {
"type": "string"
},
"options": {
"$ref": "#/definitions/list_or_dict"
}
},
"type": "object"
},
"type": "array"
},
"env_file": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"type": "object"
}
]
},
"type": "array"
}
]
},
"generic_resources": {
"id": "#/definitions/generic_resources",
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"discrete_resource_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"healthcheck": {
"additionalProperties": false,
"id": "#/definitions/healthcheck",
"patternProperties": {
"^x-": {}
},
"properties": {
"disable": {
"type": "boolean"
},
"interval": {
"format": "duration",
"type": "string"
},
"retries": {
"type": "number"
},
"start_interval": {
"format": "duration",
"type": "string"
},
"start_period": {
"format": "duration",
"type": "string"
},
"test": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"timeout": {
"format": "duration",
"type": "string"
}
},
"type": "object"
},
"include": {
"id": "#/definitions/include",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"env_file": {
"$ref": "#/definitions/string_or_list"
},
"path": {
"$ref": "#/definitions/string_or_list"
},
"project_directory": {
"type": "string"
}
},
"type": "object"
}
]
},
"list_of_strings": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"list_or_dict": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
".+": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"type": "object"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"network": {
"additionalProperties": false,
"id": "#/definitions/network",
"patternProperties": {
"^x-": {}
},
"properties": {
"attachable": {
"type": "boolean"
},
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"enable_ipv6": {
"type": "boolean"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"internal": {
"type": "boolean"
},
"ipam": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"items": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aux_addresses": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
},
"gateway": {
"type": "string"
},
"ip_range": {
"type": "string"
},
"subnet": {
"format": "subnet_ip_address",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"driver": {
"type": "string"
},
"options": {
"additionalProperties": false,
"patternProperties": {
"^.+$": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"secret": {
"additionalProperties": false,
"id": "#/definitions/secret",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"environment": {
"type": "string"
},
"external": {
"properties": {
"name": {
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"file": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
},
"template_driver": {
"type": "string"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"id": "#/definitions/service",
"patternProperties": {
"^x-": {}
},
"properties": {
"annotations": {
"$ref": "#/definitions/list_or_dict"
},
"attach": {
"type": "boolean"
},
"blkio_config": {
"additionalProperties": false,
"properties": {
"device_read_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_read_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_bps": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"device_write_iops": {
"items": {
"$ref": "#/definitions/blkio_limit"
},
"type": "array"
},
"weight": {
"type": "integer"
},
"weight_device": {
"items": {
"$ref": "#/definitions/blkio_weight"
},
"type": "array"
}
},
"type": "object"
},
"build": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"additional_contexts": {
"$ref": "#/definitions/list_or_dict"
},
"args": {
"$ref": "#/definitions/list_or_dict"
},
"cache_from": {
"items": {
"type": "string"
},
"type": "array"
},
"cache_to": {
"items": {
"type": "string"
},
"type": "array"
},
"context": {
"type": "string"
},
"dockerfile": {
"type": "string"
},
"dockerfile_inline": {
"type": "string"
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"network": {
"type": "string"
},
"no_cache": {
"type": "boolean"
},
"platforms": {
"items": {
"type": "string"
},
"type": "array"
},
"privileged": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"shm_size": {
"type": [
"integer",
"string"
]
},
"ssh": {
"$ref": "#/definitions/list_or_dict"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"type": "string"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
}
},
"type": "object"
}
]
},
"cap_add": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cap_drop": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cgroup": {
"enum": [
"host",
"private"
],
"type": "string"
},
"cgroup_parent": {
"type": "string"
},
"command": {
"$ref": "#/definitions/command"
},
"configs": {
"$ref": "#/definitions/service_config_or_secret"
},
"container_name": {
"type": "string"
},
"cpu_count": {
"minimum": 0,
"type": "integer"
},
"cpu_percent": {
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"cpu_period": {
"type": [
"number",
"string"
]
},
"cpu_quota": {
"type": [
"number",
"string"
]
},
"cpu_rt_period": {
"type": [
"number",
"string"
]
},
"cpu_rt_runtime": {
"type": [
"number",
"string"
]
},
"cpu_shares": {
"type": [
"number",
"string"
]
},
"cpus": {
"type": [
"number",
"string"
]
},
"cpuset": {
"type": "string"
},
"credential_spec": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"config": {
"type": "string"
},
"file": {
"type": "string"
},
"registry": {
"type": "string"
}
},
"type": "object"
},
"depends_on": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"additionalProperties": false,
"properties": {
"condition": {
"enum": [
"service_started",
"service_healthy",
"service_completed_successfully"
],
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"restart": {
"type": "boolean"
}
},
"required": [
"condition"
],
"type": "object"
}
},
"type": "object"
}
]
},
"deploy": {
"$ref": "#/definitions/deployment"
},
"develop": {
"$ref": "#/definitions/development"
},
"device_cgroup_rules": {
"$ref": "#/definitions/list_of_strings"
},
"devices": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns": {
"$ref": "#/definitions/string_or_list"
},
"dns_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"dns_search": {
"$ref": "#/definitions/string_or_list"
},
"domainname": {
"type": "string"
},
"entrypoint": {
"$ref": "#/definitions/command"
},
"env_file": {
"$ref": "#/definitions/env_file"
},
"environment": {
"$ref": "#/definitions/list_or_dict"
},
"expose": {
"items": {
"format": "expose",
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"extends": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"file": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"service"
],
"type": "object"
}
]
},
"external_links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"extra_hosts": {
"$ref": "#/definitions/list_or_dict"
},
"group_add": {
"items": {
"type": [
"string",
"number"
]
},
"type": "array",
"uniqueItems": true
},
"healthcheck": {
"$ref": "#/definitions/healthcheck"
},
"hostname": {
"type": "string"
},
"image": {
"type": "string"
},
"init": {
"type": "boolean"
},
"ipc": {
"type": "string"
},
"isolation": {
"type": "string"
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"links": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"logging": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"options": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
},
"mac_address": {
"type": "string"
},
"mem_limit": {
"type": [
"number",
"string"
]
},
"mem_reservation": {
"type": [
"string",
"integer"
]
},
"mem_swappiness": {
"type": "integer"
},
"memswap_limit": {
"type": [
"number",
"string"
]
},
"network_mode": {
"type": "string"
},
"networks": {
"oneOf": [
{
"$ref": "#/definitions/list_of_strings"
},
{
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"oneOf": [
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aliases": {
"$ref": "#/definitions/list_of_strings"
},
"ipv4_address": {
"type": "string"
},
"ipv6_address": {
"type": "string"
},
"link_local_ips": {
"$ref": "#/definitions/list_of_strings"
},
"mac_address": {
"type": "string"
},
"priority": {
"type": "number"
}
},
"type": "object"
},
{
"type": "null"
}
]
}
},
"type": "object"
}
]
},
"oom_kill_disable": {
"type": "boolean"
},
"oom_score_adj": {
"maximum": 1000,
"minimum": -1000,
"type": "integer"
},
"pid": {
"type": [
"string",
"null"
]
},
"pids_limit": {
"type": [
"number",
"string"
]
},
"platform": {
"type": "string"
},
"ports": {
"items": {
"oneOf": [
{
"format": "ports",
"type": "number"
},
{
"format": "ports",
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"host_ip": {
"type": "string"
},
"mode": {
"type": "string"
},
"protocol": {
"type": "string"
},
"published": {
"type": [
"string",
"integer"
]
},
"target": {
"type": "integer"
}
},
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"privileged": {
"type": "boolean"
},
"profiles": {
"$ref": "#/definitions/list_of_strings"
},
"pull_policy": {
"enum": [
"always",
"never",
"if_not_present",
"build",
"missing"
],
"type": "string"
},
"read_only": {
"type": "boolean"
},
"restart": {
"type": "string"
},
"runtime": {
"type": "string"
},
"scale": {
"type": "integer"
},
"secrets": {
"$ref": "#/definitions/service_config_or_secret"
},
"security_opt": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"shm_size": {
"type": [
"number",
"string"
]
},
"stdin_open": {
"type": "boolean"
},
"stop_grace_period": {
"format": "duration",
"type": "string"
},
"stop_signal": {
"type": "string"
},
"storage_opt": {
"type": "object"
},
"sysctls": {
"$ref": "#/definitions/list_or_dict"
},
"tmpfs": {
"$ref": "#/definitions/string_or_list"
},
"tty": {
"type": "boolean"
},
"ulimits": {
"$ref": "#/definitions/ulimits"
},
"user": {
"type": "string"
},
"userns_mode": {
"type": "string"
},
"uts": {
"type": "string"
},
"volumes": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bind": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"create_host_path": {
"type": "boolean"
},
"propagation": {
"type": "string"
},
"selinux": {
"enum": [
"z",
"Z"
],
"type": "string"
}
},
"type": "object"
},
"consistency": {
"type": "string"
},
"read_only": {
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"tmpfs": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"mode": {
"type": "number"
},
"size": {
"oneOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"type": {
"type": "string"
},
"volume": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"nocopy": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array",
"uniqueItems": true
},
"volumes_from": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"working_dir": {
"type": "string"
}
},
"type": "object"
},
"service_config_or_secret": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gid": {
"type": "string"
},
"mode": {
"type": "number"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
]
},
"type": "array"
},
"string_or_list": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/list_of_strings"
}
]
},
"ulimits": {
"patternProperties": {
"^[a-z]+$": {
"oneOf": [
{
"type": "integer"
},
{
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
}
},
"required": [
"soft",
"hard"
],
"type": "object"
}
]
}
},
"type": "object"
},
"volume": {
"additionalProperties": false,
"id": "#/definitions/volume",
"patternProperties": {
"^x-": {}
},
"properties": {
"driver": {
"type": "string"
},
"driver_opts": {
"patternProperties": {
"^.+$": {
"type": [
"string",
"number"
]
}
},
"type": "object"
},
"external": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"deprecated": true,
"type": "string"
}
},
"type": [
"boolean",
"object"
]
},
"labels": {
"$ref": "#/definitions/list_or_dict"
},
"name": {
"type": "string"
}
},
"type": [
"object",
"null"
]
}
},
"description": "The Compose file is a YAML file defining a multi-containers based application.",
"id": "compose_spec.json",
"patternProperties": {
"^x-": {}
},
"properties": {
"configs": {
"additionalProperties": false,
"id": "#/properties/configs",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/config"
}
},
"type": "object"
},
"include": {
"description": "compose sub-projects to be included.",
"items": {
"$ref": "#/definitions/include",
"type": "object"
},
"type": "array"
},
"name": {
"description": "define the Compose project name, until user defines one explicitly.",
"pattern": "^[a-z0-9][a-z0-9_-]*$",
"type": "string"
},
"networks": {
"id": "#/properties/networks",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/network"
}
},
"type": "object"
},
"secrets": {
"additionalProperties": false,
"id": "#/properties/secrets",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/secret"
}
},
"type": "object"
},
"services": {
"additionalProperties": false,
"id": "#/properties/services",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/service"
}
},
"type": "object"
},
"version": {
"description": "declared for backward compatibility, ignored.",
"type": "string"
},
"volumes": {
"additionalProperties": false,
"id": "#/properties/volumes",
"patternProperties": {
"^[a-zA-Z0-9._-]+$": {
"$ref": "#/definitions/volume"
}
},
"type": "object"
}
},
"title": "Compose Specification",
"type": "object"
} | MIT | en |
aws-greengrass/aws-greengrass-gdk-cli | 3b709c5926578f8bedba018b2e1957556ffc9d12 | 2023-04-21T19:06:42 | gdk/static/cli_model_schema.json | 27 | 2024-05-27T05:54:00.851262Z | {
"$defs": {
"arg_groups": {
"additionalItems": true,
"description": "Group the compatible arguments of a command in arrays to display them in a separate group in cli help.",
"items": {
"additionalProperties": true,
"description": "List of argument groups of a command.",
"properties": {
"args": {
"additionalItems": true,
"description": "List of arguments that are passed together with the cli command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"description": {
"description": "Brief description of what the command with this argument group does.",
"type": "string"
},
"title": {
"default": "",
"description": "Short title that briefly explains the argument group.",
"type": "string"
}
},
"required": [
"title",
"args",
"description"
],
"type": "object"
},
"type": "array"
},
"argument": {
"description": "Name of the argument.",
"required": [
"name",
"help"
],
"type": "object"
},
"build": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"component": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"build": {
"$ref": "#/$defs/build"
},
"init": {
"$ref": "#/$defs/init"
},
"list": {
"$ref": "#/$defs/list"
},
"publish": {
"$ref": "#/$defs/publish"
}
},
"required": [
"init",
"build",
"publish",
"list"
]
}
},
"type": "object"
},
"conflicting_arg_groups": {
"additionalItems": true,
"description": "Array of arrays where arguments of one array conflict with arguments of another array.",
"items": {
"additionalItems": true,
"description": "Array of arguments that can go together with a command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"type": "array"
},
"help": {
"description": "Description of the command which is displayed in the cli help message.",
"type": "string"
},
"init": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arg_groups": {
"$ref": "#/$defs/arg_groups"
},
"arguments": {
"description": "List of all the arguments that can be passed with the init command.",
"properties": {
"language": {
"$ref": "#/$defs/argument"
},
"name": {
"$ref": "#/$defs/argument"
},
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"language",
"repository",
"template",
"name"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"arguments",
"conflicting_arg_groups",
"arg_groups",
"help"
],
"type": "object"
},
"list": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the list command.",
"properties": {
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"template",
"repository"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"publish": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the publish command.",
"properties": {
"bucket": {
"$ref": "#/$defs/argument"
}
},
"required": [
"bucket"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "This is gdk cli model where every key in this json model represents a command or sub-command of the cli tool.",
"properties": {
"gdk": {
"description": "This is the name of the cli tool that is used as top-level parser of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"additionalProperties": false,
"properties": {
"component": {
"$ref": "#/$defs/component"
}
},
"required": [
"component"
]
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
}
},
"required": [
"gdk"
],
"type": "object"
} | Apache-2.0 | en |
aws-greengrass/aws-greengrass-gdk-cli | 4b88331624e4d16dc54bfece06b6bbfbd224e03d | 2021-12-17T18:31:21 | gdk/static/cli_model_schema.json | 27 | 2024-05-27T05:54:00.851262Z | {
"$defs": {
"arg_groups": {
"additionalItems": true,
"description": "Group the compatible arguments of a command in arrays to display them in a separate group in cli help.",
"items": {
"additionalProperties": true,
"description": "List of argument groups of a command.",
"properties": {
"args": {
"additionalItems": true,
"description": "List of arguments that are passed together with the cli command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"description": {
"description": "Brief description of what the command with this argument group does.",
"type": "string"
},
"title": {
"default": "",
"description": "Short title that briefly explains the argument group.",
"type": "string"
}
},
"required": [
"title",
"args",
"description"
],
"type": "object"
},
"type": "array"
},
"argument": {
"description": "Name of the argument.",
"required": [
"name",
"help"
],
"type": "object"
},
"conflicting_arg_groups": {
"additionalItems": true,
"description": "Array of arrays where arguments of one array conflict with arguments of another array.",
"items": {
"additionalItems": true,
"description": "Array of arguments that can go together with a command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"type": "array"
},
"help": {
"description": "Description of the command which is displayed in the cli help message.",
"type": "string"
},
"sub-commands": {
"additionalItems": true,
"description": "Array of all the sub commands of a command.",
"items": {
"description": "Name of the (sub) command.",
"type": "string"
},
"type": "array"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "This is gdk cli model where every key in this json model represents a command or sub-command of the cli tool.",
"properties": {
"build": {
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"component": {
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"$ref": "#/$defs/sub-commands"
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
},
"gdk": {
"description": "This is the name of the cli tool that is used as top-level parser of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"$ref": "#/$defs/sub-commands"
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
},
"init": {
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arg_groups": {
"$ref": "#/$defs/arg_groups"
},
"arguments": {
"description": "List of all the arguments that can be passed with the init command.",
"properties": {
"language": {
"$ref": "#/$defs/argument"
},
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"language",
"repository",
"template"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"arguments",
"conflicting_arg_groups",
"arg_groups",
"help"
],
"type": "object"
},
"list": {
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the list command.",
"properties": {
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"template",
"repository"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"publish": {
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
}
},
"required": [
"gdk",
"component",
"init",
"list",
"build",
"publish"
],
"type": "object"
} | Apache-2.0 | en |
aws-greengrass/aws-greengrass-gdk-cli | e4e664b71fc7e19dcdf926cbefc149ff33b6d11b | 2023-05-30T18:48:46 | gdk/static/cli_model_schema.json | 27 | 2024-05-27T05:54:00.851262Z | {
"$defs": {
"arg_groups": {
"additionalItems": true,
"description": "Group the compatible arguments of a command in arrays to display them in a separate group in cli help.",
"items": {
"additionalProperties": true,
"description": "List of argument groups of a command.",
"properties": {
"args": {
"additionalItems": true,
"description": "List of arguments that are passed together with the cli command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"description": {
"description": "Brief description of what the command with this argument group does.",
"type": "string"
},
"title": {
"default": "",
"description": "Short title that briefly explains the argument group.",
"type": "string"
}
},
"required": [
"title",
"args",
"description"
],
"type": "object"
},
"type": "array"
},
"argument": {
"description": "Name of the argument.",
"required": [
"name",
"help"
],
"type": "object"
},
"build": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"component": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"build": {
"$ref": "#/$defs/build"
},
"init": {
"$ref": "#/$defs/init"
},
"list": {
"$ref": "#/$defs/list"
},
"publish": {
"$ref": "#/$defs/publish"
}
},
"required": [
"init",
"build",
"publish",
"list"
]
}
},
"type": "object"
},
"conflicting_arg_groups": {
"additionalItems": true,
"description": "Array of arrays where arguments of one array conflict with arguments of another array.",
"items": {
"additionalItems": true,
"description": "Array of arguments that can go together with a command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"type": "array"
},
"help": {
"description": "Description of the command which is displayed in the cli help message.",
"type": "string"
},
"init": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arg_groups": {
"$ref": "#/$defs/arg_groups"
},
"arguments": {
"description": "List of all the arguments that can be passed with the init command.",
"properties": {
"language": {
"$ref": "#/$defs/argument"
},
"name": {
"$ref": "#/$defs/argument"
},
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"language",
"repository",
"template",
"name"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"arguments",
"conflicting_arg_groups",
"arg_groups",
"help"
],
"type": "object"
},
"list": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the list command.",
"properties": {
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"template",
"repository"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"publish": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the publish command.",
"properties": {
"bucket": {
"$ref": "#/$defs/argument"
}
},
"required": [
"bucket"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"test-e2e": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"init": {
"$ref": "#/$defs/test-e2e-init"
},
"run": {
"$ref": "#/$defs/test-e2e-run"
}
},
"required": [
"init",
"run"
]
}
},
"type": "object"
},
"test-e2e-init": {
"additionalProperties": false,
"description": "Sub command under 'test' command. This is one of the sub-parsers under 'test' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"test-e2e-run": {
"additionalProperties": false,
"description": "Sub command under 'test' command. This is one of the sub-parsers under 'test' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the test-e2e run command.",
"properties": {
"otf_options": {
"$ref": "#/$defs/argument"
}
},
"required": [
"otf_options"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "This is gdk cli model where every key in this json model represents a command or sub-command of the cli tool.",
"properties": {
"gdk": {
"description": "This is the name of the cli tool that is used as top-level parser of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"additionalProperties": false,
"properties": {
"component": {
"$ref": "#/$defs/component"
},
"test-e2e": {
"$ref": "#/$defs/test-e2e"
}
},
"required": [
"component",
"test-e2e"
]
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
}
},
"required": [
"gdk"
],
"type": "object"
} | Apache-2.0 | en |
aws-greengrass/aws-greengrass-gdk-cli | 019f0a0a753173f7595d7a688dfc7c018db933e2 | 2023-09-22T23:27:35 | gdk/static/cli_model_schema.json | 27 | 2024-05-27T05:54:00.851262Z | {
"$defs": {
"arg_groups": {
"additionalItems": true,
"description": "Group the compatible arguments of a command in arrays to display them in a separate group in cli help.",
"items": {
"additionalProperties": true,
"description": "List of argument groups of a command.",
"properties": {
"args": {
"additionalItems": true,
"description": "List of arguments that are passed together with the cli command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"description": {
"description": "Brief description of what the command with this argument group does.",
"type": "string"
},
"title": {
"default": "",
"description": "Short title that briefly explains the argument group.",
"type": "string"
}
},
"required": [
"title",
"args",
"description"
],
"type": "object"
},
"type": "array"
},
"argument": {
"description": "Name of the argument.",
"required": [
"name",
"help"
],
"type": "object"
},
"build": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"component": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"build": {
"$ref": "#/$defs/build"
},
"init": {
"$ref": "#/$defs/init"
},
"list": {
"$ref": "#/$defs/list"
},
"publish": {
"$ref": "#/$defs/publish"
}
},
"required": [
"init",
"build",
"publish",
"list"
]
}
},
"type": "object"
},
"config": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"update": {
"$ref": "#/$defs/update"
}
},
"required": [
"update"
]
}
},
"type": "object"
},
"conflicting_arg_groups": {
"additionalItems": true,
"description": "Array of arrays where arguments of one array conflict with arguments of another array.",
"items": {
"additionalItems": true,
"description": "Array of arguments that can go together with a command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"type": "array"
},
"help": {
"description": "Description of the command which is displayed in the cli help message.",
"type": "string"
},
"init": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arg_groups": {
"$ref": "#/$defs/arg_groups"
},
"arguments": {
"description": "List of all the arguments that can be passed with the init command.",
"properties": {
"language": {
"$ref": "#/$defs/argument"
},
"name": {
"$ref": "#/$defs/argument"
},
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"language",
"repository",
"template",
"name"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"arguments",
"conflicting_arg_groups",
"arg_groups",
"help"
],
"type": "object"
},
"list": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the list command.",
"properties": {
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"template",
"repository"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"publish": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the publish command.",
"properties": {
"bucket": {
"$ref": "#/$defs/argument"
}
},
"required": [
"bucket"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"test-e2e": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"init": {
"$ref": "#/$defs/test-e2e-init"
},
"run": {
"$ref": "#/$defs/test-e2e-run"
}
},
"required": [
"init",
"run"
]
}
},
"type": "object"
},
"test-e2e-init": {
"additionalProperties": false,
"description": "Sub command under 'test' command. This is one of the sub-parsers under 'test' parser.",
"properties": {
"arguments": {
"anyOf": [
{
"required": [
"otf_version"
]
},
{
"required": [
"gtf_version"
]
}
],
"description": "List of all the arguments that can be passed with the test-e2e init command.",
"properties": {
"gtf_version": {
"$ref": "#/$defs/argument"
},
"otf_version": {
"$ref": "#/$defs/argument"
}
}
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"test-e2e-run": {
"additionalProperties": false,
"description": "Sub command under 'test' command. This is one of the sub-parsers under 'test' parser.",
"properties": {
"arguments": {
"anyOf": [
{
"required": [
"otf_options"
]
},
{
"required": [
"gtf_options"
]
}
],
"description": "List of all the arguments that can be passed with the test-e2e run command.",
"properties": {
"gtf_options": {
"$ref": "#/$defs/argument"
},
"otf_options": {
"$ref": "#/$defs/argument"
}
}
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"update": {
"additionalProperties": false,
"description": "Sub command under 'config' command. This is one of the sub-parsers under 'config' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the config update command.",
"properties": {
"component": {
"$ref": "#/$defs/argument"
}
},
"required": [
"component"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "This is gdk cli model where every key in this json model represents a command or sub-command of the cli tool.",
"properties": {
"gdk": {
"description": "This is the name of the cli tool that is used as top-level parser of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"additionalProperties": false,
"properties": {
"component": {
"$ref": "#/$defs/component"
},
"config": {
"$ref": "#/$defs/config"
},
"test-e2e": {
"$ref": "#/$defs/test-e2e"
}
},
"required": [
"component",
"test-e2e",
"config"
]
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
}
},
"required": [
"gdk"
],
"type": "object"
} | Apache-2.0 | en |
aws-greengrass/aws-greengrass-gdk-cli | 32be01e889f9c82964ef9c3eed3be254d56e6a3a | 2022-01-21T19:22:35 | gdk/static/cli_model_schema.json | 27 | 2024-05-27T05:54:00.851262Z | {
"$defs": {
"arg_groups": {
"additionalItems": true,
"description": "Group the compatible arguments of a command in arrays to display them in a separate group in cli help.",
"items": {
"additionalProperties": true,
"description": "List of argument groups of a command.",
"properties": {
"args": {
"additionalItems": true,
"description": "List of arguments that are passed together with the cli command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"description": {
"description": "Brief description of what the command with this argument group does.",
"type": "string"
},
"title": {
"default": "",
"description": "Short title that briefly explains the argument group.",
"type": "string"
}
},
"required": [
"title",
"args",
"description"
],
"type": "object"
},
"type": "array"
},
"argument": {
"description": "Name of the argument.",
"required": [
"name",
"help"
],
"type": "object"
},
"conflicting_arg_groups": {
"additionalItems": true,
"description": "Array of arrays where arguments of one array conflict with arguments of another array.",
"items": {
"additionalItems": true,
"description": "Array of arguments that can go together with a command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"type": "array"
},
"help": {
"description": "Description of the command which is displayed in the cli help message.",
"type": "string"
},
"sub-commands": {
"additionalItems": true,
"description": "Array of all the sub commands of a command.",
"items": {
"description": "Name of the (sub) command.",
"type": "string"
},
"type": "array"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "This is gdk cli model where every key in this json model represents a command or sub-command of the cli tool.",
"properties": {
"build": {
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"component": {
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"$ref": "#/$defs/sub-commands"
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
},
"gdk": {
"description": "This is the name of the cli tool that is used as top-level parser of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"$ref": "#/$defs/sub-commands"
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
},
"init": {
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arg_groups": {
"$ref": "#/$defs/arg_groups"
},
"arguments": {
"description": "List of all the arguments that can be passed with the init command.",
"properties": {
"language": {
"$ref": "#/$defs/argument"
},
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"language",
"repository",
"template"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"arguments",
"conflicting_arg_groups",
"arg_groups",
"help"
],
"type": "object"
},
"list": {
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the list command.",
"properties": {
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"template",
"repository"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"publish": {
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the publish command.",
"properties": {
"bucket": {
"$ref": "#/$defs/argument"
}
},
"required": [
"bucket"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
}
},
"required": [
"gdk",
"component",
"init",
"list",
"build",
"publish"
],
"type": "object"
} | Apache-2.0 | en |
aws-greengrass/aws-greengrass-gdk-cli | d1c0df151410c6a29deab944b65c509c2dab6d39 | 2023-05-30T18:48:56 | gdk/static/cli_model_schema.json | 27 | 2024-05-27T05:54:00.851262Z | {
"$defs": {
"arg_groups": {
"additionalItems": true,
"description": "Group the compatible arguments of a command in arrays to display them in a separate group in cli help.",
"items": {
"additionalProperties": true,
"description": "List of argument groups of a command.",
"properties": {
"args": {
"additionalItems": true,
"description": "List of arguments that are passed together with the cli command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"description": {
"description": "Brief description of what the command with this argument group does.",
"type": "string"
},
"title": {
"default": "",
"description": "Short title that briefly explains the argument group.",
"type": "string"
}
},
"required": [
"title",
"args",
"description"
],
"type": "object"
},
"type": "array"
},
"argument": {
"description": "Name of the argument.",
"required": [
"name",
"help"
],
"type": "object"
},
"build": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"component": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"build": {
"$ref": "#/$defs/build"
},
"init": {
"$ref": "#/$defs/init"
},
"list": {
"$ref": "#/$defs/list"
},
"publish": {
"$ref": "#/$defs/publish"
}
},
"required": [
"init",
"build",
"publish",
"list"
]
}
},
"type": "object"
},
"conflicting_arg_groups": {
"additionalItems": true,
"description": "Array of arrays where arguments of one array conflict with arguments of another array.",
"items": {
"additionalItems": true,
"description": "Array of arguments that can go together with a command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"type": "array"
},
"help": {
"description": "Description of the command which is displayed in the cli help message.",
"type": "string"
},
"init": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arg_groups": {
"$ref": "#/$defs/arg_groups"
},
"arguments": {
"description": "List of all the arguments that can be passed with the init command.",
"properties": {
"language": {
"$ref": "#/$defs/argument"
},
"name": {
"$ref": "#/$defs/argument"
},
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"language",
"repository",
"template",
"name"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"arguments",
"conflicting_arg_groups",
"arg_groups",
"help"
],
"type": "object"
},
"list": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the list command.",
"properties": {
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"template",
"repository"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"publish": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the publish command.",
"properties": {
"bucket": {
"$ref": "#/$defs/argument"
}
},
"required": [
"bucket"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"test-e2e": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"init": {
"$ref": "#/$defs/test-e2e-init"
},
"run": {
"$ref": "#/$defs/test-e2e-run"
}
},
"required": [
"init",
"run"
]
}
},
"type": "object"
},
"test-e2e-init": {
"additionalProperties": false,
"description": "Sub command under 'test' command. This is one of the sub-parsers under 'test' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the test-e2e init command.",
"properties": {
"otf_version": {
"$ref": "#/$defs/argument"
}
},
"required": [
"otf_version"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"test-e2e-run": {
"additionalProperties": false,
"description": "Sub command under 'test' command. This is one of the sub-parsers under 'test' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the test-e2e run command.",
"properties": {
"otf_options": {
"$ref": "#/$defs/argument"
}
},
"required": [
"otf_options"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "This is gdk cli model where every key in this json model represents a command or sub-command of the cli tool.",
"properties": {
"gdk": {
"description": "This is the name of the cli tool that is used as top-level parser of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"additionalProperties": false,
"properties": {
"component": {
"$ref": "#/$defs/component"
},
"test-e2e": {
"$ref": "#/$defs/test-e2e"
}
},
"required": [
"component",
"test-e2e"
]
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
}
},
"required": [
"gdk"
],
"type": "object"
} | Apache-2.0 | en |
aws-greengrass/aws-greengrass-gdk-cli | ed6c4f19d8427ee34c50fa7ef7639b041ffd3e72 | 2023-09-19T20:19:19 | gdk/static/cli_model_schema.json | 27 | 2024-05-27T05:54:00.851262Z | {
"$defs": {
"arg_groups": {
"additionalItems": true,
"description": "Group the compatible arguments of a command in arrays to display them in a separate group in cli help.",
"items": {
"additionalProperties": true,
"description": "List of argument groups of a command.",
"properties": {
"args": {
"additionalItems": true,
"description": "List of arguments that are passed together with the cli command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"description": {
"description": "Brief description of what the command with this argument group does.",
"type": "string"
},
"title": {
"default": "",
"description": "Short title that briefly explains the argument group.",
"type": "string"
}
},
"required": [
"title",
"args",
"description"
],
"type": "object"
},
"type": "array"
},
"argument": {
"description": "Name of the argument.",
"required": [
"name",
"help"
],
"type": "object"
},
"build": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"component": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"build": {
"$ref": "#/$defs/build"
},
"init": {
"$ref": "#/$defs/init"
},
"list": {
"$ref": "#/$defs/list"
},
"publish": {
"$ref": "#/$defs/publish"
}
},
"required": [
"init",
"build",
"publish",
"list"
]
}
},
"type": "object"
},
"conflicting_arg_groups": {
"additionalItems": true,
"description": "Array of arrays where arguments of one array conflict with arguments of another array.",
"items": {
"additionalItems": true,
"description": "Array of arguments that can go together with a command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"type": "array"
},
"help": {
"description": "Description of the command which is displayed in the cli help message.",
"type": "string"
},
"init": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arg_groups": {
"$ref": "#/$defs/arg_groups"
},
"arguments": {
"description": "List of all the arguments that can be passed with the init command.",
"properties": {
"language": {
"$ref": "#/$defs/argument"
},
"name": {
"$ref": "#/$defs/argument"
},
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"language",
"repository",
"template",
"name"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"arguments",
"conflicting_arg_groups",
"arg_groups",
"help"
],
"type": "object"
},
"list": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the list command.",
"properties": {
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"template",
"repository"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"publish": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the publish command.",
"properties": {
"bucket": {
"$ref": "#/$defs/argument"
}
},
"required": [
"bucket"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"test-e2e": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"init": {
"$ref": "#/$defs/test-e2e-init"
},
"run": {
"$ref": "#/$defs/test-e2e-run"
}
},
"required": [
"init",
"run"
]
}
},
"type": "object"
},
"test-e2e-init": {
"additionalProperties": false,
"description": "Sub command under 'test' command. This is one of the sub-parsers under 'test' parser.",
"properties": {
"arguments": {
"anyOf": [
{
"required": [
"otf_version"
]
},
{
"required": [
"gtf_version"
]
}
],
"description": "List of all the arguments that can be passed with the test-e2e init command.",
"properties": {
"gtf_version": {
"$ref": "#/$defs/argument"
},
"otf_version": {
"$ref": "#/$defs/argument"
}
}
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"test-e2e-run": {
"additionalProperties": false,
"description": "Sub command under 'test' command. This is one of the sub-parsers under 'test' parser.",
"properties": {
"arguments": {
"anyOf": [
{
"required": [
"otf_options"
]
},
{
"required": [
"gtf_options"
]
}
],
"description": "List of all the arguments that can be passed with the test-e2e run command.",
"properties": {
"gtf_options": {
"$ref": "#/$defs/argument"
},
"otf_options": {
"$ref": "#/$defs/argument"
}
}
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "This is gdk cli model where every key in this json model represents a command or sub-command of the cli tool.",
"properties": {
"gdk": {
"description": "This is the name of the cli tool that is used as top-level parser of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"additionalProperties": false,
"properties": {
"component": {
"$ref": "#/$defs/component"
},
"test-e2e": {
"$ref": "#/$defs/test-e2e"
}
},
"required": [
"component",
"test-e2e"
]
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
}
},
"required": [
"gdk"
],
"type": "object"
} | Apache-2.0 | en |
aws-greengrass/aws-greengrass-gdk-cli | 7a62f9e3e2cc931b1ad84aec4f42589aa0649d78 | 2022-01-21T19:23:00 | gdk/static/cli_model_schema.json | 27 | 2024-05-27T05:54:00.851262Z | {
"$defs": {
"arg_groups": {
"additionalItems": true,
"description": "Group the compatible arguments of a command in arrays to display them in a separate group in cli help.",
"items": {
"additionalProperties": true,
"description": "List of argument groups of a command.",
"properties": {
"args": {
"additionalItems": true,
"description": "List of arguments that are passed together with the cli command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"description": {
"description": "Brief description of what the command with this argument group does.",
"type": "string"
},
"title": {
"default": "",
"description": "Short title that briefly explains the argument group.",
"type": "string"
}
},
"required": [
"title",
"args",
"description"
],
"type": "object"
},
"type": "array"
},
"argument": {
"description": "Name of the argument.",
"required": [
"name",
"help"
],
"type": "object"
},
"conflicting_arg_groups": {
"additionalItems": true,
"description": "Array of arrays where arguments of one array conflict with arguments of another array.",
"items": {
"additionalItems": true,
"description": "Array of arguments that can go together with a command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"type": "array"
},
"help": {
"description": "Description of the command which is displayed in the cli help message.",
"type": "string"
},
"sub-commands": {
"additionalItems": true,
"description": "Array of all the sub commands of a command.",
"items": {
"description": "Name of the (sub) command.",
"type": "string"
},
"type": "array"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "This is gdk cli model where every key in this json model represents a command or sub-command of the cli tool.",
"properties": {
"build": {
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"component": {
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"$ref": "#/$defs/sub-commands"
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
},
"gdk": {
"description": "This is the name of the cli tool that is used as top-level parser of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"$ref": "#/$defs/sub-commands"
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
},
"init": {
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arg_groups": {
"$ref": "#/$defs/arg_groups"
},
"arguments": {
"description": "List of all the arguments that can be passed with the init command.",
"properties": {
"language": {
"$ref": "#/$defs/argument"
},
"name": {
"$ref": "#/$defs/argument"
},
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"language",
"repository",
"template",
"name"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"arguments",
"conflicting_arg_groups",
"arg_groups",
"help"
],
"type": "object"
},
"list": {
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the list command.",
"properties": {
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"template",
"repository"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"publish": {
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the publish command.",
"properties": {
"bucket": {
"$ref": "#/$defs/argument"
}
},
"required": [
"bucket"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
}
},
"required": [
"gdk",
"component",
"init",
"list",
"build",
"publish"
],
"type": "object"
} | Apache-2.0 | en |
aws-greengrass/aws-greengrass-gdk-cli | aba675a9ddab3d0e62584c28928994bf7fc0271f | 2023-05-25T21:10:20 | gdk/static/cli_model_schema.json | 27 | 2024-05-27T05:54:00.851262Z | {
"$defs": {
"arg_groups": {
"additionalItems": true,
"description": "Group the compatible arguments of a command in arrays to display them in a separate group in cli help.",
"items": {
"additionalProperties": true,
"description": "List of argument groups of a command.",
"properties": {
"args": {
"additionalItems": true,
"description": "List of arguments that are passed together with the cli command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"description": {
"description": "Brief description of what the command with this argument group does.",
"type": "string"
},
"title": {
"default": "",
"description": "Short title that briefly explains the argument group.",
"type": "string"
}
},
"required": [
"title",
"args",
"description"
],
"type": "object"
},
"type": "array"
},
"argument": {
"description": "Name of the argument.",
"required": [
"name",
"help"
],
"type": "object"
},
"build": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"component": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"build": {
"$ref": "#/$defs/build"
},
"init": {
"$ref": "#/$defs/init"
},
"list": {
"$ref": "#/$defs/list"
},
"publish": {
"$ref": "#/$defs/publish"
}
},
"required": [
"init",
"build",
"publish",
"list"
]
}
},
"type": "object"
},
"conflicting_arg_groups": {
"additionalItems": true,
"description": "Array of arrays where arguments of one array conflict with arguments of another array.",
"items": {
"additionalItems": true,
"description": "Array of arguments that can go together with a command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"type": "array"
},
"help": {
"description": "Description of the command which is displayed in the cli help message.",
"type": "string"
},
"init": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arg_groups": {
"$ref": "#/$defs/arg_groups"
},
"arguments": {
"description": "List of all the arguments that can be passed with the init command.",
"properties": {
"language": {
"$ref": "#/$defs/argument"
},
"name": {
"$ref": "#/$defs/argument"
},
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"language",
"repository",
"template",
"name"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"arguments",
"conflicting_arg_groups",
"arg_groups",
"help"
],
"type": "object"
},
"list": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the list command.",
"properties": {
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"template",
"repository"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"publish": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the publish command.",
"properties": {
"bucket": {
"$ref": "#/$defs/argument"
}
},
"required": [
"bucket"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"test-e2e": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"init": {
"$ref": "#/$defs/test-e2e-init"
},
"run": {
"$ref": "#/$defs/test-e2e-run"
}
},
"required": [
"init",
"run"
]
}
},
"type": "object"
},
"test-e2e-init": {
"additionalProperties": false,
"description": "Sub command under 'test' command. This is one of the sub-parsers under 'test' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"test-e2e-run": {
"additionalProperties": false,
"description": "Sub command under 'test' command. This is one of the sub-parsers under 'test' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "This is gdk cli model where every key in this json model represents a command or sub-command of the cli tool.",
"properties": {
"gdk": {
"description": "This is the name of the cli tool that is used as top-level parser of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"additionalProperties": false,
"properties": {
"component": {
"$ref": "#/$defs/component"
},
"test-e2e": {
"$ref": "#/$defs/test-e2e"
}
},
"required": [
"component",
"test-e2e"
]
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
}
},
"required": [
"gdk"
],
"type": "object"
} | Apache-2.0 | en |
aws-greengrass/aws-greengrass-gdk-cli | 96511d53f026716febd351df97c60fbe8bb9b1fd | 2023-04-27T17:26:44 | gdk/static/cli_model_schema.json | 27 | 2024-05-27T05:54:00.851262Z | {
"$defs": {
"arg_groups": {
"additionalItems": true,
"description": "Group the compatible arguments of a command in arrays to display them in a separate group in cli help.",
"items": {
"additionalProperties": true,
"description": "List of argument groups of a command.",
"properties": {
"args": {
"additionalItems": true,
"description": "List of arguments that are passed together with the cli command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"description": {
"description": "Brief description of what the command with this argument group does.",
"type": "string"
},
"title": {
"default": "",
"description": "Short title that briefly explains the argument group.",
"type": "string"
}
},
"required": [
"title",
"args",
"description"
],
"type": "object"
},
"type": "array"
},
"argument": {
"description": "Name of the argument.",
"required": [
"name",
"help"
],
"type": "object"
},
"build": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"component": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"build": {
"$ref": "#/$defs/build"
},
"init": {
"$ref": "#/$defs/init"
},
"list": {
"$ref": "#/$defs/list"
},
"publish": {
"$ref": "#/$defs/publish"
}
},
"required": [
"init",
"build",
"publish",
"list"
]
}
},
"type": "object"
},
"conflicting_arg_groups": {
"additionalItems": true,
"description": "Array of arrays where arguments of one array conflict with arguments of another array.",
"items": {
"additionalItems": true,
"description": "Array of arguments that can go together with a command.",
"items": {
"description": "Name of the argument.",
"type": "string"
},
"type": "array"
},
"type": "array"
},
"help": {
"description": "Description of the command which is displayed in the cli help message.",
"type": "string"
},
"init": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arg_groups": {
"$ref": "#/$defs/arg_groups"
},
"arguments": {
"description": "List of all the arguments that can be passed with the init command.",
"properties": {
"language": {
"$ref": "#/$defs/argument"
},
"name": {
"$ref": "#/$defs/argument"
},
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"language",
"repository",
"template",
"name"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"arguments",
"conflicting_arg_groups",
"arg_groups",
"help"
],
"type": "object"
},
"list": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the list command.",
"properties": {
"repository": {
"$ref": "#/$defs/argument"
},
"template": {
"$ref": "#/$defs/argument"
}
},
"required": [
"template",
"repository"
]
},
"conflicting_arg_groups": {
"$ref": "#/$defs/conflicting_arg_groups"
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"publish": {
"additionalProperties": false,
"description": "Sub command under 'component' command. This is one of the sub-parsers under 'component' parser.",
"properties": {
"arguments": {
"description": "List of all the arguments that can be passed with the publish command.",
"properties": {
"bucket": {
"$ref": "#/$defs/argument"
}
},
"required": [
"bucket"
]
},
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help",
"arguments"
],
"type": "object"
},
"test": {
"additionalProperties": false,
"description": "A command of gdk cli tool. This is one of the sub parsers under the top-level parser ('gdk') of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"properties": {
"init": {
"$ref": "#/$defs/test-init"
},
"run": {
"$ref": "#/$defs/test-run"
}
},
"required": [
"init",
"run"
]
}
},
"type": "object"
},
"test-init": {
"additionalProperties": false,
"description": "Sub command under 'test' command. This is one of the sub-parsers under 'test' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
},
"test-run": {
"additionalProperties": false,
"description": "Sub command under 'test' command. This is one of the sub-parsers under 'test' parser.",
"properties": {
"help": {
"$ref": "#/$defs/help"
}
},
"required": [
"help"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "This is gdk cli model where every key in this json model represents a command or sub-command of the cli tool.",
"properties": {
"gdk": {
"description": "This is the name of the cli tool that is used as top-level parser of the cli.",
"properties": {
"help": {
"$ref": "#/$defs/help"
},
"sub-commands": {
"additionalProperties": false,
"properties": {
"component": {
"$ref": "#/$defs/component"
},
"test": {
"$ref": "#/$defs/test"
}
},
"required": [
"component",
"test"
]
}
},
"required": [
"sub-commands",
"help"
],
"type": "object"
}
},
"required": [
"gdk"
],
"type": "object"
} | Apache-2.0 | en |
bayashi/irir | 3e0c40ad1eed0c58ff869a9a04913608760436ae | 2023-05-22T07:56:03 | .rule_schema.json | 8 | 2024-05-27T05:52:47.043885Z | {
"$defs": {
"Rule": {
"additionalProperties": false,
"properties": {
"color": {
"enum": [
"dark_yellow",
"red",
"green",
"magenta",
"dark_green",
"dark_cyan",
"bg_red",
"bg_blue",
"yellow",
"light_gray",
"dark_red",
"dark_blue",
"cyan",
"gray",
"bg_yellow",
"error",
"bg_green",
"bg_magenta",
"bg_cyan",
"blue",
"white",
"dark_magenta",
"black"
],
"type": "string"
},
"match": {
"type": "string"
},
"target": {
"enum": [
"word",
"line"
],
"type": "string"
},
"type": {
"enum": [
"match",
"prefix",
"suffix",
"regexp"
],
"type": "string"
}
},
"required": [
"type",
"match",
"color",
"target"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"patternProperties": {
".*": {
"items": {
"$ref": "#/$defs/Rule"
},
"type": "array"
}
},
"type": "object"
} | MIT | en |
bayashi/irir | 4c8485bd0f1d5dc9426703c8a001a319d4261975 | 2023-05-22T06:11:29 | .rule_schema.json | 8 | 2024-05-27T05:52:47.043885Z | {
"$defs": {
"Rule": {
"additionalProperties": false,
"properties": {
"color": {
"type": "string"
},
"match": {
"type": "string"
},
"target": {
"enum": [
"word",
"line"
],
"type": "string"
},
"type": {
"enum": [
"match",
"prefix",
"suffix",
"regexp"
],
"type": "string"
}
},
"required": [
"type",
"match",
"color",
"target"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"patternProperties": {
".*": {
"items": {
"$ref": "#/$defs/Rule"
},
"type": "array"
}
},
"type": "object"
} | MIT | en |
PrimeDecomp/retrotool | 4631806c327918dc7c94ad2b5c8c982e81415c1e | 2023-03-27T03:44:53 | lib/templates/mp1r/root.schema.json | 15 | 2024-05-27T06:54:36.97563Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"enums": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"objects": {
"additionalProperties": false,
"patternProperties": {
"0x[A-Fa-f0-9]{8}": {
"type": "string"
}
},
"type": "object"
},
"structs": {
"items": {
"type": "string"
},
"type": "array"
},
"typedefs": {
"additionalProperties": false,
"patternProperties": {
"0x[A-Fa-f0-9]{8}": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
} | Apache-2.0 | en |
PrimeDecomp/retrotool | 4631806c327918dc7c94ad2b5c8c982e81415c1e | 2023-03-27T03:44:53 | lib/templates/mp1r/type.schema.json | 15 | 2024-05-27T06:54:36.97563Z | {
"$defs": {
"property": {
"anyOf": [
{
"properties": {
"struct": {
"type": "string"
},
"type": {
"const": "struct"
}
},
"required": [
"struct"
]
},
{
"properties": {
"supported_types": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"const": "typedef"
}
}
},
{
"properties": {
"enum": {
"type": "string"
},
"type": {
"const": "enum"
}
},
"required": [
"enum"
]
},
{
"properties": {
"element": {
"$ref": "#/$defs/property"
},
"type": {
"const": "list"
}
},
"required": [
"element"
]
},
{
"properties": {
"type": {
"const": "id"
}
}
},
{
"properties": {
"type": {
"const": "u8"
}
}
},
{
"properties": {
"type": {
"const": "u16"
}
}
},
{
"properties": {
"type": {
"const": "u32"
}
}
},
{
"properties": {
"type": {
"const": "u64"
}
}
},
{
"properties": {
"type": {
"const": "i8"
}
}
},
{
"properties": {
"type": {
"const": "i16"
}
}
},
{
"properties": {
"type": {
"const": "i32"
}
}
},
{
"properties": {
"type": {
"const": "i64"
}
}
},
{
"properties": {
"type": {
"const": "vector"
}
}
},
{
"properties": {
"type": {
"const": "color"
}
}
},
{
"properties": {
"type": {
"const": "bool"
}
}
},
{
"properties": {
"type": {
"const": "f32"
}
}
},
{
"properties": {
"type": {
"const": "f64"
}
}
}
],
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"properties": {
"properties": {
"additionalProperties": false,
"patternProperties": {
"0x[A-Fa-f0-9]{8}": {
"$ref": "#/$defs/property"
}
},
"type": "object"
},
"type": {
"const": "property_list"
}
},
"required": [
"properties"
]
},
{
"properties": {
"elements": {
"items": {
"$ref": "#/$defs/property"
},
"type": "array"
},
"type": {
"const": "struct"
}
},
"required": [
"elements"
]
},
{
"properties": {
"type": {
"const": "enum"
},
"values": {
"items": {
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"anyOf": [
{
"type": "integer"
},
{
"pattern": "0x[A-Fa-f0-9]{8}",
"type": "string"
}
]
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"values"
]
}
],
"properties": {
"$schema": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object",
"unevaluatedProperties": false
} | Apache-2.0 | en |
PrimeDecomp/retrotool | 8b67ab7648c2e83e3deacc0b872d401ec3efada1 | 2024-05-02T06:56:12 | lib/templates/mp1r/type.schema.json | 15 | 2024-05-27T06:54:36.97563Z | {
"$defs": {
"property": {
"anyOf": [
{
"properties": {
"struct": {
"type": "string"
},
"type": {
"const": "struct"
}
},
"required": [
"struct"
]
},
{
"properties": {
"supported_types": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"const": "typedef"
}
}
},
{
"properties": {
"enum": {
"type": "string"
},
"type": {
"const": "enum"
}
},
"required": [
"enum"
]
},
{
"properties": {
"element": {
"$ref": "#/$defs/property"
},
"type": {
"const": "list"
}
},
"required": [
"element"
]
},
{
"properties": {
"type": {
"const": "id"
}
}
},
{
"properties": {
"type": {
"const": "u8"
}
}
},
{
"properties": {
"type": {
"const": "u16"
}
}
},
{
"properties": {
"type": {
"const": "u32"
}
}
},
{
"properties": {
"type": {
"const": "u64"
}
}
},
{
"properties": {
"type": {
"const": "i8"
}
}
},
{
"properties": {
"type": {
"const": "i16"
}
}
},
{
"properties": {
"type": {
"const": "i32"
}
}
},
{
"properties": {
"type": {
"const": "i64"
}
}
},
{
"properties": {
"type": {
"const": "vector"
}
}
},
{
"properties": {
"type": {
"const": "color"
}
}
},
{
"properties": {
"type": {
"const": "bool"
}
}
},
{
"properties": {
"type": {
"const": "f32"
}
}
},
{
"properties": {
"type": {
"const": "f64"
}
}
},
{
"properties": {
"type": {
"const": "pooled_string"
}
}
}
],
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"properties": {
"properties": {
"additionalProperties": false,
"patternProperties": {
"0x[A-Fa-f0-9]{8}": {
"$ref": "#/$defs/property"
}
},
"type": "object"
},
"type": {
"const": "property_list"
}
},
"required": [
"properties"
]
},
{
"properties": {
"elements": {
"items": {
"$ref": "#/$defs/property"
},
"type": "array"
},
"type": {
"const": "struct"
}
},
"required": [
"elements"
]
},
{
"properties": {
"type": {
"const": "enum"
},
"values": {
"items": {
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"anyOf": [
{
"type": "integer"
},
{
"pattern": "0x[A-Fa-f0-9]{8}",
"type": "string"
}
]
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"values"
]
}
],
"properties": {
"$schema": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object",
"unevaluatedProperties": false
} | Apache-2.0 | en |
AnandChowdhary/okrs | de2588cb1a95eb58cd8233d0b4e23dfaea3e07af | 2021-12-23T10:28:37 | schema.json | 40 | 2024-05-27T05:29:08.757606Z | {
"$id": "https://raw.githubusercontent.com/AnandChowdhary/okrs/main/schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"description": "Object and Key Results with progress",
"properties": {
"objectives": {
"description": "Objectives for this quarter",
"items": {
"additionalProperties": false,
"description": "Key results for this objective",
"maxItems": 3,
"minItems": 3,
"properties": {
"key_results": {
"description": "Metrics for this key result",
"items": {
"additionalProperties": false,
"properties": {
"current_result": {
"type": "number"
},
"name": {
"type": "string"
},
"target_result": {
"type": "number"
}
},
"required": [
"name",
"target_result",
"current_result"
],
"type": "object"
},
"maxItems": 3,
"minItems": 3,
"type": "array",
"uniqueItems": true
},
"name": {
"type": "string"
}
},
"required": [
"name",
"key_results"
],
"type": "object",
"uniqueItems": true
},
"maxItems": 3,
"minItems": 3,
"type": "array",
"uniqueItems": true
},
"quarter": {
"description": "Quarter",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"year": {
"description": "Year",
"maximum": 3000,
"minimum": 2000,
"type": "integer"
}
},
"required": [
"year",
"quarter",
"objectives"
],
"title": "OKR",
"type": "object"
} | MIT | en |
AnandChowdhary/okrs | 3f26b09288f0ade391bcea7c6288859d4b72dd76 | 2021-12-23T14:28:53 | schema.json | 40 | 2024-05-27T05:29:08.757606Z | {
"$id": "https://anandchowdhary.github.io/okrs/schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"description": "Object and Key Results with progress",
"properties": {
"objectives": {
"description": "Objectives for this quarter",
"items": {
"additionalProperties": false,
"description": "Key results for this objective",
"maxItems": 3,
"minItems": 3,
"properties": {
"key_results": {
"description": "Metrics for this key result",
"items": {
"additionalProperties": false,
"properties": {
"current_result": {
"type": "number"
},
"name": {
"type": "string"
},
"target_result": {
"type": "number"
}
},
"required": [
"name",
"target_result",
"current_result"
],
"type": "object"
},
"maxItems": 3,
"minItems": 3,
"type": "array",
"uniqueItems": true
},
"name": {
"type": "string"
}
},
"required": [
"name",
"key_results"
],
"type": "object",
"uniqueItems": true
},
"maxItems": 3,
"minItems": 3,
"type": "array",
"uniqueItems": true
},
"quarter": {
"description": "Quarter",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"year": {
"description": "Year",
"maximum": 3000,
"minimum": 2000,
"type": "integer"
}
},
"required": [
"year",
"quarter",
"objectives"
],
"title": "OKR",
"type": "object"
} | MIT | en |
AnandChowdhary/okrs | f58093ed5cd9b5bd1bf1aafc1d3c1ce2f6fa780a | 2022-01-10T05:35:32 | schema.json | 40 | 2024-05-27T05:29:08.757606Z | {
"$id": "https://anandchowdhary.github.io/okrs/schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"description": "Object and Key Results with progress",
"properties": {
"objectives": {
"description": "Objectives for this quarter",
"items": {
"additionalProperties": false,
"description": "Key results for this objective",
"properties": {
"key_results": {
"description": "Metrics for this key result",
"items": {
"additionalProperties": false,
"properties": {
"current_result": {
"type": "number"
},
"name": {
"type": "string"
},
"target_result": {
"type": "number"
}
},
"required": [
"name",
"target_result",
"current_result"
],
"type": "object"
},
"maxItems": 5,
"minItems": 2,
"type": "array",
"uniqueItems": true
},
"name": {
"type": "string"
}
},
"required": [
"name",
"key_results"
],
"type": "object"
},
"maxItems": 5,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"quarter": {
"description": "Quarter",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"year": {
"description": "Year",
"maximum": 3000,
"minimum": 2000,
"type": "integer"
}
},
"required": [
"year",
"quarter",
"objectives"
],
"title": "OKR",
"type": "object"
} | MIT | en |
AnandChowdhary/okrs | 0fe4098dd460c0b56861d95004ced91954c9689e | 2021-12-23T10:27:47 | schema.json | 40 | 2024-05-27T05:29:08.757606Z | {
"$id": "https://raw.githubusercontent.com/AnandChowdhary/okrs/main/public/okrs/schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"description": "Object and Key Results with progress",
"properties": {
"objectives": {
"description": "Objectives for this quarter",
"items": {
"additionalProperties": false,
"description": "Key results for this objective",
"maxItems": 3,
"minItems": 3,
"properties": {
"key_results": {
"description": "Metrics for this key result",
"items": {
"additionalProperties": false,
"properties": {
"current_result": {
"type": "number"
},
"name": {
"type": "string"
},
"target_result": {
"type": "number"
}
},
"required": [
"name",
"target_result",
"current_result"
],
"type": "object"
},
"maxItems": 3,
"minItems": 3,
"type": "array",
"uniqueItems": true
},
"name": {
"type": "string"
}
},
"required": [
"name",
"key_results"
],
"type": "object",
"uniqueItems": true
},
"maxItems": 3,
"minItems": 3,
"type": "array",
"uniqueItems": true
},
"quarter": {
"description": "Quarter",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"year": {
"description": "Year",
"maximum": 3000,
"minimum": 2000,
"type": "integer"
}
},
"required": [
"year",
"quarter",
"objectives"
],
"title": "OKR",
"type": "object"
} | MIT | en |
airlock/microgateway | 4bbde130d99a9618184d31a8932dcf7e1ea3fb0e | 2024-04-17T13:41:01 | deploy/charts/airlock-microgateway/values.schema.json | 14 | 2024-05-27T04:30:04.736024Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"Image": {
"additionalProperties": false,
"properties": {
"digest": {
"pattern": "^$|^sha256:[a-f0-9]{64}$",
"type": "string"
},
"pullPolicy": {
"enum": [
"Always",
"IfNotPresent",
"Never"
],
"type": "string"
},
"repository": {
"minLength": 1,
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"digest",
"pullPolicy",
"repository",
"tag"
],
"type": "object"
},
"RecreateType": {
"enum": [
"Recreate"
],
"type": "string"
},
"RollingUpdate": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"maxSurge"
]
},
{
"required": [
"maxUnavailable"
]
}
],
"properties": {
"maxSurge": {
"minimum": 0,
"pattern": "^\\d+%?$",
"type": [
"integer",
"string"
]
},
"maxUnavailable": {
"minimum": 0,
"pattern": "^\\d+%?$",
"type": [
"integer",
"string"
]
}
},
"type": "object"
},
"RollingUpdateType": {
"enum": [
"RollingUpdate"
],
"type": "string"
},
"StringMap": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"UpdateStrategy": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"type": {
"$ref": "#/definitions/RecreateType"
}
},
"required": [
"type"
]
},
{
"additionalProperties": false,
"properties": {
"rollingUpdate": {
"$ref": "#/definitions/RollingUpdate"
},
"type": {
"$ref": "#/definitions/RollingUpdateType"
}
},
"required": [
"type"
]
}
],
"type": "object"
}
},
"properties": {
"commonAnnotations": {
"$ref": "#/definitions/StringMap"
},
"commonLabels": {
"$ref": "#/definitions/StringMap"
},
"crds": {
"additionalProperties": false,
"properties": {
"skipVersionCheck": {
"type": "boolean"
}
},
"type": "object"
},
"engine": {
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/definitions/Image"
},
"resources": {
"type": "object"
},
"sidecar": {
"additionalProperties": false,
"properties": {
"podMonitor": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"labels": {
"$ref": "#/definitions/StringMap"
}
},
"required": [
"create"
],
"type": "object"
}
},
"required": [
"podMonitor"
],
"type": "object"
}
},
"required": [
"image",
"resources",
"sidecar"
],
"type": "object"
},
"fullnameOverride": {
"type": "string"
},
"global": {
"type": "object"
},
"imagePullSecrets": {
"items": {
"additionalProperties": true,
"properties": {
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"license": {
"additionalProperties": false,
"properties": {
"secretName": {
"minLength": 1,
"type": "string"
}
},
"required": [
"secretName"
],
"type": "object"
},
"nameOverride": {
"type": "string"
},
"networkValidator": {
"additionalProperties": false,
"properties": {
"image": {
"$ref": "#/definitions/Image"
}
},
"required": [
"image"
],
"type": "object"
},
"operator": {
"additionalProperties": false,
"properties": {
"affinity": {
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"logLevel": {
"enum": [
"debug",
"info",
"warn",
"error"
],
"type": "string"
}
},
"required": [
"logLevel"
],
"type": "object"
},
"image": {
"$ref": "#/definitions/Image"
},
"nodeSelector": {
"$ref": "#/definitions/StringMap"
},
"podAnnotations": {
"$ref": "#/definitions/StringMap"
},
"podLabels": {
"$ref": "#/definitions/StringMap"
},
"rbac": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
}
},
"required": [
"create"
],
"type": "object"
},
"replicaCount": {
"minimum": 0,
"type": "integer"
},
"resources": {
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"$ref": "#/definitions/StringMap"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
},
"serviceAnnotations": {
"$ref": "#/definitions/StringMap"
},
"serviceLabels": {
"$ref": "#/definitions/StringMap"
},
"serviceMonitor": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"labels": {
"$ref": "#/definitions/StringMap"
}
},
"required": [
"create"
],
"type": "object"
},
"tolerations": {
"items": {
"type": "object"
},
"type": "array"
},
"updateStrategy": {
"$ref": "#/definitions/UpdateStrategy"
}
},
"required": [
"affinity",
"config",
"image",
"updateStrategy",
"nodeSelector",
"podAnnotations",
"podLabels",
"rbac",
"replicaCount",
"resources",
"serviceAccount",
"serviceAnnotations",
"serviceLabels",
"serviceMonitor",
"tolerations"
],
"type": "object"
},
"tests": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"required": [
"commonAnnotations",
"commonLabels",
"crds",
"engine",
"fullnameOverride",
"imagePullSecrets",
"license",
"nameOverride",
"operator",
"networkValidator",
"tests"
],
"type": "object"
} | MIT | en |
airlock/microgateway | c7563d3b035249eb3ea58b1bf3d5f586373f9a35 | 2023-10-11T13:52:26 | deploy/charts/airlock-microgateway-cni/values.schema.json | 14 | 2024-05-27T04:30:04.736024Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"affinity": {
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"cniBinDir": {
"type": "string"
},
"cniNetDir": {
"type": "string"
},
"excludeNamespaces": {
"items": {
"type": "string"
},
"type": "array"
},
"installMode": {
"enum": [
"chained",
"standalone"
],
"type": "string"
},
"logLevel": {
"enum": [
"debug",
"info",
"warn",
"error"
],
"type": "string"
}
},
"required": [
"cniBinDir",
"cniNetDir",
"excludeNamespaces",
"installMode",
"logLevel"
],
"type": "object"
},
"fullnameOverride": {
"type": "string"
},
"image": {
"additionalProperties": false,
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"digest",
"pullPolicy",
"repository",
"tag"
],
"type": "object"
},
"multusNetworkAttachmentDefinition": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"namespace": {
"type": "string"
}
},
"required": [
"create",
"namespace"
],
"type": "object"
},
"nameOverride": {
"type": "string"
},
"privileged": {
"type": "boolean"
},
"rbac": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"createSCCRole": {
"type": "boolean"
}
},
"required": [
"create",
"createSCCRole"
],
"type": "object"
},
"resources": {
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"create",
"name"
],
"type": "object"
},
"tests": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"required": [
"affinity",
"config",
"fullnameOverride",
"image",
"multusNetworkAttachmentDefinition",
"nameOverride",
"privileged",
"rbac",
"resources",
"serviceAccount",
"tests"
],
"type": "object"
} | MIT | en |
airlock/microgateway | 0b720e4e6f83dea5f4974fa499d9faba6b592501 | 2023-11-10T15:37:58 | deploy/charts/airlock-microgateway-cni/values.schema.json | 14 | 2024-05-27T04:30:04.736024Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"affinity": {
"type": "object"
},
"config": {
"additionalProperties": false,
"properties": {
"cniBinDir": {
"type": "string"
},
"cniNetDir": {
"type": "string"
},
"excludeNamespaces": {
"items": {
"type": "string"
},
"type": "array"
},
"installMode": {
"enum": [
"chained",
"standalone",
"manual"
],
"type": "string"
},
"logLevel": {
"enum": [
"debug",
"info",
"warn",
"error"
],
"type": "string"
}
},
"required": [
"cniBinDir",
"cniNetDir",
"excludeNamespaces",
"installMode",
"logLevel"
],
"type": "object"
},
"fullnameOverride": {
"type": "string"
},
"image": {
"additionalProperties": false,
"properties": {
"digest": {
"type": "string"
},
"pullPolicy": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"digest",
"pullPolicy",
"repository",
"tag"
],
"type": "object"
},
"multusNetworkAttachmentDefinition": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"namespace": {
"type": "string"
}
},
"required": [
"create",
"namespace"
],
"type": "object"
},
"nameOverride": {
"type": "string"
},
"privileged": {
"type": "boolean"
},
"rbac": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"createSCCRole": {
"type": "boolean"
}
},
"required": [
"create",
"createSCCRole"
],
"type": "object"
},
"resources": {
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"create",
"name"
],
"type": "object"
},
"tests": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"required": [
"affinity",
"config",
"fullnameOverride",
"image",
"multusNetworkAttachmentDefinition",
"nameOverride",
"privileged",
"rbac",
"resources",
"serviceAccount",
"tests"
],
"type": "object"
} | MIT | en |
airlock/microgateway | 4bbde130d99a9618184d31a8932dcf7e1ea3fb0e | 2024-04-17T13:41:01 | deploy/charts/airlock-microgateway-cni/values.schema.json | 14 | 2024-05-27T04:30:04.736024Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"Image": {
"additionalProperties": false,
"properties": {
"digest": {
"pattern": "^$|^sha256:[a-f0-9]{64}$",
"type": "string"
},
"pullPolicy": {
"enum": [
"Always",
"IfNotPresent",
"Never"
],
"type": "string"
},
"repository": {
"minLength": 1,
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"digest",
"pullPolicy",
"repository",
"tag"
],
"type": "object"
},
"StringMap": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"properties": {
"affinity": {
"type": "object"
},
"commonAnnotations": {
"$ref": "#/definitions/StringMap"
},
"commonLabels": {
"$ref": "#/definitions/StringMap"
},
"config": {
"additionalProperties": false,
"properties": {
"cniBinDir": {
"minLength": 1,
"type": "string"
},
"cniNetDir": {
"minLength": 1,
"type": "string"
},
"excludeNamespaces": {
"items": {
"type": "string"
},
"type": "array"
},
"installMode": {
"enum": [
"chained",
"standalone",
"manual"
],
"type": "string"
},
"logLevel": {
"enum": [
"debug",
"info",
"warn",
"error"
],
"type": "string"
}
},
"required": [
"cniBinDir",
"cniNetDir",
"excludeNamespaces",
"installMode",
"logLevel"
],
"type": "object"
},
"fullnameOverride": {
"type": "string"
},
"global": {
"type": "object"
},
"image": {
"$ref": "#/definitions/Image"
},
"imagePullSecrets": {
"items": {
"additionalProperties": true,
"properties": {
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"multusNetworkAttachmentDefinition": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"namespace": {
"type": "string"
}
},
"required": [
"create",
"namespace"
],
"type": "object"
},
"nameOverride": {
"type": "string"
},
"nodeSelector": {
"$ref": "#/definitions/StringMap"
},
"podAnnotations": {
"$ref": "#/definitions/StringMap"
},
"podLabels": {
"$ref": "#/definitions/StringMap"
},
"privileged": {
"type": "boolean"
},
"rbac": {
"additionalProperties": false,
"properties": {
"create": {
"type": "boolean"
},
"createSCCRole": {
"type": "boolean"
}
},
"required": [
"create",
"createSCCRole"
],
"type": "object"
},
"resources": {
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"$ref": "#/definitions/StringMap"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"annotations",
"create",
"name"
],
"type": "object"
},
"tests": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
},
"required": [
"affinity",
"commonAnnotations",
"commonLabels",
"config",
"fullnameOverride",
"image",
"imagePullSecrets",
"multusNetworkAttachmentDefinition",
"nameOverride",
"nodeSelector",
"podAnnotations",
"podLabels",
"privileged",
"rbac",
"resources",
"serviceAccount",
"tests"
],
"type": "object"
} | MIT | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.