Skip to content

Commit 3b428a4

Browse files
committed
Fix Markdown issues and add markdownlint configuration
1 parent 4f24192 commit 3b428a4

File tree

5 files changed

+43
-25
lines changed

5 files changed

+43
-25
lines changed

.markdownlint.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# https://github.com/DavidAnson/markdownlint
2+
3+
# Multiple headings with the same content.
4+
MD024:
5+
siblings_only: true
6+
# Emphasis used instead of a heading.
7+
MD036: false

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
1+
# GraphQL Composite Schema Spec
2+
13
> **Stage 0: Preliminary**
24
>
35
> This spec is in the proposal stage of active development, and can change
46
> before reaching `Draft` stage. For more information, please see the
57
> [Roadmap](ROADMAP.md).
68
7-
---
8-
9-
# GraphQL Composite Schema Spec
10-
119
The GraphQL Composite Schema specification is edited in the markdown files found
1210
in [`/spec`](./spec) the latest release of which is published at
13-
https://graphql.github.io/composite-schemas-spec/.
11+
<https://graphql.github.io/composite-schemas-spec/>.
1412

15-
### Contributing to this repo
13+
## Contributing to this repo
1614

1715
See more in [CONTRIBUTING.md](CONTRIBUTING.md) about contributing spec changes.
1816
If you want to start a general discussion or concern, please
@@ -27,10 +25,8 @@ separate
2725

2826
---
2927

30-
Copyright Joint Development Foundation Projects, LLC, GraphQL Series.<br>
31-
[graphql.org](https://graphql.org) | [Spec](https://spec.graphql.org) |
32-
[GitHub](https://github.com/graphql/composite-schemas-spec) |
33-
[GraphQL Foundation](https://foundation.graphql.org) |
34-
[Code of Conduct](https://code-of-conduct.graphql.org) |
35-
[Discord](https://discord.com/channels/625400653321076807/863141924126588958) |
28+
Copyright Joint Development Foundation Projects, LLC, GraphQL Series. \
29+
[graphql.org](https://graphql.org) | [Spec](https://spec.graphql.org) | [GitHub](https://github.com/graphql/composite-schemas-spec)
30+
| [GraphQL Foundation](https://foundation.graphql.org) | [Code of Conduct](https://code-of-conduct.graphql.org)
31+
| [Discord](https://discord.com/channels/625400653321076807/863141924126588958) |
3632
[Store](https://store.graphql.org)

spec/Section 2 -- Source Schema.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,18 @@ type Product {
236236
## @inaccessible
237237

238238
```graphql
239-
directive @inaccessible on FIELD_DEFINITION | OBJECT | INTERFACE | UNION | ARGUMENT_DEFINITION | SCALAR | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
239+
# prettier-ignore
240+
directive @inaccessible on
241+
| FIELD_DEFINITION
242+
| OBJECT
243+
| INTERFACE
244+
| UNION
245+
| ARGUMENT_DEFINITION
246+
| SCALAR
247+
| ENUM
248+
| ENUM_VALUE
249+
| INPUT_OBJECT
250+
| INPUT_FIELD_DEFINITION
240251
```
241252

242253
The `@inaccessible` directive is used to prevent specific type system members

spec/Section 4 -- Composition.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3637,7 +3637,7 @@ MergeTypes(types):
36373637
- If {kind} is `OBJECT`:
36383638
- Return the result of {MergeObjectTypes(types)}.
36393639

3640-
#### Merge Scalar Types
3640+
### Merge Scalar Types
36413641

36423642
**Formal Specification**
36433643

@@ -3693,7 +3693,7 @@ scalar Date
36933693
scalar Date
36943694
```
36953695

3696-
#### Merge Interface Types
3696+
### Merge Interface Types
36973697

36983698
**Formal Specification**
36993699

@@ -3812,7 +3812,7 @@ interface Product {
38123812
}
38133813
```
38143814

3815-
#### Merge Enum Types
3815+
### Merge Enum Types
38163816

38173817
**Formal Specification**
38183818

@@ -3930,7 +3930,7 @@ enum Status {
39303930
}
39313931
```
39323932

3933-
#### Merge Union Types
3933+
### Merge Union Types
39343934

39353935
**Formal Specification**
39363936

@@ -4027,7 +4027,7 @@ In this case, the `Product` type is marked with `@inaccessible` in the first
40274027
schema. As a result, the `Product` type is excluded from the composed
40284028
`SearchResult`
40294029

4030-
#### Merge Input Types
4030+
### Merge Input Types
40314031

40324032
**Formal Specification**
40334033

@@ -4160,7 +4160,7 @@ input OrderInput {
41604160
In this case, the description from the first schema is retained, while the
41614161
fields are merged from both schemas to create the final `OrderInput` type.
41624162

4163-
#### Merge Object Types
4163+
### Merge Object Types
41644164

41654165
**Formal Specification**
41664166

@@ -4317,7 +4317,7 @@ type Product {
43174317
}
43184318
```
43194319

4320-
#### Merge Output Fields
4320+
### Merge Output Fields
43214321

43224322
**Formal Specification**
43234323

@@ -4497,7 +4497,7 @@ type Product {
44974497
}
44984498
```
44994499

4500-
#### Merge Input Fields
4500+
### Merge Input Fields
45014501

45024502
**Formal Specification**
45034503

@@ -4594,7 +4594,7 @@ In the final schema, `minTotal` is defined using the most restrictive type
45944594
(`Int!`), has a default value of `0`, and includes the description from the
45954595
original field in `Schema A`.
45964596

4597-
#### Merge Argument Definitions
4597+
### Merge Argument Definitions
45984598

45994599
**Formal Specification**
46004600

@@ -4690,7 +4690,7 @@ In the merged schema, the `filter` argument is defined with the most restrictive
46904690
type (`ProductFilter!`), includes the description from the original field in
46914691
`Schema A`, and is marked as required.
46924692

4693-
#### Merge Arguments
4693+
### Merge Arguments
46944694

46954695
**Formal Specification**
46964696

spec/Spec.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ ecosystem.
2121
The GraphQL Specification Project has evolved and may continue to evolve in
2222
future editions of this specification. Previous editions of the GraphQL
2323
specification can be found at permalinks that match their release tag. The
24-
latest working draft release can be found at https://spec.graphql.org/draft.
24+
latest working draft release can be found at <https://spec.graphql.org/draft>.
2525

2626
**Copyright notice**
2727

@@ -82,9 +82,11 @@ explicitly in prose (e.g. "Note: ") or are set apart in a note block, like this:
8282

8383
Note: This is an example of a non-normative note.
8484

85+
<!-- markdownlint-disable MD025 -->
86+
8587
# [Overview](Section%201%20--%20Overview.md)
8688

87-
# [Subgraph](Section%202%20--%20Source%20Schema.md)
89+
# [Source Schema](Section%202%20--%20Source%20Schema.md)
8890

8991
# [Composition](Section%204%20--%20Composition.md)
9092

@@ -93,3 +95,5 @@ Note: This is an example of a non-normative note.
9395
# [Shared Types](Section%206%20--%20Shared%20Types.md)
9496

9597
# [Appendix A -- Field Selection](Appendix%20A%20--%20Field%20Selection.md)
98+
99+
<!-- markdownlint-enable MD025 -->

0 commit comments

Comments
 (0)