1 | {
|
2 | "definitions": {
|
3 | "Cache": {
|
4 | "additionalProperties": true,
|
5 | "type": "object",
|
6 | "title": "Cache",
|
7 | "properties": {
|
8 | "file": {
|
9 | "$ref": "#/definitions/FileCacheConfig"
|
10 | },
|
11 | "inmemoryLRU": {
|
12 | "$ref": "#/definitions/InMemoryLRUConfig"
|
13 | },
|
14 | "localforage": {
|
15 | "$ref": "#/definitions/LocalforageConfig"
|
16 | },
|
17 | "redis": {
|
18 | "$ref": "#/definitions/RedisConfig"
|
19 | }
|
20 | }
|
21 | },
|
22 | "FileCacheConfig": {
|
23 | "additionalProperties": false,
|
24 | "type": "object",
|
25 | "title": "FileCacheConfig",
|
26 | "properties": {
|
27 | "path": {
|
28 | "type": "string"
|
29 | }
|
30 | }
|
31 | },
|
32 | "InMemoryLRUConfig": {
|
33 | "additionalProperties": false,
|
34 | "type": "object",
|
35 | "title": "InMemoryLRUConfig",
|
36 | "properties": {
|
37 | "max": {
|
38 | "type": "integer"
|
39 | }
|
40 | }
|
41 | },
|
42 | "LocalforageConfig": {
|
43 | "additionalProperties": false,
|
44 | "type": "object",
|
45 | "title": "LocalforageConfig",
|
46 | "properties": {
|
47 | "driver": {
|
48 | "type": "array",
|
49 | "items": {
|
50 | "type": "string",
|
51 | "enum": ["WEBSQL", "INDEXEDDB", "LOCALSTORAGE"],
|
52 | "description": "Allowed values: WEBSQL, INDEXEDDB, LOCALSTORAGE"
|
53 | },
|
54 | "additionalItems": false,
|
55 | "description": "Allowed values: WEBSQL, INDEXEDDB, LOCALSTORAGE"
|
56 | },
|
57 | "name": {
|
58 | "type": "string"
|
59 | },
|
60 | "version": {
|
61 | "type": "number"
|
62 | },
|
63 | "size": {
|
64 | "type": "integer"
|
65 | },
|
66 | "storeName": {
|
67 | "type": "string"
|
68 | },
|
69 | "description": {
|
70 | "type": "string"
|
71 | }
|
72 | }
|
73 | },
|
74 | "RedisConfig": {
|
75 | "additionalProperties": false,
|
76 | "type": "object",
|
77 | "title": "RedisConfig",
|
78 | "properties": {
|
79 | "host": {
|
80 | "type": "string"
|
81 | },
|
82 | "port": {
|
83 | "type": "integer"
|
84 | },
|
85 | "password": {
|
86 | "type": "string"
|
87 | }
|
88 | }
|
89 | },
|
90 | "ServeConfig": {
|
91 | "additionalProperties": false,
|
92 | "type": "object",
|
93 | "title": "ServeConfig",
|
94 | "properties": {
|
95 | "fork": {
|
96 | "description": "Spawn multiple server instances as node clusters (default: `1`) (Any of: Int, Boolean)",
|
97 | "anyOf": [
|
98 | {
|
99 | "type": "integer"
|
100 | },
|
101 | {
|
102 | "type": "boolean"
|
103 | }
|
104 | ]
|
105 | },
|
106 | "port": {
|
107 | "description": "TCP Port to listen (default: `3000`) (Any of: Int, String)",
|
108 | "anyOf": [
|
109 | {
|
110 | "type": "integer"
|
111 | },
|
112 | {
|
113 | "type": "string"
|
114 | }
|
115 | ]
|
116 | },
|
117 | "exampleQuery": {
|
118 | "type": "string",
|
119 | "description": "Provide an example query or queries for GraphQL Playground"
|
120 | },
|
121 | "cors": {
|
122 | "$ref": "#/definitions/CorsConfig"
|
123 | },
|
124 | "handlers": {
|
125 | "type": "array",
|
126 | "items": {
|
127 | "description": "Any of: WebhookHandler, ExpressHandler",
|
128 | "anyOf": [
|
129 | {
|
130 | "$ref": "#/definitions/WebhookHandler"
|
131 | },
|
132 | {
|
133 | "$ref": "#/definitions/ExpressHandler"
|
134 | }
|
135 | ]
|
136 | },
|
137 | "additionalItems": false,
|
138 | "description": "Any of: WebhookHandler, ExpressHandler"
|
139 | },
|
140 | "staticFiles": {
|
141 | "type": "string"
|
142 | }
|
143 | }
|
144 | },
|
145 | "CorsConfig": {
|
146 | "additionalProperties": false,
|
147 | "type": "object",
|
148 | "title": "CorsConfig",
|
149 | "properties": {
|
150 | "origin": {
|
151 | "type": "array",
|
152 | "items": {
|
153 | "type": "string"
|
154 | },
|
155 | "additionalItems": false
|
156 | },
|
157 | "allowedHeaders": {
|
158 | "type": "array",
|
159 | "items": {
|
160 | "type": "string"
|
161 | },
|
162 | "additionalItems": false
|
163 | },
|
164 | "exposedHeaders": {
|
165 | "type": "array",
|
166 | "items": {
|
167 | "type": "string"
|
168 | },
|
169 | "additionalItems": false
|
170 | },
|
171 | "credentials": {
|
172 | "type": "boolean"
|
173 | },
|
174 | "maxAge": {
|
175 | "type": "integer"
|
176 | },
|
177 | "preflightContinue": {
|
178 | "type": "boolean"
|
179 | },
|
180 | "optionsSuccessStatus": {
|
181 | "type": "integer"
|
182 | }
|
183 | }
|
184 | },
|
185 | "ExpressHandler": {
|
186 | "additionalProperties": false,
|
187 | "type": "object",
|
188 | "title": "ExpressHandler",
|
189 | "properties": {
|
190 | "path": {
|
191 | "type": "string"
|
192 | },
|
193 | "handler": {
|
194 | "type": "string"
|
195 | },
|
196 | "method": {
|
197 | "type": "string",
|
198 | "enum": ["GET", "POST", "DELETE", "PATCH"],
|
199 | "description": "Allowed values: GET, POST, DELETE, PATCH"
|
200 | }
|
201 | },
|
202 | "required": ["path", "handler"]
|
203 | },
|
204 | "WebhookHandler": {
|
205 | "additionalProperties": false,
|
206 | "type": "object",
|
207 | "title": "WebhookHandler",
|
208 | "properties": {
|
209 | "path": {
|
210 | "type": "string"
|
211 | },
|
212 | "pubsubTopic": {
|
213 | "type": "string"
|
214 | },
|
215 | "payload": {
|
216 | "type": "string"
|
217 | }
|
218 | },
|
219 | "required": ["path", "pubsubTopic"]
|
220 | },
|
221 | "Source": {
|
222 | "additionalProperties": false,
|
223 | "type": "object",
|
224 | "title": "Source",
|
225 | "properties": {
|
226 | "name": {
|
227 | "type": "string",
|
228 | "description": "The name you wish to set to your remote API, this will be used for building the GraphQL context"
|
229 | },
|
230 | "handler": {
|
231 | "$ref": "#/definitions/Handler",
|
232 | "description": "Point to the handler you wish to use, it can either be a predefined handler, or a custom"
|
233 | },
|
234 | "transforms": {
|
235 | "type": "array",
|
236 | "items": {
|
237 | "$ref": "#/definitions/Transform"
|
238 | },
|
239 | "additionalItems": false,
|
240 | "description": "List of transforms to apply to the current API source, before unifying it with the rest of the sources"
|
241 | }
|
242 | },
|
243 | "required": ["name", "handler"]
|
244 | },
|
245 | "Transform": {
|
246 | "additionalProperties": true,
|
247 | "type": "object",
|
248 | "title": "Transform",
|
249 | "properties": {
|
250 | "cache": {
|
251 | "type": "array",
|
252 | "items": {
|
253 | "$ref": "#/definitions/CacheTransformConfig"
|
254 | },
|
255 | "additionalItems": false,
|
256 | "description": "Transformer to apply caching for your data sources"
|
257 | },
|
258 | "federation": {
|
259 | "$ref": "#/definitions/FederationTransform"
|
260 | },
|
261 | "filterSchema": {
|
262 | "type": "array",
|
263 | "items": {
|
264 | "type": "string"
|
265 | },
|
266 | "additionalItems": false
|
267 | },
|
268 | "mock": {
|
269 | "$ref": "#/definitions/MockingConfig",
|
270 | "description": "Mock configuration for your source"
|
271 | },
|
272 | "namingConvention": {
|
273 | "$ref": "#/definitions/NamingConventionTransformConfig",
|
274 | "description": "Transformer to apply naming convention to GraphQL Types"
|
275 | },
|
276 | "prefix": {
|
277 | "$ref": "#/definitions/PrefixTransformConfig",
|
278 | "description": "Prefix transform"
|
279 | },
|
280 | "rename": {
|
281 | "type": "array",
|
282 | "items": {
|
283 | "$ref": "#/definitions/RenameTransformObject"
|
284 | },
|
285 | "additionalItems": false,
|
286 | "description": "Transformer to apply rename of a GraphQL type"
|
287 | },
|
288 | "resolversComposition": {
|
289 | "type": "array",
|
290 | "items": {
|
291 | "$ref": "#/definitions/ResolversCompositionTransformObject"
|
292 | },
|
293 | "additionalItems": false,
|
294 | "description": "Transformer to apply composition to resolvers"
|
295 | },
|
296 | "snapshot": {
|
297 | "$ref": "#/definitions/SnapshotTransformConfig",
|
298 | "description": "Configuration for Snapshot extension"
|
299 | }
|
300 | }
|
301 | },
|
302 | "Handler": {
|
303 | "additionalProperties": true,
|
304 | "type": "object",
|
305 | "title": "Handler",
|
306 | "properties": {
|
307 | "graphql": {
|
308 | "$ref": "#/definitions/GraphQLHandler",
|
309 | "description": "Handler for remote/local/third-party GraphQL schema"
|
310 | },
|
311 | "grpc": {
|
312 | "$ref": "#/definitions/GrpcHandler",
|
313 | "description": "Handler for gRPC and Protobuf schemas"
|
314 | },
|
315 | "jsonSchema": {
|
316 | "$ref": "#/definitions/JsonSchemaHandler",
|
317 | "description": "Handler for JSON Schema specification. Source could be a local json file, or a url to it."
|
318 | },
|
319 | "mongoose": {
|
320 | "$ref": "#/definitions/MongooseHandler"
|
321 | },
|
322 | "mysql": {
|
323 | "$ref": "#/definitions/MySQLHandler"
|
324 | },
|
325 | "neo4j": {
|
326 | "$ref": "#/definitions/Neo4jHandler",
|
327 | "description": "Handler for Neo4j"
|
328 | },
|
329 | "odata": {
|
330 | "$ref": "#/definitions/ODataHandler",
|
331 | "description": "Handler for OData"
|
332 | },
|
333 | "openapi": {
|
334 | "$ref": "#/definitions/OpenapiHandler",
|
335 | "description": "Handler for Swagger / OpenAPI 2/3 specification. Source could be a local json/swagger file, or a url to it."
|
336 | },
|
337 | "postgraphile": {
|
338 | "$ref": "#/definitions/PostGraphileHandler",
|
339 | "description": "Handler for Postgres database, based on `postgraphile`"
|
340 | },
|
341 | "soap": {
|
342 | "$ref": "#/definitions/SoapHandler",
|
343 | "description": "Handler for SOAP"
|
344 | },
|
345 | "thrift": {
|
346 | "$ref": "#/definitions/ThriftHandler",
|
347 | "description": "Handler for OData"
|
348 | },
|
349 | "tuql": {
|
350 | "$ref": "#/definitions/TuqlHandler",
|
351 | "description": "Handler for SQLite database, based on `tuql`"
|
352 | }
|
353 | }
|
354 | },
|
355 | "AdditionalStitchingResolverObject": {
|
356 | "additionalProperties": false,
|
357 | "type": "object",
|
358 | "title": "AdditionalStitchingResolverObject",
|
359 | "properties": {
|
360 | "type": {
|
361 | "type": "string"
|
362 | },
|
363 | "field": {
|
364 | "type": "string"
|
365 | },
|
366 | "requiredSelectionSet": {
|
367 | "type": "string"
|
368 | },
|
369 | "targetSource": {
|
370 | "type": "string"
|
371 | },
|
372 | "targetMethod": {
|
373 | "type": "string"
|
374 | },
|
375 | "args": {
|
376 | "type": "object",
|
377 | "properties": {}
|
378 | },
|
379 | "returnData": {
|
380 | "type": "string"
|
381 | },
|
382 | "resultSelectedFields": {
|
383 | "type": "object",
|
384 | "properties": {}
|
385 | },
|
386 | "resultSelectionSet": {
|
387 | "type": "string"
|
388 | },
|
389 | "resultDepth": {
|
390 | "type": "integer"
|
391 | }
|
392 | },
|
393 | "required": ["type", "field", "targetSource", "targetMethod"]
|
394 | },
|
395 | "AdditionalSubscriptionObject": {
|
396 | "additionalProperties": false,
|
397 | "type": "object",
|
398 | "title": "AdditionalSubscriptionObject",
|
399 | "properties": {
|
400 | "type": {
|
401 | "type": "string"
|
402 | },
|
403 | "field": {
|
404 | "type": "string"
|
405 | },
|
406 | "pubsubTopic": {
|
407 | "type": "string"
|
408 | },
|
409 | "returnData": {
|
410 | "type": "string"
|
411 | },
|
412 | "filterBy": {
|
413 | "type": "string"
|
414 | }
|
415 | },
|
416 | "required": ["type", "field", "pubsubTopic"]
|
417 | },
|
418 | "PubSubConfig": {
|
419 | "additionalProperties": false,
|
420 | "type": "object",
|
421 | "title": "PubSubConfig",
|
422 | "properties": {
|
423 | "name": {
|
424 | "type": "string"
|
425 | },
|
426 | "config": {
|
427 | "anyOf": [
|
428 | {
|
429 | "type": "object",
|
430 | "additionalProperties": true
|
431 | },
|
432 | {
|
433 | "type": "string"
|
434 | }
|
435 | ]
|
436 | }
|
437 | },
|
438 | "required": ["name"]
|
439 | },
|
440 | "GraphQLHandler": {
|
441 | "additionalProperties": false,
|
442 | "type": "object",
|
443 | "title": "GraphQLHandler",
|
444 | "properties": {
|
445 | "endpoint": {
|
446 | "type": "string",
|
447 | "description": "A url to your remote GraphQL endpoint"
|
448 | },
|
449 | "schemaHeaders": {
|
450 | "type": "object",
|
451 | "properties": {},
|
452 | "description": "JSON object representing the Headers to add to the runtime of the API calls only for schema introspection"
|
453 | },
|
454 | "operationHeaders": {
|
455 | "type": "object",
|
456 | "properties": {},
|
457 | "description": "JSON object representing the Headers to add to the runtime of the API calls only for operation during runtime"
|
458 | },
|
459 | "useGETForQueries": {
|
460 | "type": "boolean",
|
461 | "description": "Use HTTP GET for Query operations"
|
462 | },
|
463 | "method": {
|
464 | "type": "string",
|
465 | "enum": ["GET", "POST"],
|
466 | "description": "HTTP method used for GraphQL operations (Allowed values: GET, POST)"
|
467 | },
|
468 | "enableSubscriptions": {
|
469 | "type": "boolean",
|
470 | "description": "Enable GraphQL Subscriptions using WebSocket"
|
471 | },
|
472 | "customFetch": {
|
473 | "anyOf": [
|
474 | {
|
475 | "type": "object",
|
476 | "additionalProperties": true
|
477 | },
|
478 | {
|
479 | "type": "string"
|
480 | }
|
481 | ],
|
482 | "description": "Path to a custom W3 Compatible Fetch Implementation"
|
483 | },
|
484 | "webSocketImpl": {
|
485 | "type": "string",
|
486 | "description": "Path to a custom W3 Compatible WebSocket Implementation"
|
487 | },
|
488 | "introspection": {
|
489 | "type": "string",
|
490 | "description": "Path to the introspection\nYou can seperately give schema introspection"
|
491 | },
|
492 | "cacheIntrospection": {
|
493 | "description": "Cache Introspection (Any of: GraphQLIntrospectionCachingOptions, Boolean)",
|
494 | "anyOf": [
|
495 | {
|
496 | "$ref": "#/definitions/GraphQLIntrospectionCachingOptions"
|
497 | },
|
498 | {
|
499 | "type": "boolean"
|
500 | }
|
501 | ]
|
502 | }
|
503 | },
|
504 | "required": ["endpoint"]
|
505 | },
|
506 | "GraphQLIntrospectionCachingOptions": {
|
507 | "additionalProperties": false,
|
508 | "type": "object",
|
509 | "title": "GraphQLIntrospectionCachingOptions",
|
510 | "properties": {
|
511 | "ttl": {
|
512 | "type": "integer",
|
513 | "description": "Time to live of introspection cache"
|
514 | },
|
515 | "path": {
|
516 | "type": "string",
|
517 | "description": "Path to Introspection JSON File"
|
518 | }
|
519 | }
|
520 | },
|
521 | "GrpcHandler": {
|
522 | "additionalProperties": false,
|
523 | "type": "object",
|
524 | "title": "GrpcHandler",
|
525 | "properties": {
|
526 | "endpoint": {
|
527 | "type": "string",
|
528 | "description": "gRPC Endpoint"
|
529 | },
|
530 | "protoFilePath": {
|
531 | "description": "gRPC Proto file that contains your protobuf schema (Any of: ProtoFilePath, String)",
|
532 | "anyOf": [
|
533 | {
|
534 | "$ref": "#/definitions/ProtoFilePath"
|
535 | },
|
536 | {
|
537 | "type": "string"
|
538 | }
|
539 | ]
|
540 | },
|
541 | "serviceName": {
|
542 | "type": "string",
|
543 | "description": "Your base service name\nUsed for naming only"
|
544 | },
|
545 | "packageName": {
|
546 | "type": "string",
|
547 | "description": "Your base package name\nUsed for naming only"
|
548 | },
|
549 | "requestTimeout": {
|
550 | "type": "integer",
|
551 | "description": "Request timeout in milliseconds\nDefault: 200000"
|
552 | },
|
553 | "credentialsSsl": {
|
554 | "$ref": "#/definitions/GrpcCredentialsSsl",
|
555 | "description": "SSL Credentials"
|
556 | },
|
557 | "useHTTPS": {
|
558 | "type": "boolean",
|
559 | "description": "Use https instead of http for gRPC connection"
|
560 | },
|
561 | "metaData": {
|
562 | "type": "object",
|
563 | "properties": {},
|
564 | "description": "MetaData"
|
565 | }
|
566 | },
|
567 | "required": ["endpoint", "protoFilePath"]
|
568 | },
|
569 | "LoadOptions": {
|
570 | "additionalProperties": false,
|
571 | "type": "object",
|
572 | "title": "LoadOptions",
|
573 | "properties": {
|
574 | "includeDirs": {
|
575 | "type": "array",
|
576 | "items": {
|
577 | "type": "string"
|
578 | },
|
579 | "additionalItems": false
|
580 | }
|
581 | }
|
582 | },
|
583 | "ProtoFilePath": {
|
584 | "additionalProperties": false,
|
585 | "type": "object",
|
586 | "title": "ProtoFilePath",
|
587 | "properties": {
|
588 | "file": {
|
589 | "type": "string"
|
590 | },
|
591 | "load": {
|
592 | "$ref": "#/definitions/LoadOptions"
|
593 | }
|
594 | },
|
595 | "required": ["file"]
|
596 | },
|
597 | "GrpcCredentialsSsl": {
|
598 | "additionalProperties": false,
|
599 | "type": "object",
|
600 | "title": "GrpcCredentialsSsl",
|
601 | "properties": {
|
602 | "rootCA": {
|
603 | "type": "string"
|
604 | },
|
605 | "certChain": {
|
606 | "type": "string"
|
607 | },
|
608 | "privateKey": {
|
609 | "type": "string"
|
610 | }
|
611 | }
|
612 | },
|
613 | "JsonSchemaHandler": {
|
614 | "additionalProperties": false,
|
615 | "type": "object",
|
616 | "title": "JsonSchemaHandler",
|
617 | "properties": {
|
618 | "baseUrl": {
|
619 | "type": "string"
|
620 | },
|
621 | "operationHeaders": {
|
622 | "type": "object",
|
623 | "properties": {}
|
624 | },
|
625 | "schemaHeaders": {
|
626 | "type": "object",
|
627 | "properties": {}
|
628 | },
|
629 | "operations": {
|
630 | "type": "array",
|
631 | "items": {
|
632 | "$ref": "#/definitions/JsonSchemaOperation"
|
633 | },
|
634 | "additionalItems": false
|
635 | },
|
636 | "disableTimestampScalar": {
|
637 | "type": "boolean"
|
638 | },
|
639 | "baseSchema": {
|
640 | "anyOf": [
|
641 | {
|
642 | "type": "object",
|
643 | "additionalProperties": true
|
644 | },
|
645 | {
|
646 | "type": "string"
|
647 | }
|
648 | ]
|
649 | }
|
650 | },
|
651 | "required": ["baseUrl", "operations"]
|
652 | },
|
653 | "JsonSchemaOperation": {
|
654 | "additionalProperties": false,
|
655 | "type": "object",
|
656 | "title": "JsonSchemaOperation",
|
657 | "properties": {
|
658 | "field": {
|
659 | "type": "string"
|
660 | },
|
661 | "path": {
|
662 | "type": "string"
|
663 | },
|
664 | "pubsubTopic": {
|
665 | "type": "string"
|
666 | },
|
667 | "description": {
|
668 | "type": "string"
|
669 | },
|
670 | "type": {
|
671 | "type": "string",
|
672 | "enum": ["Query", "Mutation", "Subscription"],
|
673 | "description": "Allowed values: Query, Mutation, Subscription"
|
674 | },
|
675 | "method": {
|
676 | "type": "string",
|
677 | "enum": ["GET", "DELETE", "POST", "PUT", "PATCH"],
|
678 | "description": "Allowed values: GET, DELETE, POST, PUT, PATCH"
|
679 | },
|
680 | "requestSchema": {
|
681 | "anyOf": [
|
682 | {
|
683 | "type": "object",
|
684 | "additionalProperties": true
|
685 | },
|
686 | {
|
687 | "type": "string"
|
688 | }
|
689 | ]
|
690 | },
|
691 | "requestSample": {
|
692 | "anyOf": [
|
693 | {
|
694 | "type": "object",
|
695 | "additionalProperties": true
|
696 | },
|
697 | {
|
698 | "type": "string"
|
699 | }
|
700 | ]
|
701 | },
|
702 | "requestTypeName": {
|
703 | "type": "string"
|
704 | },
|
705 | "responseSample": {
|
706 | "anyOf": [
|
707 | {
|
708 | "type": "object",
|
709 | "additionalProperties": true
|
710 | },
|
711 | {
|
712 | "type": "string"
|
713 | }
|
714 | ]
|
715 | },
|
716 | "responseSchema": {
|
717 | "anyOf": [
|
718 | {
|
719 | "type": "object",
|
720 | "additionalProperties": true
|
721 | },
|
722 | {
|
723 | "type": "string"
|
724 | }
|
725 | ]
|
726 | },
|
727 | "responseTypeName": {
|
728 | "type": "string"
|
729 | },
|
730 | "argTypeMap": {
|
731 | "type": "object",
|
732 | "properties": {}
|
733 | },
|
734 | "headers": {
|
735 | "type": "object",
|
736 | "properties": {}
|
737 | }
|
738 | },
|
739 | "required": ["field", "type", "method"]
|
740 | },
|
741 | "MongooseHandler": {
|
742 | "additionalProperties": false,
|
743 | "type": "object",
|
744 | "title": "MongooseHandler",
|
745 | "properties": {
|
746 | "connectionString": {
|
747 | "type": "string"
|
748 | },
|
749 | "models": {
|
750 | "type": "array",
|
751 | "items": {
|
752 | "$ref": "#/definitions/MongooseModel"
|
753 | },
|
754 | "additionalItems": false
|
755 | },
|
756 | "discriminators": {
|
757 | "type": "array",
|
758 | "items": {
|
759 | "$ref": "#/definitions/MongooseModel"
|
760 | },
|
761 | "additionalItems": false
|
762 | }
|
763 | }
|
764 | },
|
765 | "MongooseModel": {
|
766 | "additionalProperties": false,
|
767 | "type": "object",
|
768 | "title": "MongooseModel",
|
769 | "properties": {
|
770 | "name": {
|
771 | "type": "string"
|
772 | },
|
773 | "path": {
|
774 | "type": "string"
|
775 | },
|
776 | "options": {
|
777 | "$ref": "#/definitions/ComposeWithMongooseOpts"
|
778 | }
|
779 | },
|
780 | "required": ["name", "path"]
|
781 | },
|
782 | "ComposeWithMongooseOpts": {
|
783 | "additionalProperties": false,
|
784 | "type": "object",
|
785 | "title": "ComposeWithMongooseOpts",
|
786 | "properties": {
|
787 | "name": {
|
788 | "type": "string"
|
789 | },
|
790 | "description": {
|
791 | "type": "string"
|
792 | },
|
793 | "fields": {
|
794 | "$ref": "#/definitions/ComposeWithMongooseFieldsOpts"
|
795 | },
|
796 | "inputType": {
|
797 | "$ref": "#/definitions/ComposeMongooseInputType"
|
798 | },
|
799 | "resolvers": {
|
800 | "$ref": "#/definitions/TypeConverterResolversOpts"
|
801 | }
|
802 | }
|
803 | },
|
804 | "ComposeMongooseInputType": {
|
805 | "additionalProperties": false,
|
806 | "type": "object",
|
807 | "title": "ComposeMongooseInputType",
|
808 | "properties": {
|
809 | "name": {
|
810 | "type": "string"
|
811 | },
|
812 | "description": {
|
813 | "type": "string"
|
814 | },
|
815 | "fields": {
|
816 | "$ref": "#/definitions/ComposeWithMongooseFieldsOpts"
|
817 | },
|
818 | "resolvers": {
|
819 | "$ref": "#/definitions/TypeConverterResolversOpts"
|
820 | }
|
821 | }
|
822 | },
|
823 | "ComposeWithMongooseFieldsOpts": {
|
824 | "additionalProperties": false,
|
825 | "type": "object",
|
826 | "title": "ComposeWithMongooseFieldsOpts",
|
827 | "properties": {
|
828 | "only": {
|
829 | "type": "array",
|
830 | "items": {
|
831 | "type": "string"
|
832 | },
|
833 | "additionalItems": false
|
834 | },
|
835 | "remove": {
|
836 | "type": "array",
|
837 | "items": {
|
838 | "type": "string"
|
839 | },
|
840 | "additionalItems": false
|
841 | },
|
842 | "required": {
|
843 | "type": "array",
|
844 | "items": {
|
845 | "type": "string"
|
846 | },
|
847 | "additionalItems": false
|
848 | }
|
849 | }
|
850 | },
|
851 | "TypeConverterResolversOpts": {
|
852 | "additionalProperties": false,
|
853 | "type": "object",
|
854 | "title": "TypeConverterResolversOpts",
|
855 | "properties": {
|
856 | "findById": {
|
857 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
858 | "anyOf": [
|
859 | {
|
860 | "type": "boolean"
|
861 | },
|
862 | {
|
863 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
864 | }
|
865 | ]
|
866 | },
|
867 | "findByIds": {
|
868 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
869 | "anyOf": [
|
870 | {
|
871 | "type": "boolean"
|
872 | },
|
873 | {
|
874 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
875 | }
|
876 | ]
|
877 | },
|
878 | "findOne": {
|
879 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
880 | "anyOf": [
|
881 | {
|
882 | "type": "boolean"
|
883 | },
|
884 | {
|
885 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
886 | }
|
887 | ]
|
888 | },
|
889 | "findMany": {
|
890 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
891 | "anyOf": [
|
892 | {
|
893 | "type": "boolean"
|
894 | },
|
895 | {
|
896 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
897 | }
|
898 | ]
|
899 | },
|
900 | "updateById": {
|
901 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
902 | "anyOf": [
|
903 | {
|
904 | "type": "boolean"
|
905 | },
|
906 | {
|
907 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
908 | }
|
909 | ]
|
910 | },
|
911 | "updateOne": {
|
912 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
913 | "anyOf": [
|
914 | {
|
915 | "type": "boolean"
|
916 | },
|
917 | {
|
918 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
919 | }
|
920 | ]
|
921 | },
|
922 | "updateMany": {
|
923 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
924 | "anyOf": [
|
925 | {
|
926 | "type": "boolean"
|
927 | },
|
928 | {
|
929 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
930 | }
|
931 | ]
|
932 | },
|
933 | "removeById": {
|
934 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
935 | "anyOf": [
|
936 | {
|
937 | "type": "boolean"
|
938 | },
|
939 | {
|
940 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
941 | }
|
942 | ]
|
943 | },
|
944 | "removeOne": {
|
945 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
946 | "anyOf": [
|
947 | {
|
948 | "type": "boolean"
|
949 | },
|
950 | {
|
951 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
952 | }
|
953 | ]
|
954 | },
|
955 | "removeMany": {
|
956 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
957 | "anyOf": [
|
958 | {
|
959 | "type": "boolean"
|
960 | },
|
961 | {
|
962 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
963 | }
|
964 | ]
|
965 | },
|
966 | "createOne": {
|
967 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
968 | "anyOf": [
|
969 | {
|
970 | "type": "boolean"
|
971 | },
|
972 | {
|
973 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
974 | }
|
975 | ]
|
976 | },
|
977 | "createMany": {
|
978 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
979 | "anyOf": [
|
980 | {
|
981 | "type": "boolean"
|
982 | },
|
983 | {
|
984 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
985 | }
|
986 | ]
|
987 | },
|
988 | "count": {
|
989 | "description": "Any of: Boolean, ComposeWithMongooseResolverOpts",
|
990 | "anyOf": [
|
991 | {
|
992 | "type": "boolean"
|
993 | },
|
994 | {
|
995 | "$ref": "#/definitions/ComposeWithMongooseResolverOpts"
|
996 | }
|
997 | ]
|
998 | },
|
999 | "connection": {
|
1000 | "description": "Any of: Boolean, JSON",
|
1001 | "anyOf": [
|
1002 | {
|
1003 | "type": "boolean"
|
1004 | },
|
1005 | {
|
1006 | "type": "object",
|
1007 | "properties": {}
|
1008 | }
|
1009 | ]
|
1010 | },
|
1011 | "pagination": {
|
1012 | "description": "Any of: Boolean, PaginationResolverOpts",
|
1013 | "anyOf": [
|
1014 | {
|
1015 | "type": "boolean"
|
1016 | },
|
1017 | {
|
1018 | "$ref": "#/definitions/PaginationResolverOpts"
|
1019 | }
|
1020 | ]
|
1021 | }
|
1022 | }
|
1023 | },
|
1024 | "ComposeWithMongooseResolverOpts": {
|
1025 | "additionalProperties": false,
|
1026 | "type": "object",
|
1027 | "title": "ComposeWithMongooseResolverOpts",
|
1028 | "properties": {
|
1029 | "filter": {
|
1030 | "$ref": "#/definitions/FilterHelperArgsOpts"
|
1031 | },
|
1032 | "sort": {
|
1033 | "$ref": "#/definitions/SortHelperArgsOpts"
|
1034 | },
|
1035 | "limit": {
|
1036 | "$ref": "#/definitions/LimitHelperArgsOpts"
|
1037 | },
|
1038 | "record": {
|
1039 | "$ref": "#/definitions/RecordHelperArgsOpts"
|
1040 | },
|
1041 | "skip": {
|
1042 | "type": "boolean"
|
1043 | }
|
1044 | }
|
1045 | },
|
1046 | "FilterHelperArgsOpts": {
|
1047 | "additionalProperties": false,
|
1048 | "type": "object",
|
1049 | "title": "FilterHelperArgsOpts",
|
1050 | "properties": {
|
1051 | "filterTypeName": {
|
1052 | "type": "string"
|
1053 | },
|
1054 | "isRequired": {
|
1055 | "type": "boolean"
|
1056 | },
|
1057 | "onlyIndexed": {
|
1058 | "type": "boolean"
|
1059 | },
|
1060 | "requiredFields": {
|
1061 | "type": "array",
|
1062 | "items": {
|
1063 | "type": "string"
|
1064 | },
|
1065 | "additionalItems": false
|
1066 | },
|
1067 | "operators": {
|
1068 | "description": "Any of: Boolean, JSON",
|
1069 | "anyOf": [
|
1070 | {
|
1071 | "type": "boolean"
|
1072 | },
|
1073 | {
|
1074 | "type": "object",
|
1075 | "properties": {}
|
1076 | }
|
1077 | ]
|
1078 | },
|
1079 | "removeFields": {
|
1080 | "type": "array",
|
1081 | "items": {
|
1082 | "type": "string"
|
1083 | },
|
1084 | "additionalItems": false
|
1085 | }
|
1086 | }
|
1087 | },
|
1088 | "SortHelperArgsOpts": {
|
1089 | "additionalProperties": false,
|
1090 | "type": "object",
|
1091 | "title": "SortHelperArgsOpts",
|
1092 | "properties": {
|
1093 | "sortTypeName": {
|
1094 | "type": "string"
|
1095 | }
|
1096 | }
|
1097 | },
|
1098 | "LimitHelperArgsOpts": {
|
1099 | "additionalProperties": false,
|
1100 | "type": "object",
|
1101 | "title": "LimitHelperArgsOpts",
|
1102 | "properties": {
|
1103 | "defaultValue": {
|
1104 | "type": "integer"
|
1105 | }
|
1106 | }
|
1107 | },
|
1108 | "RecordHelperArgsOpts": {
|
1109 | "additionalProperties": false,
|
1110 | "type": "object",
|
1111 | "title": "RecordHelperArgsOpts",
|
1112 | "properties": {
|
1113 | "recordTypeName": {
|
1114 | "type": "string"
|
1115 | },
|
1116 | "isRequired": {
|
1117 | "type": "boolean"
|
1118 | },
|
1119 | "removeFields": {
|
1120 | "type": "array",
|
1121 | "items": {
|
1122 | "type": "string"
|
1123 | },
|
1124 | "additionalItems": false
|
1125 | },
|
1126 | "requiredFields": {
|
1127 | "type": "array",
|
1128 | "items": {
|
1129 | "type": "string"
|
1130 | },
|
1131 | "additionalItems": false
|
1132 | }
|
1133 | }
|
1134 | },
|
1135 | "PaginationResolverOpts": {
|
1136 | "additionalProperties": false,
|
1137 | "type": "object",
|
1138 | "title": "PaginationResolverOpts",
|
1139 | "properties": {
|
1140 | "perPage": {
|
1141 | "type": "integer"
|
1142 | }
|
1143 | }
|
1144 | },
|
1145 | "MySQLHandler": {
|
1146 | "additionalProperties": false,
|
1147 | "type": "object",
|
1148 | "title": "MySQLHandler",
|
1149 | "properties": {
|
1150 | "host": {
|
1151 | "type": "string"
|
1152 | },
|
1153 | "port": {
|
1154 | "type": "integer"
|
1155 | },
|
1156 | "user": {
|
1157 | "type": "string"
|
1158 | },
|
1159 | "password": {
|
1160 | "type": "string"
|
1161 | },
|
1162 | "database": {
|
1163 | "type": "string"
|
1164 | }
|
1165 | },
|
1166 | "required": ["host", "port", "user", "database"]
|
1167 | },
|
1168 | "Neo4jHandler": {
|
1169 | "additionalProperties": false,
|
1170 | "type": "object",
|
1171 | "title": "Neo4jHandler",
|
1172 | "properties": {
|
1173 | "url": {
|
1174 | "type": "string",
|
1175 | "description": "URL for the Neo4j Instance e.g. neo4j://localhost"
|
1176 | },
|
1177 | "username": {
|
1178 | "type": "string",
|
1179 | "description": "Username for basic authentication"
|
1180 | },
|
1181 | "password": {
|
1182 | "type": "string",
|
1183 | "description": "Password for basic authentication"
|
1184 | },
|
1185 | "alwaysIncludeRelationships": {
|
1186 | "type": "boolean",
|
1187 | "description": "Specifies whether relationships should always be included in the type definitions as [relationship](https://grandstack.io/docs/neo4j-graphql-js.html#relationship-types) types, even if the relationships do not have properties."
|
1188 | },
|
1189 | "database": {
|
1190 | "type": "string",
|
1191 | "description": "Specifies database name"
|
1192 | },
|
1193 | "typeDefs": {
|
1194 | "type": "string",
|
1195 | "description": "Provide GraphQL Type Definitions instead of inferring"
|
1196 | },
|
1197 | "cacheIntrospection": {
|
1198 | "description": "Cache Introspection (Any of: Neo4jIntrospectionCachingOptions, Boolean)",
|
1199 | "anyOf": [
|
1200 | {
|
1201 | "$ref": "#/definitions/Neo4jIntrospectionCachingOptions"
|
1202 | },
|
1203 | {
|
1204 | "type": "boolean"
|
1205 | }
|
1206 | ]
|
1207 | }
|
1208 | },
|
1209 | "required": ["url", "username", "password"]
|
1210 | },
|
1211 | "Neo4jIntrospectionCachingOptions": {
|
1212 | "additionalProperties": false,
|
1213 | "type": "object",
|
1214 | "title": "Neo4jIntrospectionCachingOptions",
|
1215 | "properties": {
|
1216 | "ttl": {
|
1217 | "type": "integer",
|
1218 | "description": "Time to live of introspection cache"
|
1219 | }
|
1220 | }
|
1221 | },
|
1222 | "ODataHandler": {
|
1223 | "additionalProperties": false,
|
1224 | "type": "object",
|
1225 | "title": "ODataHandler",
|
1226 | "properties": {
|
1227 | "baseUrl": {
|
1228 | "type": "string",
|
1229 | "description": "Base URL for OData API"
|
1230 | },
|
1231 | "metadata": {
|
1232 | "type": "string",
|
1233 | "description": "Custom $metadata File or URL"
|
1234 | },
|
1235 | "operationHeaders": {
|
1236 | "type": "object",
|
1237 | "properties": {},
|
1238 | "description": "Headers to be used with the operation requests"
|
1239 | },
|
1240 | "schemaHeaders": {
|
1241 | "type": "object",
|
1242 | "properties": {},
|
1243 | "description": "Headers to be used with the $metadata requests"
|
1244 | },
|
1245 | "batch": {
|
1246 | "type": "string",
|
1247 | "enum": ["multipart", "json"],
|
1248 | "description": "Enable batching (Allowed values: multipart, json)"
|
1249 | },
|
1250 | "expandNavProps": {
|
1251 | "type": "boolean",
|
1252 | "description": "Use $expand for navigation props instead of seperate HTTP requests (Default: false)"
|
1253 | }
|
1254 | },
|
1255 | "required": ["baseUrl"]
|
1256 | },
|
1257 | "OpenapiHandler": {
|
1258 | "additionalProperties": false,
|
1259 | "type": "object",
|
1260 | "title": "OpenapiHandler",
|
1261 | "properties": {
|
1262 | "source": {
|
1263 | "type": "string",
|
1264 | "description": "A pointer to your API source - could be a local file, remote file or url endpoint"
|
1265 | },
|
1266 | "sourceFormat": {
|
1267 | "type": "string",
|
1268 | "enum": ["json", "yaml"],
|
1269 | "description": "Format of the source file (Allowed values: json, yaml)"
|
1270 | },
|
1271 | "operationHeaders": {
|
1272 | "type": "object",
|
1273 | "properties": {},
|
1274 | "description": "JSON object representing the Headers to add to the runtime of the API calls"
|
1275 | },
|
1276 | "schemaHeaders": {
|
1277 | "type": "object",
|
1278 | "properties": {},
|
1279 | "description": "If you are using a remote URL endpoint to fetch your schema, you can set headers for the HTTP request to fetch your schema."
|
1280 | },
|
1281 | "baseUrl": {
|
1282 | "type": "string",
|
1283 | "description": "Specifies the URL on which all paths will be based on.\nOverrides the server object in the OAS."
|
1284 | },
|
1285 | "qs": {
|
1286 | "type": "object",
|
1287 | "properties": {},
|
1288 | "description": "JSON object representing the query search parameters to add to the API calls"
|
1289 | },
|
1290 | "customFetch": {
|
1291 | "anyOf": [
|
1292 | {
|
1293 | "type": "object",
|
1294 | "additionalProperties": true
|
1295 | },
|
1296 | {
|
1297 | "type": "string"
|
1298 | }
|
1299 | ],
|
1300 | "description": "W3 Compatible Fetch Implementation"
|
1301 | },
|
1302 | "includeHttpDetails": {
|
1303 | "type": "boolean",
|
1304 | "description": "Include HTTP Response details to the result object"
|
1305 | },
|
1306 | "addLimitArgument": {
|
1307 | "type": "boolean",
|
1308 | "description": "Auto-generate a 'limit' argument for all fields that return lists of objects, including ones produced by links"
|
1309 | }
|
1310 | },
|
1311 | "required": ["source"]
|
1312 | },
|
1313 | "PostGraphileHandler": {
|
1314 | "additionalProperties": false,
|
1315 | "type": "object",
|
1316 | "title": "PostGraphileHandler",
|
1317 | "properties": {
|
1318 | "connectionString": {
|
1319 | "type": "string",
|
1320 | "description": "A connection string to your Postgres database"
|
1321 | },
|
1322 | "schemaName": {
|
1323 | "type": "array",
|
1324 | "items": {
|
1325 | "type": "string"
|
1326 | },
|
1327 | "additionalItems": false,
|
1328 | "description": "An array of strings which specifies the PostgreSQL schemas that PostGraphile will use to create a GraphQL schema. The default schema is the public schema."
|
1329 | },
|
1330 | "pool": {
|
1331 | "type": "object",
|
1332 | "properties": {},
|
1333 | "description": "Connection Pool settings"
|
1334 | },
|
1335 | "appendPlugins": {
|
1336 | "type": "array",
|
1337 | "items": {
|
1338 | "type": "string"
|
1339 | },
|
1340 | "additionalItems": false,
|
1341 | "description": "Extra Postgraphile Plugins to append"
|
1342 | },
|
1343 | "skipPlugins": {
|
1344 | "type": "array",
|
1345 | "items": {
|
1346 | "type": "string"
|
1347 | },
|
1348 | "additionalItems": false,
|
1349 | "description": "Postgraphile Plugins to skip (e.g. \"graphile-build#NodePlugin\")"
|
1350 | },
|
1351 | "options": {
|
1352 | "description": "Extra Postgraphile options that will be added to the postgraphile constructor. It can either be an object or a string pointing to the object's path (e.g. \"./my-config#options\"). See the [postgraphile docs](https://www.graphile.org/postgraphile/usage-library/) for more information. (Any of: JSON, String)",
|
1353 | "anyOf": [
|
1354 | {
|
1355 | "type": "object",
|
1356 | "properties": {}
|
1357 | },
|
1358 | {
|
1359 | "type": "string"
|
1360 | }
|
1361 | ]
|
1362 | },
|
1363 | "cacheIntrospection": {
|
1364 | "description": "Cache Introspection (Any of: GraphQLIntrospectionCachingOptions, Boolean)",
|
1365 | "anyOf": [
|
1366 | {
|
1367 | "$ref": "#/definitions/GraphQLIntrospectionCachingOptions"
|
1368 | },
|
1369 | {
|
1370 | "type": "boolean"
|
1371 | }
|
1372 | ]
|
1373 | }
|
1374 | }
|
1375 | },
|
1376 | "SoapHandler": {
|
1377 | "additionalProperties": false,
|
1378 | "type": "object",
|
1379 | "title": "SoapHandler",
|
1380 | "properties": {
|
1381 | "wsdl": {
|
1382 | "type": "string",
|
1383 | "description": "A url to your WSDL"
|
1384 | },
|
1385 | "basicAuth": {
|
1386 | "$ref": "#/definitions/SoapSecurityBasicAuthConfig",
|
1387 | "description": "Basic Authentication Configuration\nIncluding username and password fields"
|
1388 | },
|
1389 | "securityCert": {
|
1390 | "$ref": "#/definitions/SoapSecurityCertificateConfig",
|
1391 | "description": "SSL Certificate Based Authentication Configuration\nIncluding public key, private key and password fields"
|
1392 | }
|
1393 | },
|
1394 | "required": ["wsdl"]
|
1395 | },
|
1396 | "SoapSecurityBasicAuthConfig": {
|
1397 | "additionalProperties": false,
|
1398 | "type": "object",
|
1399 | "title": "SoapSecurityBasicAuthConfig",
|
1400 | "properties": {
|
1401 | "username": {
|
1402 | "type": "string",
|
1403 | "description": "Username for Basic Authentication"
|
1404 | },
|
1405 | "password": {
|
1406 | "type": "string",
|
1407 | "description": "Password for Basic Authentication"
|
1408 | }
|
1409 | },
|
1410 | "required": ["username", "password"]
|
1411 | },
|
1412 | "SoapSecurityCertificateConfig": {
|
1413 | "additionalProperties": false,
|
1414 | "type": "object",
|
1415 | "title": "SoapSecurityCertificateConfig",
|
1416 | "properties": {
|
1417 | "publicKey": {
|
1418 | "type": "string",
|
1419 | "description": "Your public key"
|
1420 | },
|
1421 | "privateKey": {
|
1422 | "type": "string",
|
1423 | "description": "Your private key"
|
1424 | },
|
1425 | "password": {
|
1426 | "type": "string",
|
1427 | "description": "Password"
|
1428 | },
|
1429 | "publicKeyPath": {
|
1430 | "type": "string",
|
1431 | "description": "Path to the file or URL contains your public key"
|
1432 | },
|
1433 | "privateKeyPath": {
|
1434 | "type": "string",
|
1435 | "description": "Path to the file or URL contains your private key"
|
1436 | },
|
1437 | "passwordPath": {
|
1438 | "type": "string",
|
1439 | "description": "Path to the file or URL contains your password"
|
1440 | }
|
1441 | }
|
1442 | },
|
1443 | "ThriftHandler": {
|
1444 | "additionalProperties": false,
|
1445 | "type": "object",
|
1446 | "title": "ThriftHandler",
|
1447 | "properties": {
|
1448 | "hostName": {
|
1449 | "type": "string",
|
1450 | "description": "The name of the host to connect to."
|
1451 | },
|
1452 | "port": {
|
1453 | "type": "integer",
|
1454 | "description": "The port number to attach to on the host."
|
1455 | },
|
1456 | "path": {
|
1457 | "type": "string",
|
1458 | "description": "The path on which the Thrift service is listening. Defaults to '/thrift'."
|
1459 | },
|
1460 | "https": {
|
1461 | "type": "boolean",
|
1462 | "description": "Boolean value indicating whether to use https. Defaults to false."
|
1463 | },
|
1464 | "protocol": {
|
1465 | "type": "string",
|
1466 | "enum": ["binary", "compact", "json"],
|
1467 | "description": "Name of the Thrift protocol type to use. Defaults to 'binary'. (Allowed values: binary, compact, json)"
|
1468 | },
|
1469 | "serviceName": {
|
1470 | "type": "string",
|
1471 | "description": "The name of your service. Used for logging."
|
1472 | },
|
1473 | "operationHeaders": {
|
1474 | "type": "object",
|
1475 | "properties": {},
|
1476 | "description": "JSON object representing the Headers to add to the runtime of the API calls"
|
1477 | },
|
1478 | "schemaHeaders": {
|
1479 | "type": "object",
|
1480 | "properties": {},
|
1481 | "description": "If you are using a remote URL endpoint to fetch your schema, you can set headers for the HTTP request to fetch your schema."
|
1482 | },
|
1483 | "idl": {
|
1484 | "type": "string",
|
1485 | "description": "Path to IDL file"
|
1486 | }
|
1487 | },
|
1488 | "required": ["hostName", "port", "serviceName", "idl"]
|
1489 | },
|
1490 | "CacheTransformConfig": {
|
1491 | "additionalProperties": false,
|
1492 | "type": "object",
|
1493 | "title": "CacheTransformConfig",
|
1494 | "properties": {
|
1495 | "field": {
|
1496 | "type": "string",
|
1497 | "description": "The type and field to apply cache to, you can use wild cards as well, for example: `Query.*`"
|
1498 | },
|
1499 | "cacheKey": {
|
1500 | "type": "string",
|
1501 | "description": "Cache key to use to store your resolvers responses.\nThe defualt is: {typeName}-{fieldName}-{argsHash}-{fieldNamesHash}\n\nAvailable variables:\n- {args.argName} - use resolver argument\n- {typeName} - use name of the type\n- {fieldName} - use name of the field\n- {argsHash} - a hash based on the 'args' object\n- {fieldNamesHash} - a hash based on the field names selected by the client\n- {info} - the GraphQLResolveInfo of the resolver\n\nAvailable interpolations:\n- {format|date} - returns the current date with a specific format"
|
1502 | },
|
1503 | "invalidate": {
|
1504 | "$ref": "#/definitions/CacheInvalidateConfig",
|
1505 | "description": "Invalidation rules"
|
1506 | }
|
1507 | },
|
1508 | "required": ["field"]
|
1509 | },
|
1510 | "CacheInvalidateConfig": {
|
1511 | "additionalProperties": false,
|
1512 | "type": "object",
|
1513 | "title": "CacheInvalidateConfig",
|
1514 | "properties": {
|
1515 | "effectingOperations": {
|
1516 | "type": "array",
|
1517 | "items": {
|
1518 | "$ref": "#/definitions/CacheEffectingOperationConfig"
|
1519 | },
|
1520 | "additionalItems": false,
|
1521 | "description": "Invalidate the cache when a specific operation is done without an error"
|
1522 | },
|
1523 | "ttl": {
|
1524 | "type": "integer",
|
1525 | "description": "Specified in seconds, the time-to-live (TTL) value limits the lifespan"
|
1526 | }
|
1527 | }
|
1528 | },
|
1529 | "CacheEffectingOperationConfig": {
|
1530 | "additionalProperties": false,
|
1531 | "type": "object",
|
1532 | "title": "CacheEffectingOperationConfig",
|
1533 | "properties": {
|
1534 | "operation": {
|
1535 | "type": "string",
|
1536 | "description": "Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field."
|
1537 | },
|
1538 | "matchKey": {
|
1539 | "type": "string",
|
1540 | "description": "Cache key to invalidate on sucessful resolver (no error), see `cacheKey` for list of available options in this field."
|
1541 | }
|
1542 | },
|
1543 | "required": ["operation"]
|
1544 | },
|
1545 | "FederationTransform": {
|
1546 | "additionalProperties": false,
|
1547 | "type": "object",
|
1548 | "title": "FederationTransform",
|
1549 | "properties": {
|
1550 | "types": {
|
1551 | "type": "array",
|
1552 | "items": {
|
1553 | "$ref": "#/definitions/FederationTransformType"
|
1554 | },
|
1555 | "additionalItems": false
|
1556 | }
|
1557 | }
|
1558 | },
|
1559 | "FederationTransformType": {
|
1560 | "additionalProperties": false,
|
1561 | "type": "object",
|
1562 | "title": "FederationTransformType",
|
1563 | "properties": {
|
1564 | "name": {
|
1565 | "type": "string"
|
1566 | },
|
1567 | "config": {
|
1568 | "$ref": "#/definitions/FederationObjectConfig"
|
1569 | }
|
1570 | },
|
1571 | "required": ["name"]
|
1572 | },
|
1573 | "FederationObjectConfig": {
|
1574 | "additionalProperties": false,
|
1575 | "type": "object",
|
1576 | "title": "FederationObjectConfig",
|
1577 | "properties": {
|
1578 | "keyFields": {
|
1579 | "type": "array",
|
1580 | "items": {
|
1581 | "type": "string"
|
1582 | },
|
1583 | "additionalItems": false
|
1584 | },
|
1585 | "extend": {
|
1586 | "type": "boolean"
|
1587 | },
|
1588 | "fields": {
|
1589 | "type": "array",
|
1590 | "items": {
|
1591 | "$ref": "#/definitions/FederationField"
|
1592 | },
|
1593 | "additionalItems": false
|
1594 | },
|
1595 | "resolveReference": {
|
1596 | "description": "Any of: String, ResolveReferenceObject",
|
1597 | "anyOf": [
|
1598 | {
|
1599 | "type": "string"
|
1600 | },
|
1601 | {
|
1602 | "$ref": "#/definitions/ResolveReferenceObject"
|
1603 | }
|
1604 | ]
|
1605 | }
|
1606 | }
|
1607 | },
|
1608 | "ResolveReferenceObject": {
|
1609 | "additionalProperties": false,
|
1610 | "type": "object",
|
1611 | "title": "ResolveReferenceObject",
|
1612 | "properties": {
|
1613 | "targetSource": {
|
1614 | "type": "string"
|
1615 | },
|
1616 | "targetMethod": {
|
1617 | "type": "string"
|
1618 | },
|
1619 | "args": {
|
1620 | "type": "object",
|
1621 | "properties": {}
|
1622 | },
|
1623 | "returnData": {
|
1624 | "type": "string"
|
1625 | },
|
1626 | "resultSelectedFields": {
|
1627 | "type": "object",
|
1628 | "properties": {}
|
1629 | },
|
1630 | "resultSelectionSet": {
|
1631 | "type": "string"
|
1632 | },
|
1633 | "resultDepth": {
|
1634 | "type": "integer"
|
1635 | }
|
1636 | },
|
1637 | "required": ["targetSource", "targetMethod", "args"]
|
1638 | },
|
1639 | "FederationField": {
|
1640 | "additionalProperties": false,
|
1641 | "type": "object",
|
1642 | "title": "FederationField",
|
1643 | "properties": {
|
1644 | "name": {
|
1645 | "type": "string"
|
1646 | },
|
1647 | "config": {
|
1648 | "$ref": "#/definitions/FederationFieldConfig"
|
1649 | }
|
1650 | },
|
1651 | "required": ["name", "config"]
|
1652 | },
|
1653 | "FederationFieldConfig": {
|
1654 | "additionalProperties": false,
|
1655 | "type": "object",
|
1656 | "title": "FederationFieldConfig",
|
1657 | "properties": {
|
1658 | "external": {
|
1659 | "type": "boolean"
|
1660 | },
|
1661 | "provides": {
|
1662 | "type": "string"
|
1663 | },
|
1664 | "required": {
|
1665 | "type": "string"
|
1666 | }
|
1667 | }
|
1668 | },
|
1669 | "MockingConfig": {
|
1670 | "additionalProperties": false,
|
1671 | "type": "object",
|
1672 | "title": "MockingConfig",
|
1673 | "properties": {
|
1674 | "if": {
|
1675 | "type": "boolean",
|
1676 | "description": "If this expression is truthy, mocking would be enabled\nYou can use environment variables expression, for example: `${MOCKING_ENABLED}`"
|
1677 | },
|
1678 | "preserveResolvers": {
|
1679 | "type": "boolean",
|
1680 | "description": "Do not mock any other resolvers other than defined in `mocks`.\nFor example, you can enable this if you don't want to mock entire schema but partially."
|
1681 | },
|
1682 | "mocks": {
|
1683 | "type": "array",
|
1684 | "items": {
|
1685 | "$ref": "#/definitions/MockingFieldConfig"
|
1686 | },
|
1687 | "additionalItems": false,
|
1688 | "description": "Mock configurations"
|
1689 | }
|
1690 | }
|
1691 | },
|
1692 | "MockingFieldConfig": {
|
1693 | "additionalProperties": false,
|
1694 | "type": "object",
|
1695 | "title": "MockingFieldConfig",
|
1696 | "properties": {
|
1697 | "apply": {
|
1698 | "type": "string",
|
1699 | "description": "Resolver path\nExample: User.firstName"
|
1700 | },
|
1701 | "if": {
|
1702 | "type": "boolean",
|
1703 | "description": "If this expression is truthy, mocking would be enabled\nYou can use environment variables expression, for example: `${MOCKING_ENABLED}`"
|
1704 | },
|
1705 | "faker": {
|
1706 | "type": "string",
|
1707 | "description": "Faker.js expression or function\nRead more (https://github.com/marak/Faker.js/#fakerfake)\nExample;\nfaker: name.firstName\nfaker: \"{{ name.firstName }} {{ name.lastName }}\""
|
1708 | },
|
1709 | "custom": {
|
1710 | "type": "string",
|
1711 | "description": "Custom mocking\nIt can be a module or json file.\nBoth \"moduleName#exportName\" or only \"moduleName\" would work"
|
1712 | }
|
1713 | },
|
1714 | "required": ["apply"]
|
1715 | },
|
1716 | "NamingConventionTransformConfig": {
|
1717 | "additionalProperties": false,
|
1718 | "type": "object",
|
1719 | "title": "NamingConventionTransformConfig",
|
1720 | "properties": {
|
1721 | "typeNames": {
|
1722 | "type": "string",
|
1723 | "enum": [
|
1724 | "camelCase",
|
1725 | "capitalCase",
|
1726 | "constantCase",
|
1727 | "dotCase",
|
1728 | "headerCase",
|
1729 | "noCase",
|
1730 | "paramCase",
|
1731 | "pascalCase",
|
1732 | "pathCase",
|
1733 | "sentenceCase",
|
1734 | "snakeCase",
|
1735 | "upperCase",
|
1736 | "lowerCase"
|
1737 | ],
|
1738 | "description": "Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase"
|
1739 | },
|
1740 | "fieldNames": {
|
1741 | "type": "string",
|
1742 | "enum": [
|
1743 | "camelCase",
|
1744 | "capitalCase",
|
1745 | "constantCase",
|
1746 | "dotCase",
|
1747 | "headerCase",
|
1748 | "noCase",
|
1749 | "paramCase",
|
1750 | "pascalCase",
|
1751 | "pathCase",
|
1752 | "sentenceCase",
|
1753 | "snakeCase",
|
1754 | "upperCase",
|
1755 | "lowerCase"
|
1756 | ],
|
1757 | "description": "Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase"
|
1758 | },
|
1759 | "enumValues": {
|
1760 | "type": "string",
|
1761 | "enum": [
|
1762 | "camelCase",
|
1763 | "capitalCase",
|
1764 | "constantCase",
|
1765 | "dotCase",
|
1766 | "headerCase",
|
1767 | "noCase",
|
1768 | "paramCase",
|
1769 | "pascalCase",
|
1770 | "pathCase",
|
1771 | "sentenceCase",
|
1772 | "snakeCase",
|
1773 | "upperCase",
|
1774 | "lowerCase"
|
1775 | ],
|
1776 | "description": "Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase"
|
1777 | }
|
1778 | }
|
1779 | },
|
1780 | "PrefixTransformConfig": {
|
1781 | "additionalProperties": false,
|
1782 | "type": "object",
|
1783 | "title": "PrefixTransformConfig",
|
1784 | "properties": {
|
1785 | "value": {
|
1786 | "type": "string",
|
1787 | "description": "The prefix to apply to the schema types. By default it's the API name."
|
1788 | },
|
1789 | "ignore": {
|
1790 | "type": "array",
|
1791 | "items": {
|
1792 | "type": "string"
|
1793 | },
|
1794 | "additionalItems": false,
|
1795 | "description": "List of ignored types"
|
1796 | },
|
1797 | "includeRootOperations": {
|
1798 | "type": "boolean",
|
1799 | "description": "Changes root types and changes the field names"
|
1800 | }
|
1801 | }
|
1802 | },
|
1803 | "RenameTransformObject": {
|
1804 | "additionalProperties": false,
|
1805 | "type": "object",
|
1806 | "title": "RenameTransformObject",
|
1807 | "properties": {
|
1808 | "from": {
|
1809 | "type": "string",
|
1810 | "description": "The GraphQL type to rename"
|
1811 | },
|
1812 | "to": {
|
1813 | "type": "string",
|
1814 | "description": "The new name"
|
1815 | }
|
1816 | },
|
1817 | "required": ["from", "to"]
|
1818 | },
|
1819 | "ResolversCompositionTransformObject": {
|
1820 | "additionalProperties": false,
|
1821 | "type": "object",
|
1822 | "title": "ResolversCompositionTransformObject",
|
1823 | "properties": {
|
1824 | "resolver": {
|
1825 | "type": "string",
|
1826 | "description": "The GraphQL Resolver path\nExample: Query.users"
|
1827 | },
|
1828 | "composer": {
|
1829 | "anyOf": [
|
1830 | {
|
1831 | "type": "object",
|
1832 | "additionalProperties": true
|
1833 | },
|
1834 | {
|
1835 | "type": "string"
|
1836 | }
|
1837 | ],
|
1838 | "description": "Path to the composer function\nExample: ./src/auth.js#authComposer"
|
1839 | }
|
1840 | },
|
1841 | "required": ["resolver", "composer"]
|
1842 | },
|
1843 | "SnapshotTransformConfig": {
|
1844 | "additionalProperties": false,
|
1845 | "type": "object",
|
1846 | "title": "SnapshotTransformConfig",
|
1847 | "properties": {
|
1848 | "if": {
|
1849 | "description": "Expression for when to activate this extension.\nValue can be a valid JS expression string or a boolean (Any of: String, Boolean)",
|
1850 | "anyOf": [
|
1851 | {
|
1852 | "type": "string"
|
1853 | },
|
1854 | {
|
1855 | "type": "boolean"
|
1856 | }
|
1857 | ]
|
1858 | },
|
1859 | "apply": {
|
1860 | "type": "array",
|
1861 | "items": {
|
1862 | "type": "string"
|
1863 | },
|
1864 | "additionalItems": false,
|
1865 | "description": "Resolver to be applied\nFor example;\n apply:\n - Query.* <- * will apply this extension to all fields of Query type\n - Mutation.someMutationButProbablyYouWontNeedIt"
|
1866 | },
|
1867 | "outputDir": {
|
1868 | "type": "string",
|
1869 | "description": "Path to the directory of the generated snapshot files"
|
1870 | }
|
1871 | },
|
1872 | "required": ["apply", "outputDir"]
|
1873 | },
|
1874 | "TuqlHandler": {
|
1875 | "additionalProperties": false,
|
1876 | "type": "object",
|
1877 | "title": "TuqlHandler",
|
1878 | "properties": {
|
1879 | "db": {
|
1880 | "type": "string",
|
1881 | "description": "Pointer to your SQLite database"
|
1882 | },
|
1883 | "infile": {
|
1884 | "type": "string",
|
1885 | "description": "Path to the SQL Dump file if you want to build a in-memory database"
|
1886 | }
|
1887 | }
|
1888 | }
|
1889 | },
|
1890 | "title": "Config",
|
1891 | "type": "object",
|
1892 | "$schema": "http://json-schema.org/draft-04/schema#",
|
1893 | "required": ["sources"],
|
1894 | "properties": {
|
1895 | "serve": {
|
1896 | "$ref": "#/definitions/ServeConfig"
|
1897 | },
|
1898 | "require": {
|
1899 | "type": "array",
|
1900 | "items": {
|
1901 | "type": "string"
|
1902 | },
|
1903 | "additionalItems": false
|
1904 | },
|
1905 | "sources": {
|
1906 | "type": "array",
|
1907 | "items": {
|
1908 | "$ref": "#/definitions/Source"
|
1909 | },
|
1910 | "additionalItems": false,
|
1911 | "description": "Defines the list of your external data sources for your API mesh"
|
1912 | },
|
1913 | "transforms": {
|
1914 | "type": "array",
|
1915 | "items": {
|
1916 | "$ref": "#/definitions/Transform"
|
1917 | },
|
1918 | "additionalItems": false,
|
1919 | "description": "Transform to apply to the unified mesh schema"
|
1920 | },
|
1921 | "additionalTypeDefs": {
|
1922 | "type": "string",
|
1923 | "description": "Additional type definitions, or type definitions overrides you wish to add to the schema mesh"
|
1924 | },
|
1925 | "additionalResolvers": {
|
1926 | "type": "array",
|
1927 | "items": {
|
1928 | "description": "Any of: String, AdditionalStitchingResolverObject, AdditionalSubscriptionObject",
|
1929 | "anyOf": [
|
1930 | {
|
1931 | "type": "string"
|
1932 | },
|
1933 | {
|
1934 | "$ref": "#/definitions/AdditionalStitchingResolverObject"
|
1935 | },
|
1936 | {
|
1937 | "$ref": "#/definitions/AdditionalSubscriptionObject"
|
1938 | }
|
1939 | ]
|
1940 | },
|
1941 | "additionalItems": false,
|
1942 | "description": "Additional resolvers, or resolvers overrides you wish to add to the schema mesh (Any of: String, AdditionalStitchingResolverObject, AdditionalSubscriptionObject)"
|
1943 | },
|
1944 | "cache": {
|
1945 | "$ref": "#/definitions/Cache",
|
1946 | "description": "Backend cache"
|
1947 | },
|
1948 | "merger": {
|
1949 | "type": "string",
|
1950 | "description": "Merge method"
|
1951 | },
|
1952 | "pubsub": {
|
1953 | "description": "PubSub Implementation (Any of: String, PubSubConfig)",
|
1954 | "anyOf": [
|
1955 | {
|
1956 | "type": "string"
|
1957 | },
|
1958 | {
|
1959 | "$ref": "#/definitions/PubSubConfig"
|
1960 | }
|
1961 | ]
|
1962 | }
|
1963 | },
|
1964 | "additionalProperties": false
|
1965 | }
|