hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-25 08:24:00 +03:00
Code Issues Projects Releases Wiki Activity
e605481e94
graphql-engine/metadata.openapi.json

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

9747 lines
359 KiB
JSON
Raw Normal View History

server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
{
"components": {
"schemas": {
server: codecs for the metadata Action type PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7898 GitOrigin-RevId: 4211854f656ab02bb058b2d0831637477b3d4767
2023-02-20 20:08:49 +03:00
"ActionDefinition_Mutation_GraphQLType_InputWebhook": {
"properties": {
"arguments": {
"default": [],
"items": {
"$ref": "#/components/schemas/ArgumentDefinition_GraphQLType"
},
"type": "array"
},
"forward_client_headers": {
"default": false,
"type": "boolean"
},
"handler": {
"type": "string"
},
"headers": {
"default": [],
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HeaderConfValue"
},
{
"$ref": "#/components/schemas/HeaderConfFromEnv"
}
]
},
"type": "array"
},
"kind": {
"default": "synchronous",
"enum": [
"synchronous",
"asynchronous"
],
"type": "string"
},
"output_type": {
"type": "string"
},
"request_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/RequestTransformV1"
},
{
"$ref": "#/components/schemas/RequestTransformV2"
}
]
},
"response_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/ResponseTransformV1"
},
{
"$ref": "#/components/schemas/ResponseTransformV2"
}
]
},
"timeout": {
"default": 30,
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"type": {
"enum": [
"mutation"
],
"type": "string"
}
},
"required": [
"output_type",
"type",
"handler"
],
"type": "object"
},
"ActionDefinition_Query_GraphQLType_InputWebhook": {
"properties": {
"arguments": {
"default": [],
"items": {
"$ref": "#/components/schemas/ArgumentDefinition_GraphQLType"
},
"type": "array"
},
"forward_client_headers": {
"default": false,
"type": "boolean"
},
"handler": {
"type": "string"
},
"headers": {
"default": [],
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HeaderConfValue"
},
{
"$ref": "#/components/schemas/HeaderConfFromEnv"
}
]
},
"type": "array"
},
"output_type": {
"type": "string"
},
"request_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/RequestTransformV1"
},
{
"$ref": "#/components/schemas/RequestTransformV2"
}
]
},
"response_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/ResponseTransformV1"
},
{
"$ref": "#/components/schemas/ResponseTransformV2"
}
]
},
"timeout": {
"default": 30,
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"type": {
"enum": [
"query"
],
"type": "string"
}
},
"required": [
"output_type",
"type",
"handler"
],
"type": "object"
},
"ActionMetadata": {
"properties": {
"comment": {
"type": "string"
},
"definition": {
"oneOf": [
{
"$ref": "#/components/schemas/ActionDefinition_Query_GraphQLType_InputWebhook"
},
{
"$ref": "#/components/schemas/ActionDefinition_Mutation_GraphQLType_InputWebhook"
}
]
},
"name": {
"$ref": "#/components/schemas/GraphQLName"
},
"permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/ActionPermissionMetadata"
},
"type": "array"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
"ActionPermissionMetadata": {
"properties": {
"comment": {
"type": "string"
},
"role": {
"type": "string"
}
},
"required": [
"role"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"AddReplaceOrRemoveFields": {
"properties": {
"add_headers": {
"additionalProperties": {
"type": "string"
},
"default": {},
"type": "object"
},
"remove_headers": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
server: codecs for metrics, roles, allow list PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8114 GitOrigin-RevId: 1a1f8b6360edbdddad5cf364b533a255c15e2f4a
2023-03-10 02:09:16 +03:00
"AllowlistEntry": {
"properties": {
"collection": {
"type": "string"
},
"scope": {
"default": {
"global": true
},
"oneOf": [
{
"$ref": "#/components/schemas/AllowlistScopeGlobal"
},
{
"$ref": "#/components/schemas/AllowlistScopeRoles"
}
]
}
},
"required": [
"collection"
],
"type": "object"
},
"AllowlistScopeGlobal": {
"properties": {
"global": {
"enum": [
true
],
"type": "boolean"
}
},
"required": [
"global"
],
"type": "object"
},
"AllowlistScopeRoles": {
"properties": {
"global": {
"enum": [
false
],
"type": "boolean"
},
"roles": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"global",
"roles"
],
"type": "object"
},
server: codecs for api limits PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8065 GitOrigin-RevId: 4a14f72fa4f832f1cc6cb7f5be8d146b4f00dd44
2023-03-15 04:36:52 +03:00
"ApiLimit": {
"properties": {
"batch_limit": {
"$ref": "#/components/schemas/Limit_MaxBatchSize"
},
"depth_limit": {
"$ref": "#/components/schemas/Limit_MaxDepth"
},
"disabled": {
"default": false,
"type": "boolean"
},
"node_limit": {
"$ref": "#/components/schemas/Limit_MaxNodes"
},
"rate_limit": {
"$ref": "#/components/schemas/Limit_RateLimitConfig"
},
"time_limit": {
"$ref": "#/components/schemas/Limit_MaxTime"
}
},
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"ApolloFederationConfig": {
"nullable": true,
"properties": {
"enable": {
"description": "enable takes the version of apollo federation. Supported value is v1 only.",
"enum": [
"v1"
],
"type": "string"
}
},
"required": [
"enable"
],
"type": "object"
},
server: codecs for the metadata Action type PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7898 GitOrigin-RevId: 4211854f656ab02bb058b2d0831637477b3d4767
2023-02-20 20:08:49 +03:00
"ArgumentDefinition_GraphQLType": {
"properties": {
"description": {
"type": "string"
},
"name": {
"$ref": "#/components/schemas/GraphQLName"
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"AutoTriggerLogCleanupConfig": {
"properties": {
"batch_size": {
"default": 10000,
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"clean_invocation_logs": {
"default": false,
"type": "boolean"
},
"clear_older_than": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"paused": {
"default": false,
"type": "boolean"
},
"schedule": {
"$ref": "#/components/schemas/CronSchedule"
},
"timeout": {
"default": 60,
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
}
},
"required": [
"schedule",
"clear_older_than"
],
"type": "object"
},
server: codecs for backend configs PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8269 GitOrigin-RevId: 34330f383ca82fb159842a171a763c178b462788
2023-03-30 18:52:20 +03:00
"BackendMap_BackendConfigWrapper": {
"properties": {
"bigquery": {
"items": {
"type": "null"
},
"type": "array"
},
"citus": {
"items": {
"type": "null"
},
"type": "array"
},
"cockroach": {
"items": {
"type": "null"
},
"type": "array"
},
"dataconnector": {
"additionalProperties": {
"$ref": "#/components/schemas/DataConnectorOptions"
},
"type": "object"
},
"mssql": {
"items": {
"type": "null"
},
"type": "array"
},
"postgres": {
"items": {
"type": "null"
},
"type": "array"
}
},
"type": "object"
},
server: codecs for computed field definitions PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8270 GitOrigin-RevId: a0954d79c1fecb7eeba4eb47983e65d3637a23c3
2023-03-10 02:45:13 +03:00
"BigQueryComputedFieldDefinition": {
"properties": {
"argument_mapping": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"function": {
"$ref": "#/components/schemas/BigQueryFunctionName"
},
"return_table": {
"$ref": "#/components/schemas/BigQueryTableName"
}
},
"required": [
"function",
"argument_mapping"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"BigQueryConnSourceConfig": {
"properties": {
"datasets": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/components/schemas/FromEnv"
}
]
},
"global_select_limit": {
"nullable": true,
"oneOf": [
{
"additionalProperties": true,
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"$ref": "#/components/schemas/FromEnv"
}
]
},
"project_id": {
"oneOf": [
{
"additionalProperties": true,
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"$ref": "#/components/schemas/FromEnv"
}
]
},
"retry_base_delay": {
"nullable": true,
"oneOf": [
{
"additionalProperties": true,
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"$ref": "#/components/schemas/FromEnv"
}
]
},
"retry_limit": {
"nullable": true,
"oneOf": [
{
"additionalProperties": true,
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"$ref": "#/components/schemas/FromEnv"
}
]
},
"service_account": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/FromEnv"
},
{
"$ref": "#/components/schemas/BigQueryServiceAccount"
},
{
"description": "JSON-encoded string",
"type": "string"
},
{
"$ref": "#/components/schemas/BigQueryServiceAccount"
}
]
}
},
"required": [
"service_account",
"datasets",
"project_id"
],
"type": "object"
},
"BigQueryFunctionName": {
"properties": {
"dataset": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"BigQueryServiceAccount": {
"properties": {
"client_email": {
"type": "string"
},
"private_key": {
"type": "string"
},
"project_id": {
"type": "string"
}
},
"required": [
"client_email",
"private_key",
"project_id"
],
"type": "object"
},
"BigQueryTableName": {
"properties": {
"dataset": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"dataset"
],
"type": "object"
},
"BigqueryArrRelUsingFKeyOnMultipleColumns": {
"properties": {
"columns": {
"items": {
"type": "string"
},
"type": "array"
},
"table": {
"$ref": "#/components/schemas/BigQueryTableName"
}
},
"required": [
"table",
"columns"
],
"type": "object"
},
"BigqueryArrRelUsingFKeyOnSingleColumn": {
"properties": {
"column": {
"type": "string"
},
"table": {
"$ref": "#/components/schemas/BigQueryTableName"
}
},
"required": [
"table",
"column"
],
"type": "object"
},
"BigqueryBoolExp": {
"additionalProperties": true
},
"BigqueryComputedFieldMetadata": {
"properties": {
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"definition": {
server: codecs for computed field definitions PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8270 GitOrigin-RevId: a0954d79c1fecb7eeba4eb47983e65d3637a23c3
2023-03-10 02:45:13 +03:00
"$ref": "#/components/schemas/BigQueryComputedFieldDefinition"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"name": {
"type": "string"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
"BigqueryDelPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"filter": {
"$ref": "#/components/schemas/BigqueryBoolExp"
server/postgres: delete input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9666 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 5fa7702401065869c953b23c6734b9b367247634
2023-06-28 16:44:14 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"filter"
],
"type": "object"
},
"BigqueryDeletePermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/BigqueryDelPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"BigqueryFunctionMetadata": {
"description": "A custom SQL function to add to the GraphQL schema with configuration.\n\nhttps://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/custom-functions.html#args-syntax\n",
"properties": {
"comment": {
"type": "string"
},
"configuration": {
"$ref": "#/components/schemas/FunctionConfig"
},
"function": {
"$ref": "#/components/schemas/BigQueryFunctionName"
},
"permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/FunctionPermissionInfo"
},
"type": "array"
}
},
"required": [
"function"
],
"type": "object"
},
"BigqueryInsPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"check": {
"$ref": "#/components/schemas/BigqueryBoolExp"
},
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"set": {
"additionalProperties": {
"additionalProperties": true
},
"type": "object"
server/postgres: insert input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9620 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 345c3f763f8dd3397c999c5967af39192b944640
2023-06-25 16:46:35 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"check"
],
"type": "object"
},
"BigqueryInsertPermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/BigqueryInsPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
chore(server): more expressive logical models PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9197 GitOrigin-RevId: 3471c68d4e59310bdb62ecb3694ab30a2094916e
2023-05-19 19:12:51 +03:00
"BigqueryLogicalModelField": {
"description": "A field of a logical model",
"properties": {
"description": {
"description": "Optional description of this field",
"type": "string"
},
"name": {
"description": "Name of the field",
"type": "string"
},
"type": {
"additionalProperties": true,
"description": "Type of the field\nA type used in a Logical Model field\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
"BigqueryLogicalModelMetadata": {
"description": "A return type.",
"properties": {
"description": {
"description": "Optional description text which appears in the GraphQL Schema.",
"type": "string"
},
"fields": {
"description": "Return types for the logical model",
"items": {
"additionalProperties": true,
chore(server): more expressive logical models PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9197 GitOrigin-RevId: 3471c68d4e59310bdb62ecb3694ab30a2094916e
2023-05-19 19:12:51 +03:00
"anyOf": [
{
"$ref": "#/components/schemas/BigqueryLogicalModelField"
},
{
"$ref": "#/components/schemas/BigqueryLogicalModelField"
}
]
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
},
"type": "array"
},
"name": {
"description": "A name for a logical model",
"type": "string"
},
"select_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/BigquerySelectPermDef"
},
"type": "array"
}
},
"required": [
"name",
"fields"
],
"type": "object"
},
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"BigqueryNativeQueryMetadata": {
"description": "A native query as represented in metadata.",
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"properties": {
"arguments": {
"additionalProperties": {
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
"$ref": "#/components/schemas/BigqueryNullableScalarType"
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
},
"default": {},
"description": "Free variables in the expression and their types",
"type": "object"
},
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
"array_relationships": {
"default": [],
"items": {
chore(server): Native Query -> Table array relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10100 GitOrigin-RevId: 55f38a904767e1b25916fb31b3c5ece898c10349
2023-08-14 15:33:50 +03:00
"$ref": "#/components/schemas/RelDef_RelManualConfig__BigQuery"
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
},
"type": "array"
},
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"code": {
"description": "Native code expression (SQL) to run\nAn interpolated query expressed in native code (SQL)",
"type": "string"
},
"description": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"description": "A description of the native query which appears in the graphql schema",
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"type": "string"
},
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
"object_relationships": {
"default": [],
"items": {
chore(server): Native Query -> Table object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10098 GitOrigin-RevId: 9b98bb0e285560cd03b04f867d1fa16dadd00df9
2023-08-10 17:21:34 +03:00
"$ref": "#/components/schemas/RelDef_RelManualConfig__BigQuery"
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
},
"type": "array"
},
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"returns": {
chore(server): allow Logical Models to be defined inside Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9787 GitOrigin-RevId: 48b88f3c98024d3be721ab27a28be75952586a8c
2023-07-10 16:45:42 +03:00
"additionalProperties": true,
"description": "Return type (table) of the expression\nA name or definition of a Logical Model\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
},
"root_field_name": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"description": "Root field name for the native query",
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"type": "string"
}
},
"required": [
"root_field_name",
"code",
"returns"
],
"type": "object"
},
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
"BigqueryNullableScalarType": {
"description": "A scalar type that can be nullable with an optional description",
"properties": {
"description": {
"description": "Optional description text which appears in the GraphQL Schema",
"type": "string"
},
"nullable": {
"default": false,
"description": "Whether the type is nullable",
"type": "boolean"
},
"type": {
chore(server): support all BigQuery types in docs page PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9557 GitOrigin-RevId: b567fa72180df5f5e46037d362d5ba3806aa5f72
2023-06-15 13:19:39 +03:00
"additionalProperties": true,
"description": "The base scalar type\nA scalar type for BigQuery\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
}
},
"required": [
"type"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"BigqueryObjRelRemoteTableMultipleColumns": {
"properties": {
"columns": {
"items": {
"type": "string"
},
"type": "array"
},
"table": {
"$ref": "#/components/schemas/BigQueryTableName"
}
},
"required": [
"table",
"columns"
],
"type": "object"
},
"BigqueryObjRelRemoteTableSingleColumn": {
"properties": {
"column": {
"type": "string"
},
"table": {
"$ref": "#/components/schemas/BigQueryTableName"
}
},
"required": [
"table",
"column"
],
"type": "object"
},
"BigqueryRUManual": {
"properties": {
"manual_configuration": {
chore(server): Table -> Native Query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10114 GitOrigin-RevId: 0181184d1bc0e851151f86a98c96c97888a10e3e
2023-08-17 18:34:05 +03:00
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/BigqueryRelManualTableConfig"
},
{
"$ref": "#/components/schemas/BigqueryRelManualNativeQueryConfig"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"manual_configuration"
],
"type": "object"
},
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
"BigqueryRelManualNativeQueryConfig": {
"properties": {
"column_mapping": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"additionalProperties": true,
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
]
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
},
"insertion_order": {
"enum": [
"before_parent",
"after_parent"
],
"nullable": true,
"type": "string"
},
"remote_native_query": {
"type": "string"
}
},
"required": [
"remote_native_query",
"column_mapping"
],
"type": "object"
},
"BigqueryRelManualTableConfig": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
"column_mapping": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"additionalProperties": true,
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"insertion_order": {
"enum": [
"before_parent",
"after_parent"
],
"nullable": true,
"type": "string"
},
"remote_table": {
"$ref": "#/components/schemas/BigQueryTableName"
}
},
"required": [
"remote_table",
"column_mapping"
],
"type": "object"
},
"BigquerySelPerm": {
"properties": {
"allow_aggregations": {
"default": false,
"type": "boolean"
},
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"computed_fields": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
},
"filter": {
"$ref": "#/components/schemas/BigqueryBoolExp"
},
"limit": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"query_root_fields": {
"default": null,
"items": {
"enum": [
"select",
"select_by_pk",
"select_aggregate"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"subscription_root_fields": {
"default": null,
"items": {
"enum": [
"select",
"select_by_pk",
"select_aggregate",
"select_stream"
],
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"required": [
"columns",
"filter"
],
"type": "object"
},
"BigquerySelectPermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/BigquerySelPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"BigquerySourceMetadata": {
"properties": {
"configuration": {
"$ref": "#/components/schemas/BigQueryConnSourceConfig"
},
"customization": {
"$ref": "#/components/schemas/SourceCustomization"
},
"functions": {
"default": [],
"items": {
"$ref": "#/components/schemas/BigqueryFunctionMetadata"
},
"nullable": true,
"type": "array"
},
"kind": {
"enum": [
"bigquery"
],
"type": "string"
},
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
"logical_models": {
"default": [],
"items": {
"$ref": "#/components/schemas/BigqueryLogicalModelMetadata"
},
"nullable": true,
"type": "array"
},
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"name": {
"type": "string"
},
"native_queries": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"default": [],
"items": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"$ref": "#/components/schemas/BigqueryNativeQueryMetadata"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"nullable": true,
"type": "array"
},
"query_tags": {
"$ref": "#/components/schemas/QueryTagsConfig"
},
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"stored_procedures": {
"default": [],
"items": {
"$ref": "#/components/schemas/BigqueryStoredProcedureMetadata"
},
"nullable": true,
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"tables": {
"items": {
"$ref": "#/components/schemas/BigqueryTableMetadata"
},
"type": "array"
}
},
"required": [
"name",
"kind",
"tables",
"configuration"
],
"type": "object"
},
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"BigqueryStoredProcedureMetadata": {
"description": "A stored procedure as represented in metadata.",
"properties": {
"arguments": {
"additionalProperties": {
"$ref": "#/components/schemas/BigqueryNullableScalarType"
},
"default": {},
"description": "Free variables in the expression and their types",
"type": "object"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"configuration": {
"$ref": "#/components/schemas/StoredProcedureConfig"
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
},
"description": {
"description": "A description of the stored procedure which appears in the graphql schema",
"type": "string"
},
"returns": {
"description": "Return type (table) of the expression",
"type": "string"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"stored_procedure": {
"$ref": "#/components/schemas/BigQueryFunctionName"
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
}
},
"required": [
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"stored_procedure",
"configuration",
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"returns"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"BigqueryTableConfig": {
"properties": {
"column_config": {
"additionalProperties": {
"$ref": "#/components/schemas/ColumnConfig"
},
"default": {},
"type": "object"
},
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"custom_column_names": {
"additionalProperties": {
"$ref": "#/components/schemas/GraphQLName"
},
"default": {},
"type": "object"
},
"custom_name": {
"$ref": "#/components/schemas/GraphQLName"
},
"custom_root_fields": {
"$ref": "#/components/schemas/TableCustomRootFields"
}
},
"type": "object"
},
"BigqueryTableMetadata": {
"description": "Representation of a table in metadata, 'tables.yaml' and 'metadata.json'",
"properties": {
"apollo_federation_config": {
"$ref": "#/components/schemas/ApolloFederationConfig"
},
"array_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RelDef_RelUsing__BigQuery__ArrRelUsingFKeyOn__BigQuery_"
},
"type": "array"
},
"computed_fields": {
"default": [],
"items": {
"$ref": "#/components/schemas/BigqueryComputedFieldMetadata"
},
"type": "array"
},
"configuration": {
"$ref": "#/components/schemas/BigqueryTableConfig"
},
"delete_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/BigqueryDeletePermDef"
},
"type": "array"
},
"insert_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/BigqueryInsertPermDef"
},
"type": "array"
},
"is_enum": {
"default": false,
"type": "boolean"
},
Specify table schema via logical model in `track_table` API PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9408 GitOrigin-RevId: 9ba20cd91e4d0066e0f14ce52cba0f55a7c5af31
2023-06-22 10:05:07 +03:00
"logical_model": {
"nullable": true,
"type": "string"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"object_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RelDef_RelUsing__BigQuery__ObjRelUsingChoice__BigQuery_"
},
"type": "array"
},
"remote_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RemoteRelationship_RemoteRelationshipDefinition"
},
"type": "array"
},
"select_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/BigquerySelectPermDef"
},
"type": "array"
},
"table": {
"$ref": "#/components/schemas/BigQueryTableName"
},
"update_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/BigqueryUpdatePermDef"
},
"type": "array"
}
},
"required": [
"table"
],
"type": "object"
},
"BigqueryUpdPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"check": {
"$ref": "#/components/schemas/BigqueryBoolExp"
},
"columns": {
"description": "Allowed columns",
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"filter": {
"$ref": "#/components/schemas/BigqueryBoolExp"
},
"set": {
"additionalProperties": {
"additionalProperties": true
},
"description": "Preset columns",
"type": "object"
server/postgres: update input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9665 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 35bd769281982833e86c5bb708b3edf5a040708b
2023-06-28 13:18:09 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"columns",
"filter"
],
"type": "object"
},
"BigqueryUpdatePermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/BigqueryUpdPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"BodyTransformFn_ModifyAsFormURLEncoded": {
"properties": {
"action": {
"enum": [
"x_www_form_urlencoded"
],
"type": "string"
},
"form_template": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"required": [
"action",
"form_template"
],
"type": "object"
},
"BodyTransformFn_ModifyAsJSON": {
"properties": {
"action": {
"enum": [
"transform"
],
"type": "string"
},
"template": {
"type": "string"
}
},
"required": [
"action",
"template"
],
"type": "object"
},
"BodyTransformFn_Remove": {
"properties": {
"action": {
"enum": [
"remove"
],
"type": "string"
}
},
"required": [
"action"
],
"type": "object"
},
"CertVar": {
"nullable": true,
"properties": {
"from_env": {
"type": "string"
}
},
"required": [
"from_env"
],
"type": "object"
},
"CitusArrRelUsingFKeyOnMultipleColumns": {
"properties": {
"columns": {
"items": {
"type": "string"
},
"type": "array"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"columns"
],
"type": "object"
},
"CitusArrRelUsingFKeyOnSingleColumn": {
"properties": {
"column": {
"type": "string"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"column"
],
"type": "object"
},
"CitusBoolExp": {
"additionalProperties": true
},
"CitusComputedFieldMetadata": {
"properties": {
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"definition": {
server: codecs for computed field definitions PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8270 GitOrigin-RevId: a0954d79c1fecb7eeba4eb47983e65d3637a23c3
2023-03-10 02:45:13 +03:00
"$ref": "#/components/schemas/PostgresComputedFieldDefinition"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"name": {
"type": "string"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
"CitusDelPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"filter": {
"$ref": "#/components/schemas/CitusBoolExp"
server/postgres: delete input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9666 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 5fa7702401065869c953b23c6734b9b367247634
2023-06-28 16:44:14 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"filter"
],
"type": "object"
},
"CitusDeletePermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/CitusDelPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"CitusEventTriggerConfEventTriggerConf": {
"properties": {
"cleanup_config": {
"$ref": "#/components/schemas/AutoTriggerLogCleanupConfig"
},
"definition": {
"$ref": "#/components/schemas/CitusTriggerOpsDef"
},
"headers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HeaderConfValue"
},
{
"$ref": "#/components/schemas/HeaderConfFromEnv"
}
]
},
"type": "array"
},
"name": {
"type": "string"
},
"request_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/RequestTransformV1"
},
{
"$ref": "#/components/schemas/RequestTransformV2"
}
]
},
"response_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/ResponseTransformV1"
},
{
"$ref": "#/components/schemas/ResponseTransformV2"
}
]
},
"retry_conf": {
"$ref": "#/components/schemas/RetryConf"
},
"trigger_on_replication": {
"default": false,
"type": "boolean"
},
"webhook": {
"type": "string"
},
"webhook_from_env": {
"type": "string"
}
},
"required": [
"name",
"definition",
"retry_conf"
],
"type": "object"
},
"CitusFunctionMetadata": {
"description": "A custom SQL function to add to the GraphQL schema with configuration.\n\nhttps://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/custom-functions.html#args-syntax\n",
"properties": {
"comment": {
"type": "string"
},
"configuration": {
"$ref": "#/components/schemas/FunctionConfig"
},
"function": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_FunctionName"
},
{
"type": "string"
}
],
"description": "Name of the SQL function"
},
"permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/FunctionPermissionInfo"
},
"type": "array"
}
},
"required": [
"function"
],
"type": "object"
},
"CitusHealthCheckConfig": {
"nullable": true,
"properties": {
"interval": {
"type": "number"
},
"retries": {
"default": 3,
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"retry_interval": {
"default": 10,
"type": "number"
},
"test": {
"$ref": "#/components/schemas/HealthCheckTestSql"
},
"timeout": {
"default": 10,
"type": "number"
}
},
"required": [
"interval"
],
"type": "object"
},
"CitusInsPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"check": {
"$ref": "#/components/schemas/CitusBoolExp"
},
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"set": {
"additionalProperties": {
"additionalProperties": true
},
"type": "object"
server/postgres: insert input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9620 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 345c3f763f8dd3397c999c5967af39192b944640
2023-06-25 16:46:35 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"check"
],
"type": "object"
},
"CitusInsertPermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/CitusInsPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
chore(server): more expressive logical models PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9197 GitOrigin-RevId: 3471c68d4e59310bdb62ecb3694ab30a2094916e
2023-05-19 19:12:51 +03:00
"CitusLogicalModelField": {
"description": "A field of a logical model",
"properties": {
"description": {
"description": "Optional description of this field",
"type": "string"
},
"name": {
"description": "Name of the field",
"type": "string"
},
"type": {
"additionalProperties": true,
"description": "Type of the field\nA type used in a Logical Model field\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
"CitusLogicalModelMetadata": {
"description": "A return type.",
"properties": {
"description": {
"description": "Optional description text which appears in the GraphQL Schema.",
"type": "string"
},
"fields": {
"description": "Return types for the logical model",
"items": {
"additionalProperties": true,
chore(server): more expressive logical models PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9197 GitOrigin-RevId: 3471c68d4e59310bdb62ecb3694ab30a2094916e
2023-05-19 19:12:51 +03:00
"anyOf": [
{
"$ref": "#/components/schemas/CitusLogicalModelField"
},
{
"$ref": "#/components/schemas/CitusLogicalModelField"
}
]
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
},
"type": "array"
},
"name": {
"description": "A name for a logical model",
"type": "string"
},
"select_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/CitusSelectPermDef"
},
"type": "array"
}
},
"required": [
"name",
"fields"
],
"type": "object"
},
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"CitusNativeQueryMetadata": {
"description": "A native query as represented in metadata.",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
"arguments": {
"additionalProperties": {
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
"$ref": "#/components/schemas/CitusNullableScalarType"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"default": {},
"description": "Free variables in the expression and their types",
"type": "object"
},
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
"array_relationships": {
"default": [],
"items": {
chore(server): Native Query -> Table array relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10100 GitOrigin-RevId: 55f38a904767e1b25916fb31b3c5ece898c10349
2023-08-14 15:33:50 +03:00
"$ref": "#/components/schemas/RelDef_RelManualConfig___Postgres__Citus_"
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
},
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"code": {
"description": "Native code expression (SQL) to run\nAn interpolated query expressed in native code (SQL)",
"type": "string"
},
"description": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"description": "A description of the native query which appears in the graphql schema",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "string"
},
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
"object_relationships": {
"default": [],
"items": {
chore(server): Native Query -> Table object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10098 GitOrigin-RevId: 9b98bb0e285560cd03b04f867d1fa16dadd00df9
2023-08-10 17:21:34 +03:00
"$ref": "#/components/schemas/RelDef_RelManualConfig___Postgres__Citus_"
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
},
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"returns": {
chore(server): allow Logical Models to be defined inside Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9787 GitOrigin-RevId: 48b88f3c98024d3be721ab27a28be75952586a8c
2023-07-10 16:45:42 +03:00
"additionalProperties": true,
"description": "Return type (table) of the expression\nA name or definition of a Logical Model\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"root_field_name": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"description": "Root field name for the native query",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "string"
}
},
"required": [
"root_field_name",
"code",
"returns"
],
"type": "object"
},
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
"CitusNullableScalarType": {
"description": "A scalar type that can be nullable with an optional description",
"properties": {
"description": {
"description": "Optional description text which appears in the GraphQL Schema",
"type": "string"
},
"nullable": {
"default": false,
"description": "Whether the type is nullable",
"type": "boolean"
},
"type": {
"description": "The base scalar type\nPostgres Scalar Types",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"CitusObjRelRemoteTableMultipleColumns": {
"properties": {
"columns": {
"items": {
"type": "string"
},
"type": "array"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"columns"
],
"type": "object"
},
"CitusObjRelRemoteTableSingleColumn": {
"properties": {
"column": {
"type": "string"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"column"
],
"type": "object"
},
"CitusRUManual": {
"properties": {
"manual_configuration": {
chore(server): Table -> Native Query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10114 GitOrigin-RevId: 0181184d1bc0e851151f86a98c96c97888a10e3e
2023-08-17 18:34:05 +03:00
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/CitusRelManualTableConfig"
},
{
"$ref": "#/components/schemas/CitusRelManualNativeQueryConfig"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"manual_configuration"
],
"type": "object"
},
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
"CitusRelManualNativeQueryConfig": {
"properties": {
"column_mapping": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"additionalProperties": true,
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
]
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
},
"insertion_order": {
"enum": [
"before_parent",
"after_parent"
],
"nullable": true,
"type": "string"
},
"remote_native_query": {
"type": "string"
}
},
"required": [
"remote_native_query",
"column_mapping"
],
"type": "object"
},
"CitusRelManualTableConfig": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
"column_mapping": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"additionalProperties": true,
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"insertion_order": {
"enum": [
"before_parent",
"after_parent"
],
"nullable": true,
"type": "string"
},
"remote_table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"remote_table",
"column_mapping"
],
"type": "object"
},
"CitusSelPerm": {
"properties": {
"allow_aggregations": {
"default": false,
"type": "boolean"
},
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"computed_fields": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
},
"filter": {
"$ref": "#/components/schemas/CitusBoolExp"
},
"limit": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"query_root_fields": {
"default": null,
"items": {
"enum": [
"select",
"select_by_pk",
"select_aggregate"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"subscription_root_fields": {
"default": null,
"items": {
"enum": [
"select",
"select_by_pk",
"select_aggregate",
"select_stream"
],
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"required": [
"columns",
"filter"
],
"type": "object"
},
"CitusSelectPermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/CitusSelPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"CitusSourceMetadata": {
"properties": {
"configuration": {
"$ref": "#/components/schemas/PostgresConnConfiguration"
},
"customization": {
"$ref": "#/components/schemas/SourceCustomization"
},
"functions": {
"default": [],
"items": {
"$ref": "#/components/schemas/CitusFunctionMetadata"
},
"nullable": true,
"type": "array"
},
"health_check": {
"$ref": "#/components/schemas/CitusHealthCheckConfig"
},
"kind": {
"enum": [
"citus"
],
"type": "string"
},
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
"logical_models": {
"default": [],
"items": {
"$ref": "#/components/schemas/CitusLogicalModelMetadata"
},
"nullable": true,
"type": "array"
},
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"name": {
"type": "string"
},
"native_queries": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"default": [],
"items": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"$ref": "#/components/schemas/CitusNativeQueryMetadata"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"nullable": true,
"type": "array"
},
"query_tags": {
"$ref": "#/components/schemas/QueryTagsConfig"
},
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"stored_procedures": {
"default": [],
"items": {
"$ref": "#/components/schemas/CitusStoredProcedureMetadata"
},
"nullable": true,
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"tables": {
"items": {
"$ref": "#/components/schemas/CitusTableMetadata"
},
"type": "array"
}
},
"required": [
"name",
"kind",
"tables",
"configuration"
],
"type": "object"
},
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"CitusStoredProcedureMetadata": {
"description": "A stored procedure as represented in metadata.",
"properties": {
"arguments": {
"additionalProperties": {
"$ref": "#/components/schemas/CitusNullableScalarType"
},
"default": {},
"description": "Free variables in the expression and their types",
"type": "object"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"configuration": {
"$ref": "#/components/schemas/StoredProcedureConfig"
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
},
"description": {
"description": "A description of the stored procedure which appears in the graphql schema",
"type": "string"
},
"returns": {
"description": "Return type (table) of the expression",
"type": "string"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"stored_procedure": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_FunctionName"
},
{
"type": "string"
}
],
"description": "The name of the SQL stored procedure"
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
}
},
"required": [
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"stored_procedure",
"configuration",
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"returns"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"CitusSubscribeOpSpec": {
"properties": {
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"payload": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"required": [
"columns"
],
"type": "object"
},
"CitusTableConfig": {
"properties": {
"column_config": {
"additionalProperties": {
"$ref": "#/components/schemas/ColumnConfig"
},
"default": {},
"type": "object"
},
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"custom_column_names": {
"additionalProperties": {
"$ref": "#/components/schemas/GraphQLName"
},
"default": {},
"type": "object"
},
"custom_name": {
"$ref": "#/components/schemas/GraphQLName"
},
"custom_root_fields": {
"$ref": "#/components/schemas/TableCustomRootFields"
}
},
"type": "object"
},
"CitusTableMetadata": {
"description": "Representation of a table in metadata, 'tables.yaml' and 'metadata.json'",
"properties": {
"apollo_federation_config": {
"$ref": "#/components/schemas/ApolloFederationConfig"
},
"array_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RelDef_RelUsing___Postgres__Citus___ArrRelUsingFKeyOn___Postgres__Citus__"
},
"type": "array"
},
"computed_fields": {
"default": [],
"items": {
"$ref": "#/components/schemas/CitusComputedFieldMetadata"
},
"type": "array"
},
"configuration": {
"$ref": "#/components/schemas/CitusTableConfig"
},
"delete_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/CitusDeletePermDef"
},
"type": "array"
},
"event_triggers": {
"default": [],
"items": {
"$ref": "#/components/schemas/CitusEventTriggerConfEventTriggerConf"
},
"type": "array"
},
"insert_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/CitusInsertPermDef"
},
"type": "array"
},
"is_enum": {
"default": false,
"type": "boolean"
},
Specify table schema via logical model in `track_table` API PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9408 GitOrigin-RevId: 9ba20cd91e4d0066e0f14ce52cba0f55a7c5af31
2023-06-22 10:05:07 +03:00
"logical_model": {
"nullable": true,
"type": "string"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"object_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RelDef_RelUsing___Postgres__Citus___ObjRelUsingChoice___Postgres__Citus__"
},
"type": "array"
},
"remote_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RemoteRelationship_RemoteRelationshipDefinition"
},
"type": "array"
},
"select_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/CitusSelectPermDef"
},
"type": "array"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
},
"update_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/CitusUpdatePermDef"
},
"type": "array"
}
},
"required": [
"table"
],
"type": "object"
},
"CitusTriggerOpsDef": {
"properties": {
"delete": {
"$ref": "#/components/schemas/CitusSubscribeOpSpec"
},
"enable_manual": {
"type": "boolean"
},
"insert": {
"$ref": "#/components/schemas/CitusSubscribeOpSpec"
},
"update": {
"$ref": "#/components/schemas/CitusSubscribeOpSpec"
}
},
"type": "object"
},
"CitusUpdPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"check": {
"$ref": "#/components/schemas/CitusBoolExp"
},
"columns": {
"description": "Allowed columns",
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"filter": {
"$ref": "#/components/schemas/CitusBoolExp"
},
"set": {
"additionalProperties": {
"additionalProperties": true
},
"description": "Preset columns",
"type": "object"
server/postgres: update input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9665 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 35bd769281982833e86c5bb708b3edf5a040708b
2023-06-28 13:18:09 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"columns",
"filter"
],
"type": "object"
},
"CitusUpdatePermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/CitusUpdPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"CockroachArrRelUsingFKeyOnMultipleColumns": {
"properties": {
"columns": {
"items": {
"type": "string"
},
"type": "array"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"columns"
],
"type": "object"
},
"CockroachArrRelUsingFKeyOnSingleColumn": {
"properties": {
"column": {
"type": "string"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"column"
],
"type": "object"
},
"CockroachBoolExp": {
"additionalProperties": true
},
"CockroachComputedFieldMetadata": {
"properties": {
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"definition": {
server: codecs for computed field definitions PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8270 GitOrigin-RevId: a0954d79c1fecb7eeba4eb47983e65d3637a23c3
2023-03-10 02:45:13 +03:00
"$ref": "#/components/schemas/PostgresComputedFieldDefinition"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"name": {
"type": "string"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
"CockroachDelPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"filter": {
"$ref": "#/components/schemas/CockroachBoolExp"
server/postgres: delete input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9666 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 5fa7702401065869c953b23c6734b9b367247634
2023-06-28 16:44:14 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"filter"
],
"type": "object"
},
"CockroachDeletePermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/CockroachDelPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"CockroachEventTriggerConfEventTriggerConf": {
"properties": {
"cleanup_config": {
"$ref": "#/components/schemas/AutoTriggerLogCleanupConfig"
},
"definition": {
"$ref": "#/components/schemas/CockroachTriggerOpsDef"
},
"headers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HeaderConfValue"
},
{
"$ref": "#/components/schemas/HeaderConfFromEnv"
}
]
},
"type": "array"
},
"name": {
"type": "string"
},
"request_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/RequestTransformV1"
},
{
"$ref": "#/components/schemas/RequestTransformV2"
}
]
},
"response_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/ResponseTransformV1"
},
{
"$ref": "#/components/schemas/ResponseTransformV2"
}
]
},
"retry_conf": {
"$ref": "#/components/schemas/RetryConf"
},
"trigger_on_replication": {
"default": false,
"type": "boolean"
},
"webhook": {
"type": "string"
},
"webhook_from_env": {
"type": "string"
}
},
"required": [
"name",
"definition",
"retry_conf"
],
"type": "object"
},
"CockroachFunctionMetadata": {
"description": "A custom SQL function to add to the GraphQL schema with configuration.\n\nhttps://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/custom-functions.html#args-syntax\n",
"properties": {
"comment": {
"type": "string"
},
"configuration": {
"$ref": "#/components/schemas/FunctionConfig"
},
"function": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_FunctionName"
},
{
"type": "string"
}
],
"description": "Name of the SQL function"
},
"permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/FunctionPermissionInfo"
},
"type": "array"
}
},
"required": [
"function"
],
"type": "object"
},
"CockroachHealthCheckConfig": {
"nullable": true,
"properties": {
"interval": {
"type": "number"
},
"retries": {
"default": 3,
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"retry_interval": {
"default": 10,
"type": "number"
},
"test": {
"$ref": "#/components/schemas/HealthCheckTestSql"
},
"timeout": {
"default": 10,
"type": "number"
}
},
"required": [
"interval"
],
"type": "object"
},
"CockroachInsPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"check": {
"$ref": "#/components/schemas/CockroachBoolExp"
},
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"set": {
"additionalProperties": {
"additionalProperties": true
},
"type": "object"
server/postgres: insert input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9620 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 345c3f763f8dd3397c999c5967af39192b944640
2023-06-25 16:46:35 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"check"
],
"type": "object"
},
"CockroachInsertPermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/CockroachInsPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
chore(server): more expressive logical models PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9197 GitOrigin-RevId: 3471c68d4e59310bdb62ecb3694ab30a2094916e
2023-05-19 19:12:51 +03:00
"CockroachLogicalModelField": {
"description": "A field of a logical model",
"properties": {
"description": {
"description": "Optional description of this field",
"type": "string"
},
"name": {
"description": "Name of the field",
"type": "string"
},
"type": {
"additionalProperties": true,
"description": "Type of the field\nA type used in a Logical Model field\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
"CockroachLogicalModelMetadata": {
"description": "A return type.",
"properties": {
"description": {
"description": "Optional description text which appears in the GraphQL Schema.",
"type": "string"
},
"fields": {
"description": "Return types for the logical model",
"items": {
"additionalProperties": true,
chore(server): more expressive logical models PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9197 GitOrigin-RevId: 3471c68d4e59310bdb62ecb3694ab30a2094916e
2023-05-19 19:12:51 +03:00
"anyOf": [
{
"$ref": "#/components/schemas/CockroachLogicalModelField"
},
{
"$ref": "#/components/schemas/CockroachLogicalModelField"
}
]
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
},
"type": "array"
},
"name": {
"description": "A name for a logical model",
"type": "string"
},
"select_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/CockroachSelectPermDef"
},
"type": "array"
}
},
"required": [
"name",
"fields"
],
"type": "object"
},
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"CockroachNativeQueryMetadata": {
"description": "A native query as represented in metadata.",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
"arguments": {
"additionalProperties": {
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
"$ref": "#/components/schemas/CockroachNullableScalarType"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"default": {},
"description": "Free variables in the expression and their types",
"type": "object"
},
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
"array_relationships": {
"default": [],
"items": {
chore(server): Native Query -> Table array relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10100 GitOrigin-RevId: 55f38a904767e1b25916fb31b3c5ece898c10349
2023-08-14 15:33:50 +03:00
"$ref": "#/components/schemas/RelDef_RelManualConfig___Postgres__Cockroach_"
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
},
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"code": {
"description": "Native code expression (SQL) to run\nAn interpolated query expressed in native code (SQL)",
"type": "string"
},
"description": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"description": "A description of the native query which appears in the graphql schema",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "string"
},
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
"object_relationships": {
"default": [],
"items": {
chore(server): Native Query -> Table object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10098 GitOrigin-RevId: 9b98bb0e285560cd03b04f867d1fa16dadd00df9
2023-08-10 17:21:34 +03:00
"$ref": "#/components/schemas/RelDef_RelManualConfig___Postgres__Cockroach_"
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
},
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"returns": {
chore(server): allow Logical Models to be defined inside Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9787 GitOrigin-RevId: 48b88f3c98024d3be721ab27a28be75952586a8c
2023-07-10 16:45:42 +03:00
"additionalProperties": true,
"description": "Return type (table) of the expression\nA name or definition of a Logical Model\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"root_field_name": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"description": "Root field name for the native query",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "string"
}
},
"required": [
"root_field_name",
"code",
"returns"
],
"type": "object"
},
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
"CockroachNullableScalarType": {
"description": "A scalar type that can be nullable with an optional description",
"properties": {
"description": {
"description": "Optional description text which appears in the GraphQL Schema",
"type": "string"
},
"nullable": {
"default": false,
"description": "Whether the type is nullable",
"type": "boolean"
},
"type": {
"description": "The base scalar type\nPostgres Scalar Types",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"CockroachObjRelRemoteTableMultipleColumns": {
"properties": {
"columns": {
"items": {
"type": "string"
},
"type": "array"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"columns"
],
"type": "object"
},
"CockroachObjRelRemoteTableSingleColumn": {
"properties": {
"column": {
"type": "string"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"column"
],
"type": "object"
},
"CockroachRUManual": {
"properties": {
"manual_configuration": {
chore(server): Table -> Native Query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10114 GitOrigin-RevId: 0181184d1bc0e851151f86a98c96c97888a10e3e
2023-08-17 18:34:05 +03:00
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/CockroachRelManualTableConfig"
},
{
"$ref": "#/components/schemas/CockroachRelManualNativeQueryConfig"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"manual_configuration"
],
"type": "object"
},
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
"CockroachRelManualNativeQueryConfig": {
"properties": {
"column_mapping": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"additionalProperties": true,
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
]
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
},
"insertion_order": {
"enum": [
"before_parent",
"after_parent"
],
"nullable": true,
"type": "string"
},
"remote_native_query": {
"type": "string"
}
},
"required": [
"remote_native_query",
"column_mapping"
],
"type": "object"
},
"CockroachRelManualTableConfig": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
"column_mapping": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"additionalProperties": true,
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"insertion_order": {
"enum": [
"before_parent",
"after_parent"
],
"nullable": true,
"type": "string"
},
"remote_table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"remote_table",
"column_mapping"
],
"type": "object"
},
"CockroachSelPerm": {
"properties": {
"allow_aggregations": {
"default": false,
"type": "boolean"
},
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"computed_fields": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
},
"filter": {
"$ref": "#/components/schemas/CockroachBoolExp"
},
"limit": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"query_root_fields": {
"default": null,
"items": {
"enum": [
"select",
"select_by_pk",
"select_aggregate"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"subscription_root_fields": {
"default": null,
"items": {
"enum": [
"select",
"select_by_pk",
"select_aggregate",
"select_stream"
],
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"required": [
"columns",
"filter"
],
"type": "object"
},
"CockroachSelectPermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/CockroachSelPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"CockroachSourceMetadata": {
"properties": {
"configuration": {
"$ref": "#/components/schemas/PostgresConnConfiguration"
},
"customization": {
"$ref": "#/components/schemas/SourceCustomization"
},
"functions": {
"default": [],
"items": {
"$ref": "#/components/schemas/CockroachFunctionMetadata"
},
"nullable": true,
"type": "array"
},
"health_check": {
"$ref": "#/components/schemas/CockroachHealthCheckConfig"
},
"kind": {
"enum": [
"cockroach"
],
"type": "string"
},
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
"logical_models": {
"default": [],
"items": {
"$ref": "#/components/schemas/CockroachLogicalModelMetadata"
},
"nullable": true,
"type": "array"
},
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"name": {
"type": "string"
},
"native_queries": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"default": [],
"items": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"$ref": "#/components/schemas/CockroachNativeQueryMetadata"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"nullable": true,
"type": "array"
},
"query_tags": {
"$ref": "#/components/schemas/QueryTagsConfig"
},
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"stored_procedures": {
"default": [],
"items": {
"$ref": "#/components/schemas/CockroachStoredProcedureMetadata"
},
"nullable": true,
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"tables": {
"items": {
"$ref": "#/components/schemas/CockroachTableMetadata"
},
"type": "array"
}
},
"required": [
"name",
"kind",
"tables",
"configuration"
],
"type": "object"
},
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"CockroachStoredProcedureMetadata": {
"description": "A stored procedure as represented in metadata.",
"properties": {
"arguments": {
"additionalProperties": {
"$ref": "#/components/schemas/CockroachNullableScalarType"
},
"default": {},
"description": "Free variables in the expression and their types",
"type": "object"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"configuration": {
"$ref": "#/components/schemas/StoredProcedureConfig"
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
},
"description": {
"description": "A description of the stored procedure which appears in the graphql schema",
"type": "string"
},
"returns": {
"description": "Return type (table) of the expression",
"type": "string"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"stored_procedure": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_FunctionName"
},
{
"type": "string"
}
],
"description": "The name of the SQL stored procedure"
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
}
},
"required": [
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"stored_procedure",
"configuration",
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"returns"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"CockroachSubscribeOpSpec": {
"properties": {
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"payload": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"required": [
"columns"
],
"type": "object"
},
"CockroachTableConfig": {
"properties": {
"column_config": {
"additionalProperties": {
"$ref": "#/components/schemas/ColumnConfig"
},
"default": {},
"type": "object"
},
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"custom_column_names": {
"additionalProperties": {
"$ref": "#/components/schemas/GraphQLName"
},
"default": {},
"type": "object"
},
"custom_name": {
"$ref": "#/components/schemas/GraphQLName"
},
"custom_root_fields": {
"$ref": "#/components/schemas/TableCustomRootFields"
}
},
"type": "object"
},
"CockroachTableMetadata": {
"description": "Representation of a table in metadata, 'tables.yaml' and 'metadata.json'",
"properties": {
"apollo_federation_config": {
"$ref": "#/components/schemas/ApolloFederationConfig"
},
"array_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RelDef_RelUsing___Postgres__Cockroach___ArrRelUsingFKeyOn___Postgres__Cockroach__"
},
"type": "array"
},
"computed_fields": {
"default": [],
"items": {
"$ref": "#/components/schemas/CockroachComputedFieldMetadata"
},
"type": "array"
},
"configuration": {
"$ref": "#/components/schemas/CockroachTableConfig"
},
"delete_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/CockroachDeletePermDef"
},
"type": "array"
},
"event_triggers": {
"default": [],
"items": {
"$ref": "#/components/schemas/CockroachEventTriggerConfEventTriggerConf"
},
"type": "array"
},
"insert_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/CockroachInsertPermDef"
},
"type": "array"
},
"is_enum": {
"default": false,
"type": "boolean"
},
Specify table schema via logical model in `track_table` API PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9408 GitOrigin-RevId: 9ba20cd91e4d0066e0f14ce52cba0f55a7c5af31
2023-06-22 10:05:07 +03:00
"logical_model": {
"nullable": true,
"type": "string"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"object_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RelDef_RelUsing___Postgres__Cockroach___ObjRelUsingChoice___Postgres__Cockroach__"
},
"type": "array"
},
"remote_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RemoteRelationship_RemoteRelationshipDefinition"
},
"type": "array"
},
"select_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/CockroachSelectPermDef"
},
"type": "array"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
},
"update_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/CockroachUpdatePermDef"
},
"type": "array"
}
},
"required": [
"table"
],
"type": "object"
},
"CockroachTriggerOpsDef": {
"properties": {
"delete": {
"$ref": "#/components/schemas/CockroachSubscribeOpSpec"
},
"enable_manual": {
"type": "boolean"
},
"insert": {
"$ref": "#/components/schemas/CockroachSubscribeOpSpec"
},
"update": {
"$ref": "#/components/schemas/CockroachSubscribeOpSpec"
}
},
"type": "object"
},
"CockroachUpdPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"check": {
"$ref": "#/components/schemas/CockroachBoolExp"
},
"columns": {
"description": "Allowed columns",
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"filter": {
"$ref": "#/components/schemas/CockroachBoolExp"
},
"set": {
"additionalProperties": {
"additionalProperties": true
},
"description": "Preset columns",
"type": "object"
server/postgres: update input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9665 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 35bd769281982833e86c5bb708b3edf5a040708b
2023-06-28 13:18:09 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"columns",
"filter"
],
"type": "object"
},
"CockroachUpdatePermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/CockroachUpdPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"CollectionDef": {
"properties": {
"queries": {
"items": {
"$ref": "#/components/schemas/ListedQuery"
},
"type": "array"
}
},
"required": [
"queries"
],
"type": "object"
},
"ColumnConfig": {
"properties": {
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"custom_name": {
"$ref": "#/components/schemas/GraphQLName"
}
},
"type": "object"
},
server: codec for dataconnector ConnSourceConfig PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8271 GitOrigin-RevId: b5aaa86a5e453fecb1e88c2afb223857e50c8b7d
2023-03-30 21:36:25 +03:00
"Config": {
"additionalProperties": {
"additionalProperties": true
},
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"ConnectionTemplate": {
"description": "https://hasura.io/docs/latest/graphql/core/api-reference/syntax-defs.html#pgconnectiontemplate",
"nullable": true,
"properties": {
"template": {
"additionalProperties": true,
"description": "Connection kriti template (read more in the docs)\nKritiTemplate"
},
"version": {
"default": 1,
"description": "Optional connection template version (supported versions: [1], default: 1)",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
}
},
"required": [
"template"
],
"type": "object"
},
"CreateCollection": {
"properties": {
"comment": {
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/CollectionDef"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
"CronSchedule": {
"type": "string"
},
server: codecs for cron triggers PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8029 GitOrigin-RevId: c26308782618c760921a0eff3e4bd87702bd3eb2
2023-02-20 05:50:42 +03:00
"CronTriggerMetadata": {
"properties": {
"comment": {
"type": "string"
},
"headers": {
"default": [],
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HeaderConfValue"
},
{
"$ref": "#/components/schemas/HeaderConfFromEnv"
}
]
},
"type": "array"
},
"include_in_metadata": {
"type": "boolean"
},
"name": {
"type": "string"
},
"payload": {
"additionalProperties": true
},
"request_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/RequestTransformV1"
},
{
"$ref": "#/components/schemas/RequestTransformV2"
}
]
},
"response_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/ResponseTransformV1"
},
{
"$ref": "#/components/schemas/ResponseTransformV2"
}
]
},
"retry_conf": {
"$ref": "#/components/schemas/STRetryConf"
},
"schedule": {
"$ref": "#/components/schemas/CronSchedule"
},
"webhook": {
"type": "string"
}
},
"required": [
"name",
"webhook",
"schedule",
"include_in_metadata"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"CustomRootField": {
"properties": {
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"name": {
"$ref": "#/components/schemas/GraphQLName"
}
},
"type": "object"
},
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"CustomTypes": {
"properties": {
"enums": {
"default": [],
"items": {
"$ref": "#/components/schemas/EnumTypeDefinition"
},
"type": "array"
},
"input_objects": {
"default": [],
"items": {
"$ref": "#/components/schemas/InputObjectTypeDefinition"
},
"type": "array"
},
"objects": {
"default": [],
"items": {
"$ref": "#/components/schemas/ObjectTypeDefinition"
},
"type": "array"
},
"scalars": {
"default": [],
"items": {
"$ref": "#/components/schemas/ScalarTypeDefinition"
},
"type": "array"
}
},
"type": "object"
},
server: codec for dataconnector ConnSourceConfig PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8271 GitOrigin-RevId: b5aaa86a5e453fecb1e88c2afb223857e50c8b7d
2023-03-30 21:36:25 +03:00
"DataConnectorConnSourceConfig": {
"properties": {
"template": {
"type": "string"
},
Dynamic from file template variables in Data Connector config Kriti transforms PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10408 Co-authored-by: Matthew Goodwin <49927862+m4ttheweric@users.noreply.github.com> Co-authored-by: Vijay Prasanna <11921040+vijayprasanna13@users.noreply.github.com> GitOrigin-RevId: c6d7a47079d93a6c0a987cd1df7ece9fa4d1a917
2023-10-27 15:34:42 +03:00
"template_variables": {
"additionalProperties": {
"$ref": "#/components/schemas/TemplateVariableSource"
},
"type": "object"
},
server: codec for dataconnector ConnSourceConfig PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8271 GitOrigin-RevId: b5aaa86a5e453fecb1e88c2afb223857e50c8b7d
2023-03-30 21:36:25 +03:00
"timeout": {
"oneOf": [
{
"$ref": "#/components/schemas/DataConnectorSourceTimeoutSeconds"
},
{
"$ref": "#/components/schemas/DataConnectorSourceTimeoutMilliseconds"
},
{
"$ref": "#/components/schemas/DataConnectorSourceTimeoutMicroseconds"
}
]
},
"value": {
"$ref": "#/components/schemas/Config"
}
},
"required": [
"value"
],
"type": "object"
},
server: update metadata.openapi.json PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8574 GitOrigin-RevId: 456a7d6cad66b6281e90b0c2623274c04fe15f47
2023-03-31 00:55:06 +03:00
"DataConnectorOptions": {
"properties": {
"display_name": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": [
"uri"
],
"type": "object"
},
server: codec for dataconnector ConnSourceConfig PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8271 GitOrigin-RevId: b5aaa86a5e453fecb1e88c2afb223857e50c8b7d
2023-03-30 21:36:25 +03:00
"DataConnectorSourceTimeoutMicroseconds": {
"properties": {
"microseconds": {
"type": "number"
}
},
"required": [
"microseconds"
],
"type": "object"
},
"DataConnectorSourceTimeoutMilliseconds": {
"properties": {
"milliseconds": {
"type": "number"
}
},
"required": [
"milliseconds"
],
"type": "object"
},
"DataConnectorSourceTimeoutSeconds": {
"properties": {
"seconds": {
"type": "number"
}
},
"required": [
"seconds"
],
"type": "object"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"DataconnectorArrRelUsingFKeyOnMultipleColumns": {
"properties": {
"columns": {
"items": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"type": "array"
},
"table": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"table",
"columns"
],
"type": "object"
},
"DataconnectorArrRelUsingFKeyOnSingleColumn": {
"properties": {
"column": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"table": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"table",
"column"
],
"type": "object"
},
"DataconnectorBoolExp": {
"additionalProperties": true
},
"DataconnectorComputedFieldMetadata": {
"properties": {
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"definition": {
server: codecs for computed field definitions PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8270 GitOrigin-RevId: a0954d79c1fecb7eeba4eb47983e65d3637a23c3
2023-03-10 02:45:13 +03:00
"items": {
"type": "null"
},
"type": "array"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"name": {
"type": "string"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
"DataconnectorDelPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"filter": {
"$ref": "#/components/schemas/DataconnectorBoolExp"
server/postgres: delete input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9666 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 5fa7702401065869c953b23c6734b9b367247634
2023-06-28 16:44:14 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"filter"
],
"type": "object"
},
"DataconnectorDeletePermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/DataconnectorDelPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"DataconnectorFunctionMetadata": {
"description": "A custom SQL function to add to the GraphQL schema with configuration.\n\nhttps://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/custom-functions.html#args-syntax\n",
"properties": {
"comment": {
"type": "string"
},
"configuration": {
"$ref": "#/components/schemas/FunctionConfig"
},
"function": {
"description": "Name of the SQL function",
"items": {
"type": "string"
},
"type": "array"
},
"permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/FunctionPermissionInfo"
},
"type": "array"
}
},
"required": [
"function"
],
"type": "object"
},
"DataconnectorInsPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"check": {
"$ref": "#/components/schemas/DataconnectorBoolExp"
},
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"set": {
"additionalProperties": {
"additionalProperties": true
},
"type": "object"
server/postgres: insert input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9620 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 345c3f763f8dd3397c999c5967af39192b944640
2023-06-25 16:46:35 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"check"
],
"type": "object"
},
"DataconnectorInsertPermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/DataconnectorInsPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
chore(server): more expressive logical models PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9197 GitOrigin-RevId: 3471c68d4e59310bdb62ecb3694ab30a2094916e
2023-05-19 19:12:51 +03:00
"DataconnectorLogicalModelField": {
"description": "A field of a logical model",
"properties": {
"description": {
"description": "Optional description of this field",
"type": "string"
},
"name": {
"description": "Name of the field",
"type": "string"
},
"type": {
"additionalProperties": true,
"description": "Type of the field\nA type used in a Logical Model field\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
"DataconnectorLogicalModelMetadata": {
"description": "A return type.",
"properties": {
"description": {
"description": "Optional description text which appears in the GraphQL Schema.",
"type": "string"
},
"fields": {
"description": "Return types for the logical model",
"items": {
"additionalProperties": true,
chore(server): more expressive logical models PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9197 GitOrigin-RevId: 3471c68d4e59310bdb62ecb3694ab30a2094916e
2023-05-19 19:12:51 +03:00
"anyOf": [
{
"$ref": "#/components/schemas/DataconnectorLogicalModelField"
},
{
"$ref": "#/components/schemas/DataconnectorLogicalModelField"
}
]
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
},
"type": "array"
},
"name": {
"description": "A name for a logical model",
"type": "string"
},
"select_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/DataconnectorSelectPermDef"
},
"type": "array"
}
},
"required": [
"name",
"fields"
],
"type": "object"
},
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"DataconnectorNativeQueryMetadata": {
"description": "A native query as represented in metadata.",
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"properties": {
"arguments": {
"additionalProperties": {
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
"$ref": "#/components/schemas/DataconnectorNullableScalarType"
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
},
"default": {},
"description": "Free variables in the expression and their types",
"type": "object"
},
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
"array_relationships": {
"default": [],
"items": {
chore(server): Native Query -> Table array relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10100 GitOrigin-RevId: 55f38a904767e1b25916fb31b3c5ece898c10349
2023-08-14 15:33:50 +03:00
"$ref": "#/components/schemas/RelDef_RelManualConfig__DataConnector"
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
},
"type": "array"
},
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"code": {
"description": "Native code expression (SQL) to run\nAn interpolated query expressed in native code (SQL)",
"type": "string"
},
"description": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"description": "A description of the native query which appears in the graphql schema",
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"type": "string"
},
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
"object_relationships": {
"default": [],
"items": {
chore(server): Native Query -> Table object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10098 GitOrigin-RevId: 9b98bb0e285560cd03b04f867d1fa16dadd00df9
2023-08-10 17:21:34 +03:00
"$ref": "#/components/schemas/RelDef_RelManualConfig__DataConnector"
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
},
"type": "array"
},
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"returns": {
chore(server): allow Logical Models to be defined inside Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9787 GitOrigin-RevId: 48b88f3c98024d3be721ab27a28be75952586a8c
2023-07-10 16:45:42 +03:00
"additionalProperties": true,
"description": "Return type (table) of the expression\nA name or definition of a Logical Model\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
},
"root_field_name": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"description": "Root field name for the native query",
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"type": "string"
}
},
"required": [
"root_field_name",
"code",
"returns"
],
"type": "object"
},
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
"DataconnectorNullableScalarType": {
"description": "A scalar type that can be nullable with an optional description",
"properties": {
"description": {
"description": "Optional description text which appears in the GraphQL Schema",
"type": "string"
},
"nullable": {
"default": false,
"description": "Whether the type is nullable",
"type": "boolean"
},
"type": {
"$ref": "#/components/schemas/ScalarType"
}
},
"required": [
"type"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"DataconnectorObjRelRemoteTableMultipleColumns": {
"properties": {
"columns": {
"items": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"type": "array"
},
"table": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"table",
"columns"
],
"type": "object"
},
"DataconnectorObjRelRemoteTableSingleColumn": {
"properties": {
"column": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"table": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"table",
"column"
],
"type": "object"
},
"DataconnectorRUManual": {
"properties": {
"manual_configuration": {
chore(server): Table -> Native Query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10114 GitOrigin-RevId: 0181184d1bc0e851151f86a98c96c97888a10e3e
2023-08-17 18:34:05 +03:00
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/DataconnectorRelManualTableConfig"
},
{
"$ref": "#/components/schemas/DataconnectorRelManualNativeQueryConfig"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"manual_configuration"
],
"type": "object"
},
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
"DataconnectorRelManualNativeQueryConfig": {
"properties": {
"column_mapping": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"additionalProperties": true,
"anyOf": [
{
"additionalProperties": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"type": "object"
},
{
"additionalProperties": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"type": "object"
}
]
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
},
"insertion_order": {
"enum": [
"before_parent",
"after_parent"
],
"nullable": true,
"type": "string"
},
"remote_native_query": {
"type": "string"
}
},
"required": [
"remote_native_query",
"column_mapping"
],
"type": "object"
},
"DataconnectorRelManualTableConfig": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
"column_mapping": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"additionalProperties": true,
"anyOf": [
{
"additionalProperties": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"type": "object"
},
{
"additionalProperties": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
"type": "object"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"insertion_order": {
"enum": [
"before_parent",
"after_parent"
],
"nullable": true,
"type": "string"
},
"remote_table": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"remote_table",
"column_mapping"
],
"type": "object"
},
"DataconnectorSelPerm": {
"properties": {
"allow_aggregations": {
"default": false,
"type": "boolean"
},
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"computed_fields": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
},
"filter": {
"$ref": "#/components/schemas/DataconnectorBoolExp"
},
"limit": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"query_root_fields": {
"default": null,
"items": {
"enum": [
"select",
"select_by_pk",
"select_aggregate"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"subscription_root_fields": {
"default": null,
"items": {
"enum": [
"select",
"select_by_pk",
"select_aggregate",
"select_stream"
],
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"required": [
"columns",
"filter"
],
"type": "object"
},
"DataconnectorSelectPermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/DataconnectorSelPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"DataconnectorSourceMetadata": {
"properties": {
"configuration": {
server: codec for dataconnector ConnSourceConfig PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8271 GitOrigin-RevId: b5aaa86a5e453fecb1e88c2afb223857e50c8b7d
2023-03-30 21:36:25 +03:00
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/DataConnectorConnSourceConfig"
},
{
"$ref": "#/components/schemas/Config"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"customization": {
"$ref": "#/components/schemas/SourceCustomization"
},
"functions": {
"default": [],
"items": {
"$ref": "#/components/schemas/DataconnectorFunctionMetadata"
},
"nullable": true,
"type": "array"
},
"kind": {
"$ref": "#/components/schemas/GraphQLName"
},
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
"logical_models": {
"default": [],
"items": {
"$ref": "#/components/schemas/DataconnectorLogicalModelMetadata"
},
"nullable": true,
"type": "array"
},
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"name": {
"type": "string"
},
"native_queries": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"default": [],
"items": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"$ref": "#/components/schemas/DataconnectorNativeQueryMetadata"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"nullable": true,
"type": "array"
},
"query_tags": {
"$ref": "#/components/schemas/QueryTagsConfig"
},
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"stored_procedures": {
"default": [],
"items": {
"$ref": "#/components/schemas/DataconnectorStoredProcedureMetadata"
},
"nullable": true,
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"tables": {
"items": {
"$ref": "#/components/schemas/DataconnectorTableMetadata"
},
"type": "array"
}
},
"required": [
"name",
"kind",
"tables",
"configuration"
],
"type": "object"
},
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"DataconnectorStoredProcedureMetadata": {
"description": "A stored procedure as represented in metadata.",
"properties": {
"arguments": {
"additionalProperties": {
"$ref": "#/components/schemas/DataconnectorNullableScalarType"
},
"default": {},
"description": "Free variables in the expression and their types",
"type": "object"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"configuration": {
"$ref": "#/components/schemas/StoredProcedureConfig"
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
},
"description": {
"description": "A description of the stored procedure which appears in the graphql schema",
"type": "string"
},
"returns": {
"description": "Return type (table) of the expression",
"type": "string"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"stored_procedure": {
"description": "The name of the SQL stored procedure",
"items": {
"type": "string"
},
"type": "array"
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
}
},
"required": [
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"stored_procedure",
"configuration",
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"returns"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"DataconnectorTableConfig": {
"properties": {
"column_config": {
"additionalProperties": {
"$ref": "#/components/schemas/ColumnConfig"
},
"default": {},
"type": "object"
},
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"custom_column_names": {
"additionalProperties": {
"$ref": "#/components/schemas/GraphQLName"
},
"default": {},
"type": "object"
},
"custom_name": {
"$ref": "#/components/schemas/GraphQLName"
},
"custom_root_fields": {
"$ref": "#/components/schemas/TableCustomRootFields"
}
},
"type": "object"
},
"DataconnectorTableMetadata": {
"description": "Representation of a table in metadata, 'tables.yaml' and 'metadata.json'",
"properties": {
"apollo_federation_config": {
"$ref": "#/components/schemas/ApolloFederationConfig"
},
"array_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RelDef_RelUsing__DataConnector__ArrRelUsingFKeyOn__DataConnector_"
},
"type": "array"
},
"computed_fields": {
"default": [],
"items": {
"$ref": "#/components/schemas/DataconnectorComputedFieldMetadata"
},
"type": "array"
},
"configuration": {
"$ref": "#/components/schemas/DataconnectorTableConfig"
},
"delete_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/DataconnectorDeletePermDef"
},
"type": "array"
},
"insert_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/DataconnectorInsertPermDef"
},
"type": "array"
},
"is_enum": {
"default": false,
"type": "boolean"
},
Specify table schema via logical model in `track_table` API PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9408 GitOrigin-RevId: 9ba20cd91e4d0066e0f14ce52cba0f55a7c5af31
2023-06-22 10:05:07 +03:00
"logical_model": {
"nullable": true,
"type": "string"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"object_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RelDef_RelUsing__DataConnector__ObjRelUsingChoice__DataConnector_"
},
"type": "array"
},
"remote_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RemoteRelationship_RemoteRelationshipDefinition"
},
"type": "array"
},
"select_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/DataconnectorSelectPermDef"
},
"type": "array"
},
"table": {
"items": {
"type": "string"
},
"type": "array"
},
"update_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/DataconnectorUpdatePermDef"
},
"type": "array"
}
},
"required": [
"table"
],
"type": "object"
},
"DataconnectorUpdPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"check": {
"$ref": "#/components/schemas/DataconnectorBoolExp"
},
"columns": {
"description": "Allowed columns",
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"filter": {
"$ref": "#/components/schemas/DataconnectorBoolExp"
},
"set": {
"additionalProperties": {
"additionalProperties": true
},
"description": "Preset columns",
"type": "object"
server/postgres: update input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9665 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 35bd769281982833e86c5bb708b3edf5a040708b
2023-06-28 13:18:09 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"columns",
"filter"
],
"type": "object"
},
"DataconnectorUpdatePermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/DataconnectorUpdPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
server: codecs for rest endpoint definitions in metadata PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8030 GitOrigin-RevId: 0980502c535ab308e2458a98cebfd166fa55f8b6
2023-02-20 21:36:31 +03:00
"EndpointDef_QueryReference": {
"properties": {
"query": {
"$ref": "#/components/schemas/QueryReference"
}
},
"required": [
"query"
],
"type": "object"
},
"EndpointMetadata_QueryReference": {
"properties": {
"comment": {
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/EndpointDef_QueryReference"
},
"methods": {
"items": {
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"PATCH"
],
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"name",
"url",
"methods",
"definition"
],
"type": "object"
},
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"EnumTypeDefinition": {
"properties": {
"description": {
"type": "string"
},
"name": {
"$ref": "#/components/schemas/GraphQLName"
},
"values": {
"items": {
"$ref": "#/components/schemas/EnumValueDefinition"
},
"type": "array"
}
},
"required": [
"name",
"values"
],
"type": "object"
},
"EnumValueDefinition": {
"properties": {
"description": {
"type": "string"
},
"is_deprecated": {
"type": "boolean"
},
"value": {
"$ref": "#/components/schemas/GraphQLName"
}
},
"required": [
"value"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"ExtensionsSchema": {
"type": "string"
},
"FieldCall": {
"properties": {
"arguments": {
"$ref": "#/components/schemas/RemoteArguments"
},
"field": {
"$ref": "#/components/schemas/RemoteFields"
}
},
"required": [
"arguments"
],
"type": "object"
},
"FromEnv": {
"properties": {
"from_env": {
"type": "string"
}
},
"required": [
"from_env"
],
"type": "object"
},
"FunctionConfig": {
"properties": {
"custom_name": {
"$ref": "#/components/schemas/GraphQLName"
},
"custom_root_fields": {
"$ref": "#/components/schemas/FunctionCustomRootFields"
},
"exposed_as": {
"enum": [
"query",
"mutation"
],
"type": "string"
},
Adding UDF (user-defined-functions) support to Data Connectors - GDC-820 PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8121 GitOrigin-RevId: ceb3e29e330bba294061f85c1f75700974d01452
2023-05-19 07:47:12 +03:00
"response": {
"additionalProperties": true
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"session_argument": {
"type": "string"
}
},
"type": "object"
},
"FunctionCustomRootFields": {
"properties": {
"function": {
"$ref": "#/components/schemas/GraphQLName"
},
"function_aggregate": {
"$ref": "#/components/schemas/GraphQLName"
}
},
"type": "object"
},
"FunctionPermissionInfo": {
"properties": {
"role": {
"type": "string"
}
},
"required": [
"role"
],
"type": "object"
},
Adding UDF (user-defined-functions) support to Data Connectors - GDC-820 PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8121 GitOrigin-RevId: ceb3e29e330bba294061f85c1f75700974d01452
2023-05-19 07:47:12 +03:00
"FunctionReturnType": {
"discriminator": {
"mapping": {
"inferred": "InferredFunctionResponse",
"table": "TableFunctionResponse"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/InferredFunctionResponse"
},
{
"$ref": "#/components/schemas/TableFunctionResponse"
}
]
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"GraphQLName": {
"type": "string"
},
"GraphQLSchema": {
"type": "string"
},
"GraphQLValue_Name": {
"additionalProperties": true,
"anyOf": [
{
"type": "string"
},
{
"type": "null"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
},
{
"$ref": "#/components/schemas/GraphQLName"
},
{
"items": {
"$ref": "#/components/schemas/GraphQLValue_Name"
},
"type": "array"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/GraphQLValue_Name"
},
"type": "object"
},
{
"type": "null"
}
]
},
"HeaderConfFromEnv": {
"properties": {
"name": {
"type": "string"
},
"value_from_env": {
"type": "string"
}
},
"required": [
"name",
"value_from_env"
],
"type": "object"
},
"HeaderConfValue": {
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"HealthCheckTestSql": {
"properties": {
"sql": {
"default": "SELECT 1",
"type": "string"
}
},
"type": "object"
},
Adding UDF (user-defined-functions) support to Data Connectors - GDC-820 PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8121 GitOrigin-RevId: ceb3e29e330bba294061f85c1f75700974d01452
2023-05-19 07:47:12 +03:00
"InferredFunctionResponse": {
"properties": {
"type": {
"enum": [
"inferred"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"InputObjectFieldDefinition": {
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"InputObjectTypeDefinition": {
"properties": {
"description": {
"type": "string"
},
"fields": {
"items": {
"$ref": "#/components/schemas/InputObjectFieldDefinition"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"fields"
],
"type": "object"
},
server: codecs for api limits PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8065 GitOrigin-RevId: 4a14f72fa4f832f1cc6cb7f5be8d146b4f00dd44
2023-03-15 04:36:52 +03:00
"Limit_MaxBatchSize": {
"properties": {
"global": {
"maximum": 9223372036854775807,
"minimum": 0,
"type": "number"
},
"per_role": {
"additionalProperties": {
"maximum": 9223372036854775807,
"minimum": 0,
"type": "number"
},
"default": {},
"type": "object"
}
},
"required": [
"global"
],
"type": "object"
},
"Limit_MaxDepth": {
"properties": {
"global": {
"maximum": 9223372036854775807,
"minimum": 0,
"type": "number"
},
"per_role": {
"additionalProperties": {
"maximum": 9223372036854775807,
"minimum": 0,
"type": "number"
},
"default": {},
"type": "object"
}
},
"required": [
"global"
],
"type": "object"
},
"Limit_MaxNodes": {
"properties": {
"global": {
"maximum": 9223372036854775807,
"minimum": 0,
"type": "number"
},
"per_role": {
"additionalProperties": {
"maximum": 9223372036854775807,
"minimum": 0,
"type": "number"
},
"default": {},
"type": "object"
}
},
"required": [
"global"
],
"type": "object"
},
"Limit_MaxTime": {
"properties": {
"global": {
"maximum": 1.79769313486231590772930519078902473361797697894230657273430081157732675805500963132708477322407536021120113879871393357658789768814416622492847430639474124377767893424865485276302219601246094119453082952085005768838150682342462881473913110540827237163350510684586298239947245938479716304835356329624224137216e308,
"minimum": 0,
"type": "number"
},
"per_role": {
"additionalProperties": {
"maximum": 1.79769313486231590772930519078902473361797697894230657273430081157732675805500963132708477322407536021120113879871393357658789768814416622492847430639474124377767893424865485276302219601246094119453082952085005768838150682342462881473913110540827237163350510684586298239947245938479716304835356329624224137216e308,
"minimum": 0,
"type": "number"
},
"default": {},
"type": "object"
}
},
"required": [
"global"
],
"type": "object"
},
"Limit_RateLimitConfig": {
"properties": {
"global": {
"$ref": "#/components/schemas/RateLimitConfig"
},
"per_role": {
"additionalProperties": {
"$ref": "#/components/schemas/RateLimitConfig"
},
"default": {},
"type": "object"
}
},
"required": [
"global"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"ListedQuery": {
"properties": {
"name": {
"type": "string"
},
"query": {
"type": "string"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"MSSQLConnConfiguration": {
"properties": {
"connection_info": {
"$ref": "#/components/schemas/MSSQLConnectionInfo"
},
"read_replicas": {
"items": {
"$ref": "#/components/schemas/MSSQLConnectionInfo"
},
"nullable": true,
"type": "array"
}
},
"required": [
"connection_info"
],
"type": "object"
},
"MSSQLConnectionInfo": {
"properties": {
"connection_string": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/FromEnv"
}
]
},
mssql isolation level option PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9626 GitOrigin-RevId: 43861a982afadd9fdefb7d8996999e051e751222
2023-06-23 18:19:26 +03:00
"isolation_level": {
"default": "read-committed",
"description": "The transaction isolation level in which the queries made to the source will be run with (default: read-committed).\nIsolation level",
"type": "string"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"pool_settings": {
feat(SqlServer): Configuration option to disable the connection pool PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9834 Co-authored-by: Samir Talwar <47582+SamirTalwar@users.noreply.github.com> GitOrigin-RevId: 6b7f8bd660ddda0cae3a5457267f5af4906ff65a
2023-07-18 21:39:20 +03:00
"additionalProperties": true,
"anyOf": [
{
"enum": [
{
"enable": false
}
],
"type": "object"
},
{
"$ref": "#/components/schemas/MSSQLPoolSettings"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"connection_string",
"pool_settings"
],
"type": "object"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"MSSQLFunctionName": {
"properties": {
"name": {
"type": "string"
},
"schema": {
"default": "dbo",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"MSSQLPoolSettings": {
"properties": {
"idle_timeout": {
"default": 5,
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"max_connections": {
"default": 50,
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"nullable": true,
"type": "number"
},
"total_max_connections": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"nullable": true,
"type": "number"
}
},
"type": "object"
},
"MSSQLTableName": {
"properties": {
"name": {
"type": "string"
},
"schema": {
"default": "dbo",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Metadata": {
"description": "configuration format for the Hasura GraphQL Engine",
"oneOf": [
{
"$ref": "#/components/schemas/MetadataV1"
},
{
"$ref": "#/components/schemas/MetadataV2"
},
{
"$ref": "#/components/schemas/MetadataV3"
}
]
},
"MetadataV1": {
"properties": {
"functions": {
"description": "user-defined SQL functions\n\n\narray of values of unspecified type - this is a placeholder that will eventually be replaced with a more detailed description",
"items": {
"additionalProperties": true
},
"type": "array"
},
"remote_schemas": {
"description": "merge remote GraphQL schemas and provide a unified GraphQL API\n\n\narray of values of unspecified type - this is a placeholder that will eventually be replaced with a more detailed description",
"items": {
"additionalProperties": true
},
"type": "array"
},
"tables": {
"description": "configured database tables\n\n\narray of values of unspecified type - this is a placeholder that will eventually be replaced with a more detailed description",
"items": {
"additionalProperties": true
},
"type": "array"
},
"version": {
"enum": [
1
],
"type": "number"
}
},
"required": [
"tables"
],
"type": "object"
},
"MetadataV2": {
"properties": {
"actions": {
"description": "action definitions which extend Hasura's schema with custom business logic using custom queries and mutations\n\n\narray of values of unspecified type - this is a placeholder that will eventually be replaced with a more detailed description",
"items": {
"additionalProperties": true
},
"type": "array"
},
"allowlist": {
"description": "safe GraphQL operations - when allow lists are enabled only these operations are allowed\n\n\narray of values of unspecified type - this is a placeholder that will eventually be replaced with a more detailed description",
"items": {
"additionalProperties": true
},
"type": "array"
},
"cron_triggers": {
"description": "reliably trigger HTTP endpoints to run custom business logic periodically based on a cron schedule\n\n\narray of values of unspecified type - this is a placeholder that will eventually be replaced with a more detailed description",
"items": {
"additionalProperties": true
},
"type": "array"
},
"custom_types": {
"additionalProperties": true,
"description": "custom type definitions\n\n\nobject with unspecified properties - this is a placeholder that will eventually be replaced with a more detailed description"
},
"functions": {
"description": "user-defined SQL functions\n\n\narray of values of unspecified type - this is a placeholder that will eventually be replaced with a more detailed description",
"items": {
"additionalProperties": true
},
"type": "array"
},
"query_collections": {
"description": "group queries using query collections\n\n\narray of values of unspecified type - this is a placeholder that will eventually be replaced with a more detailed description",
"items": {
"additionalProperties": true
},
"type": "array"
},
"remote_schemas": {
"description": "merge remote GraphQL schemas and provide a unified GraphQL API\n\n\narray of values of unspecified type - this is a placeholder that will eventually be replaced with a more detailed description",
"items": {
"additionalProperties": true
},
"type": "array"
},
"tables": {
"description": "configured database tables\n\n\narray of values of unspecified type - this is a placeholder that will eventually be replaced with a more detailed description",
"items": {
"additionalProperties": true
},
"type": "array"
},
"version": {
"enum": [
2
],
"type": "number"
}
},
"required": [
"version",
"tables"
],
"type": "object"
},
"MetadataV3": {
"properties": {
"actions": {
server: codecs for the metadata Action type PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7898 GitOrigin-RevId: 4211854f656ab02bb058b2d0831637477b3d4767
2023-02-20 20:08:49 +03:00
"default": [],
"description": "action definitions which extend Hasura's schema with custom business logic using custom queries and mutations",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"items": {
server: codecs for the metadata Action type PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7898 GitOrigin-RevId: 4211854f656ab02bb058b2d0831637477b3d4767
2023-02-20 20:08:49 +03:00
"$ref": "#/components/schemas/ActionMetadata"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"type": "array"
},
"allowlist": {
server: codecs for metrics, roles, allow list PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8114 GitOrigin-RevId: 1a1f8b6360edbdddad5cf364b533a255c15e2f4a
2023-03-10 02:09:16 +03:00
"default": [],
"description": "safe GraphQL operations - when allow lists are enabled only these operations are allowed",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"items": {
server: codecs for metrics, roles, allow list PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8114 GitOrigin-RevId: 1a1f8b6360edbdddad5cf364b533a255c15e2f4a
2023-03-10 02:09:16 +03:00
"$ref": "#/components/schemas/AllowlistEntry"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"type": "array"
},
"api_limits": {
server: codecs for api limits PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8065 GitOrigin-RevId: 4a14f72fa4f832f1cc6cb7f5be8d146b4f00dd44
2023-03-15 04:36:52 +03:00
"$ref": "#/components/schemas/ApiLimit"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"backend_configs": {
server: codecs for backend configs PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8269 GitOrigin-RevId: 34330f383ca82fb159842a171a763c178b462788
2023-03-30 18:52:20 +03:00
"$ref": "#/components/schemas/BackendMap_BackendConfigWrapper"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"cron_triggers": {
server: codecs for cron triggers PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8029 GitOrigin-RevId: c26308782618c760921a0eff3e4bd87702bd3eb2
2023-02-20 05:50:42 +03:00
"default": [],
"description": "reliably trigger HTTP endpoints to run custom business logic periodically based on a cron schedule",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"items": {
server: codecs for cron triggers PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8029 GitOrigin-RevId: c26308782618c760921a0eff3e4bd87702bd3eb2
2023-02-20 05:50:42 +03:00
"$ref": "#/components/schemas/CronTriggerMetadata"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"type": "array"
},
"custom_types": {
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"$ref": "#/components/schemas/CustomTypes"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"graphql_schema_introspection": {
server: codecs for network config, graphql introspection PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8132 GitOrigin-RevId: 6b800f35a76b6d38817862a4678644b8bf230a95
2023-03-17 20:44:28 +03:00
"default": [],
"items": {
"type": "string"
},
"type": "array"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"inherited_roles": {
server: codecs for metrics, roles, allow list PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8114 GitOrigin-RevId: 1a1f8b6360edbdddad5cf364b533a255c15e2f4a
2023-03-10 02:09:16 +03:00
"default": [],
"description": "an inherited role is a way to create a new role which inherits permissions from two or more roles",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"items": {
server: codecs for metrics, roles, allow list PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8114 GitOrigin-RevId: 1a1f8b6360edbdddad5cf364b533a255c15e2f4a
2023-03-10 02:09:16 +03:00
"$ref": "#/components/schemas/Role"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"type": "array"
},
"metrics_config": {
server: codecs for metrics, roles, allow list PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8114 GitOrigin-RevId: 1a1f8b6360edbdddad5cf364b533a255c15e2f4a
2023-03-10 02:09:16 +03:00
"$ref": "#/components/schemas/MetricsConfig"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"network": {
server: codecs for network config, graphql introspection PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8132 GitOrigin-RevId: 6b800f35a76b6d38817862a4678644b8bf230a95
2023-03-17 20:44:28 +03:00
"$ref": "#/components/schemas/Network"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"opentelemetry": {
server: codecs for open telemetry configuration PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8317 GitOrigin-RevId: 36dbe374164712167d7a4a31ea0509850060df36
2023-03-15 05:18:14 +03:00
"$ref": "#/components/schemas/OpenTelemetryConfig"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"query_collections": {
"default": [],
"description": "group queries using query collections",
"items": {
"$ref": "#/components/schemas/CreateCollection"
},
"type": "array"
},
"remote_schemas": {
"default": [],
"description": "merge remote GraphQL schemas and provide a unified GraphQL API",
"items": {
"$ref": "#/components/schemas/RemoteSchemaMetadata_RemoteRelationshipDefinition"
},
"type": "array"
},
"rest_endpoints": {
server: codecs for rest endpoint definitions in metadata PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8030 GitOrigin-RevId: 0980502c535ab308e2458a98cebfd166fa55f8b6
2023-02-20 21:36:31 +03:00
"default": [],
"description": "REST interfaces to saved GraphQL queries and mutations",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"items": {
server: codecs for rest endpoint definitions in metadata PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8030 GitOrigin-RevId: 0980502c535ab308e2458a98cebfd166fa55f8b6
2023-02-20 21:36:31 +03:00
"$ref": "#/components/schemas/EndpointMetadata_QueryReference"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"type": "array"
},
"sources": {
"description": "configured databases",
"items": {
"$ref": "#/components/schemas/SourceMetadata"
},
"type": "array"
},
"version": {
"enum": [
3
],
"type": "number"
}
},
"required": [
"version",
"sources"
],
"type": "object"
},
server: codecs for metrics, roles, allow list PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8114 GitOrigin-RevId: 1a1f8b6360edbdddad5cf364b533a255c15e2f4a
2023-03-10 02:09:16 +03:00
"MetricsConfig": {
"properties": {
"analyze_query_variables": {
"type": "boolean"
},
"analyze_response_body": {
"type": "boolean"
}
},
"required": [
"analyze_query_variables",
"analyze_response_body"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"MssqlArrRelUsingFKeyOnMultipleColumns": {
"properties": {
"columns": {
"items": {
"type": "string"
},
"type": "array"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/MSSQLTableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"columns"
],
"type": "object"
},
"MssqlArrRelUsingFKeyOnSingleColumn": {
"properties": {
"column": {
"type": "string"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/MSSQLTableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"column"
],
"type": "object"
},
"MssqlBoolExp": {
"additionalProperties": true
},
"MssqlComputedFieldMetadata": {
"properties": {
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"definition": {
server: codecs for computed field definitions PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8270 GitOrigin-RevId: a0954d79c1fecb7eeba4eb47983e65d3637a23c3
2023-03-10 02:45:13 +03:00
"additionalProperties": true
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"name": {
"type": "string"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
"MssqlDelPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"filter": {
"$ref": "#/components/schemas/MssqlBoolExp"
server/postgres: delete input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9666 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 5fa7702401065869c953b23c6734b9b367247634
2023-06-28 16:44:14 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"filter"
],
"type": "object"
},
"MssqlDeletePermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/MssqlDelPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"MssqlEventTriggerConfEventTriggerConf": {
"properties": {
"cleanup_config": {
"$ref": "#/components/schemas/AutoTriggerLogCleanupConfig"
},
"definition": {
"$ref": "#/components/schemas/MssqlTriggerOpsDef"
},
"headers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HeaderConfValue"
},
{
"$ref": "#/components/schemas/HeaderConfFromEnv"
}
]
},
"type": "array"
},
"name": {
"type": "string"
},
"request_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/RequestTransformV1"
},
{
"$ref": "#/components/schemas/RequestTransformV2"
}
]
},
"response_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/ResponseTransformV1"
},
{
"$ref": "#/components/schemas/ResponseTransformV2"
}
]
},
"retry_conf": {
"$ref": "#/components/schemas/RetryConf"
},
"trigger_on_replication": {
"default": true,
"type": "boolean"
},
"webhook": {
"type": "string"
},
"webhook_from_env": {
"type": "string"
}
},
"required": [
"name",
"definition",
"retry_conf"
],
"type": "object"
},
"MssqlFunctionMetadata": {
"description": "A custom SQL function to add to the GraphQL schema with configuration.\n\nhttps://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/custom-functions.html#args-syntax\n",
"properties": {
"comment": {
"type": "string"
},
"configuration": {
"$ref": "#/components/schemas/FunctionConfig"
},
"function": {
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/MSSQLFunctionName"
},
{
"type": "string"
}
],
"description": "Name of the SQL function"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/FunctionPermissionInfo"
},
"type": "array"
}
},
"required": [
"function"
],
"type": "object"
},
"MssqlHealthCheckConfig": {
"nullable": true,
"properties": {
"interval": {
"type": "number"
},
"retries": {
"default": 3,
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"retry_interval": {
"default": 10,
"type": "number"
},
"test": {
"$ref": "#/components/schemas/HealthCheckTestSql"
},
"timeout": {
"default": 10,
"type": "number"
}
},
"required": [
"interval"
],
"type": "object"
},
"MssqlInsPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"check": {
"$ref": "#/components/schemas/MssqlBoolExp"
},
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"set": {
"additionalProperties": {
"additionalProperties": true
},
"type": "object"
server/postgres: insert input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9620 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 345c3f763f8dd3397c999c5967af39192b944640
2023-06-25 16:46:35 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"check"
],
"type": "object"
},
"MssqlInsertPermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/MssqlInsPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
chore(server): more expressive logical models PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9197 GitOrigin-RevId: 3471c68d4e59310bdb62ecb3694ab30a2094916e
2023-05-19 19:12:51 +03:00
"MssqlLogicalModelField": {
"description": "A field of a logical model",
"properties": {
"description": {
"description": "Optional description of this field",
"type": "string"
},
"name": {
"description": "Name of the field",
"type": "string"
},
"type": {
"additionalProperties": true,
"description": "Type of the field\nA type used in a Logical Model field\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
"MssqlLogicalModelMetadata": {
"description": "A return type.",
"properties": {
"description": {
"description": "Optional description text which appears in the GraphQL Schema.",
"type": "string"
},
"fields": {
"description": "Return types for the logical model",
"items": {
"additionalProperties": true,
chore(server): more expressive logical models PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9197 GitOrigin-RevId: 3471c68d4e59310bdb62ecb3694ab30a2094916e
2023-05-19 19:12:51 +03:00
"anyOf": [
{
"$ref": "#/components/schemas/MssqlLogicalModelField"
},
{
"$ref": "#/components/schemas/MssqlLogicalModelField"
}
]
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
},
"type": "array"
},
"name": {
"description": "A name for a logical model",
"type": "string"
},
"select_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/MssqlSelectPermDef"
},
"type": "array"
}
},
"required": [
"name",
"fields"
],
"type": "object"
},
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"MssqlNativeQueryMetadata": {
"description": "A native query as represented in metadata.",
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"properties": {
"arguments": {
"additionalProperties": {
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
"$ref": "#/components/schemas/MssqlNullableScalarType"
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
},
"default": {},
"description": "Free variables in the expression and their types",
"type": "object"
},
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
"array_relationships": {
"default": [],
"items": {
chore(server): Native Query -> Table array relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10100 GitOrigin-RevId: 55f38a904767e1b25916fb31b3c5ece898c10349
2023-08-14 15:33:50 +03:00
"$ref": "#/components/schemas/RelDef_RelManualConfig__MSSQL"
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
},
"type": "array"
},
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"code": {
"description": "Native code expression (SQL) to run\nAn interpolated query expressed in native code (SQL)",
"type": "string"
},
"description": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"description": "A description of the native query which appears in the graphql schema",
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"type": "string"
},
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
"object_relationships": {
"default": [],
"items": {
chore(server): Native Query -> Table object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10098 GitOrigin-RevId: 9b98bb0e285560cd03b04f867d1fa16dadd00df9
2023-08-10 17:21:34 +03:00
"$ref": "#/components/schemas/RelDef_RelManualConfig__MSSQL"
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
},
"type": "array"
},
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"returns": {
chore(server): allow Logical Models to be defined inside Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9787 GitOrigin-RevId: 48b88f3c98024d3be721ab27a28be75952586a8c
2023-07-10 16:45:42 +03:00
"additionalProperties": true,
"description": "Return type (table) of the expression\nA name or definition of a Logical Model\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
},
"root_field_name": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"description": "Root field name for the native query",
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"type": "string"
}
},
"required": [
"root_field_name",
"code",
"returns"
],
"type": "object"
},
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
"MssqlNullableScalarType": {
"description": "A scalar type that can be nullable with an optional description",
"properties": {
"description": {
"description": "Optional description text which appears in the GraphQL Schema",
"type": "string"
},
"nullable": {
"default": false,
"description": "Whether the type is nullable",
"type": "boolean"
},
"type": {
"$ref": "#/components/schemas/ScalarType"
}
},
"required": [
"type"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"MssqlObjRelRemoteTableMultipleColumns": {
"properties": {
"columns": {
"items": {
"type": "string"
},
"type": "array"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/MSSQLTableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"columns"
],
"type": "object"
},
"MssqlObjRelRemoteTableSingleColumn": {
"properties": {
"column": {
"type": "string"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/MSSQLTableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"column"
],
"type": "object"
},
"MssqlRUManual": {
"properties": {
"manual_configuration": {
chore(server): Table -> Native Query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10114 GitOrigin-RevId: 0181184d1bc0e851151f86a98c96c97888a10e3e
2023-08-17 18:34:05 +03:00
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/MssqlRelManualTableConfig"
},
{
"$ref": "#/components/schemas/MssqlRelManualNativeQueryConfig"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"manual_configuration"
],
"type": "object"
},
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
"MssqlRelManualNativeQueryConfig": {
"properties": {
"column_mapping": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"additionalProperties": true,
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
]
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
},
"insertion_order": {
"enum": [
"before_parent",
"after_parent"
],
"nullable": true,
"type": "string"
},
"remote_native_query": {
"type": "string"
}
},
"required": [
"remote_native_query",
"column_mapping"
],
"type": "object"
},
"MssqlRelManualTableConfig": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
"column_mapping": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"additionalProperties": true,
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"insertion_order": {
"enum": [
"before_parent",
"after_parent"
],
"nullable": true,
"type": "string"
},
"remote_table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/MSSQLTableName"
},
{
"type": "string"
}
]
}
},
"required": [
"remote_table",
"column_mapping"
],
"type": "object"
},
"MssqlSelPerm": {
"properties": {
"allow_aggregations": {
"default": false,
"type": "boolean"
},
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"computed_fields": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
},
"filter": {
"$ref": "#/components/schemas/MssqlBoolExp"
},
"limit": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"query_root_fields": {
"default": null,
"items": {
"enum": [
"select",
"select_by_pk",
"select_aggregate"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"subscription_root_fields": {
"default": null,
"items": {
"enum": [
"select",
"select_by_pk",
"select_aggregate",
"select_stream"
],
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"required": [
"columns",
"filter"
],
"type": "object"
},
"MssqlSelectPermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/MssqlSelPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"MssqlSourceMetadata": {
"properties": {
"configuration": {
"$ref": "#/components/schemas/MSSQLConnConfiguration"
},
"customization": {
"$ref": "#/components/schemas/SourceCustomization"
},
"functions": {
"default": [],
"items": {
"$ref": "#/components/schemas/MssqlFunctionMetadata"
},
"nullable": true,
"type": "array"
},
"health_check": {
"$ref": "#/components/schemas/MssqlHealthCheckConfig"
},
"kind": {
"enum": [
"mssql"
],
"type": "string"
},
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
"logical_models": {
"default": [],
"items": {
"$ref": "#/components/schemas/MssqlLogicalModelMetadata"
},
"nullable": true,
"type": "array"
},
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"name": {
"type": "string"
},
"native_queries": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"default": [],
"items": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"$ref": "#/components/schemas/MssqlNativeQueryMetadata"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"nullable": true,
"type": "array"
},
"query_tags": {
"$ref": "#/components/schemas/QueryTagsConfig"
},
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"stored_procedures": {
"default": [],
"items": {
"$ref": "#/components/schemas/MssqlStoredProcedureMetadata"
},
"nullable": true,
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"tables": {
"items": {
"$ref": "#/components/schemas/MssqlTableMetadata"
},
"type": "array"
}
},
"required": [
"name",
"kind",
"tables",
"configuration"
],
"type": "object"
},
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"MssqlStoredProcedureMetadata": {
"description": "A stored procedure as represented in metadata.",
"properties": {
"arguments": {
"additionalProperties": {
"$ref": "#/components/schemas/MssqlNullableScalarType"
},
"default": {},
"description": "Free variables in the expression and their types",
"type": "object"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"configuration": {
"$ref": "#/components/schemas/StoredProcedureConfig"
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
},
"description": {
"description": "A description of the stored procedure which appears in the graphql schema",
"type": "string"
},
"returns": {
"description": "Return type (table) of the expression",
"type": "string"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"stored_procedure": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/MSSQLFunctionName"
},
{
"type": "string"
}
],
"description": "The name of the SQL stored procedure"
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
}
},
"required": [
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"stored_procedure",
"configuration",
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"returns"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"MssqlSubscribeOpSpec": {
"properties": {
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"payload": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"required": [
"columns"
],
"type": "object"
},
"MssqlTableConfig": {
"properties": {
"column_config": {
"additionalProperties": {
"$ref": "#/components/schemas/ColumnConfig"
},
"default": {},
"type": "object"
},
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"custom_column_names": {
"additionalProperties": {
"$ref": "#/components/schemas/GraphQLName"
},
"default": {},
"type": "object"
},
"custom_name": {
"$ref": "#/components/schemas/GraphQLName"
},
"custom_root_fields": {
"$ref": "#/components/schemas/TableCustomRootFields"
}
},
"type": "object"
},
"MssqlTableMetadata": {
"description": "Representation of a table in metadata, 'tables.yaml' and 'metadata.json'",
"properties": {
"apollo_federation_config": {
"$ref": "#/components/schemas/ApolloFederationConfig"
},
"array_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RelDef_RelUsing__MSSQL__ArrRelUsingFKeyOn__MSSQL_"
},
"type": "array"
},
"computed_fields": {
"default": [],
"items": {
"$ref": "#/components/schemas/MssqlComputedFieldMetadata"
},
"type": "array"
},
"configuration": {
"$ref": "#/components/schemas/MssqlTableConfig"
},
"delete_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/MssqlDeletePermDef"
},
"type": "array"
},
"event_triggers": {
"default": [],
"items": {
"$ref": "#/components/schemas/MssqlEventTriggerConfEventTriggerConf"
},
"type": "array"
},
"insert_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/MssqlInsertPermDef"
},
"type": "array"
},
"is_enum": {
"default": false,
"type": "boolean"
},
Specify table schema via logical model in `track_table` API PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9408 GitOrigin-RevId: 9ba20cd91e4d0066e0f14ce52cba0f55a7c5af31
2023-06-22 10:05:07 +03:00
"logical_model": {
"nullable": true,
"type": "string"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"object_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RelDef_RelUsing__MSSQL__ObjRelUsingChoice__MSSQL_"
},
"type": "array"
},
"remote_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RemoteRelationship_RemoteRelationshipDefinition"
},
"type": "array"
},
"select_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/MssqlSelectPermDef"
},
"type": "array"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/MSSQLTableName"
},
{
"type": "string"
}
]
},
"update_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/MssqlUpdatePermDef"
},
"type": "array"
}
},
"required": [
"table"
],
"type": "object"
},
"MssqlTriggerOpsDef": {
"properties": {
"delete": {
"$ref": "#/components/schemas/MssqlSubscribeOpSpec"
},
"enable_manual": {
"type": "boolean"
},
"insert": {
"$ref": "#/components/schemas/MssqlSubscribeOpSpec"
},
"update": {
"$ref": "#/components/schemas/MssqlSubscribeOpSpec"
}
},
"type": "object"
},
"MssqlUpdPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"check": {
"$ref": "#/components/schemas/MssqlBoolExp"
},
"columns": {
"description": "Allowed columns",
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"filter": {
"$ref": "#/components/schemas/MssqlBoolExp"
},
"set": {
"additionalProperties": {
"additionalProperties": true
},
"description": "Preset columns",
"type": "object"
server/postgres: update input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9665 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 35bd769281982833e86c5bb708b3edf5a040708b
2023-06-28 13:18:09 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"columns",
"filter"
],
"type": "object"
},
"MssqlUpdatePermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/MssqlUpdPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"NamingCase": {
"enum": [
"hasura-default",
"graphql-default"
],
"type": "string"
},
"Network": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"tls_allowlist": {
"default": [],
"items": {
"$ref": "#/components/schemas/TlsAllow"
},
"type": "array"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"type": "object"
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"ObjectFieldDefinition_GraphQLType": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"arguments": {
"additionalProperties": true
},
"description": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "string"
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"name": {
"$ref": "#/components/schemas/GraphQLName"
},
"type": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"ObjectTypeDefinition": {
"properties": {
"description": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "string"
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"fields": {
"items": {
"$ref": "#/components/schemas/ObjectFieldDefinition_GraphQLType"
},
"type": "array"
},
"name": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "string"
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/TypeRelationshipDefinition"
},
"type": "array"
}
},
"required": [
"name",
"fields"
],
"type": "object"
},
"OpenTelemetryConfig": {
"properties": {
"batch_span_processor": {
"$ref": "#/components/schemas/OtelBatchSpanProcessorConfig"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"data_types": {
"default": [],
"items": {
"enum": [
INFRA-833: OpenTelemetry exporter for metrics I scratched out some changes to support this in the front end, mostly to test it easily, maybe this can be used without much rework (validation seems to work correctly, but the tests need to be extended and probably fixed): <img width="648" alt="fd" src="https://github.com/hasura/graphql-engine-mono/assets/68095256/e5873a90-ef83-43c3-9d54-cfc0a693baca"> ------- ## Fake OTel collector for testing ChatGPT spit this out, and it's what I used to test, if it's useful to others: ``` python from flask import Flask, request from opentelemetry.proto.collector.trace.v1.trace_service_pb2 import ExportTraceServiceRequest from opentelemetry.proto.collector.metrics.v1.metrics_service_pb2 import ExportMetricsServiceRequest import google.protobuf.json_format as json_format app = Flask(__name__) @app.route("/v1/traces", methods=["POST"]) def handle_traces(): if request.method == 'POST': binary_trace = request.get_data() trace_request = ExportTraceServiceRequest() trace_request.ParseFromString(binary_trace) print("Received trace data:\n") print(json_format.MessageToJson(trace_request, indent=2, preserving_proto_field_name=True)) return "Trace data received", 200 @app.route("/v1/metrics", methods=["POST"]) def handle_metrics(): if request.method == 'POST': binary_metric = request.get_data() metric_request = ExportMetricsServiceRequest() metric_request.ParseFromString(binary_metric) print("Received metrics data:\n") print(json_format.MessageToJson(metric_request, indent=2, preserving_proto_field_name=True)) return "Metrics data received", 200 if __name__ == "__main__": app.run(host="0.0.0.0", port=8080) ``` PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9552 Co-authored-by: Puru Gupta <32328846+purugupta99@users.noreply.github.com> Co-authored-by: Toan Nguyen <1615675+hgiasac@users.noreply.github.com> Co-authored-by: Varun Choudhary <68095256+Varun-Choudhary@users.noreply.github.com> Co-authored-by: Daniele Cammareri <5709409+dancamma@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com> GitOrigin-RevId: f340bfc5c135a7bb24735b524d015e05db422fd2
2023-07-26 08:20:30 +03:00
"traces",
INFRA-832: logs OTLP export https://hasurahq.atlassian.net/browse/INFRA-832 Foundational work already merged: - #10171 - 0184ba8bfcae9b - 699317ffd061d3 PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10238 Co-authored-by: Varun Choudhary <68095256+Varun-Choudhary@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Toan Nguyen <1615675+hgiasac@users.noreply.github.com> GitOrigin-RevId: d88c6a1aafe74e7393873aacc61e6fce3bc7c068
2023-09-13 19:48:28 +03:00
"metrics",
"logs"
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
],
"type": "string"
},
"type": "array"
},
"exporter_otlp": {
"$ref": "#/components/schemas/OtelExporterConfig"
},
"status": {
"default": "disabled",
"enum": [
"enabled",
"disabled"
],
"type": "string"
}
},
"type": "object"
},
"OtelBatchSpanProcessorConfig": {
"properties": {
"max_export_batch_size": {
"default": 512,
"description": "The maximum batch size of every export. It must be smaller or equal to maxQueueSize (not yet configurable). Default 512.",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "number"
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
}
},
"type": "object"
},
"OtelExporterConfig": {
"properties": {
"headers": {
"default": [],
"description": "Key-value pairs to be used as headers to send with an export request.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HeaderConfValue"
},
{
"$ref": "#/components/schemas/HeaderConfFromEnv"
}
]
},
"type": "array"
},
INFRA-832: logs OTLP export https://hasurahq.atlassian.net/browse/INFRA-832 Foundational work already merged: - #10171 - 0184ba8bfcae9b - 699317ffd061d3 PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10238 Co-authored-by: Varun Choudhary <68095256+Varun-Choudhary@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Toan Nguyen <1615675+hgiasac@users.noreply.github.com> GitOrigin-RevId: d88c6a1aafe74e7393873aacc61e6fce3bc7c068
2023-09-13 19:48:28 +03:00
"otlp_logs_endpoint": {
"description": "Target URL to which the exporter is going to send logs. No default.",
"type": "string"
},
INFRA-833: OpenTelemetry exporter for metrics I scratched out some changes to support this in the front end, mostly to test it easily, maybe this can be used without much rework (validation seems to work correctly, but the tests need to be extended and probably fixed): <img width="648" alt="fd" src="https://github.com/hasura/graphql-engine-mono/assets/68095256/e5873a90-ef83-43c3-9d54-cfc0a693baca"> ------- ## Fake OTel collector for testing ChatGPT spit this out, and it's what I used to test, if it's useful to others: ``` python from flask import Flask, request from opentelemetry.proto.collector.trace.v1.trace_service_pb2 import ExportTraceServiceRequest from opentelemetry.proto.collector.metrics.v1.metrics_service_pb2 import ExportMetricsServiceRequest import google.protobuf.json_format as json_format app = Flask(__name__) @app.route("/v1/traces", methods=["POST"]) def handle_traces(): if request.method == 'POST': binary_trace = request.get_data() trace_request = ExportTraceServiceRequest() trace_request.ParseFromString(binary_trace) print("Received trace data:\n") print(json_format.MessageToJson(trace_request, indent=2, preserving_proto_field_name=True)) return "Trace data received", 200 @app.route("/v1/metrics", methods=["POST"]) def handle_metrics(): if request.method == 'POST': binary_metric = request.get_data() metric_request = ExportMetricsServiceRequest() metric_request.ParseFromString(binary_metric) print("Received metrics data:\n") print(json_format.MessageToJson(metric_request, indent=2, preserving_proto_field_name=True)) return "Metrics data received", 200 if __name__ == "__main__": app.run(host="0.0.0.0", port=8080) ``` PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9552 Co-authored-by: Puru Gupta <32328846+purugupta99@users.noreply.github.com> Co-authored-by: Toan Nguyen <1615675+hgiasac@users.noreply.github.com> Co-authored-by: Varun Choudhary <68095256+Varun-Choudhary@users.noreply.github.com> Co-authored-by: Daniele Cammareri <5709409+dancamma@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com> GitOrigin-RevId: f340bfc5c135a7bb24735b524d015e05db422fd2
2023-07-26 08:20:30 +03:00
"otlp_metrics_endpoint": {
"description": "Target URL to which the exporter is going to send metrics. No default.",
"type": "string"
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"otlp_traces_endpoint": {
"description": "Target URL to which the exporter is going to send traces. No default.",
"type": "string"
},
"protocol": {
"default": "http/protobuf",
"description": "The transport protocol\nPossible protocol to use with OTLP. Currently, only http/protobuf is supported.",
"enum": [
"http/protobuf"
],
"type": "string"
},
"resource_attributes": {
"default": [],
"description": "Attributes to send as the resource attributes of an export request. We currently only support string-valued attributes.",
"items": {
"$ref": "#/components/schemas/OtelNameValue"
},
"type": "array"
server: support w3c traceparent context PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10218 Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com> GitOrigin-RevId: d3dbea6220fd2127ab76c0a240fc4725ca5d6aac
2023-09-13 16:40:54 +03:00
},
"traces_propagators": {
"default": [
"b3"
],
"description": "List of propagators to inject and extract traces data from headers.",
"items": {
"description": "Possible trace propagators to use with OTLP",
"enum": [
"b3",
"tracecontext"
],
"type": "string"
},
"type": "array"
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
}
},
"type": "object"
},
"OtelNameValue": {
"description": "Internal helper type for JSON lists of key-value pairs",
"properties": {
"name": {
"type": "string"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"value": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "string"
}
},
"required": [
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"name",
"value"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
],
"type": "object"
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"PGClientCerts": {
"description": "https://hasura.io/docs/latest/graphql/core/api-reference/syntax-defs.html#pgcertsettings",
"nullable": true,
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"sslcert": {
"$ref": "#/components/schemas/CertVar"
},
"sslkey": {
"$ref": "#/components/schemas/CertVar"
},
"sslmode": {
"$ref": "#/components/schemas/SSLMode"
},
"sslpassword": {
"$ref": "#/components/schemas/CertVar"
},
"sslrootcert": {
"$ref": "#/components/schemas/CertVar"
}
},
"required": [
"sslmode"
],
"type": "object"
},
"PGConnectionParams": {
"properties": {
"database": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "string"
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"host": {
"type": "string"
},
"password": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"nullable": true,
"type": "string"
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
},
"port": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"username": {
"type": "string"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"host",
"username",
"port",
"database"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
],
"type": "object"
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"PostgresArrRelUsingFKeyOnMultipleColumns": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
"columns": {
"items": {
"type": "string"
},
"type": "array"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"$ref": "#/components/schemas/PostgresQualified_TableName"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"columns"
],
"type": "object"
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"PostgresArrRelUsingFKeyOnSingleColumn": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
"column": {
"type": "string"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"$ref": "#/components/schemas/PostgresQualified_TableName"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"column"
],
"type": "object"
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"PostgresBoolExp": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"additionalProperties": true
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"PostgresComputedFieldDefinition": {
"properties": {
"function": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_FunctionName"
},
{
"type": "string"
}
]
},
"session_argument": {
"type": "string"
},
"table_argument": {
"type": "string"
}
},
"required": [
"function"
],
"type": "object"
},
"PostgresComputedFieldMetadata": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"definition": {
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"$ref": "#/components/schemas/PostgresComputedFieldDefinition"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"name": {
"type": "string"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"PostgresConnConfiguration": {
"description": "https://hasura.io/docs/latest/graphql/core/api-reference/syntax-defs.html#pgconfiguration",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
chore(server): delete MySQL native backend PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9050 GitOrigin-RevId: 1515fb0efdb1baa05ffe3ff7cf6f230acd0cde29
2023-05-05 13:31:19 +03:00
"connection_info": {
"$ref": "#/components/schemas/PostgresSourceConnInfo"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"connection_set": {
"additionalProperties": true,
"description": "connection set used for connection template (supported only for cloud/enterprise edition)\nPostgresConnectionSet",
"nullable": true
},
"connection_template": {
"$ref": "#/components/schemas/ConnectionTemplate"
},
"extensions_schema": {
"$ref": "#/components/schemas/ExtensionsSchema"
},
"read_replicas": {
"description": "Optional list of read replica configuration (supported only in cloud/enterprise versions)",
"items": {
"$ref": "#/components/schemas/PostgresSourceConnInfo"
},
"nullable": true,
"type": "array"
}
},
"required": [
"connection_info"
],
"type": "object"
},
"PostgresDelPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"filter": {
"$ref": "#/components/schemas/PostgresBoolExp"
server/postgres: delete input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9666 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 5fa7702401065869c953b23c6734b9b367247634
2023-06-28 16:44:14 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"filter"
],
"type": "object"
},
"PostgresDeletePermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/PostgresDelPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"PostgresEventTriggerConfEventTriggerConf": {
"properties": {
"cleanup_config": {
"$ref": "#/components/schemas/AutoTriggerLogCleanupConfig"
},
"definition": {
"$ref": "#/components/schemas/PostgresTriggerOpsDef"
},
"headers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HeaderConfValue"
},
{
"$ref": "#/components/schemas/HeaderConfFromEnv"
}
]
},
"type": "array"
},
"name": {
"type": "string"
},
"request_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/RequestTransformV1"
},
{
"$ref": "#/components/schemas/RequestTransformV2"
}
]
},
"response_transform": {
"oneOf": [
{
"$ref": "#/components/schemas/ResponseTransformV1"
},
{
"$ref": "#/components/schemas/ResponseTransformV2"
}
]
},
"retry_conf": {
"$ref": "#/components/schemas/RetryConf"
},
"trigger_on_replication": {
"default": false,
"type": "boolean"
},
"webhook": {
"type": "string"
},
"webhook_from_env": {
"type": "string"
}
},
"required": [
"name",
"definition",
"retry_conf"
],
"type": "object"
},
"PostgresFunctionMetadata": {
"description": "A custom SQL function to add to the GraphQL schema with configuration.\n\nhttps://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/custom-functions.html#args-syntax\n",
"properties": {
"comment": {
"type": "string"
},
"configuration": {
"$ref": "#/components/schemas/FunctionConfig"
},
"function": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_FunctionName"
},
{
"type": "string"
}
],
"description": "Name of the SQL function"
},
"permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/FunctionPermissionInfo"
},
"type": "array"
}
},
"required": [
"function"
],
"type": "object"
},
"PostgresHealthCheckConfig": {
"nullable": true,
"properties": {
"interval": {
"type": "number"
},
"retries": {
"default": 3,
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"retry_interval": {
"default": 10,
"type": "number"
},
"test": {
"$ref": "#/components/schemas/HealthCheckTestSql"
},
"timeout": {
"default": 10,
"type": "number"
}
},
"required": [
"interval"
],
"type": "object"
},
"PostgresInsPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"check": {
"$ref": "#/components/schemas/PostgresBoolExp"
},
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"set": {
"additionalProperties": {
"additionalProperties": true
},
"type": "object"
server/postgres: insert input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9620 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 345c3f763f8dd3397c999c5967af39192b944640
2023-06-25 16:46:35 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"check"
],
"type": "object"
},
"PostgresInsertPermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/PostgresInsPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
chore(server): more expressive logical models PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9197 GitOrigin-RevId: 3471c68d4e59310bdb62ecb3694ab30a2094916e
2023-05-19 19:12:51 +03:00
"PostgresLogicalModelField": {
"description": "A field of a logical model",
"properties": {
"description": {
"description": "Optional description of this field",
"type": "string"
},
"name": {
"description": "Name of the field",
"type": "string"
},
"type": {
"additionalProperties": true,
"description": "Type of the field\nA type used in a Logical Model field\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
"PostgresLogicalModelMetadata": {
"description": "A return type.",
"properties": {
"description": {
"description": "Optional description text which appears in the GraphQL Schema.",
"type": "string"
},
"fields": {
"description": "Return types for the logical model",
"items": {
"additionalProperties": true,
chore(server): more expressive logical models PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9197 GitOrigin-RevId: 3471c68d4e59310bdb62ecb3694ab30a2094916e
2023-05-19 19:12:51 +03:00
"anyOf": [
{
"$ref": "#/components/schemas/PostgresLogicalModelField"
},
{
"$ref": "#/components/schemas/PostgresLogicalModelField"
}
]
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
},
"type": "array"
},
"name": {
"description": "A name for a logical model",
"type": "string"
},
"select_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/PostgresSelectPermDef"
},
"type": "array"
}
},
"required": [
"name",
"fields"
],
"type": "object"
},
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"PostgresNativeQueryMetadata": {
"description": "A native query as represented in metadata.",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
"arguments": {
"additionalProperties": {
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
"$ref": "#/components/schemas/PostgresNullableScalarType"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"default": {},
"description": "Free variables in the expression and their types",
"type": "object"
},
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
"array_relationships": {
"default": [],
"items": {
chore(server): Native Query -> Table array relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10100 GitOrigin-RevId: 55f38a904767e1b25916fb31b3c5ece898c10349
2023-08-14 15:33:50 +03:00
"$ref": "#/components/schemas/RelDef_RelManualConfig___Postgres__Vanilla_"
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
},
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"code": {
"description": "Native code expression (SQL) to run\nAn interpolated query expressed in native code (SQL)",
"type": "string"
},
"description": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"description": "A description of the native query which appears in the graphql schema",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "string"
},
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
"object_relationships": {
"default": [],
"items": {
chore(server): Native Query -> Table object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10098 GitOrigin-RevId: 9b98bb0e285560cd03b04f867d1fa16dadd00df9
2023-08-10 17:21:34 +03:00
"$ref": "#/components/schemas/RelDef_RelManualConfig___Postgres__Vanilla_"
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
},
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"returns": {
chore(server): allow Logical Models to be defined inside Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9787 GitOrigin-RevId: 48b88f3c98024d3be721ab27a28be75952586a8c
2023-07-10 16:45:42 +03:00
"additionalProperties": true,
"description": "Return type (table) of the expression\nA name or definition of a Logical Model\nvalue with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"root_field_name": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"description": "Root field name for the native query",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "string"
}
},
"required": [
"root_field_name",
"code",
"returns"
],
"type": "object"
},
feature(server): allow nullability in Logical Model arguments PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8214 GitOrigin-RevId: 1ecf4c9c362aad9eabad2134a70266ff1170577b
2023-03-07 13:03:34 +03:00
"PostgresNullableScalarType": {
"description": "A scalar type that can be nullable with an optional description",
"properties": {
"description": {
"description": "Optional description text which appears in the GraphQL Schema",
"type": "string"
},
"nullable": {
"default": false,
"description": "Whether the type is nullable",
"type": "boolean"
},
"type": {
"description": "The base scalar type\nPostgres Scalar Types",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"PostgresObjRelRemoteTableMultipleColumns": {
"properties": {
"columns": {
"items": {
"type": "string"
},
"type": "array"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"columns"
],
"type": "object"
},
"PostgresObjRelRemoteTableSingleColumn": {
"properties": {
"column": {
"type": "string"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"table",
"column"
],
"type": "object"
},
"PostgresPoolSettings": {
"description": "https://hasura.io/docs/latest/graphql/core/api-reference/syntax-defs.html#pgpoolsettings",
"nullable": true,
"properties": {
"connection_lifetime": {
"description": "Time from connection creation after which the connection should be destroyed and a new one created. A value of 0 indicates we should never destroy an active connection. If 0 is passed, memory from large query results may not be reclaimed. (default: 600 sec)",
"nullable": true,
"type": "number"
},
"idle_timeout": {
"description": "The idle timeout (in seconds) per connection (default: 180)",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"nullable": true,
"type": "number"
},
"max_connections": {
"description": "Maximum number of connections to be kept in the pool (default: 50)",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"nullable": true,
"type": "number"
},
"pool_timeout": {
"description": "Maximum time to wait while acquiring a Postgres connection from the pool, in seconds (default: forever)",
"nullable": true,
"type": "number"
},
"retries": {
"description": "Number of retries to perform (default: 1)",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"nullable": true,
"type": "number"
},
"total_max_connections": {
"description": "Total maximum number of connections across all instances (cloud only, default: null)",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"nullable": true,
"type": "number"
}
},
"type": "object"
},
"PostgresQualified_FunctionName": {
"properties": {
"name": {
"type": "string"
},
"schema": {
"default": "public",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"PostgresQualified_TableName": {
"properties": {
"name": {
"type": "string"
},
"schema": {
"default": "public",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"PostgresRUManual": {
"properties": {
"manual_configuration": {
chore(server): Table -> Native Query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10114 GitOrigin-RevId: 0181184d1bc0e851151f86a98c96c97888a10e3e
2023-08-17 18:34:05 +03:00
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresRelManualTableConfig"
},
{
"$ref": "#/components/schemas/PostgresRelManualNativeQueryConfig"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"manual_configuration"
],
"type": "object"
},
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
"PostgresRelManualNativeQueryConfig": {
"properties": {
"column_mapping": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"additionalProperties": true,
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
]
feature(server): metadata for native query -> native query object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9026 GitOrigin-RevId: 5a0528ed48f6e0d2e9a3e7f5d3090a0208dad3e1
2023-05-04 17:31:14 +03:00
},
"insertion_order": {
"enum": [
"before_parent",
"after_parent"
],
"nullable": true,
"type": "string"
},
"remote_native_query": {
"type": "string"
}
},
"required": [
"remote_native_query",
"column_mapping"
],
"type": "object"
},
"PostgresRelManualTableConfig": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"properties": {
"column_mapping": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"additionalProperties": true,
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"insertion_order": {
"enum": [
"before_parent",
"after_parent"
],
"nullable": true,
"type": "string"
},
"remote_table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
}
},
"required": [
"remote_table",
"column_mapping"
],
"type": "object"
},
"PostgresSelPerm": {
"properties": {
"allow_aggregations": {
"default": false,
"type": "boolean"
},
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"computed_fields": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
},
"filter": {
"$ref": "#/components/schemas/PostgresBoolExp"
},
"limit": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"query_root_fields": {
"default": null,
"items": {
"enum": [
"select",
"select_by_pk",
"select_aggregate"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"subscription_root_fields": {
"default": null,
"items": {
"enum": [
"select",
"select_by_pk",
"select_aggregate",
"select_stream"
],
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"required": [
"columns",
"filter"
],
"type": "object"
},
"PostgresSelectPermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/PostgresSelPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
"PostgresSourceConnInfo": {
"description": "https://hasura.io/docs/latest/graphql/core/api-reference/syntax-defs.html#pgsourceconnectioninfo",
"properties": {
"database_url": {
server: GS-650: dynamic postgres connection strings from file PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10401 Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com> Co-authored-by: Matthew Goodwin <49927862+m4ttheweric@users.noreply.github.com> GitOrigin-RevId: 94967922738533a80c1af33cca7feab724cc89f6
2023-10-27 01:22:47 +03:00
"description": "The database connection URL as a string, from an environment variable, as connection parameters, or dynamically read from a file at connect time.",
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/FromEnv"
},
{
"$ref": "#/components/schemas/UrlConfFromParams"
}
]
},
"isolation_level": {
"$ref": "#/components/schemas/TxIsolation"
},
"pool_settings": {
"$ref": "#/components/schemas/PostgresPoolSettings"
},
"ssl_configuration": {
"$ref": "#/components/schemas/PGClientCerts"
},
"use_prepared_statements": {
"default": false,
"description": "If set to true the server prepares statement before executing on the source database (default: false). For more details, refer to the Postgres docs",
"type": "boolean"
}
},
"required": [
"database_url"
],
"type": "object"
},
"PostgresSourceMetadata": {
"properties": {
"configuration": {
"$ref": "#/components/schemas/PostgresConnConfiguration"
},
"customization": {
"$ref": "#/components/schemas/SourceCustomization"
},
"functions": {
"default": [],
"items": {
"$ref": "#/components/schemas/PostgresFunctionMetadata"
},
"nullable": true,
"type": "array"
},
"health_check": {
"$ref": "#/components/schemas/PostgresHealthCheckConfig"
},
"kind": {
"additionalProperties": true,
"enum": [
"postgres",
"pg"
],
"type": "string"
},
Rename "Custom Return Types" → "Logical Models" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8800 GitOrigin-RevId: e5e10f31c6cc8953a8ee947441a7f80b0e9b5e5e
2023-04-19 12:03:36 +03:00
"logical_models": {
"default": [],
"items": {
"$ref": "#/components/schemas/PostgresLogicalModelMetadata"
},
"nullable": true,
"type": "array"
},
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"name": {
"type": "string"
},
"native_queries": {
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"default": [],
"items": {
Rename "Logical Models" → "Native Queries" PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8769 GitOrigin-RevId: 66f2cbfb620d641e672a4074554d9d324a18c591
2023-04-13 19:10:38 +03:00
"$ref": "#/components/schemas/PostgresNativeQueryMetadata"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"nullable": true,
"type": "array"
},
"query_tags": {
"$ref": "#/components/schemas/QueryTagsConfig"
},
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"stored_procedures": {
"default": [],
"items": {
"$ref": "#/components/schemas/PostgresStoredProcedureMetadata"
},
"nullable": true,
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"tables": {
"items": {
"$ref": "#/components/schemas/PostgresTableMetadata"
},
"type": "array"
}
},
"required": [
"name",
"kind",
"tables",
"configuration"
],
"type": "object"
},
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"PostgresStoredProcedureMetadata": {
"description": "A stored procedure as represented in metadata.",
"properties": {
"arguments": {
"additionalProperties": {
"$ref": "#/components/schemas/PostgresNullableScalarType"
},
"default": {},
"description": "Free variables in the expression and their types",
"type": "object"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"configuration": {
"$ref": "#/components/schemas/StoredProcedureConfig"
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
},
"description": {
"description": "A description of the stored procedure which appears in the graphql schema",
"type": "string"
},
"returns": {
"description": "Return type (table) of the expression",
"type": "string"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"stored_procedure": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_FunctionName"
},
{
"type": "string"
}
],
"description": "The name of the SQL stored procedure"
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
}
},
"required": [
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"stored_procedure",
"configuration",
Stored procedures api commands PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8975 GitOrigin-RevId: c71a9f74bf01bb8c0bc8c8cd4b744b530d99476a
2023-04-28 16:37:01 +03:00
"returns"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"PostgresSubscribeOpSpec": {
"properties": {
"columns": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"payload": {
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"required": [
"columns"
],
"type": "object"
},
"PostgresTableConfig": {
"properties": {
"column_config": {
"additionalProperties": {
"$ref": "#/components/schemas/ColumnConfig"
},
"default": {},
"type": "object"
},
"comment": {
"default": null,
"nullable": true,
"type": "string"
},
"custom_column_names": {
"additionalProperties": {
"$ref": "#/components/schemas/GraphQLName"
},
"default": {},
"type": "object"
},
"custom_name": {
"$ref": "#/components/schemas/GraphQLName"
},
"custom_root_fields": {
"$ref": "#/components/schemas/TableCustomRootFields"
}
},
"type": "object"
},
"PostgresTableMetadata": {
"description": "Representation of a table in metadata, 'tables.yaml' and 'metadata.json'",
"properties": {
"apollo_federation_config": {
"$ref": "#/components/schemas/ApolloFederationConfig"
},
"array_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RelDef_RelUsing___Postgres__Vanilla___ArrRelUsingFKeyOn___Postgres__Vanilla__"
},
"type": "array"
},
"computed_fields": {
"default": [],
"items": {
"$ref": "#/components/schemas/PostgresComputedFieldMetadata"
},
"type": "array"
},
"configuration": {
"$ref": "#/components/schemas/PostgresTableConfig"
},
"delete_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/PostgresDeletePermDef"
},
"type": "array"
},
"event_triggers": {
"default": [],
"items": {
"$ref": "#/components/schemas/PostgresEventTriggerConfEventTriggerConf"
},
"type": "array"
},
"insert_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/PostgresInsertPermDef"
},
"type": "array"
},
"is_enum": {
"default": false,
"type": "boolean"
},
Specify table schema via logical model in `track_table` API PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9408 GitOrigin-RevId: 9ba20cd91e4d0066e0f14ce52cba0f55a7c5af31
2023-06-22 10:05:07 +03:00
"logical_model": {
"nullable": true,
"type": "string"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"object_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RelDef_RelUsing___Postgres__Vanilla___ObjRelUsingChoice___Postgres__Vanilla__"
},
"type": "array"
},
"remote_relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RemoteRelationship_RemoteRelationshipDefinition"
},
"type": "array"
},
"select_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/PostgresSelectPermDef"
},
"type": "array"
},
"table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
},
"update_permissions": {
"default": [],
"items": {
"$ref": "#/components/schemas/PostgresUpdatePermDef"
},
"type": "array"
}
},
"required": [
"table"
],
"type": "object"
},
"PostgresTriggerOpsDef": {
"properties": {
"delete": {
"$ref": "#/components/schemas/PostgresSubscribeOpSpec"
},
"enable_manual": {
"type": "boolean"
},
"insert": {
"$ref": "#/components/schemas/PostgresSubscribeOpSpec"
},
"update": {
"$ref": "#/components/schemas/PostgresSubscribeOpSpec"
}
},
"type": "object"
},
"PostgresUpdPerm": {
"properties": {
"backend_only": {
"default": false,
"type": "boolean"
},
"check": {
"$ref": "#/components/schemas/PostgresBoolExp"
},
"columns": {
"description": "Allowed columns",
"oneOf": [
{
"enum": [
"*"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"filter": {
"$ref": "#/components/schemas/PostgresBoolExp"
},
"set": {
"additionalProperties": {
"additionalProperties": true
},
"description": "Preset columns",
"type": "object"
server/postgres: update input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9665 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 35bd769281982833e86c5bb708b3edf5a040708b
2023-06-28 13:18:09 +03:00
},
"validate_input": {
"$ref": "#/components/schemas/ValidateInputInputWebhook"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"columns",
"filter"
],
"type": "object"
},
"PostgresUpdatePermDef": {
"properties": {
"comment": {
"nullable": true,
"type": "string"
},
"permission": {
"$ref": "#/components/schemas/PostgresUpdPerm"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"permission"
],
"type": "object"
},
server: codecs for rest endpoint definitions in metadata PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8030 GitOrigin-RevId: 0980502c535ab308e2458a98cebfd166fa55f8b6
2023-02-20 21:36:31 +03:00
"QueryReference": {
"properties": {
"collection_name": {
"type": "string"
},
"query_name": {
"type": "string"
}
},
"required": [
"collection_name",
"query_name"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"QueryTagsConfig": {
"nullable": true,
"properties": {
"disabled": {
"default": false,
"type": "boolean"
},
"format": {
"$ref": "#/components/schemas/QueryTagsFormat"
},
"omit_request_id": {
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"default": true,
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"type": "boolean"
}
},
"type": "object"
},
"QueryTagsFormat": {
"enum": [
"standard",
"sqlcommenter"
],
"type": "string"
},
"RUFKeyOn_ArrRelUsingFKeyOn__BigQuery": {
"properties": {
"foreign_key_constraint_on": {
"oneOf": [
{
"$ref": "#/components/schemas/BigqueryArrRelUsingFKeyOnSingleColumn"
},
{
"$ref": "#/components/schemas/BigqueryArrRelUsingFKeyOnMultipleColumns"
}
]
}
},
"required": [
"foreign_key_constraint_on"
],
"type": "object"
},
"RUFKeyOn_ArrRelUsingFKeyOn__DataConnector": {
"properties": {
"foreign_key_constraint_on": {
"oneOf": [
{
"$ref": "#/components/schemas/DataconnectorArrRelUsingFKeyOnSingleColumn"
},
{
"$ref": "#/components/schemas/DataconnectorArrRelUsingFKeyOnMultipleColumns"
}
]
}
},
"required": [
"foreign_key_constraint_on"
],
"type": "object"
},
"RUFKeyOn_ArrRelUsingFKeyOn__MSSQL": {
"properties": {
"foreign_key_constraint_on": {
"oneOf": [
{
"$ref": "#/components/schemas/MssqlArrRelUsingFKeyOnSingleColumn"
},
{
"$ref": "#/components/schemas/MssqlArrRelUsingFKeyOnMultipleColumns"
}
]
}
},
"required": [
"foreign_key_constraint_on"
],
"type": "object"
},
"RUFKeyOn_ArrRelUsingFKeyOn___Postgres__Citus_": {
"properties": {
"foreign_key_constraint_on": {
"oneOf": [
{
"$ref": "#/components/schemas/CitusArrRelUsingFKeyOnSingleColumn"
},
{
"$ref": "#/components/schemas/CitusArrRelUsingFKeyOnMultipleColumns"
}
]
}
},
"required": [
"foreign_key_constraint_on"
],
"type": "object"
},
"RUFKeyOn_ArrRelUsingFKeyOn___Postgres__Cockroach_": {
"properties": {
"foreign_key_constraint_on": {
"oneOf": [
{
"$ref": "#/components/schemas/CockroachArrRelUsingFKeyOnSingleColumn"
},
{
"$ref": "#/components/schemas/CockroachArrRelUsingFKeyOnMultipleColumns"
}
]
}
},
"required": [
"foreign_key_constraint_on"
],
"type": "object"
},
"RUFKeyOn_ArrRelUsingFKeyOn___Postgres__Vanilla_": {
"properties": {
"foreign_key_constraint_on": {
"oneOf": [
{
"$ref": "#/components/schemas/PostgresArrRelUsingFKeyOnSingleColumn"
},
{
"$ref": "#/components/schemas/PostgresArrRelUsingFKeyOnMultipleColumns"
}
]
}
},
"required": [
"foreign_key_constraint_on"
],
"type": "object"
},
"RUFKeyOn_ObjRelUsingChoice__BigQuery": {
"properties": {
"foreign_key_constraint_on": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/components/schemas/BigqueryObjRelRemoteTableSingleColumn"
},
{
"$ref": "#/components/schemas/BigqueryObjRelRemoteTableMultipleColumns"
}
]
}
},
"required": [
"foreign_key_constraint_on"
],
"type": "object"
},
"RUFKeyOn_ObjRelUsingChoice__DataConnector": {
"properties": {
"foreign_key_constraint_on": {
"oneOf": [
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
{
"items": {
"type": "string"
},
"type": "array"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
{
"type": "string"
},
{
"items": {
Support joins on nested fields for MongoDB PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10345 GitOrigin-RevId: 1a4886b7ac5110ddf9233596068810963bde3371
2023-10-30 05:25:57 +03:00
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
},
"type": "array"
},
{
"$ref": "#/components/schemas/DataconnectorObjRelRemoteTableSingleColumn"
},
{
"$ref": "#/components/schemas/DataconnectorObjRelRemoteTableMultipleColumns"
}
]
}
},
"required": [
"foreign_key_constraint_on"
],
"type": "object"
},
"RUFKeyOn_ObjRelUsingChoice__MSSQL": {
"properties": {
"foreign_key_constraint_on": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/components/schemas/MssqlObjRelRemoteTableSingleColumn"
},
{
"$ref": "#/components/schemas/MssqlObjRelRemoteTableMultipleColumns"
}
]
}
},
"required": [
"foreign_key_constraint_on"
],
"type": "object"
},
"RUFKeyOn_ObjRelUsingChoice___Postgres__Citus_": {
"properties": {
"foreign_key_constraint_on": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/components/schemas/CitusObjRelRemoteTableSingleColumn"
},
{
"$ref": "#/components/schemas/CitusObjRelRemoteTableMultipleColumns"
}
]
}
},
"required": [
"foreign_key_constraint_on"
],
"type": "object"
},
"RUFKeyOn_ObjRelUsingChoice___Postgres__Cockroach_": {
"properties": {
"foreign_key_constraint_on": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/components/schemas/CockroachObjRelRemoteTableSingleColumn"
},
{
"$ref": "#/components/schemas/CockroachObjRelRemoteTableMultipleColumns"
}
]
}
},
"required": [
"foreign_key_constraint_on"
],
"type": "object"
},
"RUFKeyOn_ObjRelUsingChoice___Postgres__Vanilla_": {
"properties": {
"foreign_key_constraint_on": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/components/schemas/PostgresObjRelRemoteTableSingleColumn"
},
{
"$ref": "#/components/schemas/PostgresObjRelRemoteTableMultipleColumns"
}
]
}
},
"required": [
"foreign_key_constraint_on"
],
"type": "object"
},
server: codecs for api limits PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8065 GitOrigin-RevId: 4a14f72fa4f832f1cc6cb7f5be8d146b4f00dd44
2023-03-15 04:36:52 +03:00
"RateLimitConfig": {
"properties": {
"max_reqs_per_min": {
"maximum": 9223372036854775807,
"minimum": 0,
"type": "number"
},
"unique_params": {
"description": "This would be either fixed value \"IP\" or a list of Session variables",
"oneOf": [
{
"enum": [
"IP",
"ip"
],
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"required": [
"max_reqs_per_min"
],
"type": "object"
},
chore(server): Native Query -> Table object relationships PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10098 GitOrigin-RevId: 9b98bb0e285560cd03b04f867d1fa16dadd00df9
2023-08-10 17:21:34 +03:00
"RelDef_RelManualConfig__BigQuery": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/BigqueryRelManualTableConfig"
},
{
"$ref": "#/components/schemas/BigqueryRelManualNativeQueryConfig"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelManualConfig__DataConnector": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/DataconnectorRelManualTableConfig"
},
{
"$ref": "#/components/schemas/DataconnectorRelManualNativeQueryConfig"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelManualConfig__MSSQL": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/MssqlRelManualTableConfig"
},
{
"$ref": "#/components/schemas/MssqlRelManualNativeQueryConfig"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelManualConfig___Postgres__Citus_": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/CitusRelManualTableConfig"
},
{
"$ref": "#/components/schemas/CitusRelManualNativeQueryConfig"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelManualConfig___Postgres__Cockroach_": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/CockroachRelManualTableConfig"
},
{
"$ref": "#/components/schemas/CockroachRelManualNativeQueryConfig"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelManualConfig___Postgres__Vanilla_": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresRelManualTableConfig"
},
{
"$ref": "#/components/schemas/PostgresRelManualNativeQueryConfig"
}
]
}
},
"required": [
chore(server): metadata changes for array relationships for Native Queries PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8670 GitOrigin-RevId: c23e23e3cf48013ab76fc2fa98c8b8b800c6cee6
2023-04-17 14:30:10 +03:00
"name",
"using"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"RelDef_RelUsing__BigQuery__ArrRelUsingFKeyOn__BigQuery_": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"oneOf": [
{
"$ref": "#/components/schemas/RUFKeyOn_ArrRelUsingFKeyOn__BigQuery"
},
{
"$ref": "#/components/schemas/BigqueryRUManual"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelUsing__BigQuery__ObjRelUsingChoice__BigQuery_": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"oneOf": [
{
"$ref": "#/components/schemas/RUFKeyOn_ObjRelUsingChoice__BigQuery"
},
{
"$ref": "#/components/schemas/BigqueryRUManual"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelUsing__DataConnector__ArrRelUsingFKeyOn__DataConnector_": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"oneOf": [
{
"$ref": "#/components/schemas/RUFKeyOn_ArrRelUsingFKeyOn__DataConnector"
},
{
"$ref": "#/components/schemas/DataconnectorRUManual"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelUsing__DataConnector__ObjRelUsingChoice__DataConnector_": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"oneOf": [
{
"$ref": "#/components/schemas/RUFKeyOn_ObjRelUsingChoice__DataConnector"
},
{
"$ref": "#/components/schemas/DataconnectorRUManual"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelUsing__MSSQL__ArrRelUsingFKeyOn__MSSQL_": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"oneOf": [
{
"$ref": "#/components/schemas/RUFKeyOn_ArrRelUsingFKeyOn__MSSQL"
},
{
"$ref": "#/components/schemas/MssqlRUManual"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelUsing__MSSQL__ObjRelUsingChoice__MSSQL_": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"oneOf": [
{
"$ref": "#/components/schemas/RUFKeyOn_ObjRelUsingChoice__MSSQL"
},
{
"$ref": "#/components/schemas/MssqlRUManual"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelUsing___Postgres__Citus___ArrRelUsingFKeyOn___Postgres__Citus__": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"oneOf": [
{
"$ref": "#/components/schemas/RUFKeyOn_ArrRelUsingFKeyOn___Postgres__Citus_"
},
{
"$ref": "#/components/schemas/CitusRUManual"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelUsing___Postgres__Citus___ObjRelUsingChoice___Postgres__Citus__": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"oneOf": [
{
"$ref": "#/components/schemas/RUFKeyOn_ObjRelUsingChoice___Postgres__Citus_"
},
{
"$ref": "#/components/schemas/CitusRUManual"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelUsing___Postgres__Cockroach___ArrRelUsingFKeyOn___Postgres__Cockroach__": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"oneOf": [
{
"$ref": "#/components/schemas/RUFKeyOn_ArrRelUsingFKeyOn___Postgres__Cockroach_"
},
{
"$ref": "#/components/schemas/CockroachRUManual"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelUsing___Postgres__Cockroach___ObjRelUsingChoice___Postgres__Cockroach__": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"oneOf": [
{
"$ref": "#/components/schemas/RUFKeyOn_ObjRelUsingChoice___Postgres__Cockroach_"
},
{
"$ref": "#/components/schemas/CockroachRUManual"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelUsing___Postgres__Vanilla___ArrRelUsingFKeyOn___Postgres__Vanilla__": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"oneOf": [
{
"$ref": "#/components/schemas/RUFKeyOn_ArrRelUsingFKeyOn___Postgres__Vanilla_"
},
{
"$ref": "#/components/schemas/PostgresRUManual"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelDef_RelUsing___Postgres__Vanilla___ObjRelUsingChoice___Postgres__Vanilla__": {
"properties": {
"comment": {
"type": "string"
},
"name": {
"type": "string"
},
"using": {
"oneOf": [
{
"$ref": "#/components/schemas/RUFKeyOn_ObjRelUsingChoice___Postgres__Vanilla_"
},
{
"$ref": "#/components/schemas/PostgresRUManual"
}
]
}
},
"required": [
"name",
"using"
],
"type": "object"
},
"RelationshipToSchema": {
"properties": {
"to_remote_schema": {
"$ref": "#/components/schemas/ToSchemaRelationshipDef"
}
},
"required": [
"to_remote_schema"
],
"type": "object"
},
"RelationshipToSource": {
"properties": {
"to_source": {
"$ref": "#/components/schemas/ToSourceRelationshipDef"
}
},
"required": [
"to_source"
],
"type": "object"
},
"RemoteArguments": {
"additionalProperties": {
"$ref": "#/components/schemas/GraphQLValue_Name"
},
"description": "Remote arguments are represented by an object that maps each argument name to its value.",
"type": "object"
},
"RemoteFieldCustomization": {
"properties": {
"mapping": {
"additionalProperties": {
"$ref": "#/components/schemas/GraphQLName"
},
"type": "object"
},
"parent_type": {
"$ref": "#/components/schemas/GraphQLName"
},
"prefix": {
"$ref": "#/components/schemas/GraphQLName"
},
"suffix": {
"$ref": "#/components/schemas/GraphQLName"
}
},
"required": [
"parent_type",
"mapping"
],
"type": "object"
},
"RemoteFields": {
"additionalProperties": {
"$ref": "#/components/schemas/FieldCall"
},
"description": "Remote fields are represented by an object that maps each field name to its arguments.",
"type": "object"
},
"RemoteRelationship_RemoteRelationshipDefinition": {
"properties": {
"definition": {
"oneOf": [
{
"$ref": "#/components/schemas/RelationshipToSource"
},
{
"$ref": "#/components/schemas/RelationshipToSchema"
},
{
"$ref": "#/components/schemas/ToSchemaRelationshipDefLegacyFormat"
}
]
},
"name": {
"type": "string"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
"RemoteSchemaCustomization": {
"properties": {
"field_names": {
"items": {
"$ref": "#/components/schemas/RemoteFieldCustomization"
},
"type": "array"
},
"root_fields_namespace": {
"$ref": "#/components/schemas/GraphQLName"
},
"type_names": {
"$ref": "#/components/schemas/RemoteTypeCustomization"
}
},
"type": "object"
},
"RemoteSchemaDef": {
"properties": {
"customization": {
"$ref": "#/components/schemas/RemoteSchemaCustomization"
},
"forward_client_headers": {
"default": false,
"type": "boolean"
},
"headers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HeaderConfValue"
},
{
"$ref": "#/components/schemas/HeaderConfFromEnv"
}
]
},
"type": "array"
},
"timeout_seconds": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"url": {
"type": "string"
},
"url_from_env": {
"type": "string"
}
},
"type": "object"
},
"RemoteSchemaMetadata_RemoteRelationshipDefinition": {
"properties": {
"relationships": {
"default": [],
"items": {
"$ref": "#/components/schemas/RemoteRelationship_RemoteRelationshipDefinition"
},
"type": "array"
},
"type_name": {
"$ref": "#/components/schemas/GraphQLName"
}
},
"required": [
"type_name"
],
"type": "object"
},
"RemoteSchemaPermissionDefinition": {
"properties": {
"schema": {
"$ref": "#/components/schemas/GraphQLSchema"
}
},
"required": [
"schema"
],
"type": "object"
},
"RemoteSchemaPermissionMetadata": {
"properties": {
"comment": {
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/RemoteSchemaPermissionDefinition"
},
"role": {
"type": "string"
}
},
"required": [
"role",
"definition"
],
"type": "object"
},
"RemoteTypeCustomization": {
"properties": {
"mapping": {
"additionalProperties": {
"$ref": "#/components/schemas/GraphQLName"
},
"type": "object"
},
"prefix": {
"$ref": "#/components/schemas/GraphQLName"
},
"suffix": {
"$ref": "#/components/schemas/GraphQLName"
}
},
"required": [
"mapping"
],
"type": "object"
},
"RequestTransformV1": {
"properties": {
"body": {
"type": "string"
},
"method": {
"type": "string"
},
"query_params": {
"oneOf": [
{
"additionalProperties": {
"nullable": true,
"type": "string"
},
"type": "object"
},
{
"type": "string"
}
]
},
"request_headers": {
"$ref": "#/components/schemas/AddReplaceOrRemoveFields"
},
"template_engine": {
"default": "Kriti",
"enum": [
"Kriti"
],
"type": "string"
},
"url": {
"type": "string"
},
"version": {
"enum": [
1
],
"type": "number"
}
},
"type": "object"
},
"RequestTransformV2": {
"properties": {
"body": {
"oneOf": [
{
"$ref": "#/components/schemas/BodyTransformFn_Remove"
},
{
"$ref": "#/components/schemas/BodyTransformFn_ModifyAsJSON"
},
{
"$ref": "#/components/schemas/BodyTransformFn_ModifyAsFormURLEncoded"
}
]
},
"method": {
"type": "string"
},
"query_params": {
"oneOf": [
{
"additionalProperties": {
"nullable": true,
"type": "string"
},
"type": "object"
},
{
"type": "string"
}
]
},
"request_headers": {
"$ref": "#/components/schemas/AddReplaceOrRemoveFields"
},
"template_engine": {
"default": "Kriti",
"enum": [
"Kriti"
],
"type": "string"
},
"url": {
"type": "string"
},
"version": {
"enum": [
2
],
"type": "number"
}
},
"required": [
"version"
],
"type": "object"
},
"ResponseTransformV1": {
"properties": {
"body": {
"type": "string"
},
"template_engine": {
"default": "Kriti",
"enum": [
"Kriti"
],
"type": "string"
},
"version": {
"enum": [
1
],
"type": "number"
}
},
"type": "object"
},
"ResponseTransformV2": {
"properties": {
"body": {
"oneOf": [
{
"$ref": "#/components/schemas/BodyTransformFn_Remove"
},
{
"$ref": "#/components/schemas/BodyTransformFn_ModifyAsJSON"
},
{
"$ref": "#/components/schemas/BodyTransformFn_ModifyAsFormURLEncoded"
}
]
},
"template_engine": {
"default": "Kriti",
"enum": [
"Kriti"
],
"type": "string"
},
"version": {
"enum": [
2
],
"type": "number"
}
},
"required": [
"version"
],
"type": "object"
},
"RetryConf": {
"properties": {
"interval_sec": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"num_retries": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"timeout_sec": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
}
},
"required": [
"num_retries",
"interval_sec"
],
"type": "object"
},
server: codecs for metrics, roles, allow list PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8114 GitOrigin-RevId: 1a1f8b6360edbdddad5cf364b533a255c15e2f4a
2023-03-10 02:09:16 +03:00
"Role": {
"properties": {
"role_name": {
"type": "string"
},
"role_set": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"role_name",
"role_set"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"RootFieldsCustomization": {
"properties": {
"namespace": {
"$ref": "#/components/schemas/GraphQLName"
},
"prefix": {
"$ref": "#/components/schemas/GraphQLName"
},
"suffix": {
"$ref": "#/components/schemas/GraphQLName"
}
},
"type": "object"
},
"SSLMode": {
"enum": [
"disable",
"allow",
"prefer",
"require",
"verify-ca",
"verify-full"
],
"type": "string"
},
server: codecs for cron triggers PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8029 GitOrigin-RevId: c26308782618c760921a0eff3e4bd87702bd3eb2
2023-02-20 05:50:42 +03:00
"STRetryConf": {
"properties": {
"num_retries": {
"default": 0,
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"retry_interval_seconds": {
"default": 10,
"type": "number"
},
"timeout_seconds": {
"default": 60,
"type": "number"
},
"tolerance_seconds": {
"default": 21600,
"type": "number"
}
},
"type": "object"
},
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"ScalarType": {
"additionalProperties": true,
"description": "value with unspecified type - this is a placeholder that will eventually be replaced with a more detailed description"
},
"ScalarTypeDefinition": {
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"SourceCustomization": {
"properties": {
"naming_convention": {
"$ref": "#/components/schemas/NamingCase"
},
"root_fields": {
"$ref": "#/components/schemas/RootFieldsCustomization"
},
"type_names": {
"$ref": "#/components/schemas/SourceTypeCustomization"
}
},
"type": "object"
},
"SourceMetadata": {
"oneOf": [
{
"$ref": "#/components/schemas/PostgresSourceMetadata"
},
{
"$ref": "#/components/schemas/CitusSourceMetadata"
},
{
"$ref": "#/components/schemas/CockroachSourceMetadata"
},
{
"$ref": "#/components/schemas/MssqlSourceMetadata"
},
{
"$ref": "#/components/schemas/BigquerySourceMetadata"
},
{
"$ref": "#/components/schemas/DataconnectorSourceMetadata"
}
]
},
"SourceTypeCustomization": {
"properties": {
"prefix": {
"$ref": "#/components/schemas/GraphQLName"
},
"suffix": {
"$ref": "#/components/schemas/GraphQLName"
}
},
"type": "object"
},
Refer to a stored procedure by name in commands interface PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9014 GitOrigin-RevId: 64f51811770d88ad6d5b298fc4c71170ffd7182c
2023-05-02 16:30:22 +03:00
"StoredProcedureConfig": {
"properties": {
"custom_name": {
"$ref": "#/components/schemas/GraphQLName"
},
"exposed_as": {
"enum": [
"query"
],
"type": "string"
}
},
"required": [
"exposed_as"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"TableCustomRootFields": {
"properties": {
"delete": {
"default": null,
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/CustomRootField"
}
]
},
"delete_by_pk": {
"default": null,
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/CustomRootField"
}
]
},
"insert": {
"default": null,
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/CustomRootField"
}
]
},
"insert_one": {
"default": null,
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/CustomRootField"
}
]
},
"select": {
"default": null,
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/CustomRootField"
}
]
},
"select_aggregate": {
"default": null,
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/CustomRootField"
}
]
},
"select_by_pk": {
"default": null,
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/CustomRootField"
}
]
},
"select_stream": {
"default": null,
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/CustomRootField"
}
]
},
"update": {
"default": null,
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/CustomRootField"
}
]
},
"update_by_pk": {
"default": null,
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/CustomRootField"
}
]
},
"update_many": {
"default": null,
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/CustomRootField"
}
]
}
},
"type": "object"
},
Adding UDF (user-defined-functions) support to Data Connectors - GDC-820 PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8121 GitOrigin-RevId: ceb3e29e330bba294061f85c1f75700974d01452
2023-05-19 07:47:12 +03:00
"TableFunctionResponse": {
"properties": {
"table": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"table"
],
"type": "string"
}
},
"required": [
"table",
"type"
],
"type": "object"
},
Dynamic from file template variables in Data Connector config Kriti transforms PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10408 Co-authored-by: Matthew Goodwin <49927862+m4ttheweric@users.noreply.github.com> Co-authored-by: Vijay Prasanna <11921040+vijayprasanna13@users.noreply.github.com> GitOrigin-RevId: c6d7a47079d93a6c0a987cd1df7ece9fa4d1a917
2023-10-27 15:34:42 +03:00
"TemplateVariableDynamicFromFile": {
"properties": {
"filepath": {
"type": "string"
},
"type": {
"enum": [
"dynamic_from_file"
],
"type": "string"
}
},
"required": [
"filepath",
"type"
],
"type": "object"
},
"TemplateVariableSource": {
"discriminator": {
"mapping": {
"dynamic_from_file": "TemplateVariableDynamicFromFile"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/TemplateVariableDynamicFromFile"
}
]
},
server: codecs for network config, graphql introspection PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8132 GitOrigin-RevId: 6b800f35a76b6d38817862a4678644b8bf230a95
2023-03-17 20:44:28 +03:00
"TlsAllow": {
"properties": {
"host": {
"type": "string"
},
"permissions": {
"items": {
"enum": [
"self-signed"
],
"type": "string"
},
"type": "array"
},
"suffix": {
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"ToSchemaRelationshipDef": {
"properties": {
"lhs_fields": {
"items": {
"type": "string"
},
"type": "array"
},
"remote_field": {
"$ref": "#/components/schemas/RemoteFields"
},
"remote_schema": {
"type": "string"
}
},
"required": [
"remote_schema",
"lhs_fields",
"remote_field"
],
"type": "object"
},
"ToSchemaRelationshipDefLegacyFormat": {
"properties": {
"hasura_fields": {
"items": {
"type": "string"
},
"type": "array"
},
"remote_field": {
"$ref": "#/components/schemas/RemoteFields"
},
"remote_schema": {
"type": "string"
}
},
"required": [
"remote_schema",
"hasura_fields",
"remote_field"
],
"type": "object"
},
"ToSourceRelationshipDef": {
"properties": {
"field_mapping": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"relationship_type": {
"enum": [
"object",
"array"
],
"type": "string"
},
"source": {
"type": "string"
},
"table": {
"additionalProperties": true
}
},
"required": [
"relationship_type",
"field_mapping",
"source",
"table"
],
"type": "object"
},
"TxIsolation": {
"enum": [
"read-committed",
"repeatable-read",
"serializable"
],
"type": "string"
},
ci: fix an error in a recently-added buildkite test script PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8001 GitOrigin-RevId: 12f7d66772eb6d9b011b7a77a85544ffeb6ec270
2023-02-16 00:06:20 +03:00
"TypeRelationshipDefinition": {
"properties": {
"field_mapping": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"remote_table": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "#/components/schemas/PostgresQualified_TableName"
},
{
"type": "string"
}
]
},
"source": {
"default": "default",
"type": "string"
},
"type": {
"enum": [
"object",
"array"
],
"type": "string"
}
},
"required": [
"name",
"type",
"remote_table",
"field_mapping"
],
"type": "object"
},
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
"UrlConfFromParams": {
"properties": {
"connection_parameters": {
server: GS-650: dynamic postgres connection strings from file PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10401 Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com> Co-authored-by: Matthew Goodwin <49927862+m4ttheweric@users.noreply.github.com> GitOrigin-RevId: 94967922738533a80c1af33cca7feab724cc89f6
2023-10-27 01:22:47 +03:00
"oneOf": [
{
"properties": {
"Left": {
"$ref": "#/components/schemas/PGConnectionParams"
}
},
"required": [
"Left"
],
"type": "object"
},
{
"properties": {
"Right": {
"type": "string"
}
},
"required": [
"Right"
],
"type": "object"
}
]
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
},
"required": [
"connection_parameters"
],
"type": "object"
server/postgres: insert input validation [experimental] PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9620 Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com> GitOrigin-RevId: 345c3f763f8dd3397c999c5967af39192b944640
2023-06-25 16:46:35 +03:00
},
"ValidateInputHttpDefinition": {
"properties": {
"forward_client_headers": {
"default": false,
"type": "boolean"
},
"headers": {
"default": [],
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HeaderConfValue"
},
{
"$ref": "#/components/schemas/HeaderConfFromEnv"
}
]
},
"type": "array"
},
"timeout": {
"default": 10,
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "number"
},
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"ValidateInputInputWebhook": {
"properties": {
"definition": {
"$ref": "#/components/schemas/ValidateInputHttpDefinition"
},
"type": {
"enum": [
"http"
],
"type": "string"
}
},
"required": [
"type",
"definition"
],
"type": "object"
server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding ## Description Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not. Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on. For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525 GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 21:36:25 +03:00
}
}
},
"info": {
"title": "",
"version": ""
},
"openapi": "3.0.0",
"paths": {}
}
Reference in New Issue Copy Permalink