schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
flow.schema.json | CaptureDef | A Capture binds an external system and target (e.x., a SQL table or cloud storage bucket) from which data should be continuously captured, with a Flow collection into that captured data is ingested. Multiple Captures may be bound to a single collection, but only one capture may exist for a given endpoint and target. | {"type": "object", "required": ["bindings", "endpoint"], "properties": {"autoDiscover": {}, "bindings": {"type": "array", "items": {}}, "endpoint": {}, "interval": {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"}, "shards": {}}, "additionalProperties": false} |
flow.schema.json | interval | Configured intervals are applicable only to connectors which are unable to continuously tail their source, and which instead produce a current quantity of output and then exit. Flow will start the connector again after the given interval of time has passed.
Intervals are relative to the start of an invocation and not its completion. For example, if the interval is five minutes, and an invocation of the capture finishes after two minutes, then the next invocation will be started after three additional minutes. | {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"} |
flow.schema.json | CaptureEndpoint | An endpoint from which Flow will capture. | {"oneOf": [{"type": "object", "required": ["connector"], "properties": {"connector": {}}, "additionalProperties": false}]} |
flow.schema.json | Collection | Collection names are paths of Unicode letters, numbers, '-', '_', or '.'. Each path component is separated by a slash '/', and a name may not begin or end in a '/'. | {"examples": ["acmeCo/collection"], "type": "string", "pattern": "^[\\p{Letter}\\p{Number}\\-_\\.]+(/[\\p{Letter}\\p{Number}\\-_\\.]+)*$"} |
flow.schema.json | CollectionDef | Collection describes a set of related documents, where each adheres to a common schema and grouping key. Collections are append-only: once a document is added to a collection, it is never removed. However, it may be replaced or updated (either in whole, or in part) by a future document sharing its key. Each new document of a given key is "reduced" into existing documents of the key. By default, this reduction is achieved by completely replacing the previous document, but much richer reduction behaviors can be specified through the use of annotated reduction strategies of the collection schema. | {"examples": [{"key": ["/json/ptr"], "schema": {"properties": {"bar": {"const": 42}, "foo": {"type": "integer"}}, "type": "object"}}], "type": "object", "oneOf": [{"required": ["schema"], "properties": {"readSchema": false, "writeSchema": false}}, {"required": ["readSchema", "writeSchema"], "properties": {"schema": false}}], "required": ["key"], "properties": {"derive": {}, "journals": {}, "key": {}, "projections": {"examples": [{"a_field": "/json/ptr", "a_partition": {"location": "/json/ptr", "partition": true}}], "type": "object", "patternProperties": {"^([^/~]|(~[01]))+(/([^/~]|(~[01]))+)*$": {}}, "additionalProperties": false}, "readSchema": {}, "schema": {"examples": ["../path/to/schema#/$defs/subPath"]}, "writeSchema": {}}, "additionalProperties": false} |
flow.schema.json | CompositeKey | Ordered JSON-Pointers which define how a composite key may be extracted from a collection document. | {"examples": [["/json/ptr"]], "type": "array", "items": {}} |
flow.schema.json | CompressionCodec | A CompressionCodec may be applied to compress journal fragments before they're persisted to cloud stoage. The compression applied to a journal fragment is included in its filename, such as ".gz" for GZIP. A collection's compression may be changed at any time, and will affect newly-written journal fragments. | {"examples": ["GZIP_OFFLOAD_DECOMPRESSION"], "type": "string", "enum": ["NONE", "GZIP", "ZSTANDARD", "SNAPPY", "GZIP_OFFLOAD_DECOMPRESSION"]} |
flow.schema.json | ConnectorConfig | Connector image and configuration specification. | {"type": "object", "required": ["config", "image"], "properties": {"config": {}, "image": {"type": "string"}}} |
flow.schema.json | Derivation | Derive specifies how a collection is derived from other collections. | {"type": "object", "required": ["transforms", "using"], "properties": {"shards": {}, "shuffleKeyTypes": {"type": "array", "items": {}}, "transforms": {"type": "array", "items": {}}, "using": {}}, "additionalProperties": false} |
flow.schema.json | shuffleKeyTypes | Typically you omit this and Flow infers it from your transform shuffle keys. In some circumstances, Flow may require that you explicitly tell it of your shuffled key types. | {"type": "array", "items": {}} |
flow.schema.json | DeriveUsing | A derivation runtime implementation. | {"oneOf": [{"type": "object", "required": ["connector"], "properties": {"connector": {}}, "additionalProperties": false}, {"type": "object", "required": ["sqlite"], "properties": {"sqlite": {}}, "additionalProperties": false}, {"type": "object", "required": ["typescript"], "properties": {"typescript": {}}, "additionalProperties": false}]} |
flow.schema.json | migrations | Migrations may be provided as an inline string, or as a relative URL to a file containing the migration SQL. | {"type": "array", "items": {"oneOf": [{"examples": ["https://example/resource"], "type": "string", "pattern": "^[^ ]+$"}, {"type": "string", "contentMediaType": "text/x.sql"}]}} |
flow.schema.json | items | A URL identifying a resource, which may be a relative local path with respect to the current resource (i.e, ../path/to/flow.yaml), or may be an external absolute URL (i.e., http://example/flow.yaml). | {"examples": ["https://example/resource"], "type": "string", "pattern": "^[^ ]+$"} |
flow.schema.json | module | Module is either a relative URL of a TypeScript module file, or is an inline representation of a Typescript module. The module must have a exported Derivation variable which is an instance implementing the corresponding Derivation interface. | {"oneOf": [{"examples": ["https://example/resource"], "type": "string", "pattern": "^[^ ]+$"}, {"type": "string", "contentMediaType": "text/x.typescript"}]} |
flow.schema.json | module | A URL identifying a resource, which may be a relative local path with respect to the current resource (i.e, ../path/to/flow.yaml), or may be an external absolute URL (i.e., http://example/flow.yaml). | {"examples": ["https://example/resource"], "type": "string", "pattern": "^[^ ]+$"} |
flow.schema.json | Field | Field names a projection of a document location. They may include '/', but cannot begin or end with one. Many Fields are automatically inferred by Flow from a collection JSON Schema, and are the JSON Pointer of the document location with the leading '/' removed. User-provided Fields which act as a logical partitions are restricted to Unicode letters, numbers, '-', '_', or '.' | {"examples": ["my_field"], "type": "string", "pattern": "^([^/~]|(~[01]))+(/([^/~]|(~[01]))+)*$"} |
flow.schema.json | FragmentTemplate | A FragmentTemplate configures how journal fragment files are produced as part of a collection. | {"examples": [{"compressionCodec": "ZSTANDARD", "flushInterval": "1h"}], "type": "object", "properties": {"compressionCodec": {}, "flushInterval": {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"}, "length": {"type": "integer", "format": "uint32", "maximum": 4096.0, "minimum": 32.0}, "retention": {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"}}, "additionalProperties": false} |
flow.schema.json | flushInterval | into cloud storage. Intervals are converted into uniform time segments: 24h will "roll" all fragments at midnight UTC every day, 1h at the top of every hour, 15m a :00, :15, :30, :45 past the hour, and so on. If not set, then fragments are not flushed on time-based intervals. | {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"} |
flow.schema.json | length | When a collection journal fragment reaches this threshold, it will be closed off and pushed to cloud storage. If not set, a default of 512MB is used. | {"type": "integer", "format": "uint32", "maximum": 4096.0, "minimum": 32.0} |
flow.schema.json | retention | If not set, then fragments are retained indefinitely. | {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"} |
flow.schema.json | FullSource | A source collection and details of how it's read. | {"examples": [{"name": "source/collection"}], "type": "object", "required": ["name"], "properties": {"name": {}, "notAfter": {"type": ["string", "null"], "format": "date-time"}, "notBefore": {"type": ["string", "null"], "format": "date-time"}, "partitions": {"examples": [{"exclude": {"other_partition": [32, 64]}, "include": {"a_partition": ["A", "B"]}}]}}, "additionalProperties": false} |
flow.schema.json | notAfter | Source collection documents published after this date-time are filtered. `notAfter` is *only* a filter. Updating its value will not cause Flow to re-process documents that have already been read. Optional. Default is to process all documents. | {"type": ["string", "null"], "format": "date-time"} |
flow.schema.json | notBefore | Source collection documents published before this date-time are filtered. `notBefore` is *only* a filter. Updating its value will not cause Flow to re-process documents that have already been read. Optional. Default is to process all documents. | {"type": ["string", "null"], "format": "date-time"} |
flow.schema.json | JournalTemplate | A JournalTemplate configures the journals which make up the physical partitions of a collection. | {"examples": [{"fragments": {"compressionCodec": "ZSTANDARD", "flushInterval": "1h"}}], "type": "object", "required": ["fragments"], "properties": {"fragments": {}}, "additionalProperties": false} |
flow.schema.json | JsonPointer | JSON Pointer which identifies a location in a document. | {"examples": ["/json/ptr"], "type": "string", "pattern": "^(/([^/~]|(~[01]))+)*$"} |
flow.schema.json | Materialization | Materialization names are paths of Unicode letters, numbers, '-', '_', or '.'. Each path component is separated by a slash '/', and a name may not begin or end in a '/'. | {"examples": ["acmeCo/materialization"], "type": "string", "pattern": "^[\\p{Letter}\\p{Number}\\-_\\.]+(/[\\p{Letter}\\p{Number}\\-_\\.]+)*$"} |
flow.schema.json | disable | Disabled bindings are inactive, and not validated. | {"type": "boolean"} |
flow.schema.json | priority | When all bindings are of equal priority, Flow processes documents according to their associated publishing time, as encoded in the document UUID.
However, when one binding has a higher priority than others, then *all* ready documents are processed through the binding before *any* documents of other bindings are processed. | {"type": "integer", "format": "uint32", "minimum": 0.0} |
flow.schema.json | MaterializationDef | A Materialization binds a Flow collection with an external system & target (e.x, a SQL table) into which the collection is to be continuously materialized. | {"type": "object", "required": ["bindings", "endpoint"], "properties": {"bindings": {"type": "array", "items": {}}, "endpoint": {}, "shards": {}, "sourceCapture": {}}, "additionalProperties": false} |
flow.schema.json | MaterializationEndpoint | An Endpoint connector used for Flow materializations. | {"oneOf": [{"type": "object", "required": ["connector"], "properties": {"connector": {}}, "additionalProperties": false}]} |
flow.schema.json | MaterializationFields | MaterializationFields defines a selection of projections to materialize, as well as optional per-projection, driver-specific configuration. | {"examples": [{"exclude": ["removed"], "include": {"added": {}}, "recommended": true}], "type": "object", "required": ["recommended"], "properties": {"exclude": {"type": "array", "items": {}}, "include": {"type": "object", "additionalProperties": true}, "recommended": {"type": "boolean"}}, "additionalProperties": false} |
flow.schema.json | exclude | This removes from recommended projections, where enabled. | {"type": "array", "items": {}} |
flow.schema.json | include | This supplements any recommended fields, where enabled. Values are passed through to the driver, e.x. for customization of the driver's schema generation or runtime behavior with respect to the field. | {"type": "object", "additionalProperties": true} |
flow.schema.json | PartitionSelector | Partition selectors identify a desired subset of the available logical partitions of a collection. | {"examples": [{"exclude": {"other_partition": [32, 64]}, "include": {"a_partition": ["A", "B"]}}], "type": "object", "properties": {"exclude": {"default": {}, "type": "object", "additionalProperties": {"type": "array", "items": true}}, "include": {"default": {}, "type": "object", "additionalProperties": {"type": "array", "items": true}}}, "additionalProperties": false} |
flow.schema.json | exclude | Partition field names and values which are excluded from the source collection. Any documents matching *any one* of the partition values will be excluded. | {"default": {}, "type": "object", "additionalProperties": {"type": "array", "items": true}} |
flow.schema.json | include | Partition field names and corresponding values which must be matched from the Source collection. Only documents having one of the specified values across all specified partition names will be matched. For example, source: [App, Web] region: [APAC] would mean only documents of 'App' or 'Web' source and also occurring in the 'APAC' region will be processed. | {"default": {}, "type": "object", "additionalProperties": {"type": "array", "items": true}} |
flow.schema.json | Projection | Projections are named locations within a collection document which may be used for logical partitioning or directly exposed to databases into which collections are materialized. | {"anyOf": [{}, {"type": "object", "required": ["location"], "properties": {"location": {}, "partition": {"default": false, "type": "boolean"}}, "additionalProperties": false}]} |
flow.schema.json | RelativeUrl | A URL identifying a resource, which may be a relative local path with respect to the current resource (i.e, ../path/to/flow.yaml), or may be an external absolute URL (i.e., http://example/flow.yaml). | {"examples": ["https://example/resource"], "type": "string", "pattern": "^[^ ]+$"} |
flow.schema.json | Schema | A schema is a draft 2020-12 JSON Schema which validates Flow documents. Schemas also provide annotations at document locations, such as reduction strategies for combining one document into another.
Schemas may be defined inline to the catalog, or given as a relative or absolute URI. URIs may optionally include a JSON fragment pointer that locates a specific sub-schema therein.
For example, "schemas/marketing.yaml#/$defs/campaign" would reference the schema at location {"$defs": {"campaign": ...}} within ./schemas/marketing.yaml. | {"examples": ["http://example/schema#/$defs/subPath", "../path/to/schema#/$defs/subPath", {"properties": {"bar": {"const": 42}, "foo": {"type": "integer"}}, "type": "object"}]} |
flow.schema.json | ShardTemplate | A ShardTemplate configures how shards process a catalog task. | {"examples": [{"hotStandbys": 1, "maxTxnDuration": "30s"}], "type": "object", "properties": {"disable": {"type": "boolean"}, "hotStandbys": {"type": "integer", "format": "uint32", "minimum": 0.0}, "logLevel": {"type": "string"}, "maxTxnDuration": {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"}, "minTxnDuration": {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"}, "readChannelSize": {"type": "integer", "format": "uint32", "minimum": 0.0}, "ringBufferSize": {"type": "integer", "format": "uint32", "minimum": 0.0}}, "additionalProperties": false} |
flow.schema.json | hotStandbys | Hot standbys of a shard actively replicate the shard's state to another machine, and are able to be quickly promoted to take over processing for the shard should its current primary fail. If not set, then no hot standbys are maintained. EXPERIMENTAL: this field MAY be removed. | {"type": "integer", "format": "uint32", "minimum": 0.0} |
flow.schema.json | logLevel | Log levels may currently be "error", "warn", "info", "debug", or "trace". If not set, the effective log level is "info". | {"type": "string"} |
flow.schema.json | maxTxnDuration | This duration upper-bounds the amount of time during which a transaction may process documents before it must flush and commit. It may run for less time if there aren't additional ready documents for it to process. If not set, the maximum duration defaults to five minutes for materializations, and one second for captures and derivations. EXPERIMENTAL: this field MAY be removed. | {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"} |
flow.schema.json | minTxnDuration | This duration lower-bounds the amount of time during which a transaction must process documents before it must flush and commit. It may run for more time if additional documents are available. The default value is zero seconds. Larger values may result in more data reduction, at the cost of more latency. EXPERIMENTAL: this field MAY be removed. | {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"} |
flow.schema.json | readChannelSize | Larger values are recommended for tasks having more than one shard split and long, bursty transaction durations. If not set, a reasonable default (currently 4,096) is used. EXPERIMENTAL: this field is LIKELY to be removed. | {"type": "integer", "format": "uint32", "minimum": 0.0} |
flow.schema.json | ringBufferSize | The ring buffer is a performance optimization only: catalog tasks will replay portions of journals as needed when messages aren't available in the buffer. It can remain small if upstream task transactions are small, but larger transactions will achieve better performance with a larger ring. If not set, a reasonable default (currently 65,536) is used. EXPERIMENTAL: this field is LIKELY to be removed. | {"type": "integer", "format": "uint32", "minimum": 0.0} |
flow.schema.json | Shuffle | A Shuffle specifies how a shuffling key is to be extracted from collection documents. | {"examples": [{"key": ["/json/ptr"]}], "oneOf": [{"type": "string", "enum": ["any"]}, {"type": "object", "required": ["key"], "properties": {"key": {}}, "additionalProperties": false}, {"type": "object", "required": ["lambda"], "properties": {"lambda": true}, "additionalProperties": false}]} |
flow.schema.json | Shuffle | Use 'any' if your transformation does not rely on internal task state, or if your derivation is not intended to scale beyond a single shard. | {"type": "string", "enum": ["any"]} |
flow.schema.json | Shuffle | Lambdas may be provided inline, or as a relative URL to a file containing the lambda. | {"type": "object", "required": ["lambda"], "properties": {"lambda": true}, "additionalProperties": false} |
flow.schema.json | ShuffleType | Type of a shuffled key component. | {"type": "string", "enum": ["boolean", "integer", "string"]} |
flow.schema.json | Source | A source collection and details of how it's read. | {"examples": ["source/collection"], "anyOf": [{}, {}]} |
flow.schema.json | Test | Test names are paths of Unicode letters, numbers, '-', '_', or '.'. Each path component is separated by a slash '/', and a name may not begin or end in a '/'. | {"examples": ["acmeCo/conversions/test"], "type": "string", "pattern": "^[\\p{Letter}\\p{Number}\\-_\\.]+(/[\\p{Letter}\\p{Number}\\-_\\.]+)*$"} |
flow.schema.json | TestDocuments | A test step describes either an "ingest" of document fixtures into a collection, or a "verify" of expected document fixtures from a collection. | {"examples": ["../path/to/test-documents.json", [{"a": "document"}, {"another": "document"}]]} |
flow.schema.json | TestStep | A test step describes either an "ingest" of document fixtures into a collection, or a "verify" of expected document fixtures from a collection. | {"examples": [{"ingest": {"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]}}, {"verify": {"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]}}], "oneOf": [{"type": "object", "required": ["ingest"], "properties": {"ingest": {}}, "additionalProperties": false}, {"type": "object", "required": ["verify"], "properties": {"verify": {}}, "additionalProperties": false}]} |
flow.schema.json | ingest | Description of the ingestion. | {"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]} |
flow.schema.json | verify | Description of the verification. | {"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]} |
flow.schema.json | TestStep | Ingest document fixtures into a collection. | {"type": "object", "required": ["ingest"], "properties": {"ingest": {}}, "additionalProperties": false} |
flow.schema.json | TestStep | Verify the contents of a collection match a set of document fixtures. | {"type": "object", "required": ["verify"], "properties": {"verify": {}}, "additionalProperties": false} |
flow.schema.json | TestStepIngest | An ingestion test step ingests document fixtures into the named collection. | {"examples": [{"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]}], "type": "object", "required": ["collection", "documents"], "properties": {"collection": {}, "documents": {}}, "additionalProperties": false} |
flow.schema.json | examples | Description of the ingestion. | {"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]} |
flow.schema.json | documents | Each document must conform to the collection's schema. | {} |
flow.schema.json | TestStepVerify | A verification test step verifies that the contents of the named collection match the expected fixtures, after fully processing all preceding ingestion test steps. | {"examples": [{"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]}], "type": "object", "required": ["collection", "documents"], "properties": {"collection": {}, "documents": {}}, "additionalProperties": false} |
flow.schema.json | examples | Description of the verification. | {"collection": "acmeCo/collection", "documents": [{"a": "document"}, {"another": "document"}]} |
flow.schema.json | documents | Each document may contain only a portion of the matched document's properties, and any properties present in the actual document but not in this document fixture are ignored. All other values must match or the test will fail. | {} |
flow.schema.json | Transform | Transform names are Unicode letters, numbers, '-', '_', or '.'. | {"examples": ["myTransform"], "type": "string", "pattern": "^[\\p{Letter}\\p{Number}\\-_\\.]+$"} |
flow.schema.json | TransformDef | A Transform reads and shuffles documents of a source collection, and processes each document through either one or both of a register "update" lambda and a derived document "publish" lambda. | {"examples": [{"name": "my-transform", "shuffle": "any", "source": "some/source/collection"}], "type": "object", "required": ["name", "shuffle", "source"], "properties": {"disable": {"type": "boolean"}, "lambda": {}, "name": {}, "priority": {"type": "integer", "format": "uint32", "minimum": 0.0}, "readDelay": {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"}, "shuffle": {}, "source": {}}, "additionalProperties": false} |
flow.schema.json | disable | Disabled transforms are completely ignored at runtime and are not validated. | {"type": "boolean"} |
flow.schema.json | lambda | Lambdas may be provided inline, or as a relative URL to a file containing the lambda. | {} |
flow.schema.json | name | The names of transforms within a derivation must be unique and stable. | {} |
flow.schema.json | priority | When all transforms are of equal priority, Flow processes documents according to their associated publishing time, as encoded in the document UUID.
However, when one transform has a higher priority than others, then *all* ready documents are processed through the transform before *any* documents of other transforms are processed. | {"type": "integer", "format": "uint32", "minimum": 0.0} |
flow.schema.json | readDelay | Delays are applied as an adjustment to the UUID clock encoded within each document, which is then used to impose a relative ordering of all documents read by this derivation. This means that read delays are applied in a consistent way, even when back-filling over historical documents. When caught up and tailing the source collection, delays also "gate" documents such that they aren't processed until the current wall-time reflects the delay. | {"type": ["string", "null"], "pattern": "^\\d+(s|m|h)$"} |
bukkit-plugin.json | command | Optional command attributes. | {"type": "object", "properties": {"aliases": {"type": ["string", "array"]}, "permission": {"type": "string"}, "permission-message": {"type": "string", "examples": ["You do not have <permission>"]}, "usage": {"type": "string"}}} |
bukkit-plugin.json | description | A user-friendly description for a command. | {"type": "string"} |
bukkit-plugin.json | aliases | Alternate command names a user may use instead. | {"type": ["string", "array"]} |
bukkit-plugin.json | permission | The permission required to use the command. | {"type": "string"} |
bukkit-plugin.json | permission-message | A no-permission message. | {"type": "string", "examples": ["You do not have <permission>"]} |
bukkit-plugin.json | usage | A short description of how to use this command. | {"type": "string"} |
bukkit-plugin.json | permission | Optional permission attributes. | {"properties": {"default": {}, "children": {"type": ["array", "object"], "items": {"type": "string"}, "additionalProperties": {"type": ["boolean", "object"], "items": {"type": "boolean"}}}}} |
bukkit-plugin.json | description | A short description of what this permission allows. | {"type": "string"} |
bukkit-plugin.json | default | The default state for the permission. | {} |
bukkit-plugin.json | children | Allows other permissions to be set as a relation to the parent permission. | {"type": ["array", "object"], "items": {"type": "string"}, "additionalProperties": {"type": ["boolean", "object"], "items": {"type": "boolean"}}} |
bukkit-plugin.json | name | The unique name of plugin. | {} |
bukkit-plugin.json | main | The plugin's initial class file. | {"type": "string", "pattern": "^(?!org\\.bukkit\\.)([a-zA-Z_$][a-zA-Z\\d_$]*\\.)*[a-zA-Z_$][a-zA-Z\\d_$]*$"} |
bukkit-plugin.json | version | A plugin revision identifier. | {"type": ["string", "number"]} |
bukkit-plugin.json | description | Human readable plugin summary. | {"type": "string"} |
bukkit-plugin.json | author | The plugin author. | {"type": "string"} |
bukkit-plugin.json | authors | The plugin contributors. | {"type": "array", "items": {"type": "string"}} |
bukkit-plugin.json | website | The URL to the plugin's site | {"type": "string", "format": "uri"} |
bukkit-plugin.json | prefix | The token to prefix plugin log entries. | {"type": "string"} |
bukkit-plugin.json | database | Set to true if this plugin uses a database. | {"type": "boolean", "default": false} |
bukkit-plugin.json | load | The phase of server-startup this plugin will load during. | {"type": "string", "enum": ["STARTUP", "POSTWORLD"], "default": "POSTWORLD"} |
bukkit-plugin.json | depend | Other required plugins. | {"type": "array", "items": {}} |
bukkit-plugin.json | softdepend | Other plugins that add functionality. | {"type": "array", "items": {}} |
bukkit-plugin.json | loadbefore | A list of plugins should be loaded after this plugin. | {"type": "array", "items": {}} |
bukkit-plugin.json | commands | The commands the plugin will register | {"type": "object", "additionalProperties": {}} |
bukkit-plugin.json | permissions | The permissions the plugin will register | {"type": "object", "additionalProperties": {"type": "object"}} |
bukkit-plugin.json | default-permission | Gives the default default state of permissions registered for the plugin. | {} |
bukkit-plugin.json | awareness | The concepts that the plugin acknowledges. | {"type": "array", "items": {"type": "string", "pattern": "^!@.+$", "examples": ["!@UTF-8"]}} |
bukkit-plugin.json | api-version | Gives the API version which this plugin is designed to support. | {"type": ["string", "number"], "examples": ["1.13", "1.14", "1.15", "1.16"]} |
bukkit-plugin.json | libraries | A list of libraries the server should download and supply to the plugin when loading it. | {"type": "array", "items": {"type": "string", "pattern": "([^: ]+):([^: ]+)(:([^: ]*)(:([^: ]+))?)?:([^: ]+)", "examples": ["org.xerial:sqlite-jdbc:3.34.0", "com.google.dagger:dagger:2.36"]}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.