@jahia/cypress 3.25.0 → 3.26.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/schema.graphql CHANGED
@@ -1,4 +1,4 @@
1
- # This file was generated based on ".graphqlconfig". Do not edit manually.
1
+ # This file was generated. Do not edit manually.
2
2
 
3
3
  schema {
4
4
  query: Query
@@ -6,6 +6,13 @@ schema {
6
6
  subscription: Subscription
7
7
  }
8
8
 
9
+ directive @fetcher(name: String) on FIELD_DEFINITION
10
+
11
+ directive @mapping(ignoreDefaultQueries: Boolean, node: String, property: String) on OBJECT | FIELD_DEFINITION
12
+
13
+ "Indicates an Input Object is a OneOf Input Object."
14
+ directive @oneOf on INPUT_OBJECT
15
+
9
16
  "GraphQL representation of a JCR item definition"
10
17
  interface JCRItemDefinition {
11
18
  "Reports whether the item is to be automatically created when its parent node is created."
@@ -145,6 +152,8 @@ interface JCRNode {
145
152
  ): Boolean
146
153
  "Check if the node as a renderable template associated with it (not a view a template)."
147
154
  isDisplayableNode: Boolean
155
+ "true if node is under a mounted node"
156
+ isExternal: Boolean!
148
157
  "Reports if the current node matches the nodetype(s) passed in parameter"
149
158
  isNodeType(
150
159
  "Node type name"
@@ -201,6 +210,11 @@ interface JCRNode {
201
210
  "When set to true, returns the node in the default language if there is no translation for the requested language. Returns null if the option \"Replace untranslated content with the default language content\" is not activated for the site of the requested node. Will also return null if there is no translation for the default language."
202
211
  useFallbackLanguage: Boolean = false
203
212
  ): JCRProperty
213
+ "Returns count of all references of the node across all sites"
214
+ referenceCount(
215
+ "Filter out referencing types which should not be counted"
216
+ typesFilter: InputNodeTypesInput
217
+ ): Int
204
218
  "GraphQL representations of the reference properties that target the current JCR Node"
205
219
  references(
206
220
  "fetching only nodes after this node (exclusive)"
@@ -209,6 +223,8 @@ interface JCRNode {
209
223
  before: String,
210
224
  "Filter by graphQL fields values"
211
225
  fieldFilter: InputFieldFiltersInput,
226
+ "Sort by graphQL fields values"
227
+ fieldSorter: InputFieldSorterInput,
212
228
  "fetching only the first certain number of nodes"
213
229
  first: Int,
214
230
  "fetching only the last certain number of nodes"
@@ -218,6 +234,15 @@ interface JCRNode {
218
234
  "fetching only nodes after this node (inclusive)"
219
235
  offset: Int
220
236
  ): JCRPropertyConnection!
237
+ "Get render URL"
238
+ renderUrl(
239
+ "Finds displayable node"
240
+ findDisplayable: Boolean = false,
241
+ "The language content is rendered in"
242
+ language: String!,
243
+ "The target workspace"
244
+ workspace: Workspace!
245
+ ): String
221
246
  "Gets the fully rendered content for this node"
222
247
  renderedContent(
223
248
  "Rendering context configuration"
@@ -232,16 +257,44 @@ interface JCRNode {
232
257
  requestAttributes: [InputRenderRequestAttributeInput],
233
258
  "Template type"
234
259
  templateType: String,
235
- "Name of the view"
260
+ "Name of the view (leave null for default)"
236
261
  view: String
237
262
  ): RenderedNode
238
263
  "GraphQL representation of the site the JCR node belongs to, or the system site in case the node does not belong to any site"
239
264
  site: JCRSite
265
+ "Get node thumbnail URL"
266
+ thumbnailUrl(
267
+ "Checks if requested thumbnail node exists"
268
+ checkIfExists: Boolean = false,
269
+ "Thumbnail name"
270
+ name: String
271
+ ): String
240
272
  "Returns languages of available translations for this node"
241
273
  translationLanguages(
242
274
  "Optional: Return languages only if it is active for the site"
243
275
  isActiveOnly: Boolean
244
276
  ): [String]
277
+ "Get node URL"
278
+ url: String
279
+ "GraphQL representations of the reference properties that target the current JCR Node"
280
+ usages(
281
+ "fetching only nodes after this node (exclusive)"
282
+ after: String,
283
+ "fetching only nodes before this node (exclusive)"
284
+ before: String,
285
+ "Filter by graphQL fields values"
286
+ fieldFilter: InputFieldFiltersInput,
287
+ "Sort by graphQL fields values"
288
+ fieldSorter: InputFieldSorterInput,
289
+ "fetching only the first certain number of nodes"
290
+ first: Int,
291
+ "fetching only the last certain number of nodes"
292
+ last: Int,
293
+ "fetching only the first certain number of nodes"
294
+ limit: Int,
295
+ "fetching only nodes after this node (inclusive)"
296
+ offset: Int
297
+ ): UsageConnection!
245
298
  "The UUID of the JCR node this object represents"
246
299
  uuid: String!
247
300
  "Get vanity URLs from the current node filtered by the parameters"
@@ -325,6 +378,8 @@ type AclRole {
325
378
  type AdminMutation {
326
379
  "Get Jahia admin mutation"
327
380
  jahia: JahiaAdminMutation!
381
+ "Mount point mutation extension API"
382
+ mountPoint: GqlMountPointMutation
328
383
  "Personal API tokens mutations"
329
384
  personalApiTokens: PersonalApiTokensMutation
330
385
  }
@@ -337,10 +392,14 @@ type AdminQuery {
337
392
  datetime: String
338
393
  "Get Jahia admin query"
339
394
  jahia: JahiaAdminQuery!
395
+ "Mount point mutation extension API"
396
+ mountPoint: GqlMountPointQuery
340
397
  "Personal API tokens queries"
341
398
  personalApiTokens: PersonalApiTokensQuery
342
399
  "Get available ACL roles; does not include any hidden or privileged roles"
343
400
  roles: [AclRole]
401
+ "Jahia admin tools"
402
+ tools: AdminTools
344
403
  "Get user administration endpoint"
345
404
  userAdmin: UserAdminQuery
346
405
  "Get user group endpoint"
@@ -349,16 +408,105 @@ type AdminQuery {
349
408
  version: String! @deprecated(reason: "Deprecated")
350
409
  }
351
410
 
411
+ "Jahia admin tools"
412
+ type AdminTools {
413
+ "Will return dependencies of a bundle (modules or packages)"
414
+ findDependencies(
415
+ "will return only dependencies of Jahia modules (not bundles)"
416
+ ModulesOnly: Boolean = true,
417
+ "will return only bundle name matching the RegExp"
418
+ RegExp: String,
419
+ "will return only dependencies with a strict version specified (a version that reprobates upgrade of minor ones)"
420
+ StrictVersionOnly: Boolean = true
421
+ ): FindDependencies
422
+ "Will return all the duplicate export packages and the bundles that export them"
423
+ findMatchingExportPackages(
424
+ "will return only export-package matching the RegExp"
425
+ RegExp: String,
426
+ "will return only export-package found multiple times for a same package name"
427
+ duplicates: Boolean = false
428
+ ): FindExportPackage
429
+ "Will return all the import packages matching the given parameters."
430
+ findMatchingImportPackages(
431
+ "will return only import-package matching the RegExp"
432
+ RegExp: String,
433
+ "will return only import-package matching the given version"
434
+ version: String,
435
+ "will return only import-package with no version range limitations"
436
+ versionMissing: Boolean = false
437
+ ): FindImportPackage
438
+ }
439
+
352
440
  "Asset type for files"
353
441
  type Asset {
354
442
  "Asset metadata"
355
443
  metadata: Metadata
356
444
  "Asset size"
357
- size: Long
445
+ size: Float
358
446
  "Mime type of the asset"
359
447
  type: String
360
448
  }
361
449
 
450
+ "Result of the dependency inspector operation."
451
+ type BundleDependency {
452
+ "An error occurred during parsing dependency"
453
+ error: String
454
+ "The name of the dependency"
455
+ name: String
456
+ "The dependency is optional"
457
+ optional: Boolean
458
+ "The status of that dependency."
459
+ status: String
460
+ "The type of the dependency."
461
+ type: String
462
+ "The version of the dependency (can be a range, a number or empty)"
463
+ version: String
464
+ }
465
+
466
+ "Result of the dependency inspector operation."
467
+ type BundleWithDependencies {
468
+ "Display name of the bundle."
469
+ bundleDisplayName: String
470
+ "ID of the bundle."
471
+ bundleId: Long
472
+ "Name of the bundle."
473
+ bundleName: String
474
+ "Symbolic name of the bundle."
475
+ bundleSymbolicName: String
476
+ "List of bundle dependencies (packages and modules)."
477
+ dependencies: [BundleDependency]
478
+ "Is module dependencies can be safely upgraded without breaking module wiring ?"
479
+ dependenciesUpgradables: Boolean
480
+ }
481
+
482
+ "Result of the export package inspector operation."
483
+ type BundleWithExportPackage {
484
+ "Display name of the bundle."
485
+ bundleDisplayName: String
486
+ "ID of the bundle."
487
+ bundleId: Long
488
+ "Name of the bundle."
489
+ bundleName: String
490
+ "Symbolic name of the bundle."
491
+ bundleSymbolicName: String
492
+ "The full export-package clause."
493
+ matchingExportPackage: String
494
+ }
495
+
496
+ "Result of the import package inspector operation."
497
+ type BundleWithImportPackages {
498
+ "Display name of the bundle."
499
+ bundleDisplayName: String
500
+ "ID of the bundle."
501
+ bundleId: Long
502
+ "Name of the bundle."
503
+ bundleName: String
504
+ "Symbolic name of the bundle."
505
+ bundleSymbolicName: String
506
+ "List of matching imported packages."
507
+ matchingImportPackages: [String]
508
+ }
509
+
362
510
  "Category type"
363
511
  type Category {
364
512
  "Description"
@@ -496,111 +644,38 @@ type Current_32_user {
496
644
  username: String!
497
645
  }
498
646
 
499
- type EditorForm {
500
- "Retrieve a description text for the form, might contain explanations on how to use the form"
501
- description: String
502
- "Retrieve the displayable name of the form (in a specific language)"
503
- displayName: String
504
- "Returns the preview status of the form. If true, the form can display a preview."
505
- hasPreview: Boolean
506
- "Retrieve the name (aka identifier) of the form"
507
- name: String
508
- "Retrieve the sections that make up the form"
509
- sections: [EditorFormSection]
647
+ "Result of the export package inspector operation."
648
+ type ExportPackages {
649
+ "Flat list of exported packages"
650
+ matchingExportPackages: [String]
651
+ "The bundles that export the package."
652
+ matchingExportPackagesDetailed: [BundleWithExportPackage]
653
+ "the package name."
654
+ packageName: String
510
655
  }
511
656
 
512
- type EditorFormField {
513
- "This value contains the current existing values for the field."
514
- currentValues: [EditorFormFieldValue]
515
- "The declaring node type for the field"
516
- declaringNodeType: String
517
- "This value contains the default values for the field."
518
- defaultValues: [EditorFormFieldValue]
519
- "The description of the field"
520
- description: String
521
- "The displayable name of the field"
522
- displayName: String
523
- "The error message of the field"
524
- errorMessage: String
525
- "This value is true if the field allows for internationalized values"
526
- i18n: Boolean
527
- "This value is true if the field is mandatory"
528
- mandatory: Boolean
529
- "This value is true if the field value is multi-valued."
530
- multiple: Boolean
531
- "The name of the field"
532
- name: String
533
- "This value is true if the field is readonly. This could be due to locks or permissions"
534
- readOnly: Boolean
535
- "The required type for the field"
536
- requiredType: JCRPropertyType
537
- "Options for the selector type. For JCR definitions, this will usually include choicelist initializer name and properties."
538
- selectorOptions: [EditorFormProperty]
539
- "The selector type for the field. In the case of fields generated from node types, this is actually the SelectorType."
540
- selectorType: String
541
- "This array contains the list of possible values to choose from"
542
- valueConstraints: [EditorFormFieldValueConstraint]
543
- }
544
-
545
- type EditorFormFieldSet {
546
- "Only used in the case of a dynamic field set. Set to true if it is activated"
547
- activated: Boolean
548
- "Get the internationalized description of the field set"
549
- description: String
550
- "Get the internationalized displayable name of the field set"
551
- displayName: String
552
- "Defines if the field has to be displayed or not"
553
- displayed: Boolean
554
- "True if this is dynamic field set (meaningin it can be activated or not)"
555
- dynamic: Boolean
556
- "Get the fields contained in the target"
557
- fields: [EditorFormField]
558
- "Get the name of the field set"
559
- name: String
560
- "This value is true if the fieldset is readonly. This could be due to locks or permissions"
561
- readOnly: Boolean
562
- }
563
-
564
- type EditorFormFieldValue {
565
- "This value's string representation"
566
- string: String
567
- "The type of this value"
568
- type: String
569
- }
570
-
571
- type EditorFormFieldValueConstraint {
572
- "The value as it is intended to be displayed in UIs"
573
- displayValue: String
574
- "The key of the value to get the translated value from the client side"
575
- displayValueKey: String
576
- "The properties for the value"
577
- properties: [EditorFormProperty]
578
- "The actual value to be used in storage"
579
- value: EditorFormFieldValue
657
+ "Result of the dependency inspector operation."
658
+ type FindDependencies {
659
+ "List of matching bundles."
660
+ bundles: [BundleWithDependencies]
661
+ "Total number of dependencies."
662
+ totalCount: Int
580
663
  }
581
664
 
582
- type EditorFormProperty {
583
- "Property name"
584
- name: String
585
- "Property value"
586
- value: String
587
- "Property values"
588
- values: [String]
665
+ "Result of the export package inspector operation."
666
+ type FindExportPackage {
667
+ "List of matching packages"
668
+ packages: [ExportPackages]
669
+ "Total number of matching export packages."
670
+ totalCount: Int
589
671
  }
590
672
 
591
- type EditorFormSection {
592
- "Returns the description of the section"
593
- description: String
594
- "Retrieve the displayable name of the section"
595
- displayName: String
596
- "Is the section expanded"
597
- expanded: Boolean
598
- "Returns the field sets contained in this section"
599
- fieldSets: [EditorFormFieldSet]
600
- "Check if this section should be hide"
601
- hide: Boolean
602
- "Retrieve the name (aka identifier) of the section"
603
- name: String
673
+ "Result of the import package inspector operation."
674
+ type FindImportPackage {
675
+ "List of matching bundles."
676
+ bundles: [BundleWithImportPackages]
677
+ "Total number of matching import packages."
678
+ totalCount: Int
604
679
  }
605
680
 
606
681
  "GraphQL representation of a generic JCR node"
@@ -726,6 +801,8 @@ type GenericJCRNode implements JCRNode {
726
801
  ): Boolean
727
802
  "Check if the node as a renderable template associated with it (not a view a template)."
728
803
  isDisplayableNode: Boolean
804
+ "true if node is under a mounted node"
805
+ isExternal: Boolean!
729
806
  "Reports if the current node matches the nodetype(s) passed in parameter"
730
807
  isNodeType(
731
808
  "Node type name"
@@ -782,6 +859,11 @@ type GenericJCRNode implements JCRNode {
782
859
  "When set to true, returns the node in the default language if there is no translation for the requested language. Returns null if the option \"Replace untranslated content with the default language content\" is not activated for the site of the requested node. Will also return null if there is no translation for the default language."
783
860
  useFallbackLanguage: Boolean = false
784
861
  ): JCRProperty
862
+ "Returns count of all references of the node across all sites"
863
+ referenceCount(
864
+ "Filter out referencing types which should not be counted"
865
+ typesFilter: InputNodeTypesInput
866
+ ): Int
785
867
  "GraphQL representations of the reference properties that target the current JCR Node"
786
868
  references(
787
869
  "fetching only nodes after this node (exclusive)"
@@ -790,6 +872,8 @@ type GenericJCRNode implements JCRNode {
790
872
  before: String,
791
873
  "Filter by graphQL fields values"
792
874
  fieldFilter: InputFieldFiltersInput,
875
+ "Sort by graphQL fields values"
876
+ fieldSorter: InputFieldSorterInput,
793
877
  "fetching only the first certain number of nodes"
794
878
  first: Int,
795
879
  "fetching only the last certain number of nodes"
@@ -799,6 +883,15 @@ type GenericJCRNode implements JCRNode {
799
883
  "fetching only nodes after this node (inclusive)"
800
884
  offset: Int
801
885
  ): JCRPropertyConnection!
886
+ "Get render URL."
887
+ renderUrl(
888
+ "Finds displayable node"
889
+ findDisplayable: Boolean = false,
890
+ "The language content is rendered in"
891
+ language: String!,
892
+ "The target workspace"
893
+ workspace: Workspace!
894
+ ): String
802
895
  "Gets the fully rendered content for this node"
803
896
  renderedContent(
804
897
  "Rendering context configuration"
@@ -813,16 +906,44 @@ type GenericJCRNode implements JCRNode {
813
906
  requestAttributes: [InputRenderRequestAttributeInput],
814
907
  "Template type"
815
908
  templateType: String,
816
- "Name of the view"
909
+ "Name of the view (leave null for default)"
817
910
  view: String
818
911
  ): RenderedNode
819
912
  "GraphQL representation of the site the JCR node belongs to, or the system site in case the node does not belong to any site"
820
913
  site: JCRSite
914
+ "Get node thumbnail URL"
915
+ thumbnailUrl(
916
+ "Optional: Checks if requested thumbnail node exists, returns null if it doesn't"
917
+ checkIfExists: Boolean = false,
918
+ "Thumbnail name"
919
+ name: String
920
+ ): String
821
921
  "Returns languages of available translations for this node"
822
922
  translationLanguages(
823
923
  "Optional: Return languages only if it is active for the site"
824
924
  isActiveOnly: Boolean
825
925
  ): [String]
926
+ "Get node URL"
927
+ url: String
928
+ "GraphQL representations of the reference properties that target the current JCR Node"
929
+ usages(
930
+ "fetching only nodes after this node (exclusive)"
931
+ after: String,
932
+ "fetching only nodes before this node (exclusive)"
933
+ before: String,
934
+ "Filter by graphQL fields values"
935
+ fieldFilter: InputFieldFiltersInput,
936
+ "Sort by graphQL fields values"
937
+ fieldSorter: InputFieldSorterInput,
938
+ "fetching only the first certain number of nodes"
939
+ first: Int,
940
+ "fetching only the last certain number of nodes"
941
+ last: Int,
942
+ "fetching only the first certain number of nodes"
943
+ limit: Int,
944
+ "fetching only nodes after this node (inclusive)"
945
+ offset: Int
946
+ ): UsageConnection!
826
947
  "The UUID of the JCR node this object represents"
827
948
  uuid: String!
828
949
  "Get vanity URLs from the current node filtered by the parameters"
@@ -901,12 +1022,26 @@ type GqlBackgroundJob {
901
1022
  ): String
902
1023
  "The job name"
903
1024
  name: String
1025
+ "GraphQL representation of publication job"
1026
+ publicationJob: GqlPublicationBackgroundJob
904
1027
  "The site key. The returned value will be null in case the job doesn't have associated site key"
905
1028
  siteKey: String
906
1029
  "The user key. The returned value will be null in case the job doesn't have associated user key"
907
1030
  userKey: String
908
1031
  }
909
1032
 
1033
+ "Condition for override item"
1034
+ type GqlCondition {
1035
+ "Item will apply only on this nodetype"
1036
+ nodeType: String
1037
+ "Item will apply only if node has orderable children"
1038
+ orderable: Boolean
1039
+ "Item will apply only if user has permissions"
1040
+ withPermission: String
1041
+ "Item will apply only if user has not permissions"
1042
+ withoutPermission: String
1043
+ }
1044
+
910
1045
  "Mutation for OSGi configuration"
911
1046
  type GqlConfigurationMutation {
912
1047
  "Modify a list of items"
@@ -974,6 +1109,131 @@ type GqlDashboard {
974
1109
  toolsAccess: Boolean
975
1110
  }
976
1111
 
1112
+ type GqlDistributedSessionsMutation {
1113
+ "Delete a session"
1114
+ removeSession(
1115
+ "Session id"
1116
+ id: String!
1117
+ ): Boolean
1118
+ }
1119
+
1120
+ type GqlDistributedSessionsQuery {
1121
+ localSessions(
1122
+ "fetching only nodes after this node (exclusive)"
1123
+ after: String,
1124
+ "fetching only nodes before this node (exclusive)"
1125
+ before: String,
1126
+ "Filter by graphQL fields values"
1127
+ fieldFilter: InputFieldFiltersInput,
1128
+ "Group fields by criteria"
1129
+ fieldGrouping: InputFieldGroupingInput,
1130
+ "sort by GraphQL field values"
1131
+ fieldSorter: InputFieldSorterInput,
1132
+ "fetching only the first certain number of nodes"
1133
+ first: Int,
1134
+ "fetching only the last certain number of nodes"
1135
+ last: Int,
1136
+ "fetching only the first certain number of nodes"
1137
+ limit: Int,
1138
+ "fetching only nodes after this node (inclusive)"
1139
+ offset: Int
1140
+ ): GqlSessionConnection
1141
+ sessions(
1142
+ "fetching only nodes after this node (exclusive)"
1143
+ after: String,
1144
+ "fetching only nodes before this node (exclusive)"
1145
+ before: String,
1146
+ "Filter by graphQL fields values"
1147
+ fieldFilter: InputFieldFiltersInput,
1148
+ "Group fields by criteria"
1149
+ fieldGrouping: InputFieldGroupingInput,
1150
+ "sort by GraphQL field values"
1151
+ fieldSorter: InputFieldSorterInput,
1152
+ "fetching only the first certain number of nodes"
1153
+ first: Int,
1154
+ "fetching only the last certain number of nodes"
1155
+ last: Int,
1156
+ "fetching only the first certain number of nodes"
1157
+ limit: Int,
1158
+ "fetching only nodes after this node (inclusive)"
1159
+ offset: Int
1160
+ ): GqlSessionConnection
1161
+ sessionsCount: Int
1162
+ }
1163
+
1164
+ type GqlEditorForm {
1165
+ "Retrieve a description text for the form, might contain explanations on how to use the form"
1166
+ description: String
1167
+ "Retrieve the displayable name of the form (in a specific language)"
1168
+ displayName: String
1169
+ "Returns the preview status of the form. If true, the form can display a preview."
1170
+ hasPreview: Boolean
1171
+ "Get list of merged forms."
1172
+ mergedItems(
1173
+ "Filter on field values"
1174
+ filter: InputFieldFiltersInput
1175
+ ): [GqlMergedItem]
1176
+ "Retrieve the name (aka identifier) of the form"
1177
+ name: String
1178
+ "Retrieve the sections that make up the form"
1179
+ sections: [GqlEditorFormSection]
1180
+ "Returns the advanced mode status of the form. If true advanced mode is available."
1181
+ showAdvancedMode: Boolean
1182
+ }
1183
+
1184
+ type GqlEditorFormField {
1185
+ "The declaring node type for the field"
1186
+ declaringNodeType: String
1187
+ "This value contains the default values for the field."
1188
+ defaultValues: [GqlEditorFormValue]
1189
+ "The description of the field"
1190
+ description: String
1191
+ "The displayable name of the field"
1192
+ displayName: String
1193
+ "The error message of the field"
1194
+ errorMessage: String
1195
+ "This value is true if the field allows for internationalized values"
1196
+ i18n: Boolean
1197
+ "This value is true if the field is mandatory"
1198
+ mandatory: Boolean
1199
+ "This value is true if the field value is multi-valued."
1200
+ multiple: Boolean
1201
+ "The name of the field"
1202
+ name: String
1203
+ "This value is true if the field is readonly. This could be due to locks or permissions"
1204
+ readOnly: Boolean
1205
+ "The required type for the field"
1206
+ requiredType: JCRPropertyType
1207
+ "Options for the selector type. For JCR definitions, this will usually include choicelist initializer name and properties."
1208
+ selectorOptions: [GqlEditorFormProperty]
1209
+ "The selector type for the field. In the case of fields generated from node types, this is actually the SelectorType."
1210
+ selectorType: String
1211
+ "This array contains the list of possible values to choose from"
1212
+ valueConstraints: [GqlEditorFormValueConstraint]
1213
+ "This fields set is visible"
1214
+ visible: Boolean
1215
+ }
1216
+
1217
+ type GqlEditorFormFieldSet {
1218
+ "Only used in the case of a dynamic field set. Set to true if it is activated"
1219
+ activated: Boolean
1220
+ "Get the internationalized description of the field set"
1221
+ description: String
1222
+ "Get the internationalized displayable name of the field set"
1223
+ displayName: String
1224
+ "True if this is dynamic field set (meaning it can be activated or not)"
1225
+ dynamic: Boolean
1226
+ "Get the fields contained in the target"
1227
+ fields: [GqlEditorFormField]
1228
+ "Only used in the case of a dynamic field set. Set to true if it is activated"
1229
+ hasEnableSwitch: Boolean
1230
+ "Get the name of the field set"
1231
+ name: String
1232
+ "This value is true if the fieldset is readonly. This could be due to locks or permissions"
1233
+ readOnly: Boolean
1234
+ visible: Boolean
1235
+ }
1236
+
977
1237
  type GqlEditorFormMutations {
978
1238
  "Publish the edited node with the associated technical sub nodes (visibility conditions, vanity urls, ACLs)"
979
1239
  publishForm(
@@ -989,6 +1249,48 @@ type GqlEditorFormMutations {
989
1249
  ): Boolean
990
1250
  }
991
1251
 
1252
+ type GqlEditorFormProperty {
1253
+ "Property name"
1254
+ name: String
1255
+ "Property value"
1256
+ value: String
1257
+ "Property values"
1258
+ values: [String]
1259
+ }
1260
+
1261
+ type GqlEditorFormSection {
1262
+ "Returns the description of the section"
1263
+ description: String
1264
+ "Retrieve the displayable name of the section"
1265
+ displayName: String
1266
+ "Is the section expanded"
1267
+ expanded: Boolean
1268
+ "Returns the field sets contained in this section"
1269
+ fieldSets: [GqlEditorFormFieldSet]
1270
+ "Retrieve the name (aka identifier) of the section"
1271
+ name: String
1272
+ "This section is visible"
1273
+ visible: Boolean
1274
+ }
1275
+
1276
+ type GqlEditorFormValue {
1277
+ "This value's string representation"
1278
+ string: String
1279
+ "The type of this value"
1280
+ type: String
1281
+ }
1282
+
1283
+ type GqlEditorFormValueConstraint {
1284
+ "The value as it is intended to be displayed in UIs"
1285
+ displayValue: String
1286
+ "The key of the value to get the translated value from the client side"
1287
+ displayValueKey: String
1288
+ "The properties for the value"
1289
+ properties: [GqlEditorFormProperty]
1290
+ "The actual value to be used in storage"
1291
+ value: GqlEditorFormValue
1292
+ }
1293
+
992
1294
  type GqlEditorForms {
993
1295
  "Retrieve the custom configuration path for CKEditor"
994
1296
  ckeditorConfigPath(
@@ -1008,14 +1310,14 @@ type GqlEditorForms {
1008
1310
  excludedNodeTypes: [String],
1009
1311
  "if true, retrieves all the sub types of the given node types, if false, returns the type only. Default value is true"
1010
1312
  includeSubTypes: Boolean = true,
1011
- "thPath of an existing node under with the new content will be created."
1012
- nodePath: String!,
1013
1313
  "List of types we want to retrieve, null for all"
1014
1314
  nodeTypes: [String],
1015
1315
  "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
1016
1316
  uiLocale: String!,
1017
1317
  "if true, check the contribute property of the node. Default value is true"
1018
- useContribute: Boolean = true
1318
+ useContribute: Boolean = true,
1319
+ "Path or id of an existing node under with the new content will be created."
1320
+ uuidOrPath: String!
1019
1321
  ): [NodeTypeTreeEntry]
1020
1322
  "Get a editor form to create a new content from its nodetype and parent"
1021
1323
  createForm(
@@ -1027,7 +1329,7 @@ type GqlEditorForms {
1027
1329
  uiLocale: String!,
1028
1330
  "uuid or path of an existing node under with the new content will be created."
1029
1331
  uuidOrPath: String!
1030
- ): EditorForm
1332
+ ): GqlEditorForm
1031
1333
  "Get a editor form from a locale and an existing node"
1032
1334
  editForm(
1033
1335
  "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
@@ -1036,7 +1338,7 @@ type GqlEditorForms {
1036
1338
  uiLocale: String!,
1037
1339
  "UUID or path of an existing node under with the new content will be created."
1038
1340
  uuidOrPath: String!
1039
- ): EditorForm
1341
+ ): GqlEditorForm
1040
1342
  "Get field constraints"
1041
1343
  fieldConstraints(
1042
1344
  "Object contains additional information of the node"
@@ -1055,7 +1357,7 @@ type GqlEditorForms {
1055
1357
  primaryNodeType: String!,
1056
1358
  "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
1057
1359
  uiLocale: String!
1058
- ): [EditorFormFieldValueConstraint]
1360
+ ): [GqlEditorFormValueConstraint]
1059
1361
  "Retrieve the number of sub contents under the node for given types"
1060
1362
  subContentsCount(
1061
1363
  "List of node types to check for"
@@ -1069,11 +1371,20 @@ type GqlEditorForms {
1069
1371
 
1070
1372
  "Server healthCheck"
1071
1373
  type GqlHealthCheck {
1072
- probes: [GqlProbe]
1374
+ "Probes registered in SAM for the requested severity"
1375
+ probes(
1376
+ "Return probes matching this status or above"
1377
+ health: GqlProbeHealth
1378
+ ): [GqlProbe]
1073
1379
  "Highest reported status across all probes"
1074
1380
  status: GqlProbeStatus
1075
1381
  }
1076
1382
 
1383
+ type GqlHzPartition {
1384
+ id: Int
1385
+ owner: String
1386
+ }
1387
+
1077
1388
  type GqlJcrImageTransformMutation {
1078
1389
  "Crop an image under the current node"
1079
1390
  cropImage(
@@ -1112,6 +1423,22 @@ type GqlLockDetail {
1112
1423
  type: String
1113
1424
  }
1114
1425
 
1426
+ "Override item"
1427
+ type GqlMergedItem {
1428
+ "Name of the bundle owning this file"
1429
+ bundleName: String
1430
+ "Conditions set on this form/fieldset"
1431
+ condition: GqlCondition
1432
+ "Get field set detail, if item is a field set"
1433
+ fieldSet: GqlEditorFormFieldSet
1434
+ "File name and path"
1435
+ filename: String
1436
+ "Get form detail, if item is a form"
1437
+ form: GqlEditorForm
1438
+ "Override priority"
1439
+ priority: Float
1440
+ }
1441
+
1115
1442
  type GqlModule {
1116
1443
  "User facing description for the module"
1117
1444
  description: String
@@ -1127,6 +1454,96 @@ type GqlModule {
1127
1454
  version: String
1128
1455
  }
1129
1456
 
1457
+ "Mount point object"
1458
+ type GqlMountPoint {
1459
+ "Mount point name"
1460
+ mountName: String
1461
+ "Mount point local reference path"
1462
+ mountPointRefPath: String
1463
+ "Mount status"
1464
+ mountStatus: String
1465
+ "Mount node type"
1466
+ nodeType: String
1467
+ "Mount point additional properties"
1468
+ properties: [GqlMountPointProperty]
1469
+ "Mount point property"
1470
+ property(
1471
+ "The name of the property"
1472
+ name: String!
1473
+ ): String
1474
+ "Mount point node uuid"
1475
+ uuid: String
1476
+ }
1477
+
1478
+ "Mount point mutation object"
1479
+ type GqlMountPointMutation {
1480
+ "Create a mounted mount point node in /mounts"
1481
+ add(
1482
+ "Target local mount point"
1483
+ mountPointRefPath: String,
1484
+ "Mount point name"
1485
+ name: String!
1486
+ ): String
1487
+ "Create a mounted VFS mount point node in /mounts"
1488
+ addVfs(
1489
+ "Target local mount point"
1490
+ mountPointRefPath: String,
1491
+ "Name for the mount point"
1492
+ name: String!,
1493
+ "VFS root mount point"
1494
+ rootPath: String
1495
+ ): String
1496
+ "Modify an existing mount point node"
1497
+ modify(
1498
+ "Change local mount point, or set to empty string to remove"
1499
+ mountPointRefPath: String,
1500
+ "Rename existing mount point"
1501
+ name: String,
1502
+ "Mount point path or ID to modify"
1503
+ pathOrId: String!
1504
+ ): Boolean
1505
+ "Modify an existing mount point node"
1506
+ modifyVfs(
1507
+ "Change target local mount point, or set to empty string to remove"
1508
+ mountPointRefPath: String,
1509
+ "Rename existing mount point"
1510
+ name: String,
1511
+ "Mount point path or ID to modify"
1512
+ pathOrId: String!,
1513
+ "VFS root mount point"
1514
+ rootPath: String
1515
+ ): Boolean
1516
+ "Mount an existing mount point"
1517
+ mount(
1518
+ "Mount point path or ID to mount"
1519
+ pathOrId: String!
1520
+ ): Boolean
1521
+ "Unmount an existing mount point"
1522
+ unmount(
1523
+ "Mount point path or ID to unmount"
1524
+ pathOrId: String!
1525
+ ): Boolean
1526
+ }
1527
+
1528
+ "Mount point property"
1529
+ type GqlMountPointProperty {
1530
+ "The property key"
1531
+ key: String
1532
+ "The property value"
1533
+ value: String
1534
+ }
1535
+
1536
+ "Mount point queries object"
1537
+ type GqlMountPointQuery {
1538
+ "Get mount point with given name, or null if it doesn't exists"
1539
+ mountPoint(
1540
+ "Name for the mount point"
1541
+ name: String!
1542
+ ): GqlMountPoint
1543
+ "Get list of mount points, or empty list if no mounts exist"
1544
+ mountPoints: [GqlMountPoint]
1545
+ }
1546
+
1130
1547
  "Possible operations on a node"
1131
1548
  type GqlOperationsSupport {
1132
1549
  "Can node be locked"
@@ -1137,6 +1554,7 @@ type GqlOperationsSupport {
1137
1554
  publication: Boolean!
1138
1555
  }
1139
1556
 
1557
+ "Probes registered with SAM"
1140
1558
  type GqlProbe {
1141
1559
  "Description specified by the developer of the probe"
1142
1560
  description: String
@@ -1153,7 +1571,61 @@ type GqlProbeStatus {
1153
1571
  "Health of the probe"
1154
1572
  health: GqlProbeHealth
1155
1573
  "Message explaining probe status"
1156
- message: String
1574
+ message: String @deprecated(reason: "When multiple probe return the same error status (YELLOW or RED), the message does not guarantee which of the probe will get its message returned. We recommend using the \"health\" parameter and corresponding individual probe message instead.")
1575
+ }
1576
+
1577
+ "Publication background job"
1578
+ type GqlPublicationBackgroundJob {
1579
+ "The amount of time the job ran for (in milliseconds). The returned value will be -1 until the job has actually completed"
1580
+ duration: Long
1581
+ "The job group name"
1582
+ group: String
1583
+ "The job (Boolean) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
1584
+ jobBooleanProperty(
1585
+ "The job name"
1586
+ name: String
1587
+ ): Boolean
1588
+ "The job (Int) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
1589
+ jobIntegerProperty(
1590
+ "The job name"
1591
+ name: String
1592
+ ): Int
1593
+ "The job (Long) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
1594
+ jobLongProperty(
1595
+ "The job name"
1596
+ name: String
1597
+ ): Long
1598
+ "The job state is different from the status, it reflect the last action done on the job instance (Started, Vetoed, Finished)"
1599
+ jobState: GqlBackgroundJobState
1600
+ "The job status"
1601
+ jobStatus: GqlBackgroundJobStatus
1602
+ "The job (String) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
1603
+ jobStringProperty(
1604
+ "The job name"
1605
+ name: String
1606
+ ): String
1607
+ "Publication language"
1608
+ language: String
1609
+ "The job name"
1610
+ name: String
1611
+ "The site key. The returned value will be null in case the job doesn't have associated site key"
1612
+ siteKey: String
1613
+ "The user key. The returned value will be null in case the job doesn't have associated user key"
1614
+ userKey: String
1615
+ }
1616
+
1617
+ "Publication event"
1618
+ type GqlPublicationEvent {
1619
+ "Language"
1620
+ language: String
1621
+ "Paths"
1622
+ paths: [String]
1623
+ "Site key"
1624
+ siteKey: String
1625
+ "State of the publication event"
1626
+ state: State
1627
+ "User"
1628
+ user: String
1157
1629
  }
1158
1630
 
1159
1631
  "Publication status information for a JCR node"
@@ -1184,6 +1656,36 @@ type GqlScope {
1184
1656
  name: String
1185
1657
  }
1186
1658
 
1659
+ type GqlSession {
1660
+ cost: Long
1661
+ creationTime: String
1662
+ id: String
1663
+ lastAccessedTime: String
1664
+ maxInactiveIntervalInSeconds: Int
1665
+ partition: GqlHzPartition
1666
+ user: User
1667
+ }
1668
+
1669
+ "A connection to a list of items."
1670
+ type GqlSessionConnection {
1671
+ "a list of edges"
1672
+ edges: [GqlSessionEdge]
1673
+ "a list of nodes"
1674
+ nodes: [GqlSession]
1675
+ "details about this specific page"
1676
+ pageInfo: PageInfo!
1677
+ }
1678
+
1679
+ "An edge in a connection"
1680
+ type GqlSessionEdge {
1681
+ "cursor marks a unique position or index into the connection"
1682
+ cursor: String!
1683
+ "index in the connection"
1684
+ index: Int
1685
+ "The item at the end of the edge"
1686
+ node: GqlSession
1687
+ }
1688
+
1187
1689
  type GqlWorkflowEvent {
1188
1690
  "Number of tasks for current user"
1189
1691
  activeWorkflowTaskCountForUser: Int
@@ -1290,15 +1792,15 @@ type GroupEdge {
1290
1792
  "Asset type for image"
1291
1793
  type ImageAsset {
1292
1794
  "Image height"
1293
- height: Long
1795
+ height: Float
1294
1796
  "Asset metadata"
1295
1797
  metadata: Metadata
1296
1798
  "Image size"
1297
- size: Long
1799
+ size: Float
1298
1800
  "Mime type of image"
1299
1801
  type: String
1300
1802
  "Image width"
1301
- width: Long
1803
+ width: Float
1302
1804
  }
1303
1805
 
1304
1806
  "JCR Mutations"
@@ -1325,6 +1827,8 @@ type JCRMutation {
1325
1827
  ): [JCRNodeMutation]
1326
1828
  "Copy a single node to a different parent node"
1327
1829
  copyNode(
1830
+ "The child node types that should be skipped during copy"
1831
+ childNodeTypesToSkip: [String],
1328
1832
  "The name of the node at the new location or null if its current name should be preserved"
1329
1833
  destName: String,
1330
1834
  "Path or UUID of the destination parent node to copy the node to"
@@ -1333,7 +1837,11 @@ type JCRMutation {
1333
1837
  pathOrId: String!
1334
1838
  ): JCRNodeMutation
1335
1839
  "Copy multiple nodes to different parent node(s)"
1336
- copyNodes(nodes: [InputCarriedJCRNode!]!): [JCRNodeMutation]
1840
+ copyNodes(
1841
+ "The child node types that should be skipped during copy"
1842
+ childNodeTypesToSkip: [String],
1843
+ nodes: [InputCarriedJCRNode!]!
1844
+ ): [JCRNodeMutation]
1337
1845
  "Delete an existing node and all its children"
1338
1846
  deleteNode(
1339
1847
  "The path or id of the node to delete"
@@ -1396,6 +1904,8 @@ type JCRMutation {
1396
1904
  ): [VanityUrlMappingMutation]
1397
1905
  "Paste a single node to a different parent node"
1398
1906
  pasteNode(
1907
+ "The child node types that should be skipped during copy"
1908
+ childNodeTypesToSkip: [String],
1399
1909
  "The name of the node at the new location or null if its current name should be preserved"
1400
1910
  destName: String,
1401
1911
  "Path or UUID of the destination parent node to paste the node to"
@@ -1409,6 +1919,8 @@ type JCRMutation {
1409
1919
  ): JCRNodeMutation
1410
1920
  "Paste multiple nodes to different parent node(s)"
1411
1921
  pasteNodes(
1922
+ "The child node types that should be skipped during copy"
1923
+ childNodeTypesToSkip: [String],
1412
1924
  "Paste mode, either COPY or MOVE"
1413
1925
  mode: PasteMode!,
1414
1926
  "The way to deal with duplicate node names when they are not allowed, either FAIL or RENAME"
@@ -1551,7 +2063,9 @@ type JCRNodeMutation {
1551
2063
  "The target node path of the current node after the move operation"
1552
2064
  destPath: String,
1553
2065
  "The parent node path or id under which the current node will be moved to"
1554
- parentPathOrId: String
2066
+ parentPathOrId: String,
2067
+ "Renames current node before moving if the name exists under destination node"
2068
+ renameOnConflict: Boolean
1555
2069
  ): String
1556
2070
  "Mutates a set of existing direct sub nodes, based on filters passed as parameter"
1557
2071
  mutateChildren(
@@ -1803,6 +2317,10 @@ type JCRProperty {
1803
2317
  refNode: JCRNode
1804
2318
  "GraphQL representations of the nodes this property references in case the property is multiple-valued, null otherwise"
1805
2319
  refNodes: [JCRNode]
2320
+ "Gets the rendered value of that property"
2321
+ renderedValue: String
2322
+ "Gets the rendered values of that property"
2323
+ renderedValues: [String]
1806
2324
  "The binary size of the JCR node as a Long, null otherwise"
1807
2325
  size: Long
1808
2326
  "The type of the JCR property"
@@ -2172,6 +2690,8 @@ type JCRSite implements JCRNode {
2172
2690
  installedModulesWithAllDependencies: [String]
2173
2691
  "Check if the node as a renderable template associated with it (not a view a template)."
2174
2692
  isDisplayableNode: Boolean
2693
+ "true if node is under a mounted node"
2694
+ isExternal: Boolean!
2175
2695
  "Reports if the current node matches the nodetype(s) passed in parameter"
2176
2696
  isNodeType(
2177
2697
  "Node type name"
@@ -2230,6 +2750,11 @@ type JCRSite implements JCRNode {
2230
2750
  "When set to true, returns the node in the default language if there is no translation for the requested language. Returns null if the option \"Replace untranslated content with the default language content\" is not activated for the site of the requested node. Will also return null if there is no translation for the default language."
2231
2751
  useFallbackLanguage: Boolean = false
2232
2752
  ): JCRProperty
2753
+ "Returns count of all references of the node across all sites"
2754
+ referenceCount(
2755
+ "Filter out referencing types which should not be counted"
2756
+ typesFilter: InputNodeTypesInput
2757
+ ): Int
2233
2758
  "GraphQL representations of the reference properties that target the current JCR Node"
2234
2759
  references(
2235
2760
  "fetching only nodes after this node (exclusive)"
@@ -2238,6 +2763,8 @@ type JCRSite implements JCRNode {
2238
2763
  before: String,
2239
2764
  "Filter by graphQL fields values"
2240
2765
  fieldFilter: InputFieldFiltersInput,
2766
+ "Sort by graphQL fields values"
2767
+ fieldSorter: InputFieldSorterInput,
2241
2768
  "fetching only the first certain number of nodes"
2242
2769
  first: Int,
2243
2770
  "fetching only the last certain number of nodes"
@@ -2247,6 +2774,15 @@ type JCRSite implements JCRNode {
2247
2774
  "fetching only nodes after this node (inclusive)"
2248
2775
  offset: Int
2249
2776
  ): JCRPropertyConnection!
2777
+ "Get render URL."
2778
+ renderUrl(
2779
+ "Finds displayable node"
2780
+ findDisplayable: Boolean = false,
2781
+ "The language content is rendered in"
2782
+ language: String!,
2783
+ "The target workspace"
2784
+ workspace: Workspace!
2785
+ ): String
2250
2786
  "Gets the fully rendered content for this node"
2251
2787
  renderedContent(
2252
2788
  "Rendering context configuration"
@@ -2261,7 +2797,7 @@ type JCRSite implements JCRNode {
2261
2797
  requestAttributes: [InputRenderRequestAttributeInput],
2262
2798
  "Template type"
2263
2799
  templateType: String,
2264
- "Name of the view"
2800
+ "Name of the view (leave null for default)"
2265
2801
  view: String
2266
2802
  ): RenderedNode
2267
2803
  "Site server name"
@@ -2270,11 +2806,39 @@ type JCRSite implements JCRNode {
2270
2806
  site: JCRSite
2271
2807
  "Site key"
2272
2808
  sitekey: String
2809
+ "Get node thumbnail URL"
2810
+ thumbnailUrl(
2811
+ "Optional: Checks if requested thumbnail node exists, returns null if it doesn't"
2812
+ checkIfExists: Boolean = false,
2813
+ "Thumbnail name"
2814
+ name: String
2815
+ ): String
2273
2816
  "Returns languages of available translations for this node"
2274
2817
  translationLanguages(
2275
2818
  "Optional: Return languages only if it is active for the site"
2276
2819
  isActiveOnly: Boolean
2277
2820
  ): [String]
2821
+ "Get node URL"
2822
+ url: String
2823
+ "GraphQL representations of the reference properties that target the current JCR Node"
2824
+ usages(
2825
+ "fetching only nodes after this node (exclusive)"
2826
+ after: String,
2827
+ "fetching only nodes before this node (exclusive)"
2828
+ before: String,
2829
+ "Filter by graphQL fields values"
2830
+ fieldFilter: InputFieldFiltersInput,
2831
+ "Sort by graphQL fields values"
2832
+ fieldSorter: InputFieldSorterInput,
2833
+ "fetching only the first certain number of nodes"
2834
+ first: Int,
2835
+ "fetching only the last certain number of nodes"
2836
+ last: Int,
2837
+ "fetching only the first certain number of nodes"
2838
+ limit: Int,
2839
+ "fetching only nodes after this node (inclusive)"
2840
+ offset: Int
2841
+ ): UsageConnection!
2278
2842
  "The UUID of the JCR node this object represents"
2279
2843
  uuid: String!
2280
2844
  "Get vanity URLs from the current node filtered by the parameters"
@@ -2347,7 +2911,9 @@ type JahiaAdminMutation {
2347
2911
  "If factory pid, configiration identifier (filename suffix)"
2348
2912
  identifier: String,
2349
2913
  "Configuration pid ot factory pid"
2350
- pid: String!
2914
+ pid: String!,
2915
+ "Do not create new configuration, update existing one"
2916
+ updateOnly: Boolean = false
2351
2917
  ): GqlConfigurationMutation
2352
2918
  "Create a task"
2353
2919
  createTask(
@@ -2363,6 +2929,8 @@ type JahiaAdminMutation {
2363
2929
  "Service name"
2364
2930
  service: String!
2365
2931
  ): Boolean
2932
+ "Distributed sessions admin"
2933
+ distributedSessions: GqlDistributedSessionsMutation
2366
2934
  "Shutdown the server"
2367
2935
  shutdown(
2368
2936
  "Do not send the shutdown event"
@@ -2385,8 +2953,15 @@ type JahiaAdminQuery {
2385
2953
  ): GqlConfigurationQuery
2386
2954
  "Details about the database Jahia is connected to"
2387
2955
  database: JahiaDatabase
2956
+ "Distributed sessions admin"
2957
+ distributedSessions: GqlDistributedSessionsQuery
2388
2958
  "HealthCheck node"
2389
- healthCheck(severity: GqlProbeSeverity): GqlHealthCheck
2959
+ healthCheck(
2960
+ "Returns only SAM probes with probe names included in this list"
2961
+ includes: [String!],
2962
+ "Returns SAM probes with this severity or higher"
2963
+ severity: GqlProbeSeverity
2964
+ ): GqlHealthCheck
2390
2965
  "Get server load"
2391
2966
  load: Load
2392
2967
  "Get jobs scheduler"
@@ -2477,18 +3052,27 @@ type JournalRevision {
2477
3052
 
2478
3053
  "Server load"
2479
3054
  type Load {
3055
+ "Get JCR Node Cache load across active sessions"
3056
+ cachedNodes: LoadProvider
2480
3057
  "Get requests load"
2481
- requests: LoadValue
3058
+ requests: LoadProvider
2482
3059
  "Get JCR Sessions load"
2483
- sessions: LoadValue
3060
+ sessions: LoadProvider
3061
+ "Get Thread load"
3062
+ thread: LoadProvider
2484
3063
  }
2485
3064
 
2486
- "Load value"
2487
- type LoadValue {
3065
+ "Load provider"
3066
+ type LoadProvider {
2488
3067
  "Exponential moving average"
2489
- average(interval: LoadInterval): Float
3068
+ average(
3069
+ "Interval between collection of load metrics"
3070
+ interval: LoadInterval
3071
+ ): Float
2490
3072
  "Instantaneous count"
2491
- count: Int
3073
+ count: Float
3074
+ "Load Entry"
3075
+ entry: String
2492
3076
  }
2493
3077
 
2494
3078
  "Information on node lock"
@@ -2722,6 +3306,7 @@ type Query {
2722
3306
  admin: AdminQuery!
2723
3307
  "default finder for categoryById"
2724
3308
  categoryById(
3309
+ "Node identifier"
2725
3310
  id: String,
2726
3311
  "Content language, defaults to English"
2727
3312
  language: String = "en",
@@ -2732,6 +3317,7 @@ type Query {
2732
3317
  categoryByPath(
2733
3318
  "Content language, defaults to English"
2734
3319
  language: String = "en",
3320
+ "Path of the node"
2735
3321
  path: String,
2736
3322
  "Return content from live or default workspace"
2737
3323
  preview: Boolean = false
@@ -2814,9 +3400,11 @@ type Subscription {
2814
3400
  filterByJobStatuses: [GqlBackgroundJobStatus],
2815
3401
  "Subscribe only to job with matching names"
2816
3402
  filterByNames: [String],
3403
+ "Subscribe only to job with matching user keys"
3404
+ filterByUserKey: [String],
2817
3405
  "The target scheduler for listening jobs"
2818
3406
  targetScheduler: TargetScheduler = BOTH
2819
- ): GqlBackgroundJob
3407
+ ): GqlBackgroundJob @deprecated(reason: "Use subscribeToPublicationJob instead")
2820
3408
  "Lock the node for edition and subscribe to hold the lock. The node is automatically unlocked when the client disconnect or close the connection"
2821
3409
  subscribeToEditorLock(
2822
3410
  "An ID generated client side used to identify the lock"
@@ -2824,6 +3412,11 @@ type Subscription {
2824
3412
  "Uuid of the node to be locked."
2825
3413
  nodeId: String!
2826
3414
  ): String
3415
+ "Subscription on publication jobs"
3416
+ subscribeToPublicationJob(
3417
+ "Subscribe only to job with matching user keys"
3418
+ userKeyFilter: [String]
3419
+ ): GqlPublicationEvent
2827
3420
  "Subscription on workflows"
2828
3421
  workflowEvent: GqlWorkflowEvent
2829
3422
  }
@@ -2864,6 +3457,34 @@ type TaskEdge {
2864
3457
  node: Task
2865
3458
  }
2866
3459
 
3460
+ "GraphQL representation of a usage (node holding the reference + list of properties referencing the caller)"
3461
+ type Usage {
3462
+ "The GraphQL representation of the JCR node the property belongs to."
3463
+ node: JCRNode!
3464
+ "The GraphQL representation of the references on this node."
3465
+ properties: [JCRProperty]!
3466
+ }
3467
+
3468
+ "A connection to a list of items."
3469
+ type UsageConnection {
3470
+ "a list of edges"
3471
+ edges: [UsageEdge]
3472
+ "a list of nodes"
3473
+ nodes: [Usage]
3474
+ "details about this specific page"
3475
+ pageInfo: PageInfo!
3476
+ }
3477
+
3478
+ "An edge in a connection"
3479
+ type UsageEdge {
3480
+ "cursor marks a unique position or index into the connection"
3481
+ cursor: String!
3482
+ "index in the connection"
3483
+ index: Int
3484
+ "The item at the end of the edge"
3485
+ node: Usage
3486
+ }
3487
+
2867
3488
  "GraphQL representation of a Jahia user"
2868
3489
  type User implements Principal {
2869
3490
  "Full display name"
@@ -3117,6 +3738,8 @@ type VanityUrl implements JCRNode {
3117
3738
  ): Boolean
3118
3739
  "Check if the node as a renderable template associated with it (not a view a template)."
3119
3740
  isDisplayableNode: Boolean
3741
+ "true if node is under a mounted node"
3742
+ isExternal: Boolean!
3120
3743
  "Reports if the current node matches the nodetype(s) passed in parameter"
3121
3744
  isNodeType(
3122
3745
  "Node type name"
@@ -3175,6 +3798,11 @@ type VanityUrl implements JCRNode {
3175
3798
  "When set to true, returns the node in the default language if there is no translation for the requested language. Returns null if the option \"Replace untranslated content with the default language content\" is not activated for the site of the requested node. Will also return null if there is no translation for the default language."
3176
3799
  useFallbackLanguage: Boolean = false
3177
3800
  ): JCRProperty
3801
+ "Returns count of all references of the node across all sites"
3802
+ referenceCount(
3803
+ "Filter out referencing types which should not be counted"
3804
+ typesFilter: InputNodeTypesInput
3805
+ ): Int
3178
3806
  "GraphQL representations of the reference properties that target the current JCR Node"
3179
3807
  references(
3180
3808
  "fetching only nodes after this node (exclusive)"
@@ -3183,6 +3811,8 @@ type VanityUrl implements JCRNode {
3183
3811
  before: String,
3184
3812
  "Filter by graphQL fields values"
3185
3813
  fieldFilter: InputFieldFiltersInput,
3814
+ "Sort by graphQL fields values"
3815
+ fieldSorter: InputFieldSorterInput,
3186
3816
  "fetching only the first certain number of nodes"
3187
3817
  first: Int,
3188
3818
  "fetching only the last certain number of nodes"
@@ -3192,6 +3822,15 @@ type VanityUrl implements JCRNode {
3192
3822
  "fetching only nodes after this node (inclusive)"
3193
3823
  offset: Int
3194
3824
  ): JCRPropertyConnection!
3825
+ "Get render URL."
3826
+ renderUrl(
3827
+ "Finds displayable node"
3828
+ findDisplayable: Boolean = false,
3829
+ "The language content is rendered in"
3830
+ language: String!,
3831
+ "The target workspace"
3832
+ workspace: Workspace!
3833
+ ): String
3195
3834
  "Gets the fully rendered content for this node"
3196
3835
  renderedContent(
3197
3836
  "Rendering context configuration"
@@ -3206,13 +3845,20 @@ type VanityUrl implements JCRNode {
3206
3845
  requestAttributes: [InputRenderRequestAttributeInput],
3207
3846
  "Template type"
3208
3847
  templateType: String,
3209
- "Name of the view"
3848
+ "Name of the view (leave null for default)"
3210
3849
  view: String
3211
3850
  ): RenderedNode
3212
3851
  "GraphQL representation of the site the JCR node belongs to, or the system site in case the node does not belong to any site"
3213
3852
  site: JCRSite
3214
3853
  "The node targeted by this vanity URL"
3215
3854
  targetNode: JCRNode
3855
+ "Get node thumbnail URL"
3856
+ thumbnailUrl(
3857
+ "Optional: Checks if requested thumbnail node exists, returns null if it doesn't"
3858
+ checkIfExists: Boolean = false,
3859
+ "Thumbnail name"
3860
+ name: String
3861
+ ): String
3216
3862
  "Returns languages of available translations for this node"
3217
3863
  translationLanguages(
3218
3864
  "Optional: Return languages only if it is active for the site"
@@ -3220,6 +3866,25 @@ type VanityUrl implements JCRNode {
3220
3866
  ): [String]
3221
3867
  "The vanity URL"
3222
3868
  url: String
3869
+ "GraphQL representations of the reference properties that target the current JCR Node"
3870
+ usages(
3871
+ "fetching only nodes after this node (exclusive)"
3872
+ after: String,
3873
+ "fetching only nodes before this node (exclusive)"
3874
+ before: String,
3875
+ "Filter by graphQL fields values"
3876
+ fieldFilter: InputFieldFiltersInput,
3877
+ "Sort by graphQL fields values"
3878
+ fieldSorter: InputFieldSorterInput,
3879
+ "fetching only the first certain number of nodes"
3880
+ first: Int,
3881
+ "fetching only the last certain number of nodes"
3882
+ last: Int,
3883
+ "fetching only the first certain number of nodes"
3884
+ limit: Int,
3885
+ "fetching only nodes after this node (inclusive)"
3886
+ offset: Int
3887
+ ): UsageConnection!
3223
3888
  "The UUID of the JCR node this object represents"
3224
3889
  uuid: String!
3225
3890
  "Get vanity URLs from the current node filtered by the parameters"
@@ -3368,6 +4033,7 @@ enum GqlBackgroundJobStatus {
3368
4033
  SUCCESSFUL
3369
4034
  }
3370
4035
 
4036
+ "Available health statuses for a probe"
3371
4037
  enum GqlProbeHealth {
3372
4038
  "GREEN"
3373
4039
  GREEN
@@ -3377,9 +4043,12 @@ enum GqlProbeHealth {
3377
4043
  YELLOW
3378
4044
  }
3379
4045
 
4046
+ "Available severity levels for SAM probes"
3380
4047
  enum GqlProbeSeverity {
3381
4048
  "CRITICAL"
3382
4049
  CRITICAL
4050
+ "DEBUG"
4051
+ DEBUG
3383
4052
  "HIGH"
3384
4053
  HIGH
3385
4054
  "LOW"
@@ -3431,6 +4100,7 @@ enum JCRPropertyType {
3431
4100
  WEAKREFERENCE
3432
4101
  }
3433
4102
 
4103
+ "Interval expressed in minutes"
3434
4104
  enum LoadInterval {
3435
4105
  "FIFTEEN"
3436
4106
  FIFTEEN
@@ -3559,6 +4229,16 @@ enum SortType {
3559
4229
  DESC
3560
4230
  }
3561
4231
 
4232
+ "State of the publication event"
4233
+ enum State {
4234
+ "FINISHED"
4235
+ FINISHED
4236
+ "STARTED"
4237
+ STARTED
4238
+ "UNPUBLISHED"
4239
+ UNPUBLISHED
4240
+ }
4241
+
3562
4242
  "The target scheduler(s)"
3563
4243
  enum TargetScheduler {
3564
4244
  "Both persisted and RAM schedulers will be used"
@@ -3596,7 +4276,7 @@ enum Workspace {
3596
4276
  "Date type"
3597
4277
  scalar Date
3598
4278
 
3599
- "Long type"
4279
+ "A 64-bit signed integer"
3600
4280
  scalar Long
3601
4281
 
3602
4282
  "Info about a node to be reproduced at (moved or copied to) another parent node"