architect.schema.json

title: Schema for architect.yml. See: https://docs.architect.io/reference/architect-yml

errorMessage: must contain only lower alphanumeric and single hyphens in the middle; max length 32

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32

description: A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.

description: Additional search terms to be used when the component is indexed so that others can find it more easily.

description: The name or handle of the author of the component as a developer contact.

description: The url that serves as the informational homepage of the component (i.e. a github repo).

type: number

$ref: #/definitions/SecretDefinitionSpec

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.

$ref: #/definitions/DatabaseSpec

additionalProperties: must contain only lower alphanumeric and single hyphens in the middle; max length 32

description: A database represents a stateful service powered by one of several supported database engines.

description: A database represents a stateful service powered by one of several supported database engines.

$ref: #/definitions/ServiceSpec

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

$ref: #/definitions/TaskSpec

description: A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.

pattern: must be an interpolation ref ex. $__arc__{{ secrets.example }}

$ref: #/definitions/DependencySpec

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)

$ref: #/definitions/ComponentInterfaceSpec

description: A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.

description: The top level object of the `architect.yml`; defines a deployable Architect Component.

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32

description: A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.

description: Additional search terms to be used when the component is indexed so that others can find it more easily.

description: The name or handle of the author of the component as a developer contact.

description: The url that serves as the informational homepage of the component (i.e. a github repo).

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.

description: A database represents a stateful service powered by one of several supported database engines.

description: A database represents a stateful service powered by one of several supported database engines.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)

description: The top level object of the `architect.yml`; defines a deployable Architect Component.

description: Human readable description

description: The type engine and version of database software needed for data storage.

errorMessage: must be of the format <engine>:<version> (e.g. postgres:13)

description: The connection uri of an existing database to use instead of provisioning a new one

description: Component databases let you quickly spin up a database for your service

description: Human readable description

description: The type engine and version of database software needed for data storage.

description: The connection uri of an existing database to use instead of provisioning a new one

description: Component databases let you quickly spin up a database for your service

description: Denotes whether the secret is required.

description: A human-friendly description of the secret.

description: Sets a default value for the secret if one is not provided

description: Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).

description: The number of times to retry a health check before the container is considered healthy.

description: The number of times to retry a failed health check before the container is considered unhealthy.

description: The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s

description: The time period in seconds between each health check execution. You may specify any value between: 5s and 300s

description: Delays the check from running for the specified amount of time

description: [Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set).

description: Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set).

description: [Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set).

description: Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.

description: The number of times to retry a health check before the container is considered healthy.

description: The number of times to retry a failed health check before the container is considered unhealthy.

description: The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s

description: The time period in seconds between each health check execution. You may specify any value between: 5s and 300s

description: Delays the check from running for the specified amount of time

description: Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set).

description: Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.

description: Directory at which the volume will be mounted inside the container.

description: A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set).

description: A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).

description: Human-readable description of volume

description: Marks the volume as readonly.

not: Only one of host_path, key is allowed, or none should exist

description: Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: Directory at which the volume will be mounted inside the container.

description: Human-readable description of volume

description: Marks the volume as readonly.

description: Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: The path to the directory containing the source code relative to the `architect.yml` file.

description: Option to use buildpack to build an image.

description: Build args to be passed into `docker build`.

description: Build args to be passed into `docker build`.

description: The path to the Dockerfile relative to the `build.context`

description: The stage to build in the Dockerfile

description: An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.

not: Only one of buildpack, dockerfile is allowed, or none should exist

description: The path to the directory containing the source code relative to the `architect.yml` file.

description: Option to use buildpack to build an image.

description: Build args to be passed into `docker build`.

description: Build args to be passed into `docker build`.

description: The path to the Dockerfile relative to the `build.context`

description: The stage to build in the Dockerfile

description: Custom certificate.

description: Custom certificate key.

description: Custom certificate ca.

description: Configuration for custom certificate.

description: Custom certificate.

description: Custom certificate key.

description: Custom certificate ca.

description: Configuration for custom certificate.

description: Marks the interface as an ingress.

description: The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.

errorMessage: must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between.

description: The path of the interface used for path based routing

description: IP addresses that are allowed to access the interface

description: Marks the ingress as private behind Architect authentication

description: An ingress exposes an interface to external network traffic through an architect-deployed gateway.

description: Marks the interface as an ingress.

description: The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.

description: The path of the interface used for path based routing

description: IP addresses that are allowed to access the interface

description: Marks the ingress as private behind Architect authentication

description: An ingress exposes an interface to external network traffic through an architect-deployed gateway.

description: The cpu usage required to trigger scaling.

description: The memory usage required to trigger scaling.

description: Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.

description: The cpu usage required to trigger scaling.

description: The memory usage required to trigger scaling.

description: Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.

description: The target minimum number of service replicas.

description: The target maximum number of service replicas.

description: Configuration that dictates the scaling behavior of a service.

description: The target minimum number of service replicas.

description: The target maximum number of service replicas.

description: Configuration that dictates the scaling behavior of a service.

description: Configuration that dictates the kubernetes deploy overrides.

description: Configuration that dictates the kubernetes deploy overrides.

