Skip to content

Commit

Permalink
sync metadata docs with LSP (#892)
Browse files Browse the repository at this point in the history 
Co-authored-by: hasura-bot <[email protected]>
Co-authored-by: Rob Dominguez <[email protected]>
  • Loading branch information
@hasura-bot @dliub @robertjdominguez
3 people authored Feb 13, 2025
1 parent a917acc commit 3b3729d
Show file tree
Hide file tree
Showing 16 changed files with 1,761 additions and 998 deletions.
188 changes: 118 additions & 70 deletions docs/reference/metadata-reference/aggregate-expressions.mdx
View file

Large diffs are not rendered by default.

286 changes: 172 additions & 114 deletions docs/reference/metadata-reference/auth-config.mdx
View file

Large diffs are not rendered by default.

254 changes: 161 additions & 93 deletions docs/reference/metadata-reference/boolean-expressions.mdx
View file

Large diffs are not rendered by default.

158 changes: 96 additions & 62 deletions docs/reference/metadata-reference/build-configs.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,129 +150,163 @@ definition:

## Metadata structure


### Supergraph {#supergraph-supergraph}

Defines the configuration used to build the Supergraph.

| Key | Value | Required | Description |
| ------------ | ------------------------------------------------------------ | -------- | ----------- |
| `kind` | `Supergraph` | true | |
| `version` | `v2` | true | |
| `definition` | [SupergraphDefinitionV2](#supergraph-supergraphdefinitionv2) | true | |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `kind` | `Supergraph` | true | |
| `version` | `v2` | true | |
| `definition` | [SupergraphDefinitionV2](#supergraph-supergraphdefinitionv2) | true | |



#### SupergraphDefinitionV2 {#supergraph-supergraphdefinitionv2}

Supergraph Definition V2.

| Key | Value | Required | Description |
| ----------- | -------- | -------- | -------------------------------- |
| `subgraphs` | [string] | true | Paths to subgraph configuration. |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `subgraphs` | [string] | true | Paths to subgraph configuration. |

### Subgraph {#subgraph-subgraph}

Defines the configuration used to build the Subgraph.

| Key | Value | Required | Description |
| ------------ | ------------------------------------------------------ | -------- | ----------- |
| `kind` | `Subgraph` | true | |
| `version` | `v2` | true | |
| `definition` | [SubgraphDefinitionV2](#subgraph-subgraphdefinitionv2) | true | |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `kind` | `Subgraph` | true | |
| `version` | `v2` | true | |
| `definition` | [SubgraphDefinitionV2](#subgraph-subgraphdefinitionv2) | true | |



#### SubgraphDefinitionV2 {#subgraph-subgraphdefinitionv2}

Subgraph Definition V2.

| Key | Value | Required | Description |
| -------------- | ------------------------------------------------------------ | -------- | ---------------------------------------------------- |
| `name` | string | true | Subgraph Name. |
| `generator` | [SubgraphGeneratorConfig](#subgraph-subgraphgeneratorconfig) | true | Subgraph generator Configuration. |
| `envFile` | string | false | Path to the Subgraph .env file. |
| `includePaths` | [string] | true | Paths to be included to construct Subgraph metadata. |
| `envMapping` | [EnvMapping](#subgraph-envmapping) | false | Environment Variable mapping config. |
| `connectors` | [[SubgraphConnector](#subgraph-subgraphconnector)] | false | Connectors used in subgraph. |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `name` | string | true | Subgraph Name. |
| `generator` | [SubgraphGeneratorConfig](#subgraph-subgraphgeneratorconfig) | true | Subgraph generator Configuration. |
| `envFile` | string | false | Path to the Subgraph .env file. |
| `includePaths` | [string] | true | Paths to be included to construct Subgraph metadata. |
| `envMapping` | [EnvMapping](#subgraph-envmapping) | false | Environment Variable mapping config. |
| `connectors` | [[SubgraphConnector](#subgraph-subgraphconnector)] | false | Connectors used in subgraph. |



#### SubgraphConnector {#subgraph-subgraphconnector}

Subgraph Connector config.

| Key | Value | Required | Description |
| ------------------- | ------ | -------- | ----------------------------------------------------- |
| `path` | string | true | Path to connector config file. |
| `connectorLinkName` | string | false | Name of connector link associated with the connector. |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `path` | string | true | Path to connector config file. |
| `connectorLinkName` | string | false | Name of connector link associated with the connector. |



#### EnvMapping {#subgraph-envmapping}

Environment Variables mapping config.

| Key | Value | Required | Description |
| ------------- | -------------------------------- | -------- | ---------------------------- |
| `<customKey>` | [EnvSource](#subgraph-envsource) | false | Target Environment variable. |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `<customKey>` | [EnvSource](#subgraph-envsource) | false | Target Environment variable. |



#### EnvSource {#subgraph-envsource}

Environment Variable Source.

| Key | Value | Required | Description |
| --------- | ------ | -------- | ---------------------------- |
| `fromEnv` | string | true | Source Environment variable. |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `fromEnv` | string | true | Source Environment variable. |



#### SubgraphGeneratorConfig {#subgraph-subgraphgeneratorconfig}

Subgraph generator Configuration.

| Key | Value | Required | Description |
| ------------------------ | ------------------ | -------- | ------------------------------------------------------------------- |
| `rootPath` | string | true | Path to the directory which holds all the Subgraph metadata. |
| `graphqlRootFieldPrefix` | string | false | Prefix to use while generating GraphQL root fields. |
| `graphqlTypeNamePrefix` | string | false | Prefix to use while generating GraphQL type names. |
| `namingConvention` | `none` / `graphql` | false | Naming convention to use while generating GraphQL fields and types. |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `rootPath` | string | true | Path to the directory which holds all the Subgraph metadata. |
| `graphqlRootFieldPrefix` | string | false | Prefix to use while generating GraphQL root fields. |
| `graphqlTypeNamePrefix` | string | false | Prefix to use while generating GraphQL type names. |
| `namingConvention` | `none` / `graphql` | false | Naming convention to use while generating GraphQL fields and types. |

### Connector {#connector-connector}

Defines the configuration used to build the connector.

| Key | Value | Required | Description |
| ------------ | --------------------------------------------------------- | -------- | ----------- |
| `kind` | `Connector` | true | |
| `version` | `v2` | true | |
| `definition` | [ConnectorDefinitionV2](#connector-connectordefinitionv2) | true | |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `kind` | `Connector` | true | |
| `version` | `v2` | true | |
| `definition` | [ConnectorDefinitionV2](#connector-connectordefinitionv2) | true | |



#### ConnectorDefinitionV2 {#connector-connectordefinitionv2}

Connector deployment definition V2.

| Key | Value | Required | Description |
| --------------------- | ----------------------------------------------------------- | -------- | ----------------------------------------- |
| `name` | string | true | Connector name. |
| `subgraph` | string | false | DDN project subgraph name. |
| `source` | string | true | Connector Hub ID. |
| `context` | string | true | Path to the context directory. |
| `envFile` | string | false | Path to the shared .env file. |
| `envMapping` | [EnvMapping](#connector-envmapping) | false | Environment Variable mapping config. |
| `regionConfiguration` | [[RegionConfigurationV2](#connector-regionconfigurationv2)] | false | Connector deployment Region configuration |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `name` | string | true | Connector name. |
| `subgraph` | string | false | DDN project subgraph name. |
| `source` | string | true | Connector Hub ID. |
| `context` | string | true | Path to the context directory. |
| `envFile` | string | false | Path to the shared .env file. |
| `envMapping` | [EnvMapping](#connector-envmapping) | false | Environment Variable mapping config. |
| `regionConfiguration` | [[RegionConfigurationV2](#connector-regionconfigurationv2)] | false | Connector deployment Region configuration |
| `resources` | [Resources](#connector-resources) | false | Connector deployment Resources. |



#### RegionConfigurationV2 {#connector-regionconfigurationv2}

Connector deployment Region Configuration V2.

| Key | Value | Required | Description |
| ------------ | ----------------------------------- | -------- | ------------------------------------ |
| `region` | string | true | Region to deploy the connector to. |
| `mode` | `ReadOnly` / `ReadWrite` | true | Connector deployment mode. |
| `envMapping` | [EnvMapping](#connector-envmapping) | false | Environment Variable mapping config. |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `region` | string | true | Region to deploy the connector to. |
| `mode` | `ReadOnly` / `ReadWrite` | true | Connector deployment mode. |
| `envMapping` | [EnvMapping](#connector-envmapping) | false | Environment Variable mapping config. |
| `resources` | [Resources](#connector-resources) | false | Connector deployment Resources. |



#### Resources {#connector-resources}

Connector deployment Resources.

| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `memory` | string | false | Connector deployment memory resource in bytes. Accepted units: k, M, G. Example: 128M, 1G |
| `cpu` | string | false | Connector deployment cpu resource in cores. Example: 1, 1.5 |



#### EnvMapping {#connector-envmapping}

Environment Variables mapping config.

| Key | Value | Required | Description |
| ------------- | --------------------------------- | -------- | ---------------------------- |
| `<customKey>` | [EnvSource](#connector-envsource) | false | Target Environment variable. |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `<customKey>` | [EnvSource](#connector-envsource) | false | Target Environment variable. |



#### EnvSource {#connector-envsource}

Environment Variable Source.

| Key | Value | Required | Description |
| --------- | ------ | -------- | ---------------------------- |
| `fromEnv` | string | true | Source Environment variable. |
| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `fromEnv` | string | true | Source Environment variable. |
Loading

0 comments on commit 3b3729d

Please sign in to comment.