schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
netlify.json | file | unique filepath (relative to the base of the repo). | {"type": "string"} |
netlify.json | backend | specifies how to access the content for your site, including authentication | {"type": "object"} |
netlify.json | local_backend | Set this property to connect Netlify to a local Git repo instead of a live one | {"type": "boolean"} |
netlify.json | media_folder | specifies the folder path where uploaded files should be saved, relative to the base of the repo. | {"type": "string"} |
netlify.json | public_folder | specifies the folder path where the files uploaded by the media library will be accessed, relative to the base of the built site. For fields controlled by [file] or [image] widgets, the value of the field is generated by prepending this path to the filename of the selected file. Defaults to the value of media_folder, with an opening / if one is not already included. | {"type": "string"} |
netlify.json | media_library | Media library integrations are configured via the media_library property, and its value should be an object with at least a name property. A config property can also be used for options that should be passed to the library in use. | {"type": "object", "properties": {"name": {"type": "string"}, "config": {"type": "object"}}, "required": ["name"]} |
netlify.json | site_url | should provide a URL to your published site. May be used by the CMS for various functionality. Used together with a collection's preview_path to create links to live content. | {"type": "string"} |
netlify.json | display_url | When the display_url setting is specified, the CMS UI will include a link in the fixed area at the top of the page, allowing content authors to easily return to your main site. The text of the link consists of the URL without the protocol portion (e.g., your-site.com).
Defaults to site_url. | {"type": "string"} |
netlify.json | logo_url | Logo at the top of the login page. Assumed to be a URL to an image file | {"type": "string"} |
netlify.json | show_preview_links | shows Deploy Preview Links | {"type": "boolean"} |
netlify.json | slug | For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field).
The slug template can also reference a field value by name, eg. {{title}}. If a field name conflicts with a built in template tag name - for example, if you have a field named slug, and would like to reference that field via {{slug}}, you can do so by adding the explicit fields. prefix, eg. {{fields.slug}}.
Available template tags:
Any field can be referenced by wrapping the field name in double curly braces, eg. {{author}}
{{slug}}: a url-safe version of the title field (or identifier field) for the file
{{year}}: 4-digit year of the file creation date
{{month}}: 2-digit month of the file creation date
{{day}}: 2-digit day of the month of the file creation date
{{hour}}: 2-digit hour of the file creation date
{{minute}}: 2-digit minute of the file creation date
{{second}}: 2-digit second of the file creation date | {"type": "object", "properties": {"encoding": {"enum": ["unicode", "ascii"], "default": "unicode"}, "clean_accents": {"type": "boolean"}, "sanitize_replacement": {"type": "string"}}} |
netlify.json | encoding |
unicode (default): Sanitize filenames (slugs) according to RFC3987 and the WHATWG URL spec. This spec allows non-ASCII (or non-Latin) characters to exist in URLs.
ascii: Sanitize filenames (slugs) according to RFC3986. The only allowed characters are (0-9, a-z, A-Z, _, -, ~). | {"enum": ["unicode", "ascii"], "default": "unicode"} |
netlify.json | clean_accents | Remove diacritics from slug characters before sanitizing. This is often helpful when using ascii encoding. | {"type": "boolean"} |
netlify.json | sanitize_replacement | The replacement string used to substitute unsafe characters; defaults to - | {"type": "string"} |
netlify.json | collections | The collections setting is the heart of your Netlify CMS configuration, as it determines how content types and editor fields in the UI generate files and content in your repository. Each collection you configure displays in the left sidebar of the Content page of the editor UI, in the order they are entered into your Netlify CMS config.yml file. | {"type": "array", "items": {}} |
netlify.json | editor | This setting changes options for the editor view of the collection. It has one option so far: preview | {"type": "object", "properties": {"preview": {"type": "boolean", "default": true}}} |
netlify.json | preview | Enable preview pane for this collection; defaults to true | {"type": "boolean", "default": true} |
netlify.json | summary | This setting allows the customization of the collection list view. Similar to the slug field, a string with templates can be used to include values of different fields, e.g. {{title}}. This option over-rides the default of title field and identifier_field
Template tags are the same as those for slug, with the following additions:
{{filename}} The file name without the extension part.
{{extension}} The file extension.
{{commit_date}} The file commit date on supported backends (git based backends).
{{commit_author}} The file author date on supported backends (git based backends). | {"type": "string"} |
netlify.json | sortableFields | An optional list of sort fields to show in the UI.
Defaults to inferring title, date, author and description fields and will also show Update On sort field in git based backends.
When author field can't be inferred commit author will be used. | {"type": "array"} |
netlify.json | view_filters | An optional list of predefined view filters to show in the UI.
Defaults to an empty list. | {"type": "array"} |
reference.json | Schema for serverless framework configuration files | {"$schema": "https://json-schema.org/draft-07/schema#", "fileMatch": ["serverless.yml", "serverless.yaml"], "definitions": {"Transform": {"type": "object", "oneOf": [{"properties": {"Name": {"type": "string", "enum": ["AWS::Include"]}, "Parameters": {"type": "object", "properties": {"Location": {"type": "string", "format": "uri"}}, "additionalProperties": false}}, "additionalProperties": false}, {"type": "string", "enum": ["AWS::CodeDeployBlueGreen", "AWS::CodeStar", "AWS::SecretsManager-2020-07-23", "AWS::Serverless-2016-10-31"]}]}, "AwsAlexaSmartHome": {"properties": {"appId": {"type": "string"}, "enabled": {"type": "boolean"}}, "type": "object"}, "AwsApiGateway": {"properties": {"apiKeySourceType": {"type": "string", "enum": ["HEADER", "AUTHORIZER"]}, "binaryMediaTypes": {"items": {"type": "string"}, "type": "array"}, "minimumCompressionSize": {"type": "number", "minimum": 0, "maximum": 10485760}, "restApiId": {"type": "string"}, "restApiResources": {"additionalProperties": {"type": "string"}, "type": "object"}, "restApiRootResourceId": {"type": "string"}, "websocketApiId": {"type": "string"}, "disableDefaultEndpoint": {"type": "boolean"}, "apiKeys": {"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}, "customerId": {"type": "string"}, "enabled": {"type": "boolean"}}}]}}, "metrics": {"type": "boolean"}, "shouldStartNameWithService": {"type": "boolean"}, "usagePlan": {"type": "object", "properties": {"quota": {"type": "object", "properties": {"limit": {"type": "number"}, "offset": {"type": "number"}, "period": {"type": "string"}}}, "throttle": {"type": "object", "properties": {"burstLimit": {"type": "number"}, "rateLimit": {"type": "number"}}}}}}, "type": "object"}, "AwsFunction": {"properties": {"awsKmsKeyArn": {"type": "string"}, "condition": {"type": "string"}, "dependsOn": {"items": {"type": "string"}, "type": "array"}, "destinations": {}, "environment": {}, "events": {"items": {}, "type": "array"}, "handler": {"type": "string"}, "layers": {"items": {"oneOf": [{"type": "string"}, {}, {}, {}, {}, {}]}, "type": "array"}, "memorySize": {"type": ["string", "number"]}, "name": {"type": "string"}, "onError": {"type": "string"}, "package": {}, "provisionedConcurrency": {"anyOf": [{"type": "integer", "minimum": 0}, {}, {}]}, "reservedConcurrency": {"anyOf": [{"type": "integer", "minimum": 0}, {}, {}]}, "role": {"type": "string"}, "runtime": {}, "tags": {}, "timeout": {"type": ["string", "number"]}, "tracing": {"type": "string"}, "vpc": {}, "image": {"oneOf": [{"type": "string"}, {"type": "object", "properties": {"uri": {"type": "string"}, "name": {"type": "string"}, "workingDirectory": {"type": "string"}, "command": {"type": "array", "items": {"type": "string"}}, "entryPoint": {"type": "array", "items": {"type": "string"}}}}]}, "snapStart": {"type": "boolean"}, "logDataProtectionPolicy": {}, "runtimeManagement": {}}, "type": "object"}, "AwsCloudFront": {"properties": {"eventType": {"type": "string"}, "includeBody": {"type": "boolean"}, "origin": {}, "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"}, "ServerlessCustom": {"properties": {"pythonRequirements": {}, "wsgi": {}, "prune": {}, "esbuild": {}, "splitStacks": {}, "webpack": {}, "ssmPublish": {}}, "additionalProperties": true, "type": "object"}, "AwsDeploymentBucket": {"properties": {"blockPublicAccess": {"type": "boolean"}, "maxPreviousDeploymentArtifacts": {"type": ["string", "number"]}, "name": {"type": "string"}, "serverSideEncryption": {"type": "string"}, "sseCustomerAlgorithim": {"type": "string"}, "sseCustomerKey": {"type": "string"}, "sseCustomerKeyMD5": {"type": "string"}, "sseKMSKeyId": {"type": "string"}, "tags": {}, "skipPolicySetup": {"type": "boolean"}, "versioning": {"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": {}, "alb": {}, "alexaSkill": {}, "alexaSmartHome": {}, "cloudFront": {}, "cloudwatchEvent": {}, "cloudwatchLog": {}, "cognitoUserPool": {}, "eventBridge": {}, "http": {}, "httpApi": {}, "iot": {}, "s3": {}, "schedule": {"anyOf": [{}, {"type": "string"}]}, "sns": {}, "sqs": {"anyOf": [{}, {"type": "string"}]}, "stream": {}, "websocket": {}}, "type": "object"}, "AwsEventBridge": {"properties": {"eventBus": {"type": "string", "minLength": 1}, "schedule": {"type": "string", "pattern": "^(?:cron|rate)\\(.+\\)$"}, "name": {"type": "string", "pattern": "[a-zA-Z0-9-_.]+", "minLength": 1, "maxLength": 64}, "enabled": {"type": "boolean", "default": true}, "pattern": {"anyOf": [{}, {}]}, "input": {"type": "object"}, "inputPath": {"type": "string", "minLength": 1, "maxLength": 256}, "inputTransformer": {}, "retryPolicy": {"type": "object", "properties": {"maximumEventAge": {"type": "number", "minimum": 60, "maximum": 86400}, "maximumRetryAttempts": {"type": "number", "minimum": 0, "maximum": 185}}}}, "type": "object", "anyOf": [{"required": ["pattern"]}, {"required": ["schedule"]}]}, "AwsFunctions": {"oneOf": [{"type": "object", "additionalProperties": {}}, {"type": "string", "minLength": 1}, {"type": "array", "items": {}}]}, "AwsHttp": {"oneOf": [{"properties": {"async": {"type": "boolean"}, "authorizer": {}, "cors": {}, "method": {"type": "string"}, "path": {"type": "string"}, "private": {"type": "boolean"}, "request": {}}, "type": "object"}, {"type": "string", "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+}"]}]}, "AwsHttpApiEvent": {"oneOf": [{"properties": {"authorizer": {"anyOf": [{}, {}]}, "method": {"type": "string"}, "path": {"type": "string"}}, "type": "object"}, {"type": "string", "minLength": 1}]}, "AwsHttpApiLogs": {"properties": {"format": {"type": "string"}}, "type": "object"}, "AwsHttpAuthorizer": {"anyOf": [{"type": "string", "enum": ["aws_iam"]}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["aws_iam"]}}, "required": ["type"], "additionalProperties": false}, {"properties": {"arn": {"type": "string"}, "scopes": {"type": "array", "items": {"type": "string"}}, "claims": {"type": "array", "items": {"type": "string"}}, "type": {"type": "string", "enum": ["COGNITO_USER_POOLS"]}, "identitySource": {"type": "string", "default": "method.request.header.Authorization"}, "identityValidationExpression": {"type": "string"}, "name": {"type": "string"}, "resultTtlInSeconds": {"type": "number", "minimum": 0, "maximum": 3600}}, "required": ["type", "arn"], "additionalProperties": false}, {"type": "object", "properties": {"arn": {"type": "string"}, "identitySource": {"type": "string", "default": "method.request.header.Authorization"}, "identityValidationExpression": {"type": "string"}, "name": {"type": "string"}, "resultTtlInSeconds": {"type": "number", "minimum": 0, "maximum": 3600}, "type": {"type": "string", "enum": ["request", "token", "REQUEST", "TOKEN"], "default": "token"}}, "required": ["name"], "additionalProperties": false}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["CUSTOM"]}, "authorizerId": {"type": "string"}}, "required": ["type", "authorizerId"], "additionalProperties": false}]}, "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": {}, "schema": {"additionalProperties": {"type": "string"}, "type": "object"}}, "type": "object"}, "AwsIdRefHttpApiEventAuthorizer": {"properties": {"id": {"type": "string"}, "scopes": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "AwsIot": {"properties": {"enabled": {"type": "boolean"}, "name": {"type": "string"}, "sql": {"type": "string"}, "sqlVersion": {"type": "string"}}, "type": "object"}, "AwsLogs": {"properties": {"frameworkLambda": {"type": "boolean"}, "httpApi": {"anyOf": [{}, {"type": "boolean"}]}, "restApi": {}, "websocket": {}}, "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": {}, "detail-type": {"items": {"type": "string"}, "type": "array"}, "source": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "AwsProvider": {"type": "object", "properties": {"alb": {}, "ecr": {"type": "object", "properties": {"scanOnPush": {"type": "boolean"}, "images": {"type": "object", "additionalProperties": {"oneOf": [{"type": "object", "properties": {"uri": {"type": "string"}}}, {"type": "object", "properties": {"path": {"type": "string"}, "file": {"type": "string"}, "buildArgs": {"type": "object"}, "cacheFrom": {"type": "array", "items": {"type": "string"}}}}]}}}}, "apiGateway": {}, "apiKeys": {"items": {"type": "string"}, "type": "array"}, "apiName": {"type": "string"}, "cfnRole": {"type": "string"}, "deploymentBucket": {}, "deploymentPrefix": {"type": "string"}, "endpointType": {"enum": ["EDGE", "PRIVATE", "REGIONAL"], "type": "string"}, "environment": {}, "httpApi": {}, "iam": {}, "iamManagedPolicies": {"items": {"type": "string"}, "type": "array"}, "iamRoleStatements": {"items": {}, "type": "array"}, "logRetentionInDays": {"type": ["string", "number"]}, "logs": {}, "memorySize": {"oneOf": [{"type": "string"}, {"type": "number", "minimum": 128, "maximum": 10240}], "type": ["string", "number"]}, "name": {"enum": ["aws"], "type": "string"}, "notificationArns": {"items": {"type": "string"}, "type": "array"}, "profile": {"type": "string"}, "region": {}, "reservedConcurrency": {"type": ["string", "number"]}, "resourcePolicy": {"items": {}, "type": "array"}, "role": {"type": "string"}, "rolePermissionsBoundary": {"type": "string"}, "rollbackConfiguration": {}, "runtime": {}, "stackName": {"type": "string"}, "stackParameters": {"items": {}, "type": "array"}, "stackPolicy": {"items": {}, "type": "array"}, "stackTags": {}, "stage": {"type": "string"}, "tags": {}, "timeout": {"type": ["string", "number"]}, "tracing": {}, "usagePlan": {}, "versionFunctions": {"type": "boolean"}, "architecture": {}, "vpc": {}, "websocketsApiName": {"type": "string"}, "websocketsApiRouteSelectionExpression": {"type": "string"}, "websocketsDescription": {"type": "string"}, "deploymentMethod": {"type": "string", "enum": ["direct", "changesets"]}, "disableRollback": {"type": "boolean"}, "logDataProtectionPolicy": {}, "runtimeManagement": {}}, "required": ["name"]}, "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"}, "ServerlessFrameworkResources": {"oneOf": [{"properties": {"Outputs": {}, "Resources": {}, "Mappings": {"type": "object", "patternProperties": {"^[a-zA-Z0-9._-]{1,255}$": {}}, "additionalProperties": false}, "Conditions": {}, "Parameters": {}, "Hooks": {"type": "object"}, "Rules": {"type": "object"}, "AWSTemplateFormatVersion": {"type": "string", "enum": ["2010-09-09"]}, "Metadata": {"type": "object"}, "Transform": {}}, "type": "object"}, {}]}, "ServerlessFilePath": {"type": "string", "minLength": 1, "pattern": "\\$\\{file\\(.+\\.(yml|yaml)\\)(:[A-Za-z]+)?(\\s*,\\s*(\"[^,]*\"|'[^,]*'|[A-Za-z:._-]+)\\s*)?\\}"}, "AwsRestApiLogs": {"properties": {"accessLogging": {"type": "boolean"}, "executionLogging": {"type": "boolean"}, "format": {"type": "string"}, "fullExecutionData": {"type": "boolean"}, "level": {"type": "string"}, "role": {"type": "string"}, "roleManagedExternally": {"type": "boolean"}}, "type": "object"}, "AwsRollbackConfiguration": {"properties": {"MonitoringTimeInMinutes": {"type": ["string", "number"]}, "RollbackTriggers": {"items": {}, "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": {}, "type": "array"}}, "type": "object"}, {"type": "string", "minLength": 3, "maxLength": 63, "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]$"}]}, "AwsS3Rule": {"properties": {"prefix": {"type": "string"}, "suffix": {"type": "string"}}, "type": "object"}, "ServerlessServiceConfiguration": {"properties": {"awsKmsKeyArn": {"type": "string"}, "name": {"type": "string"}}, "type": "object"}, "AwsStackParameters": {"properties": {"ParameterKey": {"type": "string"}, "ParameterValue": {"type": "string"}}, "type": "object"}, "AwsStream": {"properties": {"arn": {}, "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": {}, "throttle": {}}, "type": "object"}, "AwsVpc": {"properties": {"securityGroupIds": {"items": {}, "type": "array"}, "subnetIds": {"items": {}, "type": "array"}}, "type": "object", "required": ["securityGroupIds", "subnetIds"]}, "AwsWebsocket": {"properties": {"authorizer": {}, "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": {"level": {"type": "string", "enum": ["INFO", "ERROR"]}, "format": {"type": "string"}, "accessLogging": {"type": "boolean"}, "executionLogging": {"type": "boolean"}, "fullExecutionData": {"type": "boolean"}}, "type": "object"}}, "properties": {"app": {"type": "string"}, "custom": {}, "frameworkVersion": {"type": "string"}, "functions": {}, "layers": {}, "org": {"type": "string"}, "package": {}, "plugins": {"oneOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "object", "properties": {"localPath": {"type": "string"}, "modules": {"type": "array", "items": {"type": "string"}}}}]}, "provider": {}, "resources": {"oneOf": [{}, {"items": {}, "type": "array"}]}, "service": {"oneOf": [{}, {"type": "string"}]}, "tenant": {"type": "string"}, "stepFunctions": {}}, "type": "object", "required": ["provider", "service"]} |
|
reference.json | binaryMediaTypes | Optional binary media types the API might return | {"items": {"type": "string"}, "type": "array"} |
reference.json | disableDefaultEndpoint | Disable the default 'execute-api' HTTP endpoint (default: false) | {"type": "boolean"} |
reference.json | enabled | Can be used to disable the API key without removing it (default: true) | {"type": "boolean"} |
reference.json | shouldStartNameWithService | Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3. | {"type": "boolean"} |
reference.json | layers | 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"}, {}, {}, {}, {}, {}]}, "type": "array"} |
reference.json | command | 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 | {"type": "array", "items": {"type": "string"}} |
reference.json | entryPoint | Sometimes it appears that { from the dockerfile is not read and we have to overwrite it manually to make it work | {"type": "array", "items": {"type": "string"}} |
reference.json | snapStart | https://www.serverless.com/framework/docs/providers/aws/guide/functions#snapstart | {"type": "boolean"} |
reference.json | AwsDeploymentBucket | Configure the S3 bucket used by Serverless Framework to deploy code packages to Lambda | {"properties": {"blockPublicAccess": {"type": "boolean"}, "maxPreviousDeploymentArtifacts": {"type": ["string", "number"]}, "name": {"type": "string"}, "serverSideEncryption": {"type": "string"}, "sseCustomerAlgorithim": {"type": "string"}, "sseCustomerKey": {"type": "string"}, "sseCustomerKeyMD5": {"type": "string"}, "sseKMSKeyId": {"type": "string"}, "tags": {}, "skipPolicySetup": {"type": "boolean"}, "versioning": {"type": "boolean"}}, "type": "object"} |
reference.json | blockPublicAccess | 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"} |
reference.json | maxPreviousDeploymentArtifacts | On deployment, serverless prunes artifacts older than this limit (default: 5) | {"type": ["string", "number"]} |
reference.json | name | Name of an existing bucket to use (default: created by serverless) | {"type": "string"} |
reference.json | skipPolicySetup | Skip the creation of a default bucket policy when the deployment bucket is created (default: false) | {"type": "boolean"} |
reference.json | versioning | Enable bucket versioning (default: false) | {"type": "boolean"} |
reference.json | AwsEventBridge | Aws Lambda function Eventbridge event source | {"properties": {"eventBus": {"type": "string", "minLength": 1}, "schedule": {"type": "string", "pattern": "^(?:cron|rate)\\(.+\\)$"}, "name": {"type": "string", "pattern": "[a-zA-Z0-9-_.]+", "minLength": 1, "maxLength": 64}, "enabled": {"type": "boolean", "default": true}, "pattern": {"anyOf": [{}, {}]}, "input": {"type": "object"}, "inputPath": {"type": "string", "minLength": 1, "maxLength": 256}, "inputTransformer": {}, "retryPolicy": {"type": "object", "properties": {"maximumEventAge": {"type": "number", "minimum": 60, "maximum": 86400}, "maximumRetryAttempts": {"type": "number", "minimum": 0, "maximum": 185}}}}, "type": "object", "anyOf": [{"required": ["pattern"]}, {"required": ["schedule"]}]} |
reference.json | AwsHttpAuthorizer | AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers | {"type": "string", "enum": ["aws_iam"]} |
reference.json | AwsHttpAuthorizer | AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers | {"type": "object", "properties": {"type": {"type": "string", "enum": ["aws_iam"]}}, "required": ["type"], "additionalProperties": false} |
reference.json | arn | The arn of the cognito user pool | {"type": "string"} |
reference.json | identitySource | 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", "default": "method.request.header.Authorization"} |
reference.json | identitySource | 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", "default": "method.request.header.Authorization"} |
reference.json | AwsHttpAuthorizer | Use an existing Api Gateway Authorizer created outside or in the same stack | {"type": "object", "properties": {"type": {"type": "string", "enum": ["CUSTOM"]}, "authorizerId": {"type": "string"}}, "required": ["type", "authorizerId"], "additionalProperties": false} |
reference.json | authorizerId | The Id of the existing authorizer | {"type": "string"} |
reference.json | AwsProvider | Configuration for Serverless AWS | {"type": "object", "properties": {"alb": {}, "ecr": {"type": "object", "properties": {"scanOnPush": {"type": "boolean"}, "images": {"type": "object", "additionalProperties": {"oneOf": [{"type": "object", "properties": {"uri": {"type": "string"}}}, {"type": "object", "properties": {"path": {"type": "string"}, "file": {"type": "string"}, "buildArgs": {"type": "object"}, "cacheFrom": {"type": "array", "items": {"type": "string"}}}}]}}}}, "apiGateway": {}, "apiKeys": {"items": {"type": "string"}, "type": "array"}, "apiName": {"type": "string"}, "cfnRole": {"type": "string"}, "deploymentBucket": {}, "deploymentPrefix": {"type": "string"}, "endpointType": {"enum": ["EDGE", "PRIVATE", "REGIONAL"], "type": "string"}, "environment": {}, "httpApi": {}, "iam": {}, "iamManagedPolicies": {"items": {"type": "string"}, "type": "array"}, "iamRoleStatements": {"items": {}, "type": "array"}, "logRetentionInDays": {"type": ["string", "number"]}, "logs": {}, "memorySize": {"oneOf": [{"type": "string"}, {"type": "number", "minimum": 128, "maximum": 10240}], "type": ["string", "number"]}, "name": {"enum": ["aws"], "type": "string"}, "notificationArns": {"items": {"type": "string"}, "type": "array"}, "profile": {"type": "string"}, "region": {}, "reservedConcurrency": {"type": ["string", "number"]}, "resourcePolicy": {"items": {}, "type": "array"}, "role": {"type": "string"}, "rolePermissionsBoundary": {"type": "string"}, "rollbackConfiguration": {}, "runtime": {}, "stackName": {"type": "string"}, "stackParameters": {"items": {}, "type": "array"}, "stackPolicy": {"items": {}, "type": "array"}, "stackTags": {}, "stage": {"type": "string"}, "tags": {}, "timeout": {"type": ["string", "number"]}, "tracing": {}, "usagePlan": {}, "versionFunctions": {"type": "boolean"}, "architecture": {}, "vpc": {}, "websocketsApiName": {"type": "string"}, "websocketsApiRouteSelectionExpression": {"type": "string"}, "websocketsDescription": {"type": "string"}, "deploymentMethod": {"type": "string", "enum": ["direct", "changesets"]}, "disableRollback": {"type": "boolean"}, "logDataProtectionPolicy": {}, "runtimeManagement": {}}, "required": ["name"]} |
reference.json | scanOnPush | Enabling this will make AWS scan image for CVE(Common Vulnerabilities and Exposures) | {"type": "boolean"} |
reference.json | uri | URI of an existing Docker image in ECR | {"type": "string"} |
reference.json | path | Path to the Docker context that will be used when building that image locally (default: '.') | {"type": "string"} |
reference.json | file | Dockerfile that will be used when building the image locally (default: 'Dockerfile') | {"type": "string"} |
reference.json | apiName | Change this to use a custom name for the API Gateway API | {"type": "string"} |
reference.json | memorySize | Note: API Gateway has a maximum timeout of 30 seconds | {"type": "number", "minimum": 128, "maximum": 10240} |
reference.json | versionFunctions | Use function versioning (enabled by default) | {"type": "boolean"} |
reference.json | deploymentMethod | Method used for CloudFormation deployments: 'changesets' or 'direct' (default: changesets). See https://www.serverless.com/framework/docs/providers/aws/guide/deploying#deployment-method | {"type": "string", "enum": ["direct", "changesets"]} |
reference.json | disableRollback | Disable automatic rollback by CloudFormation on failure. To be used for non-production environments. | {"type": "boolean"} |
reference.json | ServerlessFrameworkResources | Serverless Framework Additional Resources Configuration | {"properties": {"Outputs": {}, "Resources": {}, "Mappings": {"type": "object", "patternProperties": {"^[a-zA-Z0-9._-]{1,255}$": {}}, "additionalProperties": false}, "Conditions": {}, "Parameters": {}, "Hooks": {"type": "object"}, "Rules": {"type": "object"}, "AWSTemplateFormatVersion": {"type": "string", "enum": ["2010-09-09"]}, "Metadata": {"type": "object"}, "Transform": {}}, "type": "object"} |
reference.json | Mappings | https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html | {"type": "object", "patternProperties": {"^[a-zA-Z0-9._-]{1,255}$": {}}, "additionalProperties": false} |
reference.json | Conditions | https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html | {} |
reference.json | Parameters | https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html | {} |
reference.json | Hooks | https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html | {"type": "object"} |
reference.json | Rules | https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html | {"type": "object"} |
reference.json | AWSTemplateFormatVersion | https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html | {"type": "string", "enum": ["2010-09-09"]} |
reference.json | Description | https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html | {"type": "string", "maxLength": 1024} |
reference.json | Metadata | https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html | {"type": "object"} |
reference.json | Transform | https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html | {} |
reference.json | AwsS3 | 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 | {"type": "string", "minLength": 3, "maxLength": 63, "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]$"} |
reference.json | ServerlessServiceConfiguration | **@deprecated and doesn't work in serverless framework v3** | {"properties": {"awsKmsKeyArn": {"type": "string"}, "name": {"type": "string"}}, "type": "object"} |
reference.json | format | Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html | {"type": "string"} |
reference.json | accessLogging | Enables HTTP access logs (default: true) | {"type": "boolean"} |
reference.json | executionLogging | Enable execution logging (default: true) | {"type": "boolean"} |
reference.json | fullExecutionData | Log full requests/responses for execution logging (default: true) | {"type": "boolean"} |
reference.json | localPath | The path to the local .js file that contains the plugin | {"type": "string"} |
compile-commands.json | Describes a format for specifying how to replay single compilations independently of the build system | {"$schema": "http://json-schema.org/draft-04/schema#", "definitions": {"commandObject": {"properties": {"directory": {"type": "string"}, "file": {"type": "string"}, "command": {"type": "string"}, "arguments": {"type": "array", "items": {"type": "string"}}, "output": {"type": "string"}}, "anyOf": [{"required": ["directory", "file", "command"]}, {"required": ["directory", "file", "arguments"]}]}}, "id": "https://json.schemastore.org/compile-commands.json", "items": {}, "type": "array"} |
|
compile-commands.json | directory | The working directory of the compilation. All paths specified in the command or file fields must be either absolute or relative to this directory. | {"type": "string"} |
compile-commands.json | file | The main translation unit source processed by this compilation step. This is used by tools as the key into the compilation database. There can be multiple command objects for the same file, for example if the same source file is compiled with different configurations. | {"type": "string"} |
compile-commands.json | command | The compile command executed. After JSON unescaping, this must be a valid command to rerun the exact compilation step for the translation unit in the environment the build system uses. Parameters use shell quoting and shell escaping of quotes, with '"' and '\' being the only special characters. Shell expansion is not supported. | {"type": "string"} |
compile-commands.json | arguments | The compile command executed as list of strings. | {"type": "array", "items": {"type": "string"}} |
compile-commands.json | output | The name of the output created by this compilation step. This field is optional. It can be used to distinguish different processing modes of the same input file. | {"type": "string"} |
typings.json | main | The entry point to the definition (canonical to `"main"` in NPM's `package.json`). | {"type": "string"} |
typings.json | browser | A string, or map of paths, to override during resolution. See spec: https://github.com/defunctzombie/package-browser-field-spec | {"type": ["object", "string"]} |
typings.json | version | The semver range this definition is typed for | {"type": "string"} |
typings.json | homepage | Homepage url of the source package | {"type": "string"} |
typings.json | resolution | Map of resolutions to install | {"type": ["object", "string"]} |
typings.json | files | Used as an alternative or to complement `main`, specify an array of files that are exported but aren't already part of the resolution from `main`. | {"type": "array", "items": {"type": "string"}} |
typings.json | global | Denote that this definition _must_ be installed as global. | {"type": "boolean"} |
typings.json | postmessage | A message to emit to users after typings installation. | {"type": "string"} |
typings.json | name | The name of the definition | {"type": "string"} |
typings.json | dependencies | A map of dependencies required by the project. | {"type": "object", "additionalProperties": {"type": "string"}} |
typings.json | devDependencies | A map of dependencies required by the project during development. | {"type": "object", "additionalProperties": {"type": "string"}} |
typings.json | peerDependencies | A map of dependencies expected in the parent project for this dependency to work. | {"type": "object", "additionalProperties": {"type": "string"}} |
typings.json | globalDependencies | A map of global dependencies required by the project. | {"type": "object", "additionalProperties": {"type": "string"}} |
typings.json | globalDevDependencies | A map of global dependencies required by the project during development. | {"type": "object", "additionalProperties": {"type": "string"}} |
zinoma-schema.json | Schema of the build flow configuration file `zinoma.yml`.
In order to use Žinoma with your project, you need to create a file named `zinoma.yml`. We recommend putting this file in the root directory of your project.
This struct describes the schema expected for this file. It assumes prior knowledge of the Yaml format.
__Example__
`zinoma.yml`:
```yaml targets: download_dependencies: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install
test: input: - download_dependencies.output - paths: [package.json, src, test] build: npm test
lint: input: - download_dependencies.output - paths: [package.json, src, test] build: npm run lint
check: dependencies: [test, lint]
start: input: - download_dependencies.output - paths: [package.json, src] service: exec npm run start
build: dependencies: [check] input: - paths: - Dockerfile - package.json - package-lock.json - src output: - paths: [lambda.zip] build: | docker build -t build-my-project:latest . docker create -ti --name build-my-project build-my-project:latest bash docker cp build-my-project:/var/task/lambda.zip ./ docker rm -f build-my-project ```
In this example:
- `zinoma check` will ensure the code complies to the test suites and the coding standards. - `zinoma start --watch` will run the application and restart it whenever the sources are updated. - `zinoma --clean build` will generate a clean artifact, ready to be deployed.
A fully functional and more advanced example project is available in [fbecart/zinoma-node-example](https://github.com/fbecart/zinoma-node-example). | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"imports": {"default": {}, "type": "object", "additionalProperties": {"type": "string"}}, "name": {"default": null, "type": ["string", "null"]}, "targets": {"default": {}, "type": "object", "additionalProperties": {}}}, "additionalProperties": false, "definitions": {"Dependencies": {"type": "array", "items": {"type": "string"}}, "InputResource": {"anyOf": [{"type": "string"}, {"type": "object", "required": ["paths"], "properties": {"extensions": {"type": ["array", "null"], "items": {"type": "string"}}, "paths": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, {"type": "object", "required": ["cmd_stdout"], "properties": {"cmd_stdout": {"type": "string"}}, "additionalProperties": false}]}, "InputResources": {"type": "array", "items": {}}, "OutputResource": {"anyOf": [{"type": "object", "required": ["paths"], "properties": {"extensions": {"type": ["array", "null"], "items": {"type": "string"}}, "paths": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, {"type": "object", "required": ["cmd_stdout"], "properties": {"cmd_stdout": {"type": "string"}}, "additionalProperties": false}]}, "OutputResources": {"type": "array", "items": {}}, "Target": {"anyOf": [{"type": "object", "required": ["build"], "properties": {"build": {"type": "string"}, "dependencies": {"default": [], "allOf": [{}]}, "input": {"default": [], "allOf": [{}]}, "output": {"default": [], "allOf": [{}]}}, "additionalProperties": false}, {"type": "object", "required": ["service"], "properties": {"dependencies": {"default": [], "allOf": [{}]}, "input": {"default": [], "allOf": [{}]}, "service": {"type": "string"}}, "additionalProperties": false}, {"type": "object", "required": ["dependencies"], "properties": {"dependencies": {"allOf": [{}]}}, "additionalProperties": false}]}}} |
|
zinoma-schema.json | imports | Import definitions from other Žinoma projects.
`imports` should be an object, the keys being the project names and the values their respective paths.
Before importing a project, you should make sure this project has its name defined. You should use the same name as key in the `imports` object.
Once a project is imported, targets from that project can be referenced by specifying their fully qualified name: `imported_project_name::target_name`.
__Example__
`packages/api/zinoma.yml`:
```yaml name: api
targets: test: build: cargo test ```
`packages/webapp/zinoma.yml`:
```yaml name: webapp
targets: test: build: cargo test ```
`./zinoma.yml`:
```yaml imports: api: packages/api webapp: packages/webapp
targets: test_all: dependencies: [api::test, webapp::test] ```
In this example, the target `test_all` depend from targets defined in different projects. | {"default": {}, "type": "object", "additionalProperties": {"type": "string"}} |
zinoma-schema.json | name | Name of the project.
A project name must be a string. It should start with an alphanumeric character or `_` and contain only alphanumeric characters, `-`, or `_`.
Project names should be unique. Two projects cannot have the same name.
__Example__
```yaml name: my_project ``` | {"default": null, "type": ["string", "null"]} |
zinoma-schema.json | targets | Targets (aka tasks) of this project.
[`Targets`] represent commands and scripts to execute in your build flow.
[`Targets`]: struct.Target.html
Targets run in parallel by default. To force targets to run sequentially, you can define [`dependencies`] on other targets.
[`dependencies`]: enum.Target.html#variant.Build.field.dependencies
Each target must have a unique name inside the project. The target name must be a string. It should start with an alphanumeric character or `_` and contain only alphanumeric characters, `-`, or `_`.
__Example__
```yaml targets: speak_cow: build: echo 'Moo' speak_dog: build: echo 'Woof!' ```
In this example:
- `zinoma speak_cow` will print `Moo` - `zinoma speak_dog` will print `Woof!` - `zinoma speak_cow speak_dog` will print both `Moo` and `Woof!` (not necessarily in this order) | {"default": {}, "type": "object", "additionalProperties": {}} |
zinoma-schema.json | Dependencies | List of [`targets`] that must complete successfully before this target can be built.
[`targets`]: enum.Target.html
It should be an array of strings.
If any of the dependencies fails to complete, this target will not be executed.
__Example__
```yaml targets: target1: dependencies: [] target2: dependencies: [target1] target3: dependencies: [target2] ```
In this example, `target1` must complete successfully before `target2` begins, while `target3` waits for `target2` to complete.
`zinoma target2` will run sequentially `target1` and `target2`.
`zinoma target3` will run sequentially `target1`, `target2` and `target3`. | {"type": "array", "items": {"type": "string"}} |
zinoma-schema.json | InputResource | Output resources of another target.
It should be a string with the format `<project_name>::<target_name>.output`. If the other target is located in the same project, the project name can be skipped. The `input` would then have this format: `<target_name>.output`.
When such an input is used:
- all the output resources of the other target become input resources for this target; - the other target implicitly becomes a dependency to this target.
__Example__
```yaml targets: node_dependencies: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install
compile: input: - node_dependencies.output - paths: [package.json, tsconfig.json, src] output: - paths: [dist] build: tsc
run: input: - node_dependencies.output - paths: [package.json] - compile.output service: node dist/index.js ``` | {"type": "string"} |
zinoma-schema.json | extensions | Filter files resource by file extensions.
It should be an array of strings.
If `extensions` are specified, only files matching at least one of the extensions will be included in the resource.
__Example__
```yaml targets: fmt: input: - paths: [src, tests] extensions: [rs] build: exec cargo fmt --all -- --check | {"type": ["array", "null"], "items": {"type": "string"}} |
zinoma-schema.json | paths | Paths to files or directories.
It should be an array of strings.
Each element of the array should be a path to a file or directory.
__Example__
```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ``` | {"type": "array", "items": {"type": "string"}} |
zinoma-schema.json | cmd_stdout | Shell script whose output identifies the state of a resource.
It should be a string.
__Example__
```yaml targets: build_docker_image: input: - paths: [Dockerfile, src] - cmd_stdout: 'docker image ls base:latest --format "{{.ID}}"' output: - cmd_stdout: 'docker image ls webapp:latest --format "{{.ID}}"' build: docker build -t webapp . ``` | {"type": "string"} |
zinoma-schema.json | InputResources | List of artifacts that this target depends on.
`input` should be an array of [`resources`].
[`resources`]: enum.InputResource.html
Specifying a target's `input` enables the incremental build for this target. This means that, at the time of executing the target, Žinoma will skip its build if its input resources (and [`output`] resources, if any) have not changed since its last successful completion.
[`output`]: struct.OutputResources.html
__Example__
```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] build: npm install ```
In this example, running `zinoma npm_install` once will execute `npm install`. Subsequent runs of `zinoma npm_install` will return immediately — until the content of `package.json` or `package-lock.json` is modified. | {"type": "array", "items": {}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.