description: Configuration that dictates the deploy overrides.

description: Configuration that dictates the deploy overrides.

description: A human-readable description of the interface.

description: The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host.

description: Port on which the service is listening for traffic.

description: Protocol that the interface responds to

description: A Basic Auth username required to access the interface

description: A Basic Auth password required to access the interface

description: The path of the interface

description: The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url.

description: Denotes that if this interface is made external, the gateway should use sticky sessions

description: A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec

description: A human-readable description of the interface.

description: The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host.

description: Port on which the service is listening for traffic.

description: Protocol that the interface responds to

description: A Basic Auth username required to access the interface

description: A Basic Auth password required to access the interface

description: The path of the interface

description: The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url.

description: Denotes that if this interface is made external, the gateway should use sticky sessions

description: Determines if the service should be running.

description: A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.

description: A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

not: Only one of build, image is allowed, or none should exist

description: Determines if the service should be running.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.

description: A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: A Task represents a recurring and/or exiting runtime (e.g. crons, schedulers, triggered jobs). Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.

description: A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: An empty object that optionally supports specifying a tag for backwards compatibility.

description: An empty object that optionally supports specifying a tag for backwards compatibility.

description: A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.

description: The host that the component interface should forward to.

description: The port that the component interface should forward to.

description: The protocol by which the component interface can be connected to.

description: The Basic Auth username by which a component interface can be connected to.

description: The Basic Auth password by which a component interface can be connected to.

description: The url that the component interface should forward to.

description: If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.

description: Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.

description: A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.

description: The host that the component interface should forward to.

description: The port that the component interface should forward to.

description: The protocol by which the component interface can be connected to.

description: The Basic Auth username by which a component interface can be connected to.

description: The Basic Auth password by which a component interface can be connected to.

description: The url that the component interface should forward to.

description: If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.

description: Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.

description: A human-friendly description of the output field.

description: Value of the output to be passed to upstream consumers

description: Components can define output fields that can be used to share configuration with consuming components.

description: A human-friendly description of the output field.

description: Value of the output to be passed to upstream consumers

description: Components can define output fields that can be used to share configuration with consuming components.

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32

description: A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.

description: Additional search terms to be used when the component is indexed so that others can find it more easily.

description: The name or handle of the author of the component as a developer contact.

description: The url that serves as the informational homepage of the component (i.e. a github repo).

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.

description: A database represents a stateful service powered by one of several supported database engines.

description: A database represents a stateful service powered by one of several supported database engines.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)

description: The top level object of the `architect.yml`; defines a deployable Architect Component.

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32

description: A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.

description: Additional search terms to be used when the component is indexed so that others can find it more easily.

description: The name or handle of the author of the component as a developer contact.

description: The url that serves as the informational homepage of the component (i.e. a github repo).

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.

description: A database represents a stateful service powered by one of several supported database engines.

description: A database represents a stateful service powered by one of several supported database engines.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)

description: The top level object of the `architect.yml`; defines a deployable Architect Component.

description: Human readable description

description: The type engine and version of database software needed for data storage.

description: The connection uri of an existing database to use instead of provisioning a new one

description: Component databases let you quickly spin up a database for your service

description: Human readable description

description: The type engine and version of database software needed for data storage.

description: The connection uri of an existing database to use instead of provisioning a new one

description: Component databases let you quickly spin up a database for your service

description: Denotes whether the secret is required.

description: A human-friendly description of the secret.

description: Sets a default value for the secret if one is not provided

description: Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).

description: Denotes whether the secret is required.

description: A human-friendly description of the secret.

description: Sets a default value for the secret if one is not provided

description: Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).

description: The number of times to retry a health check before the container is considered healthy.

description: The number of times to retry a failed health check before the container is considered unhealthy.

description: The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s

description: The time period in seconds between each health check execution. You may specify any value between: 5s and 300s

description: Delays the check from running for the specified amount of time

description: Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set).

description: [Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set).

description: Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.

description: The number of times to retry a health check before the container is considered healthy.

description: The number of times to retry a failed health check before the container is considered unhealthy.

description: The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s

description: The time period in seconds between each health check execution. You may specify any value between: 5s and 300s

description: Delays the check from running for the specified amount of time

description: Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set).

description: [Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set).

description: Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.

description: Directory at which the volume will be mounted inside the container.

description: Human-readable description of volume

description: Marks the volume as readonly.

description: Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: Directory at which the volume will be mounted inside the container.

description: Human-readable description of volume

description: Marks the volume as readonly.

description: Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: The path to the directory containing the source code relative to the `architect.yml` file.

description: Option to use buildpack to build an image.

description: Build args to be passed into `docker build`.

description: Build args to be passed into `docker build`.

description: The path to the Dockerfile relative to the `build.context`

description: The stage to build in the Dockerfile

description: The path to the directory containing the source code relative to the `architect.yml` file.

description: Option to use buildpack to build an image.

description: Build args to be passed into `docker build`.

description: Build args to be passed into `docker build`.

description: The path to the Dockerfile relative to the `build.context`

description: The stage to build in the Dockerfile

