Skip to content

Update enabling delivery api #6670

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 2 commits into from
Nov 14, 2024
Merged

Update enabling delivery api #6670

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a6ef92
Update enabling delivery api
nikolajlauridsen Nov 14, 2024
697e44a
Apply suggestions from code review
nikolajlauridsen Nov 14, 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
22 changes: 22 additions & 0 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 @@ -14,9 +14,19 @@ The Delivery API is an opt-in feature in Umbraco. It must be explicitly enabled

### Enable the Content Delivery API

You can enable the Delivery API when creating you project initially by using the `--use-delivery-api` or `-da` flag. This will automatically add the necessary configuration to your project.

```bash
dotnet new umbraco -n MyProject -da
```

Yuo can also enable it after the fact with the following steps:

1. Open your project's `appsettings.json`.
2. Insert the `DeliveryApi` configuration section under `Umbraco:CMS`.
3. Add the `Enabled` key and set its value to `true`.
4. Open `Program.Cs`
5. Add `.AddDeliveryApi()` to `builder.CreateUmbracoBuilder()`

{% code title="appsettings.json" %}
```json
Expand All @@ -32,6 +42,18 @@ The Delivery API is an opt-in feature in Umbraco. It must be explicitly enabled
```
{% endcode %}

{% code title="Program.cs" %}
```csharp
builder.CreateUmbracoBuilder()
.AddBackOffice()
.AddWebsite()
.AddDeliveryApi()
.AddComposers()
.Build();

```
{% endcode %}

Once the Content Delivery API is enabled, the next step is to rebuild the Delivery API content index (_DeliveryApiContentIndex_). This can be done using the **Examine Management** dashboard in the **Settings** section of the Umbraco Backoffice.

1. Access the Umbraco Backoffice.
Expand Down
22 changes: 22 additions & 0 deletions 15/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 @@ -14,9 +14,19 @@ The Delivery API is an opt-in feature in Umbraco. It must be explicitly enabled

### Enable the Content Delivery API

You can enable the Delivery API when creating you project initially by using the `--use-delivery-api` or `-da` flag. This will automatically add the necessary configuration to your project.

```bash
dotnet new umbraco -n MyProject -da
```

Yuo can also enable it after the fact with the following steps:

1. Open your project's `appsettings.json`.
2. Insert the `DeliveryApi` configuration section under `Umbraco:CMS`.
3. Add the `Enabled` key and set its value to `true`.
4. Open `Program.Cs`
5. Add `.AddDeliveryApi()` to `builder.CreateUmbracoBuilder()`

{% code title="appsettings.json" %}
```json
Expand All @@ -32,6 +42,18 @@ The Delivery API is an opt-in feature in Umbraco. It must be explicitly enabled
```
{% endcode %}

{% code title="Program.cs" %}
```csharp
builder.CreateUmbracoBuilder()
.AddBackOffice()
.AddWebsite()
.AddDeliveryApi()
.AddComposers()
.Build();

```
{% endcode %}

Once the Content Delivery API is enabled, the next step is to rebuild the Delivery API content index (_DeliveryApiContentIndex_). This can be done using the **Examine Management** dashboard in the **Settings** section of the Umbraco Backoffice.

1. Access the Umbraco Backoffice.
Expand Down
Loading