Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/api/graphql/graphql_queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -842,3 +842,7 @@
### Enable pagination for RelationList field type

To learn how to enable pagination for RelationList field type, see the [RelationList field type reference](relationlistfield.md).

### Url field type integration

Check warning on line 846 in docs/api/graphql/graphql_queries.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/graphql/graphql_queries.md#L846

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/api/graphql/graphql_queries.md", "range": {"start": {"line": 846, "column": 31}}}, "severity": "WARNING"}

To learn how to customize the URL field type when using GraphQL, see the [URL field type reference](urlfield.md#graphql-integration).
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,75 @@
### Settings

This field type doesn't have settings.

## GraphQL integration

To access the `link` and `text` properties in GraphQL responses, set the `ibexa.graphql.schema.should.extend.ezurl` parameter to `true`.

!!! note

This behaviour is enabled by default in [[= product_name =]] v5 and the parameter is removed.

Compare the examples below:

<table>
<thead><tr><th scope="col">Parameter value</th><th scope="col">Request</th><th scope="col">Responses</th></tr></thead>
<tbody>
<tr>
<td>Disabled</td>
<td class="compare">
```graphql
{
content {
article(contentId: 76) {
url_field
}
}
}
```

Check failure on line 96 in docs/content_management/field_types/field_type_reference/urlfield.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/field_types/field_type_reference/urlfield.md#L96

[Ibexa.CodeBlockLanguages] Always provide a language with a code block.
Raw output
{"message": "[Ibexa.CodeBlockLanguages] Always provide a language with a code block.", "location": {"path": "docs/content_management/field_types/field_type_reference/urlfield.md", "range": {"start": {"line": 96, "column": 1}}}, "severity": "ERROR"}
</td><td class="compare">
```graphql
{
"data": {
"content": {
"article": {
"url_field": "https://example.com"
}
}
}
}
```
</td></tr>
<tr>
<td>Enabled</td>
<td class="compare">
```graphql
{
content {
article(contentId: 76) {
url_field {
text
link
}
}
}
}

```
</td><td class="compare">
```graphql
{
"data": {
"content": {
"article": {
"field68dbd09357392": {
"text": "Example",
"link": "https://example.com"
}
}
}
}
}
```
</td></tr>
</tbody></table>
Loading