Skip to content

Commit

Permalink
Docs: Add new compatibility dates (#771)
Browse files Browse the repository at this point in the history
  • Loading branch information
rakeshkky authored Nov 20, 2024
1 parent 3fd882f commit ae3aa5c
Showing 1 changed file with 30 additions and 5 deletions.
35 changes: 30 additions & 5 deletions docs/supergraph-modeling/compatibility-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,41 @@ will be disabled. To enable these features, simply increase your `date` to a new
The following is a list of dates at which backwards-incompatible changes were added to Hasura DDN. Projects with
CompatibilityConfig `date`s prior to these dates will have these features disabled.

#### 2024-11-18

##### Disallow object boolean expression type

A build error is now raised if `ObjectBooleanExpressionType` is used to define a boolean expression. To resolve this,
you can upgrade all object boolean expression types in your metadata by running the following DDN codemod command.

```bash
ddn codemod upgrade-object-boolean-expression-types
```

Learn more about the [command here](cli/commands/ddn_codemod_upgrade-object-boolean-expression-types.mdx).

#### 2024-11-15

##### Require unique model GraphQL names

A build error is now raised if a root field defined in a `Model`'s GraphQL config conflicts with an existing root field.
Previously, the conflicting root field was silently excluded from the GraphQL schema.

##### Require a valid NDC version in data connector capabilities

A build error is now raised when there is an invalid version in the capabilities of a data connector's schema. To fix
the error, please consider upgrading to the latest version of the data connector and running `ddn connector introspect`
to correct the invalid version. Prior to this change, it was assumed that the data connector with the invalid version
was an NDC v0.1.x connector.

#### 2024-11-13

##### Allow resolving boolean expression fields without GraphQL config

Previously, comparable fields, relationships, and aggregate fields of a `BooleanExpressionType` were validated only if
the `graphql` field was configured in the metadata. These fields are now validated regardless of whether the `graphql`
configuration is specified.

#### 2024-10-31

##### Disallow comparisons against scalar array fields in predicates
Expand Down Expand Up @@ -103,12 +129,11 @@ metadata.

## Metadata structure


### v2_CompatibilityConfig {#v2_compatibilityconfig-v2_compatibilityconfig}

The compatibility configuration of the Hasura metadata.

| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `kind` | `CompatibilityConfig` | true | |
| `date` | string | true | Any backwards incompatible changes made to Hasura DDN after this date won't impact the metadata. |
| Key | Value | Required | Description |
| ------ | --------------------- | -------- | ------------------------------------------------------------------------------------------------ |
| `kind` | `CompatibilityConfig` | true | |
| `date` | string | true | Any backwards incompatible changes made to Hasura DDN after this date won't impact the metadata. |

0 comments on commit ae3aa5c

Please sign in to comment.