Skip to content

Commit da8212b

Browse files
mnoconadriendupuis
andauthored
Removed mention about enabling pagination (#2874)
* Removed mention about enabling pagination * Fixed link * Update docs/content_management/field_types/field_type_reference/relationlistfield.md Co-authored-by: Adrien Dupuis <[email protected]> * GraphQL `relations` pagination change from 4.6 to 5.0 (#2891) * About …`ibexa_object_relation_list.enable_pagination` * About …`ibexa_object_relation_list.enable_pagination` * About …`ibexa_object_relation_list.enable_pagination` * Apply suggestions from code review Co-authored-by: Marek Nocoń <[email protected]> --------- Co-authored-by: Marek Nocoń <[email protected]> --------- Co-authored-by: Adrien Dupuis <[email protected]>
1 parent 52de471 commit da8212b

File tree

4 files changed

+12
-33
lines changed

4 files changed

+12
-33
lines changed

docs/api/graphql/graphql_queries.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -838,7 +838,3 @@ children(first: 3, after: "YXJyYXljb25uZWN0aW9uOjM=")
838838
### Get Matrix field type
839839

840840
To get a Matrix field type with GraphQL, see [Matrix field type reference](matrixfield.md).
841-
842-
### Enable pagination for RelationList field type
843-
844-
To learn how to enable pagination for RelationList field type, see the [RelationList field type reference](relationlistfield.md).

docs/content_management/field_types/field_type_reference/relationlistfield.md

Lines changed: 3 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -108,32 +108,7 @@ $validators = [
108108
];
109109
```
110110

111-
### Enable pagination in GraphQL
112-
113-
To enable pagination for Relation List field type, set the `ibexa.graphql.schema.ibexa_object_relation_list.enable_pagination` parameter to `true`.
114-
115-
!!! note
116-
117-
The pagination is enabled by default in [[= product_name =]] v5 and the parameter is removed.
118-
119-
This allows you to query for only a subset of relations, as in the following example:
120-
121-
``` graphql
122-
query {
123-
content {
124-
relations(contentId: 71) {
125-
rel(first: 5) {
126-
totalCount,
127-
edges {
128-
node {
129-
_contentInfo {
130-
id
131-
}
132-
}
133-
}
134-
}
135-
}
136-
}
137-
}
138-
```
111+
### GraphQL integration
139112

113+
This field type is paginating the results when queried using [GraphQL](graphql.md).
114+
To learn more, see [Pagination in GraphQL](graphql_queries.md#pagination).

docs/release_notes/ibexa_dxp_v4.6.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ In addition, you can now use the [Taxonomy limitation](limitation_reference.md#t
216216

217217
#### Pagination for ezobjectrelationlist in GraphQL
218218

219-
To improve performance and gain greater control over the returned responses from the [GraphQL API](graphql.md), you can now [enable pagination](relationlistfield.md#enable-pagination-in-graphql) of relations specified using the RelationList field type.
219+
To improve performance and gain greater control over the returned responses from the [GraphQL API](graphql.md), you can now [enable pagination]((https://doc.ibexa.co/en/4.6/content_management/field_types/field_type_reference/relationlistfield#enable-pagination-in-graphql) of relations specified using the RelationList field type.
220220

221221
#### Breaking changes
222222

docs/update_and_migration/from_4.6/update_to_5.0.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1044,6 +1044,14 @@ If you are using GraphQL in your project, you can generate its schema by running
10441044
php bin/console ibexa:graphql:generate-schema
10451045
```
10461046

1047+
### Upgrade GraphQL usage
1048+
1049+
- In 4.6, pagination for [RelationList field type](relationlistfield.md) is disabled by default, and can be enabled using the `ibexa.graphql.schema.ibexa_object_relation_list.enable_pagination` parameter
1050+
- In 5.0, pagination for RelationList field type is always activated and can't be disabled. The previous parameter doesn't exist anymore and is ignored if set
1051+
1052+
If you have code based on `relations` request returning the entire list, you have to update it.
1053+
For more information, see [Pagination in GraphQL](graphql_queries.md#pagination).
1054+
10471055
### Update search indexes
10481056

10491057
Ensure your search index is up to date with the following command:

0 commit comments

Comments
 (0)