description: Custom certificate.

description: Custom certificate key.

description: Custom certificate ca.

description: Configuration for custom certificate.

description: Custom certificate.

description: Custom certificate key.

description: Custom certificate ca.

description: Configuration for custom certificate.

description: Marks the interface as an ingress.

description: The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.

description: The path of the interface used for path based routing

description: IP addresses that are allowed to access the interface

description: Marks the ingress as private behind Architect authentication

description: An ingress exposes an interface to external network traffic through an architect-deployed gateway.

description: Marks the interface as an ingress.

description: The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.

description: The path of the interface used for path based routing

description: IP addresses that are allowed to access the interface

description: Marks the ingress as private behind Architect authentication

description: An ingress exposes an interface to external network traffic through an architect-deployed gateway.

description: The cpu usage required to trigger scaling.

description: The memory usage required to trigger scaling.

description: Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.

description: The cpu usage required to trigger scaling.

description: The memory usage required to trigger scaling.

description: Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.

description: The target minimum number of service replicas.

description: The target maximum number of service replicas.

description: Configuration that dictates the scaling behavior of a service.

description: The target minimum number of service replicas.

description: The target maximum number of service replicas.

description: Configuration that dictates the scaling behavior of a service.

description: Configuration that dictates the kubernetes deploy overrides.

description: Configuration that dictates the kubernetes deploy overrides.

description: Configuration that dictates the deploy overrides.

description: Configuration that dictates the deploy overrides.

description: A human-readable description of the interface.

description: The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host.

description: Port on which the service is listening for traffic.

description: Protocol that the interface responds to

description: A Basic Auth username required to access the interface

description: A Basic Auth password required to access the interface

description: The path of the interface

description: The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url.

description: Denotes that if this interface is made external, the gateway should use sticky sessions

description: A human-readable description of the interface.

description: The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host.

description: Port on which the service is listening for traffic.

description: Protocol that the interface responds to

description: A Basic Auth username required to access the interface

description: A Basic Auth password required to access the interface

description: The path of the interface

description: The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url.

description: Denotes that if this interface is made external, the gateway should use sticky sessions

description: Determines if the service should be running.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.

description: A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: Determines if the service should be running.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.

description: A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: An empty object that optionally supports specifying a tag for backwards compatibility.

description: An empty object that optionally supports specifying a tag for backwards compatibility.

description: A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.

description: The host that the component interface should forward to.

description: The port that the component interface should forward to.

description: The protocol by which the component interface can be connected to.

description: The Basic Auth username by which a component interface can be connected to.

description: The Basic Auth password by which a component interface can be connected to.

description: The url that the component interface should forward to.

description: If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.

description: Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.

description: A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.

description: The host that the component interface should forward to.

description: The port that the component interface should forward to.

description: The protocol by which the component interface can be connected to.

description: The Basic Auth username by which a component interface can be connected to.

description: The Basic Auth password by which a component interface can be connected to.

description: The url that the component interface should forward to.

description: If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.

description: Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.

description: A human-friendly description of the output field.

description: Value of the output to be passed to upstream consumers

description: Components can define output fields that can be used to share configuration with consuming components.

description: A human-friendly description of the output field.

description: Value of the output to be passed to upstream consumers

description: Components can define output fields that can be used to share configuration with consuming components.

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32

description: A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.

description: Additional search terms to be used when the component is indexed so that others can find it more easily.

description: The name or handle of the author of the component as a developer contact.

description: The url that serves as the informational homepage of the component (i.e. a github repo).

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.

description: A database represents a stateful service powered by one of several supported database engines.

description: A database represents a stateful service powered by one of several supported database engines.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)

description: The top level object of the `architect.yml`; defines a deployable Architect Component.

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32

description: A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.

description: Additional search terms to be used when the component is indexed so that others can find it more easily.

description: The name or handle of the author of the component as a developer contact.

description: The url that serves as the informational homepage of the component (i.e. a github repo).

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.

additionalProperties: must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.

description: A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.

description: A database represents a stateful service powered by one of several supported database engines.

description: A database represents a stateful service powered by one of several supported database engines.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)

description: The top level object of the `architect.yml`; defines a deployable Architect Component.


typewiz.json

type: object

type: string

description: If given, all the file paths in the collected type info will be resolved relative to this directory.

description: Path to your project's tsconfig file. This is required for several other options like implicit this instrumentation and type inference using static analysis.

type: boolean

description: Try to find even more types by combining static analysis with the runtime analysis. TypeWiz will try to use TypeScript's inferred types when determining the type of a function argument.

description: Find type of this in non-class member functions. Requires common.tsConfig to be set

description: Don't add a declaration of $_$twiz to instrumented files.

description: A prefix that will be added in front of each type applied. You can use a javascript comment to mark the automatically added types. The prefix will be added after the colon character, just before the actual type.

title: Typewiz configuration schema


ocelot.json

$id: #/properties/Routes

type: array

title: The Routes Schema

$id: #/properties/Routes/items

title: The Items Schema

title: The Downstreampathtemplate Schema

title: The Upstreampathtemplate Schema

title: The Upstreamhttpmethod Schema

title: The Items Schema

title: The AddHeadersToRequest Schema

title: The AddClaimsToRequest Schema

title: The Routeclaimsrequirement Schema

title: The AddQueriesToRequest Schema

title: The Requestidkey Schema

title: The Filecacheoptions Schema

type: integer

title: The Ttlseconds Schema

title: The Region Schema

title: The Routeiscasesensitive Schema

title: The Servicename Schema

title: The Downstreamscheme Schema

title: The Downstreamhostandports Schema

title: The Items Schema

title: The Host Schema

title: The Port Schema

title: The Qosoptions Schema

title: The Exceptionsallowedbeforebreaking Schema

title: The Durationofbreak Schema

title: The Timeoutvalue Schema

title: The Loadbalancer Schema

title: The Ratelimitoptions Schema

title: The Clientwhitelist Schema

title: The Enableratelimiting Schema

title: The Period Schema

title: The Periodtimespan Schema

title: The Limit Schema

title: The Authenticationoptions Schema

title: The Authenticationproviderkey Schema

title: The Allowedscopes Schema

title: The Httphandleroptions Schema

title: The Allowautoredirect Schema

title: The Usecookiecontainer Schema

title: The Usetracing Schema

title: The Dangerousacceptanyservercertificatevalidator Schema

$id: #/properties/GlobalConfiguration

title: The Globalconfiguration Schema

title: The Requestidkey Schema

title: JSON Schema for Ocelot.json


nycrc.json

description: Name of configuration to extend from.

description: Whether or not to instrument all files (not just the ones touched by your test suite).

description: Check whether coverage is within thresholds, fail if not

description: List of extensions that nyc should attempt to handle in addition to .js

default: .js .cjs .mjs .ts .tsx .jsx

description: List of files to include for coverage.

description: List of files to exclude for coverage.

description: The names of custom reporter to show coverage results.

description: Where to put the coverage report files.

default: ./coverage

description: Don't show files with 100% statement, branch, and function coverage

description: Directory to output raw coverage information to.


database.beef.json

title: JSON Schema for Beef Database code-generation (https://github.com/Avanade/Beef).

title: 'CodeGeneration' object (database-driven)

description: The 'CodeGeneration' object defines global properties that are used to drive the underlying database-driven code generation.

title: The name of the 'Schema' where the artefacts are defined in, or should be created in, the database.

description: This is used as the default 'Schema' for all child objects.

title: The column name for the 'IsDeleted' capability.

description: Defaults to 'IsDeleted'.

title: The column name for the 'TenantId' capability.

description: Defaults to 'TenantId'.

title: The column name for the 'OrgUnitId' capability.

description: Defaults to 'OrgUnitId'.

title: The column name for the 'RowVersion' capability.

description: Defaults to 'RowVersion'.

title: The column name for the 'CreatedBy' capability.

description: Defaults to 'CreatedBy'.

title: The column name for the 'CreatedDate' capability.

description: Defaults to 'CreatedDate'.

title: The column name for the 'UpdatedBy' capability.

description: Defaults to 'UpdatedBy'.

title: The column name for the 'UpdatedDate' capability.

description: Defaults to 'UpdatedDate'.

title: The column name for the 'DeletedBy' capability.

description: Defaults to 'UpdatedBy'.

title: The column name for the 'DeletedDate' capability.

description: Defaults to 'UpdatedDate'.

title: The SQL table or function that is to be used to join against for security-based 'OrgUnitId' verification.

description: Defaults to '[Sec].[fnGetUserOrgUnits]()'.

title: The SQL stored procedure that is to be used for 'Permission' verification.

description: Defaults to '[Sec].[spCheckUserHasPermission]'.

title: The SQL function that is to be used for 'Permission' verification.

description: Defaults to '[Sec].[fnGetUserHasPermission]'.

title: The schema name for the generated 'CDC'-related database artefacts.

description: Defaults to 'XCdc' (literal).

title: The table name for the 'Cdc'-Tracking.

description: Defaults to 'CdcTracking' (literal).

title: Indicates whether to include the generation of the generic 'Cdc'-IdentifierMapping database capabilities.

title: The table name for the 'Cdc'-IdentifierMapping.

description: Defaults to 'CdcIdentifierMapping' (literal).

description: Defaults to 'spCreateCdcIdentifierMapping' (literal).

title: The default list of 'Column' names that should be excluded from the generated ETag (used for the likes of duplicate send tracking)

title: The JSON Serializer to use for JSON property attribution.

description: Defaults to 'Newtonsoft'. This can be overridden within the 'Entity'(s).

title: Indicates whether the .NET collection properties should be pluralized.

title: Indicates whether the database has (contains) the standard _Beef_ 'dbo' schema objects.

description: Defaults to 'true'.

title: The option to automatically rename the SQL Tables and Columns for use in .NET.

description: Defaults 'SnakeKebabToPascalCase' that will remove any underscores or hyphens separating each word and capitalize the first character of each; e.g. 'internal-customer_id' would be renamed as 'InternalCustomerId'. The 'PascalCase' option will capatilize the first character only.

enum: None PascalCase SnakeKebabToPascalCase

title: The entity scope option.

description: Defaults to 'Common' for backwards compatibility; 'Autonomous' is recommended. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible).

