Skip to content

Update Content Delivery API #6037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 25, 2024
Merged

Update Content Delivery API #6037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
767a10c
Write shorter sentences
erikjanwestendorp Apr 22, 2024
6e34885
Update v12
erikjanwestendorp Apr 22, 2024
7c367f6
Update v14
erikjanwestendorp Apr 24, 2024
a3b7804
Update 12/umbraco-cms/reference/content-delivery-api/README.md
erikjanwestendorp Apr 24, 2024
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: 2 additions & 2 deletions 12/umbraco-cms/reference/content-delivery-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ When querying content by path, the culture is already known and included in the
The output produced by the Delivery API can either represent a specific content item or a paged list of multiple items.

{% hint style="info" %}
When referring to a specific content item in your API requests, the `id` parameter always refers to the item’s key (GUID) and not its integer node id.
When referring to a specific content item in your API requests, the `id` parameter always refers to the item’s key (GUID). It does not refer to its integer node id.
{% endhint %}

{% swagger method="get" path="/content/item/{id}" baseUrl="/umbraco/delivery/api/v1" summary="Gets a content item by id" %}
Expand Down Expand Up @@ -578,7 +578,7 @@ GET /umbraco/delivery/api/v1/content?fetch=children:dc1f43da-49c6-4d87-b104-a586
{% endtab %}

{% tab title="filter" %}
The `filter` query parameter allows you to specify one or more filters that must match in order for a content item to be included in the response. The API provides two built-in filters that you can use right away with the `/umbraco/delivery/api/v1/content` endpoint:
The filter query parameter allows you to specify one or more filters. These filters must match in order for a content item to be included in the response. The API provides a few built-in filters that you can use right away with the `/umbraco/delivery/api/v1/content` endpoint:

**`?filter=contentType:alias`**\
This filter restricts the results to only include content items that belong to the specified content type. Replace _`alias`_ with the alias of the content type you want to filter by.
Expand Down
4 changes: 2 additions & 2 deletions 13/umbraco-cms/reference/content-delivery-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ When querying content by path, the culture is already known and included in the
The output produced by the Delivery API can either represent a specific content item or a paged list of multiple items.

{% hint style="info" %}
When referring to a specific content item in your API requests, the `id` parameter always refers to the item’s key (GUID) and not its integer node id.
When referring to a specific content item in your API requests, the `id` parameter always refers to the item’s key (GUID). It does not refer to its integer node id.
{% endhint %}

## Gets a content item by id
Expand Down Expand Up @@ -492,7 +492,7 @@ GET /umbraco/delivery/api/v2/content?fetch=children:dc1f43da-49c6-4d87-b104-a586
{% endtab %}

{% tab title="filter" %}
The `filter` query parameter allows you to specify one or more filters that must match in order for a content item to be included in the response. The API provides a few built-in filters that you can use right away with the `/umbraco/delivery/api/v2/content` endpoint:
The filter query parameter allows you to specify one or more filters. These filters must match in order for a content item to be included in the response. The API provides a few built-in filters that you can use right away with the `/umbraco/delivery/api/v2/content` endpoint:

**`?filter=contentType:alias`**\
This filter restricts the results to only include content items that belong to the specified content type. Replace _`alias`_ with the alias of the content type you want to filter by.
Expand Down
4 changes: 2 additions & 2 deletions 14/umbraco-cms/reference/content-delivery-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ When querying content by path, the culture is already known and included in the
The output produced by the Delivery API can either represent a specific content item or a paged list of multiple items.

{% hint style="info" %}
When referring to a specific content item in your API requests, the `id` parameter always refers to the item’s key (GUID) and not its integer node id.
When referring to a specific content item in your API requests, the `id` parameter always refers to the item’s key (GUID). It does not refer to its integer node id.
{% endhint %}

## Gets a content item by id
Expand Down Expand Up @@ -492,7 +492,7 @@ GET /umbraco/delivery/api/v2/content?fetch=children:dc1f43da-49c6-4d87-b104-a586
{% endtab %}

{% tab title="filter" %}
The `filter` query parameter allows you to specify one or more filters that must match in order for a content item to be included in the response. The API provides a few built-in filters that you can use right away with the `/umbraco/delivery/api/v2/content` endpoint:
The filter query parameter allows you to specify one or more filters. These filters must match in order for a content item to be included in the response. The API provides a few built-in filters that you can use right away with the `/umbraco/delivery/api/v2/content` endpoint:

**`?filter=contentType:alias`**\
This filter restricts the results to only include content items that belong to the specified content type. Replace _`alias`_ with the alias of the content type you want to filter by.
Expand Down