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

Add callout that external subschema approach is not prohibited. #19

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion spec/Section 1 -- Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ The GraphQL Composite Schemas specification has a number of design principles:
responsible for serving within the context of the larger schema, referencing
and extending that which is provided by other source schemas. The GraphQL
Composite Schemas specification does not describe how to combine arbitrary
schemas.
schemas.
Note: Tooling may be built to transform existing or external schemas into
Copy link
Member

Choose a reason for hiding this comment

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

spec-md does not support double-space forced newlines because Lee doesn't like that that's a feature of Markdown.

Also, I'm not sure this will work correctly as a "Note" callout under spec-md in this position? I'd have to render it with spec-md to be sure, but I think it would be better somewhere after the bulleted list?

Copy link
Contributor

Choose a reason for hiding this comment

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

It renders like this:

image

If you add an empty line before the note, you get:

image

Better, but ideally it would be indented.

compliant _source schemas_, but details of building such tooling is beyond the
scope of this specification.

- **Collaborative**: The GraphQL Composite Schemas specification is explicitly
designed around team collaboration. By building on a principled composition
Expand Down
Loading