enum: Common Business Autonomous

title: The root for the event name by prepending to all event subject names via CDC.

description: Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be extended within the 'Entity'(s).

title: The default formatting for the Subject when an Event is published via CDC.

description: Defaults to 'NameAndKey' (being the event subject name appended with the corresponding unique key.)'.

enum: NameOnly NameAndKey

title: The formatting for the Action when an Event is published via CDC.

description: Defaults to 'None' (no formatting required, i.e. as-is).

title: The URI root for the event source by prepending to all event source URIs for CDC.

description: The event source is only updated where an 'EventSourceKind' is not 'None'. This can be extended within the 'Entity'(s).

title: The URI kind for the event source URIs for CDC.

description: Defaults to 'None' (being the event source is not updated).

enum: None Absolute Relative RelativeOrAbsolute

title: The default formatting for the Source when an Event is published via CDC.

enum: NameOnly NameAndKey NameAndGlobalId

title: Indicates whether events will publish using the outbox pattern and therefore the event outbox artefacts are required.

title: The table name for the 'EventOutbox'.

description: Defaults to 'EventOutbox' (literal).

title: The base path (directory) prefix for the Database-related artefacts; other 'Path*' properties append to this value when they are not specifically overridden.

description: Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'.

title: The path (directory) for the Schema Database-related artefacts.

description: Defaults to 'PathBase' + '.Database/Schema' (literal). For example 'Beef.Demo.Database/Schema'.

description: Defaults to 'PathBase' + '.Database/Migrations' (literal). For example 'Beef.Demo.Database/Migrations'.

title: The path (directory) for the Business-related (.NET) artefacts.

description: Defaults to 'PathBase' + '.Business' (literal). For example 'Beef.Demo.Business'.

title: The path (directory) for the CDC-related (.NET) artefacts.

description: Defaults to 'PathBase' + '.Cdc' (literal). For example 'Beef.Demo.Cdc'.

title: Indicates whether the 'OrgUnitId' column is considered immutable, in that it can not be changed once set.

description: This is only applicable for stored procedures.

title: The base Namespace (root) for the .NET artefacts.

title: The Namespace (root) for the Common-related .NET artefacts.

description: Defaults to 'NamespaceBase' + '.Common' (literal). For example 'Beef.Demo.Common'.

title: The Namespace (root) for the Business-related .NET artefacts.

description: Defaults to 'NamespaceBase' + '.Business' (literal). For example 'Beef.Demo.Business'.

title: The Namespace (root) for the CDC-related publisher .NET artefacts.

description: Defaults to 'NamespaceBase' + '.CdcPublisher' (literal). For example 'Beef.Demo.CdcPublisher'.

title: The corresponding 'Table' collection.

$ref: #/definitions/Table

title: The corresponding 'Query' collection.

$ref: #/definitions/Query

title: 'Table' object (entity-driven)

description: The 'Table' object identifies an existing database 'Table' (or 'View') and defines its code-generation characteristics.

title: The name of the 'Table' in the database.

title: The name of the 'Schema' where the 'Table' is defined in the database.

description: Defaults to 'CodeGeneration.Schema'.

title: The 'Schema.Table' alias name.

description: Will automatically default where not specified.

title: The list of 'Column' names to be included in the underlying generated output.

description: Where not specified this indicates that all 'Columns' are to be included.

title: The list of 'Column' names to be excluded from the underlying generated output.

description: Where not specified this indicates no 'Columns' are to be excluded.

title: Indicates whether a 'Get' stored procedure is to be automatically generated where not otherwise explicitly specified.

title: Indicates whether a 'GetAll' stored procedure is to be automatically generated where not otherwise explicitly specified.

description: The 'GetAllOrderBy' is used to specify the 'GetAll' query sort order.

title: The list of 'Column' names (including sort order 'ASC'/'DESC' literal) to be used as the 'GetAll' query sort order.

description: This relates to the 'GetAll' selection.

title: Indicates whether a 'Create' stored procedure is to be automatically generated where not otherwise explicitly specified.

title: Indicates whether a 'Update' stored procedure is to be automatically generated where not otherwise explicitly specified.

title: Indicates whether a 'Upsert' stored procedure is to be automatically generated where not otherwise explicitly specified.

title: Indicates whether a 'Delete' stored procedure is to be automatically generated where not otherwise explicitly specified.

title: Indicates whether a 'Merge' (insert/update/delete of 'Udt' list) stored procedure is to be automatically generated where not otherwise explicitly specified.

description: This will also require a 'Udt' (SQL User Defined Table) and 'Tvp' (.NET Table-Valued Parameter) to function.

