Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs for subscription callback plugin #7666

Merged
merged 13 commits into from
Aug 1, 2023
Merged

Conversation

trevor-scheer
Copy link
Member

No description provided.

@trevor-scheer trevor-scheer requested a review from a team July 28, 2023 18:36
@trevor-scheer trevor-scheer requested review from a team and glasser as code owners July 28, 2023 18:36
@netlify
Copy link

netlify bot commented Jul 28, 2023

Deploy Preview for apollo-server-docs ready!

Name Link
🔨 Latest commit 5df34de
🔍 Latest deploy log https://app.netlify.com/sites/apollo-server-docs/deploys/64c9506fe079d60008a50c55
😎 Deploy Preview https://deploy-preview-7666--apollo-server-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codesandbox-ci
Copy link

codesandbox-ci bot commented Jul 28, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 5df34de:

Sandbox Source
Apollo Server Typescript Configuration
Apollo Server Configuration

Copy link
Contributor

@Meschreiber Meschreiber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of nits, but otherwise LGTM!

Also makes me think it would be nice to display parameter/options defaults prominently if they exist. (E.g. below an option's type.) Taking a note of it...

docs/source/api/plugin/subscription-callback.mdx Outdated Show resolved Hide resolved
docs/source/api/plugin/subscription-callback.mdx Outdated Show resolved Hide resolved
docs/source/api/plugin/subscription-callback.mdx Outdated Show resolved Hide resolved
docs/source/api/plugin/subscription-callback.mdx Outdated Show resolved Hide resolved
docs/source/api/plugin/subscription-callback.mdx Outdated Show resolved Hide resolved
docs/source/api/plugin/subscription-callback.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@Meschreiber Meschreiber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One last nit, but approved on my end!

minVersion: 4.9.0
---

> This document covers the usage of the Subscription callback plugin for use in Apollo Federation with Apollo Router. For more information about the protocol itself, see the [subscription callback protocol](/router/executing-operations/subscription-callback-protocol).
Copy link
Contributor

@Meschreiber Meschreiber Jul 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is getting wrapped so it looks a little funky:
image

Might be easier to just wrap the whole thing in a <blockquote>. (That's generally what I do for multi-line callouts.)

@trevor-scheer trevor-scheer enabled auto-merge (squash) August 1, 2023 18:37
@trevor-scheer trevor-scheer merged commit 159d73c into main Aug 1, 2023
@trevor-scheer trevor-scheer deleted the trevor/subs-plugin-docs branch August 1, 2023 18:37
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants