Update docs for 0.9.0-preview (Azure#256)

justinyoo · DoHoon Kim · commit af42aaf21d6e · 2021-10-05T10:20:03.000+09:00
diff --git a/docs/openapi-core.md b/docs/openapi-core.md
@@ -139,6 +139,27 @@ public class OpenApiConfigurationOptions : IOpenApiConfigurationOptions
 ```
 
 
+### Force HTTP or HTTPS for Swagger UI ###
+
+> **NOTE**: If you use the [Linux Dedicated Plan](https://docs.microsoft.com/azure/azure-functions/dedicated-plan?WT.mc_id=github-0000-juyoo), you can consider this HTTP/HTTPS enforcement settings.
+
+If you want to force either HTTP or HTTPS, configure the following properties on the `IOpenApiConfigurationOptions` interface.
+
+```csharp
+public class OpenApiConfigurationOptions : IOpenApiConfigurationOptions
+{
+    ...
+
+    public bool ForceHttps { get; set; } = true;
+    public bool ForceHttp { get; set; } = true;
+
+    ...
+}
+```
+
+You can set either property to `true`, and based on the combination of both, your Swagger UI renders contents through either HTTP or HTTPS. However, if you set both properties to `true`, HTTPS takes precedence.
+
+
 ### Inheriting `DefaultOpenApiConfigurationOptions` ###
 
 Instead of implementing `IOpenApiConfigurationOptions`, you can inherit `DefaultOpenApiConfigurationOptions`. As `Info`, `Servers` and `OpenApiVersion` properties have the modifier of `virtual`, you can freely override them or leave them as default.
@@ -172,6 +193,9 @@ public class MyOpenApiConfigurationOptions : DefaultOpenApiConfigurationOptions
     };
 
     public override OpenApiVersionType OpenApiVersion { get; set; } = OpenApiVersionType.V3;
+
+    // Consider Linux Dedicated Plan only.
+    public override bool ForceHttps { get; set; } = true;
 }
 ```
 
diff --git a/docs/openapi-in-proc.md b/docs/openapi-in-proc.md
@@ -28,80 +28,6 @@ While using this library, if you find any issue, please raise a ticket on the [I
 For detailed getting started document, find this [Enable OpenAPI Endpoints on Azure Functions (Preview) &ndash; In-Process Model](enable-open-api-endpoints-in-proc.md) page.
 
 
-## Configuration ##
+## Advanced Configuration in General ##
 
-For the extension's advanced configuration, it expects the following config keys.
-
-
-### Configure Authorization Level ###
-
-As a default, all endpoints to render Swagger UI and OpenAPI documents have the authorisation level of `AuthorizationLevel.Anonymous`. However, if you want to secure those endpoints, change their authorisation level to `AuthorizationLevel.Function` and pass the API Key through either request header or querystring parameter. This can be done through the environment variables. Here's the sample `local.settings.json` file. The other values are omitted for brevity.
-
-```json
-{
-  "Values": {
-    "OpenApi__ApiKey": "",
-    "OpenApi__AuthLevel__Document": "Anonymous",
-    "OpenApi__AuthLevel__UI": "Anonymous"
-  }
-}
-```
-
-You can have granular controls to both Swagger UI and OpenAPI documents by setting the authorisation level to `Anonymous`, `User`, `Function`, `System` or `Admin`. Make sure that you MUST provide the `OpenApi__AuthKey` value, if you choose the `OpenApi__AuthLevel__Document` value other than `Anonymous`. Otherwise, it will throw an error.
-
-> [!NOTE]
-> Both Swagger UI and OpenAPI document pages are allowed `Anonymous` access by default.
-
-
-### Configure Swagger UI Visibility ###
-
-You may want to only enable the Swagger UI page during the development time, and disable the page when publishing it to Azure. You can configure an environment variable to enable/disable the Swagger UI page. Here's the sample `local.settings.json` file. The other values are omitted for brevity.
-
-```json
-{
-  "Values": {
-    "OpenApi__HideSwaggerUI": "false"
-  }
-}
-```
-
-If you set the `OpenApi__HideSwaggerUI` value to `true`, the Swagger UI page won't be showing up, and you will see the 404 error.
-
-> [!NOTE]
-> The default value for `OpenApi__HideSwaggerUI` is `false`.
-
-
-### Configure OpenAPI Information ###
-
-As a default, the OpenAPI document automatically generated provides a minimum set of information like:
-
-* OpenAPI Version: `2.0`
-* OpenAPI Document Title: `OpenAPI Document on Azure Functions`
-* OpenAPI Document Version: `1.0.0`
-
-You may want to provide consumers with more details by implementing the `IOpenApiConfigurationOptions` interface or inheriting the `DefaultOpenApiConfigurationOptions` class. On the other hand, you can use the following environment variables to avoid the app from being recompiled and redeployed. Here's the sample `local.settings.json` file. The other values are omitted for brevity.
-
-```json
-{
-  "Values": {
-    "OpenApi__Version": "v2",
-    "OpenApi__DocTitle": "Azure Functions OpenAPI Extension",
-    "OpenApi__DocVersion": "1.0.0"
-  }
-}
-```
-
-
-### Configure Custom Base URLs ###
-
-There's a chance that you want to expose the UI and OpenAPI document through [Azure API Management](https://docs.microsoft.com/azure/api-management/api-management-key-concepts?WT.mc_id=github-0000-juyoo) or load balancing services like [Azure Front Door](https://docs.microsoft.com/azure/frontdoor/front-door-overview?WT.mc_id=github-0000-juyoo). You can configure an environment variable to add them. Here's the sample `local.settings.json` file. The other values are omitted for brevity.
-
-```json
-{
-  "Values": {
-    "OpenApi__HostNames": "https://contoso.com/api/,https://fabrikam.com/api/"
-  }
-}
-```
-
-> **NOTE**: This multiple hostnames support feature only works with OpenAPI 3.x, not OpenAPI 2.x.
+If you look for the advanced configurations in general, please find the document, [Advanced Configurations for OpenAPI Extension](./openapi.md)
diff --git a/docs/openapi-out-of-proc.md b/docs/openapi-out-of-proc.md
@@ -22,54 +22,6 @@ While using this library, if you find any issue, please raise a ticket on the [I
 For detailed getting started document, find this [Enable OpenAPI Endpoints on Azure Functions (Preview) &ndash; Out-of-Process Model](enable-open-api-endpoints-out-of-proc.md) page.
 
 
-## Configuration ##
+## Advanced Configuration in General ##
 
-For the extension's advanced configuration, it expects the following config keys.
-
-
-### Configure Authorization Level ###
-
-As a default, all endpoints to render Swagger UI and OpenAPI documents have the authorisation level of `AuthorizationLevel.Anonymous`.
-
-> **NOTE**: Currently, this out-of-process worker extension only supports the `AuthorizationLevel.Anonymous` access.
-
-
-### Configure Swagger UI Visibility ###
-
-Unlike the in-process worker model, this out-of-process worker model currently doesn't support hiding Swagger UI.
-
-
-### Configure OpenAPI Information ###
-
-As a default, the OpenAPI document automatically generated provides a minimum set of information like:
-
-* OpenAPI Version: `2.0`
-* OpenAPI Document Title: `OpenAPI Document on Azure Functions`
-* OpenAPI Document Version: `1.0.0`
-
-You may want to provide consumers with more details by implementing the `IOpenApiConfigurationOptions` interface or inheriting the `DefaultOpenApiConfigurationOptions` class. On the other hand, you can use the following environment variables to avoid the app from being recompiled and redeployed. Here's the sample `local.settings.json` file. The other values are omitted for brevity.
-
-```json
-{
-  "Values": {
-    "OpenApi__Version": "v2",
-    "OpenApi__DocTitle": "Azure Functions OpenAPI Extension",
-    "OpenApi__DocVersion": "1.0.0"
-  }
-}
-```
-
-
-### Configure Custom Base URLs ###
-
-There's a chance that you want to expose the UI and OpenAPI document through [Azure API Management](https://docs.microsoft.com/azure/api-management/api-management-key-concepts?WT.mc_id=github-0000-juyoo) or load balancing services like [Azure Front Door](https://docs.microsoft.com/azure/frontdoor/front-door-overview?WT.mc_id=github-0000-juyoo). You can configure an environment variable to add them. Here's the sample `local.settings.json` file. The other values are omitted for brevity.
-
-```json
-{
-  "Values": {
-    "OpenApi__HostNames": "https://contoso.com/api/,https://fabrikam.com/api/"
-  }
-}
-```
-
-> **NOTE**: This multiple hostnames support feature only works with OpenAPI 3.x, not OpenAPI 2.x.
+If you look for the advanced configurations in general, please find the document, [Advanced Configurations for OpenAPI Extension](./openapi.md)
diff --git a/docs/openapi.md b/docs/openapi.md
