apollo-router 2.13.1

A configurable, high-performance routing runtime for Apollo Federation 🚀
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

schema
    @link(url: "https://specs.apollo.dev/link/v1.0")
    @link(url: "https://specs.apollo.dev/join/v0.3", for: EXECUTION) {
    query: Query
}

directive @join__enumValue(graph: join__Graph!) repeatable on ENUM_VALUE

directive @join__field(
    graph: join__Graph
    requires: join__FieldSet
    provides: join__FieldSet
    type: String
    external: Boolean
    override: String
    usedOverridden: Boolean
) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION

directive @join__graph(name: String!, url: String!) on ENUM_VALUE

directive @join__implements(
    graph: join__Graph!
    interface: String!
) repeatable on OBJECT | INTERFACE

directive @join__type(
    graph: join__Graph!
    key: join__FieldSet
    extension: Boolean! = false
    resolvable: Boolean! = true
    isInterfaceObject: Boolean! = false
) repeatable on OBJECT | INTERFACE | UNION | ENUM | INPUT_OBJECT | SCALAR

directive @join__unionMember(
    graph: join__Graph!
    member: String!
) repeatable on UNION

directive @link(
    url: String
    as: String
    for: link__Purpose
    import: [link__Import]
) repeatable on SCHEMA

directive @join__directive(
    graphs: [join__Graph!]
    name: String!
    args: join__DirectiveArguments
) repeatable on SCHEMA | OBJECT | INTERFACE | FIELD_DEFINITION
scalar join__DirectiveArguments

scalar join__FieldSet

enum join__Graph {
    ACCOUNTS
        @join__graph(
            name: "accounts"
            url: "https://accounts.demo.starstuff.dev/"
        )
    INVENTORY
        @join__graph(
            name: "inventory"
            url: "https://inventory.demo.starstuff.dev/"
        )
    PRODUCTS
        @join__graph(
            name: "products"
            url: "https://products.demo.starstuff.dev/"
        )
    REVIEWS
        @join__graph(
            name: "reviews"
            url: "https://reviews.demo.starstuff.dev/"
        )
}

scalar link__Import

enum link__Purpose {
    SECURITY
    EXECUTION
}

type Product
    @join__type(graph: INVENTORY, key: "upc")
    @join__type(graph: PRODUCTS, key: "upc")
    @join__type(graph: REVIEWS, key: "upc")
    @join__directive(
        graphs: [PRODUCTS, INVENTORY, REVIEWS]
        name: "federation__cacheTag"
        args: { format: "product-{$key.upc}" }
    )
    @join__directive(
        graphs: [PRODUCTS, INVENTORY, REVIEWS]
        name: "federation__cacheTag"
        args: { format: "product" }
    ) {
    upc: String!
    weight: Int
        @join__field(graph: INVENTORY, external: true)
        @join__field(graph: PRODUCTS)
    price: Int
        @join__field(graph: INVENTORY, external: true)
        @join__field(graph: PRODUCTS)
    inStock: Boolean @join__field(graph: INVENTORY)
    shippingEstimate: Int
        @join__field(graph: INVENTORY, requires: "price weight")
    name: String @join__field(graph: PRODUCTS)
    reviews: [Review] @join__field(graph: REVIEWS)
}

type Query
    @join__type(graph: ACCOUNTS)
    @join__type(graph: INVENTORY)
    @join__type(graph: PRODUCTS)
    @join__type(graph: REVIEWS) {
    me: User @join__field(graph: ACCOUNTS)
    topProducts(first: Int = 5): [Product]
        @join__field(graph: PRODUCTS)
        @join__directive(
            graphs: [PRODUCTS]
            name: "federation__cacheTag"
            args: { format: "topProducts" }
        )
        @join__directive(
            graphs: [PRODUCTS]
            name: "federation__cacheTag"
            args: { format: "topProducts-{$args.first}" }
        )
}

type Review @join__type(graph: REVIEWS, key: "id") {
    id: ID!
    body: String
    author: User @join__field(graph: REVIEWS, provides: "username")
    product: Product @join__field(graph: REVIEWS)
}

type User
    @join__type(graph: ACCOUNTS, key: "id")
    @join__type(graph: REVIEWS, key: "id") {
    id: ID!
    name: String @join__field(graph: ACCOUNTS)
    username: String
        @join__field(graph: ACCOUNTS)
        @join__field(graph: REVIEWS, external: true)
    reviews: [Review] @join__field(graph: REVIEWS)
}