title: Indicates whether an 'Entity Framework' .NET (C#) model is to be generated.

title: The .NET (C#) EntityFramework (EF) model name.

description: Defaults to 'Name'.

title: Indicates whether a 'User Defined Table (UDT)' type should be created.

title: The list of 'Column' names to be excluded from the 'User Defined Table (UDT)'.

description: Where not specified this indicates that no 'Columns' are to be excluded.

title: The name of the .NET entity associated with the 'Udt' so that it can be expressed (created) as a Table-Valued Parameter for usage within the corresponding 'DbMapper'.

title: The entity scope option.

description: Defaults to 'CodeGeneration.EntityScope'. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible).

title: The permission (prefix) to be used for security permission checking (suffix defaults to 'Read', 'Write' or 'Delete' and can be overridden in the underlying stored procedure).

description: Defaults to 'CodeGeneration.OrgUnitImmutable'. This is only applicable for stored procedures.

description: Defaults to 'CodeGeneration.IsDeleted'.

description: Defaults to 'CodeGeneration.TenantId'.

description: Defaults to 'CodeGeneration.OrgUnitId'.

description: Defaults to 'CodeGeneration.RowVersion'.

description: Defaults to 'CodeGeneration.CreatedBy'.

description: Defaults to 'CodeGeneration.CreatedDate'.

description: Defaults to 'CodeGeneration.UpdatedBy'.

description: Defaults to 'CodeGeneration.UpdatedDate'.

description: Defaults to 'CodeGeneration.UpdatedBy'.

title: The corresponding 'StoredProcedure' collection.

$ref: #/definitions/StoredProcedure

title: 'StoredProcedure' object (database-driven)

description: The code generation for an 'StoredProcedure' is primarily driven by the 'Type' property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting 'Upsert', 'Merge' and ad-hoc queries as required.

title: The name of the 'StoredProcedure'; generally the verb/action, i.e. 'Get', 'Update', etc.

description: See 'StoredProcedureName' for the actual name used in the database.

title: The stored procedure operation type.

description: Defaults to 'GetColl'.

enum: Get GetColl Create Update Upsert Delete Merge

title: Indicates whether standardized paging support should be added.

description: This only applies where the stored procedure operation 'Type' is 'GetColl'.

title: The 'StoredProcedure' name in the database.

description: Defaults to 'sp' + 'Table.Name' + 'Name'; e.g. 'spTableName' or 'spPersonGet'.

title: The SQL statement to perform the reselect after a 'Create', 'Update' or 'Upsert' stored procedure operation 'Type'.

description: Defaults to '[{{Table.Schema}}].[sp{{Table.Name}}Get]' passing the primary key column(s).

title: Indicates whether to select into a '#TempTable' to allow other statements access to the selected data.

description: A 'Select * from #TempTable' is also performed (code-generated) where the stored procedure operation 'Type' is 'GetColl'.

title: the table hints using the SQL Server 'WITH()' statement; the value specified will be used as-is; e.g. 'NOLOCK' will result in 'WITH(NOLOCK)'.

title: The list of 'Column' names to be used in the 'Merge' statement to determine whether to _insert_, _update_ or _delete_.

description: This is used to override the default behaviour of using the primary key column(s).

title: The name of the 'StoredProcedure' in the database.

description: Defaults to 'Table.OrgUnitImmutable'.

title: The list of 'Column' names to be included in the underlying generated _settable_ output (further filters 'Table.IncludeColumns').

description: Where not specified this indicates that all 'Columns' are to be included. Only filters the columns where 'Type' is 'Get', 'GetColl', 'Create', 'Update' or 'Upsert'.

title: The list of 'Column' names to be excluded from the underlying generated _settable_ output (further filters 'Table.ExcludeColumns').

description: Where not specified this indicates no 'Columns' are to be excluded. Only filters the columns where 'Type' is 'Get', 'GetColl', 'Create', 'Update' or 'Upsert'.

title: The corresponding 'Parameter' collection.

title: The corresponding 'Where' collection.

title: The corresponding 'OrderBy' collection.

title: The corresponding 'Execute' collection.

title: 'Parameter' object (database-driven)

description: The 'Parameter' is used to define a stored procedure parameter and its charateristics. These are in addition to those that are automatically inferred (added) by the selected 'StoredProcedure.Type'.

title: The parameter name (without the '@' prefix).

title: The corresponding column name; used to infer characteristics.

description: Defaults to 'Name'.

title: The SQL type definition (overrides inherited Column definition) including length/precision/scale.

title: Indicates whether the parameter is nullable.

description: Note that when the parameter value is 'NULL' it will not be included in the query.

title: Indicates whether the column value where NULL should be treated as the specified value; results in: 'ISNULL([x].[col], value)'.

title: Indicates whether the parameter is a collection (one or more values to be included 'IN' the query).

title: The where clause equality operator

description: Defaults to 'EQ'.

title: 'Where' object (database-driven)

description: The 'Where' object defines an additional where 'Statement' to be added. This is in addition to those automatically added based on the 'StoredProcedure.Type'.

title: The where statement (TSQL).

title: 'OrderBy' object (database-driven)

description: The 'OrderBy' object defines the query order. Only valid for 'StoredProcedure.Type' of 'GetAll'.

title: The name of the 'Column' to order by.

title: The corresponding sort order.

description: Defaults to 'Ascending'.

title: 'Execute' object (database-driven)

description: The _Execute_ object enables additional TSQL statements to be embedded within the stored procedure.

title: The additional TSQL statement.

title: The location of the statement in relation to the underlying primary stored procedure statement.

description: Defaults to 'After'.

title: 'Query' object (database-driven)

description: The 'Query' object enables the definition of more complex multi-table queries ('Joins') that would primarily result in a database _View_. The primary table 'Name' for the query is required to be specified. Multiple queries can be specified for the same table(s). The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required (for example duplicate name). Additional 'Where' and 'Order' configuration can also be added as required.

title: The name of the primary table of the query.

title: The schema name of the primary table of the view.

description: Defaults to 'CodeGeneration.dbo'.

title: The 'Schema.Table' alias name.

description: Will automatically default where not specified.

title: The list of 'Column' names to be included in the underlying generated output.

description: Where not specified this indicates that all 'Columns' are to be included.

title: The list of 'Column' names to be excluded from the underlying generated output.

description: Where not specified this indicates no 'Columns' are to be excluded.

title: The list of 'Column' and 'Alias' pairs (split by a '^' lookup character) to enable column aliasing/renaming.

description: Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'

title: Indicates whether a 'View' is to be generated.

title: The 'View' name.

description: Defaults to 'vw' + 'Name'; e.g. 'vwTableName'.

title: The schema name for the 'View'.

description: Defaults to 'Schema'.

title: The permission to be used for security permission checking.

description: The suffix is optional, and where not specified will default to '.READ'.

title: The column name for the 'IsDeleted' capability.

description: Defaults to 'CodeGeneration.IsDeleted'.

title: The column name for the 'TenantId' capability.

description: Defaults to 'CodeGeneration.TenantId'.

title: The column name for the 'OrgUnitId' capability.

description: Defaults to 'CodeGeneration.OrgUnitId'.

title: The column name for the 'RowVersion' capability.

description: Defaults to 'CodeGeneration.RowVersion'.

title: The column name for the 'CreatedBy' capability.

description: Defaults to 'CodeGeneration.CreatedBy'.

title: The column name for the 'CreatedDate' capability.

description: Defaults to 'CodeGeneration.CreatedDate'.

title: The column name for the 'UpdatedBy' capability.

description: Defaults to 'CodeGeneration.UpdatedBy'.

title: The column name for the 'UpdatedDate' capability.

description: Defaults to 'CodeGeneration.UpdatedDate'.

title: The column name for the 'DeletedBy' capability.

description: Defaults to 'CodeGeneration.UpdatedBy'.

title: The column name for the 'DeletedDate' capability.

description: Defaults to 'CodeGeneration.UpdatedDate'.

title: The corresponding 'Join' collection.

title: The corresponding 'Order' collection.

title: The corresponding 'Where' collection.

title: 'QueryJoin' object (database-driven)

description: The 'QueryJoin' object defines a join to another (or same) table within a query. The 'Type' defines the join type, such as inner join, etc. The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required (for example duplicate name).

title: The name of the table to join.

title: The schema name of the table to join.

description: Defaults to 'Table.Schema'; i.e. same schema.

title: The 'Schema.Table' alias name.

title: The SQL join type.

description: Defaults to 'Inner'.

title: The list of 'Column' and 'Alias' pairs (split by a '^' lookup character) to enable column renaming.

description: Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'

description: Defaults to 'CodeGeneration.IsDeleted'.

description: Defaults to 'CodeGeneration.TenantId'.

description: Defaults to 'CodeGeneration.OrgUnitId'.

description: Defaults to 'CodeGeneration.CreatedBy'.

description: Defaults to 'CodeGeneration.UpdatedBy'.

description: Defaults to 'CodeGeneration.UpdatedBy'.

title: The corresponding 'JoinOn' collection.

title: 'QueryJoinOn' object (database-driven)

description: The 'QueryJoinOn' object defines the join on characteristics for a join within a query.

title: The name of the join column (from the 'Join' table).

title: The name of the other join to table schema.

description: Defaults to 'Table.Schema'; i.e. same schema. See also 'ToTable' and 'ToColumn' as these all relate.

title: The name of the other join to table.

description: Defaults to 'Table.Name'; i.e. primary table. See also 'ToSchema' and 'ToColumn' as these all relate.

title: The name of the other join to column.

description: Defaults to 'Name'; i.e. assumes same name. See also 'ToSchema' and 'ToTable' as these all relate.

title: The fully qualified name ('Alias.Name') of the other column being joined to or other valid SQL (e.g. function) bypassing the corresponding 'Schema', 'Table' and 'Column' logic.

title: 'QueryOrder' object (database-driven)

description: The 'QueryOrder' object that defines the query order.

title: The name of the 'Column' to order by.

description: See also 'Schema' and 'Table' as these all relate.

title: The name of order by table schema. See also 'Name' and 'Column' as these all relate.

description: Defaults to 'Query.Schema'.

title: The name of the order by table.

description: Defaults to 'Table.Name'; i.e. primary table. See also 'Schema' and 'Column' as these all relate.

title: The corresponding sort order.

description: Defaults to 'Ascending'.

title: 'QueryWhere' object (database-driven)

description: The 'QueryWhere' object defines an additional where 'Statement' to be added.

title: The where TSQL statement.


now.json

description: domain names (optionally including subdomains) added to the account, or a string for a suffixed URL using .now.sh or a Custom Deployment Suffix

description: environment keys and values

description: ZEIT Now project configuration file

description: name for the deployment

description: the Now Platform version that the deployment should use and is known to work with

$ref: #/definitions/alias

description: an ID or slug for teams, or an email address, username, or ID for users

$ref: #/definitions/env

description: environment variables passed to the invoked Serverless Functions

description: environment variables passed to the Build processes

description: a list of build descriptions whose src references valid source files

description: build description

required: src use

description: A glob expression or pathname. If more than one file is resolved, one build will be created per matched file. It can include `*` and `**`.

description: A npm module to be installed by the build process. It can include a semver compatible version (e.g.: `@org/proj@1`).

description: An object including arbitrary metadata to be passed to the Builder.

description: a list of route definitions

description: route definition

description: A PCRE-compatible regular expression that matches each incoming pathname (excluding querystring).

description: A set of HTTP method types. If no method is provided, requests with any HTTP method will be a candidate for the route.

enum: GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH

description: A destination pathname or full URL, including querystring, with the ability to embed capture groups as $1, $2…

description: A set of headers to apply for responses.

description: A status code to respond with. Can be used in tandem with `Location:` header to implement redirects.

description: A boolean to change matching behavior. If true, routing will continue even when the src is matched.

description: the deployment regions of the Serverless Functions that get created as a result of the build steps

description: region identifier

description: When set to true, both the source view and logs view will be publicly accessible (when the user is authenticated with ZEIT).

description: Git integration options

description: When set to false, Now for GitHub will not deploy the given project regardless of the GitHub app being installed.

description: When set to false, Now for GitHub will not apply the alias upon merge.

description: When set to true, Now for GitHub will stop commenting on pull requests and commits.

description: When set to false, Now for GitHub will always build pushes in sequence without cancelling a build for the most recent commit.


description: A profile is some template set of checks to run with Qodana analysis

description: The profile name (embedded or located in the project)

description: The path to the profile file relative to the project root

description: The inspections to run in addition to those from the profile

description: The ID of the inspection to be added

description: The inspections or paths to exclude from analysis

description: The ID of the inspection to exclude, or 'All'

description: The path in which to disable the inspection, relative to the project root. Omitting the paths disables the inspection everywhere

description: The default running scenario

description: The name of the script

enum: default php-migration

description: The parameters to pass to the script

description: A license rule to apply for license compatibility checks in Qodana

description: The list of project license SPDX IDs

description: The list of allowed dependency licenses for the project

description: The list of prohibited dependency licenses for the project

description: A dependency to ignore for license checks in Qodana

description: The name of a dependency to ignore

description: A dependency metadata to override for license checks in Qodana

description: The dependency name

description: The dependency version

description: The dependency homepage

description: The dependency licenses

$ref: #/definitions/license

required: name version licenses

description: A dependency to add to license checks to Qodana

description: The dependency name

description: The dependency version

description: The dependency homepage

description: The dependency licenses

description: A license to apply for license compatibility checks in Qodana

description: The SPDX ID of the license

description: The license homepage

description: Configuration for .NET solutions and projects

description: The name of a .NET solution inside the Qodana project

description: The name of a .NET project inside the Qodana project

description: The name of a configuration to be used for .NET solution or project

description: The name of a platform to be used for .NET solution or project

description: A configuration file for Qodana (https://jetbrains.com/qodana), named qodana.yaml or qodana.yml

description: The version of the file format

description: The profile configuration for Qodana analysis

$ref: #/definitions/profile

description: The number of problems that causes Qodana to exit with code 255

description: The run scenario. 'default' by default

$ref: #/definitions/script

description: The inspections and paths that are excluded from analysis

$ref: #/definitions/exclude

description: The inspections and paths that are added to those from the profile

$ref: #/definitions/include

description: The linter (Docker image) to run for Qodana CLI / any CI extensions

description: The command to run inside Docker before the analysis starts

description: Set JVM properties to be used while running Qodana

description: A list of license rules to apply for license checks

$ref: #/definitions/licenseRule

$ref: #/definitions/dependencyIgnore

$ref: #/definitions/dependencyOverride

$ref: #/definitions/customDependency

description: The configuration for .NET solutions and projects

$ref: #/definitions/dot-net

title: Qodana


ezd.schema.json

title: ezd

description: The schema for `ezd`

description: Environment variables to set for all tasks

description: Configure and run shell tasks

description: Describes the task for the user

description: Environment variables to set while executing these specific commands

description: A list of commands to execute within the local shell

description: Configure and run `docker-seq` tasks

description: Path to a `docker-seq.yml` file

description: Embedded `docker-seq.yml` configuration

description: Declare docker volumes to use within docker_seq tasks

description: Specify volume driver name

description: Set metadata for a volume

description: Set driver specific options