Skip to content

Commit fe1229a

Browse files
committed
Refactor and addition
1 parent 6778e8c commit fe1229a

File tree

1 file changed

+31
-1
lines changed
  • 17/umbraco-cms/reference/content-delivery-api

1 file changed

+31
-1
lines changed

17/umbraco-cms/reference/content-delivery-api/README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ A few additional configuration options will allow you to restrict access to the
8383
"PublicAccess": true,
8484
"ApiKey": "my-api-key",
8585
"DisallowedContentTypeAliases": ["alias1", "alias2", "alias3"],
86+
"AllowedContentTypeAliases": ["allowedAlias1", "allowedAlias2", "allowedAlias3"],
8687
"RichTextOutputAsJson": false
8788
}
8889
}
@@ -93,7 +94,36 @@ A few additional configuration options will allow you to restrict access to the
9394

9495
Find a description of each of the configuration keys in the table below.
9596

96-
<table><thead><tr><th width="340">Configuration key</th><th>Description</th></tr></thead><tbody><tr><td><code>PublicAccess</code></td><td>Determines whether the enabled Delivery API should be publicly accessible or if access should require an API key.</td></tr><tr><td><code>ApiKey</code></td><td>Specifies the API key needed to authorize access to the API when public access is disabled. This setting is also used to access draft content for preview.</td></tr><tr><td><code>DisallowedContentTypeAliases</code> </td><td>Contains the aliases of the content types that should never be exposed through the Delivery API, regardless of any other configurations.</td></tr><tr><td><code>RichTextOutputAsJson</code></td><td>Enable outputting rich text content as JSON rather than the default HTML output. JSON can be a preferred format in many scenarios, not least because it supports the routing of internal links better than HTML does.</td></tr></tbody></table>
97+
<table>
98+
<thead>
99+
<tr>
100+
<th width="340">Configuration key</th>
101+
<th>Description</th>
102+
</tr>
103+
</thead>
104+
<tbody>
105+
<tr>
106+
<td><code>PublicAccess</code></td>
107+
<td>Determines whether the enabled Delivery API should be publicly accessible or if access should require an API key.</td>
108+
</tr>
109+
<tr>
110+
<td><code>ApiKey</code></td>
111+
<td>Specifies the API key needed to authorize access to the API when public access is disabled. This setting is also used to access draft content for preview.</td>
112+
</tr>
113+
<tr>
114+
<td><code>DisallowedContentTypeAliases</code></td>
115+
<td>Contains the aliases of the content types that should never be exposed through the Delivery API.</td>
116+
</tr>
117+
<tr>
118+
<td><code>AllowedContentTypeAliases</code></td>
119+
<td>Contains the aliases of the content types that should be exposed through the Delivery API, this configuration takes precedence over the <code>DisallowedContentTypeAliases</code> so if there are any duplicates, they will be allowed regardless. Note that if this configuration contains any aliases, all other aliases will not be exposed through the Delivery API, if the configuration is empty, all aliases will be exposed, unless they are included in the <code>DisallowedContentTypeAliases</code></td>
120+
</tr>
121+
<tr>
122+
<td><code>RichTextOutputAsJson</code></td>
123+
<td>Enable outputting rich text content as JSON rather than the default HTML output. JSON can be a preferred format in many scenarios, not least because it supports the routing of internal links better than HTML does.</td>
124+
</tr>
125+
</tbody>
126+
</table>
97127

98128
{% hint style="info" %}
99129
**Are you using Umbraco Cloud?**

0 commit comments

Comments
 (0)