diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md index d4c88aa068..5e3fafa099 100644 --- a/packages/core/CHANGELOG.md +++ b/packages/core/CHANGELOG.md @@ -90,20 +90,20 @@ ```ts export type FieldDescriptionChangedChange = { - type: ChangeType.FieldDescriptionChanged; + type: ChangeType.FieldDescriptionChanged meta: { - typeName: string; - fieldName: string; - oldDescription: string; - newDescription: string; - }; - }; + typeName: string + fieldName: string + oldDescription: string + newDescription: string + } + } ``` You can construct the full `Change` object from the `type` and `meta` properties. ```ts - import { ChangeType, fieldDescriptionChangedFromMeta } from '@graphql-inspector/core'; + import { ChangeType, fieldDescriptionChangedFromMeta } from '@graphql-inspector/core' console.log( fieldDescriptionChangedFromMeta({ @@ -112,10 +112,10 @@ typeName: 'Foo', fieldName: 'bar', oldDescription: 'This is the old description', - newDescription: 'This is the new description', - }, - }), - ); + newDescription: 'This is the new description' + } + }) + ) ``` console.log output: diff --git a/website/src/pages/docs/commands/diff.mdx b/website/src/pages/docs/commands/diff.mdx index 5ff5e26f75..477090114f 100644 --- a/website/src/pages/docs/commands/diff.mdx +++ b/website/src/pages/docs/commands/diff.mdx @@ -22,7 +22,7 @@ Integrate it with GitHub, BitBucket, GitLab or any Continuous Integration. | [GitHub Application](../products/github) | Install our GitHub Application to check Pull Requests and commits. | | [GitHub Action](../products/action) | Use our GitHub Action in few steps. | | [CI](../products/ci) | GraphQL Inspector offers a version of our CLI that is better suited for Continuous Integrations. Learn more how to use it. | -| [CLI](../installation#cli) | GraphQL Inspector CLI is a simple tool to work with GraphQL schemas. | +| [CLI](../installation#cli) | GraphQL Inspector CLI is a simple tool to work with GraphQL schemas. | ## Diff - Usage