schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
mirrord-schema.json | OutgoingFilterConfig | Traffic that matches what's specified here will go through the remote pod, everything else will go through local. | {"type": "object", "required": ["remote"], "properties": {"remote": {}}, "additionalProperties": false} |
mirrord-schema.json | OutgoingFilterConfig | Traffic that matches what's specified here will go through the local app, everything else will go through the remote pod. | {"type": "object", "required": ["local"], "properties": {"local": {}}, "additionalProperties": false} |
mirrord-schema.json | PodTarget | <!--${internal}--> Mirror the pod specified by [`PodTarget::pod`]. | {"type": "object", "required": ["pod"], "properties": {"container": {"type": ["string", "null"]}, "pod": {"type": "string"}}} |
mirrord-schema.json | pod | <!--${internal}--> Pod to mirror. | {"type": "string"} |
mirrord-schema.json | PortList | <!--${internal}--> Helper struct for setting up ports configuration (part of the HTTP traffic stealer feature).
Defaults to a list of ports `[80, 8080]`.
We use this to allow implementing a custom [`Default`] initialization, as the [`MirrordConfig`] macro (currently) doesn't support more intricate expressions. | {"allOf": [{}]} |
mirrord-schema.json | RolloutTarget | <!--${internal}--> Mirror the rollout specified by [`RolloutTarget::rollout`]. | {"type": "object", "required": ["rollout"], "properties": {"container": {"type": ["string", "null"]}, "rollout": {"type": "string"}}} |
mirrord-schema.json | rollout | <!--${internal}--> Rollout to mirror. | {"type": "string"} |
mirrord-schema.json | Target | <!--${internal}--> ## path
Specifies the running pod (or deployment) to mirror.
Supports: - `pod/{sample-pod}`; - `podname/{sample-pod}`; - `deployment/{sample-deployment}`; - `container/{sample-container}`; - `containername/{sample-container}`. | {"anyOf": [{"allOf": [{}]}, {"allOf": [{}]}, {"allOf": [{}]}]} |
mirrord-schema.json | Target | <!--${internal}--> Mirror a deployment. | {"allOf": [{}]} |
mirrord-schema.json | Target | <!--${internal}--> Mirror a pod. | {"allOf": [{}]} |
mirrord-schema.json | Target | <!--${internal}--> Mirror a rollout. | {"allOf": [{}]} |
mirrord-schema.json | path | <!--${internal}--> Path is optional so that it can also be specified via env var instead of via conf file, but it is not optional in a resulting [`TargetConfig`] object - either there is a path, or the target configuration is `None`. | {"default": null, "anyOf": [{}, {"type": "null"}]} |
mirrord-schema.json | io.k8s.api.core.v1.Toleration | The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>. | {"type": "object", "properties": {"effect": {"type": "string"}, "key": {"type": "string"}, "operator": {"type": "string"}, "tolerationSeconds": {"type": "integer", "format": "int64"}, "value": {"type": "string"}}} |
mirrord-schema.json | effect | Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
| {"type": "string"} |
mirrord-schema.json | key | Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. | {"type": "string"} |
mirrord-schema.json | operator | Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
| {"type": "string"} |
mirrord-schema.json | tolerationSeconds | TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. | {"type": "integer", "format": "int64"} |
mirrord-schema.json | value | Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. | {"type": "string"} |
sarif-external-property-file-2.1.0-rtm.3.json | $schema | The URI of the JSON schema corresponding to the version of the external property file format. | {"type": "string", "format": "uri"} |
sarif-external-property-file-2.1.0-rtm.3.json | version | The SARIF format version of this external properties object. | {"enum": ["2.1.0"]} |
sarif-external-property-file-2.1.0-rtm.3.json | guid | A stable, unique identifier for this external properties object, in the form of a GUID. | {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"} |
sarif-external-property-file-2.1.0-rtm.3.json | runGuid | A stable, unique identifier for the run associated with this external properties object, in the form of a GUID. | {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"} |
sarif-external-property-file-2.1.0-rtm.3.json | conversion | A conversion object that will be merged with an external run. | {} |
sarif-external-property-file-2.1.0-rtm.3.json | graphs | An array of graph objects that will merged with an external run. | {"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | externalizedProperties | Key/value pairs that provide additional information that will be merged with an external run. | {} |
sarif-external-property-file-2.1.0-rtm.3.json | artifacts | An array of artifact objects that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | invocations | Describes the invocation of the analysis tool that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | logicalLocations | An array of logical locations such as namespaces, types or functions that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | threadFlowLocations | An array of threadFlowLocation objects that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | results | An array of result objects that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | taxonomies | Tool taxonomies that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | driver | The analysis tool object that will be merged with an external run. | {} |
sarif-external-property-file-2.1.0-rtm.3.json | extensions | Tool extensions that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | policies | Tool policies that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | translations | Tool translations that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | addresses | Addresses that will be merged with with an external run. | {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | webRequests | Requests that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | webResponses | Responses that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.3.json | properties | Key/value pairs that provide additional information about the external properties. | {} |
pmbot.yml.schema.json | actions | Actions to execute after each package manager update | {"items": {"oneOf": [{"type": "object", "properties": {"name": {"const": "create-issue"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "create-merge-request"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "auto-merge"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "webhook"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "slack"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "mattermost"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "email"}, "config": {}}}]}, "type": "array", "default": []} |
pmbot.yml.schema.json | slug | Update slug. For example, "npm", or, "npm-0" when there are multiple pmUpdates with packageManager npm. | {} |
pmbot.yml.schema.json | squash | Whether to squash commits of the update branch | {"type": "boolean", "default": true} |
pmbot.yml.schema.json | commitMessage | Commit message
This [handlebars](https://handlebarsjs.com/guide/#what-is-handlebars) template is passed the following context:
```
{
"slug": "npm-0"
}
```
| {"type": "string", "default": "chore: update {{slug}} dependencies"} |
pmbot.yml.schema.json | removeUpdateBranch | Whether to remove the update branch | {"type": "boolean", "default": true} |
pmbot.yml.schema.json | slug | Update slug. For example, "npm", or, "npm-0" when there are multiple pmUpdates with packageManager npm. | {} |
pmbot.yml.schema.json | status | Package manager update status | {} |
pmbot.yml.schema.json | statusEmoji | A status emoji corresponding to the package manager update status | {} |
pmbot.yml.schema.json | title | Issue title
This [handlebars](https://handlebarsjs.com/guide/#what-is-handlebars) template is passed the following context:
```
{
"slug": "myPm",
"status": "myStatus",
"statusEmoji": "✅"
}
```
| {"type": "string", "default": "Automated update of {{slug}} dependencies {{statusEmoji}}"} |
pmbot.yml.schema.json | additionalText | Additional text to embed in the issue description | {"type": "string"} |
pmbot.yml.schema.json | assignees | Usernames to assign to the issue created. Note that Gitlab CE only allows one assignee. | {"items": {"type": "string"}, "type": "array", "default": []} |
pmbot.yml.schema.json | closeOpen | Close open issues that were created by Pmbot. This option prevents multiple issues open simultaneously when you don't have the time to look at them. | {"type": "boolean", "default": true} |
pmbot.yml.schema.json | token | An authentication token. For Gitlab, this should be a [personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html). For Github, it should be a [Github personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | {"minLength": 1, "type": "string"} |
pmbot.yml.schema.json | title | Merge request title
This [handlebars](https://handlebarsjs.com/guide/#what-is-handlebars) template is passed the following context:
```
{
"slug": "myPm",
"status": "myStatus",
"statusEmoji": "✅"
}
```
| {"type": "string", "default": "Automated update of {{slug}} dependencies {{statusEmoji}}"} |
pmbot.yml.schema.json | additionalText | Additional text to embed in the merge request description | {"type": "string"} |
pmbot.yml.schema.json | assignees | Usernames to assign to the issue created. Note that Gitlab CE only allows one assignee. | {"items": {"type": "string"}, "type": "array", "default": []} |
pmbot.yml.schema.json | closeOpen | Close open merge requests that were created by Pmbot. This option prevents multiple merge requests open simultaneously when you don't have the time to merge them. | {"type": "boolean", "default": true} |
pmbot.yml.schema.json | squash | [GITLAB only] Whether commits of the merge request source branch should be squashed | {"type": "boolean", "default": true} |
pmbot.yml.schema.json | deleteSourceBranch | [GITLAB only] Whether the merge request source branch should be deleted | {"type": "boolean", "default": true} |
pmbot.yml.schema.json | maintainerCanModify | [GITHUB only] Whether maintainers can modify the created pull request | {"type": "boolean", "default": true} |
pmbot.yml.schema.json | token | An authentication token. For Gitlab, this should be a [personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html). For Github, it should be a [Github personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | {"minLength": 1, "type": "string"} |
pmbot.yml.schema.json | from | Sender's email. Be aware that some providers (e.g. OBVH) will silently ignore sending the email when the sender address does not match the username. | {"minLength": 1, "type": "string"} |
pmbot.yml.schema.json | to | Recipient address(es) | {"type": "string", "minLength": 1} |
pmbot.yml.schema.json | subject | Email subject
This [handlebars](https://handlebarsjs.com/guide/#what-is-handlebars) template is passed the following context:
```
{
"slug": "myPm",
"status": "myStatus",
"statusEmoji": "✅"
}
```
| {"type": "string", "default": "Automated update of {{slug}} dependencies {{statusEmoji}}"} |
pmbot.yml.schema.json | transportOptions | Nodemailer [transport options](https://nodemailer.com/smtp/#general-options) | {} |
pmbot.yml.schema.json | messageConfig | Nodemailer [message configuration](https://nodemailer.com/message/). Allows you to override message configuration properties, except `html` and `text`. | {} |
pmbot.yml.schema.json | additionalText | Additional text to embed in the email body | {"type": "string"} |
pmbot.yml.schema.json | url | Mattermost [incoming webhook URL](https://docs.mattermost.com/developer/webhooks-incoming.html#simple-incoming-webhook) | {"minLength": 1, "type": "string"} |
pmbot.yml.schema.json | channels | Channels where to send the message. Obsolete parameter when you have enabled **Lock to this channel** for the incoming webhook. | {"items": {"type": "string"}, "type": "array"} |
pmbot.yml.schema.json | title | Message title
This [handlebars](https://handlebarsjs.com/guide/#what-is-handlebars) template is passed the following context:
```
{
"slug": "myPm",
"status": "myStatus",
"statusEmoji": "✅"
}
```
| {"type": "string", "default": "Automated update of {{slug}} dependencies {{statusEmoji}}"} |
pmbot.yml.schema.json | additionalText | Additional text to embed in the message body | {"type": "string"} |
pmbot.yml.schema.json | url | Slack webhook URL.
To get this URL:
1. [Create](https://api.slack.com/apps?new_app=1) a custom Slack App. Fill in the form as follows:
- *App Name*: `Pmbot`
- *Development Slack Workspace*: Workspace where you want Pmbot to be integrated to
2. Click "Create App". You are redirected to your app's page.
3. Under menu section *Features*, select *Incoming Webhooks*, then toggle on *Activate Incoming Webhooks*. A new section named *Webhook URLs for Your Workspace* appears.
4. Under section *Webhook URLs for Your Workspace*, click *Add New Webhook To Workspace*, then select the channel to which you want messages to be sent, for example `#pmbot`.
5. Once added, copy the webhook URL and configure this action with it
| {"minLength": 1, "type": "string"} |
pmbot.yml.schema.json | title | Slack message title
This [handlebars](https://handlebarsjs.com/guide/#what-is-handlebars) template is passed the following context:
```
{
"slug": "myPm",
"status": "myStatus",
"statusEmoji": "✅"
}
```
| {"type": "string", "default": "Automated update of {{slug}} dependencies {{statusEmoji}}"} |
pmbot.yml.schema.json | additionalText | Additional text to embed in the slack message body | {"type": "string"} |
pmbot.yml.schema.json | name | Header name | {"minLength": 1, "type": "string"} |
pmbot.yml.schema.json | value | Header value | {"minLength": 1, "type": "string"} |
pmbot.yml.schema.json | url | Url to call | {"minLength": 1, "type": "string"} |
pmbot.yml.schema.json | extraData | Data that will be appended to the webhook payload in property "extraData" | {} |
pmbot.yml.schema.json | headers | Additional headers to append to the HTTP request | {"items": {}, "type": "array"} |
pmbot.yml.schema.json | pattern | A Javascript regular expression. | {"type": "string"} |
pmbot.yml.schema.json | defaultBumpRule | Default rule for bumping dependencies. Used unless a specific rule is configured. | {"enum": ["major", "minor", "patch"], "type": "string"} |
pmbot.yml.schema.json | bumpRules | Bump rules for specific dependencies. The first rule to match is used. When no custom rule is found here, we fallback the default rule. | {"items": {}, "type": "array", "default": []} |
pmbot.yml.schema.json | bumpConfig | Bump configuration. Patterns are matched against package names. | {} |
pmbot.yml.schema.json | bumpConfig | Bump configuration. Patterns are matched against dependency names formed as "<groupId>:<artifactId>" (e.g. "javax.xml.bind:jaxb-api"). | {} |
pmbot.yml.schema.json | settingsPath | Path to a maven `settings.xml` file which contains credentials for private repositories. | {} |
pmbot.yml.schema.json | on | When to trigger this action | {"items": {"enum": ["running", "pending", "interrupted", "success", "partial", "failure", "unknown"], "type": "string"}, "type": "array", "default": []} |
pmbot.yml.schema.json | enabled | When false, all updates are made at once and we do not wait for CI feedback. | {"type": "boolean", "default": true} |
pmbot.yml.schema.json | dependency | Name of the dependency | {"type": "string"} |
pmbot.yml.schema.json | versionBefore | Version of the dependency before it was updated | {"type": "string"} |
pmbot.yml.schema.json | versionAfter | Version of the dependency after it was updated | {"type": "string"} |
pmbot.yml.schema.json | packageManager | Package manager to use for this update | {"oneOf": [{"type": "object", "properties": {"name": {"const": "npm"}, "config": {"type": "object"}}}, {"type": "object", "properties": {"name": {"const": "maven"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "go"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "composer"}, "config": "object"}}, {"type": "object", "properties": {"name": {"const": "ruby"}, "config": "object"}}]} |
pmbot.yml.schema.json | ci | CI configuration for this update | {} |
pmbot.yml.schema.json | branchPrefix | Prefix of the update branch | {"type": "string", "default": "update/"} |
pmbot.yml.schema.json | commitMessage | Commit message template
This [handlebars](https://handlebarsjs.com/guide/#what-is-handlebars) template is passed the following context:
```
{
"dependency": "chalk",
"versionBefore": "1.0.0",
"versionAfter": "1.0.1"
}
```
| {"type": "string", "default": "chore: update {{dependency}} from {{versionBefore}} to {{versionAfter}}", "maxLength": 128} |
pmbot.yml.schema.json | ignore | List of dependencies to ignore. Each item should be a Javascript regular expression. | {"items": {"type": "string"}, "type": "array", "default": []} |
pmbot.yml.schema.json | actions | Actions to execute after the update | {"items": {"oneOf": [{"type": "object", "properties": {"name": {"const": "create-issue"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "create-merge-request"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "auto-merge"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "webhook"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "slack"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "mattermost"}, "config": {}}}, {"type": "object", "properties": {"name": {"const": "email"}, "config": {}}}]}, "type": "array", "default": []} |
pmbot.yml.schema.json | keepUpdateBranchOnFailure | When `true`, the update branch will **not** be deleted when the package manager update status is `failure`. | {"type": "boolean"} |
strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition.json | strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition | constraints: overall size < 100000 TBD | {"type": "object", "properties": {"avroName": {}, "doc": {}, "name": {}, "namespace": {}, "nodes": {}}, "patternProperties": {"^avro_name$": {}}, "additionalProperties": {}, "definitions": {"avro_name": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}, "doc": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}, "name": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}, "namespace": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}, "nodes": {"oneOf": [{"type": "array", "items": {"default": {}}}, {"type": "null"}], "default": [{}]}}} |
strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition.json | avro_name | avro compatible name set by creator OR derived from name (thus ignore_empty = true) | {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""} |
strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition.json | name | constraints: printable characters | {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""} |
strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition.json | namespace | constraints:
dot separated sequence of name constraints
must be Avro compatible. When absent becomes <handle>.<name>.v<version> | {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.