Skip to content

Commit

Permalink
Update define-advanced-keys.mdx (#3098)
Browse files Browse the repository at this point in the history
This PR is for a very minor grammatical correction in the docs verbiage.

<!--
First, 🌠 thank you 🌠 for taking the time to consider a contribution to
Apollo!

Here are some important details to follow:

* ⏰ Your time is important
To save your precious time, if the contribution you are making will
take more than an hour, please make sure it has been discussed in an
        issue first. This is especially true for feature requests!

* 💡 Features
Feature requests can be created and discussed within a GitHub Issue.
Be sure to search for existing feature requests (and related issues!)
prior to opening a new request. If an existing issue covers the need,
please upvote that issue by using the 👍 emote, rather than opening a
        new issue.

* 🕷 Bug fixes
These can be created and discussed in this repository. When fixing a
bug,
please _try_ to add a test which verifies the fix. If you cannot, you
should
still submit the PR but we may still ask you (and help you!) to create a
test.

* Federation versions
Please make sure you're targeting the federation version you're opening
the PR for. Federation 2 (alpha) is currently located on the `main`
branch and prior versions of Federation live on the `version-0.x`
branch.

* 📖 Contribution guidelines
Follow
https://github.com/apollographql/federation/blob/HEAD/CONTRIBUTING.md
when submitting a pull request. Make sure existing tests still pass, and
add
        tests for all new behavior.

* ✏️ Explain your pull request
Describe the big picture of your changes here to communicate to what
        your pull request is meant to accomplish. Provide 🔗 links 🔗 to
        associated issues!

We hope you will find this to be a positive experience! Open source
contribution can be intimidating and we hope to alleviate that pain as
much
as possible. Without following these guidelines, you may be missing
context
that can help you succeed with your contribution, which is why we
encourage
discussion first. Ultimately, there is no guarantee that we will be able
to
merge your pull-request, but by following these guidelines we can try to
avoid disappointment.

-->
  • Loading branch information
torressam333 authored Jul 25, 2024
1 parent 6c0f5f2 commit 2d53217
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/entities/define-advanced-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Learn how to define compound keys, nested key fields, and multiple

Depending on your entities' fields and usage, you may need to use more advanced `@key`s.
For example, you may need to define a [compound `@key`](#compound-keys) if multiple fields are required to uniquely identify an entity.
If different subgraphs interact with different fields an entity, you may need to define [multiple](#multiple-keys)&mdash;and sometimes [differing](#differing-keys-across-subgraphs)&mdash;`@key`s for the entity.
If different subgraphs interact with different fields of an entity, you may need to define [multiple](#multiple-keys)&mdash;and sometimes [differing](#differing-keys-across-subgraphs)&mdash;`@key`s for the entity.

## Compound `@key`s

Expand Down Expand Up @@ -242,4 +242,4 @@ type Query {

## Next steps

If you haven't already, learn how to [contribute entity fields](./contribute-fields) to the supergraph and [reference them](./contribute-fields#referencing-an-entity-without-contributing-fields) from subgraphs that don't contribute any fields.
If you haven't already, learn how to [contribute entity fields](./contribute-fields) to the supergraph and [reference them](./contribute-fields#referencing-an-entity-without-contributing-fields) from subgraphs that don't contribute any fields.

0 comments on commit 2d53217

Please sign in to comment.