Update docs - removing "preview"
This commit is contained in:
Justin Yoo
Родитель
e773c761d1
Коммит
e582c8626d
|
|
@ -17,5 +17,11 @@
|
|||
"azureFunctions.projectRuntime": "~3",
|
||||
"debug.internalConsoleOptions": "neverOpen",
|
||||
"azureFunctions.preDeployTask": "publish",
|
||||
"azureFunctions.showTargetFrameworkWarning": false
|
||||
"azureFunctions.showTargetFrameworkWarning": false,
|
||||
"markdownlint.config": {
|
||||
"MD028": false,
|
||||
"MD025": {
|
||||
"front_matter_title": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
## Getting Started ##
|
||||
|
||||
* [**Enable OpenAPI documents to your Azure Functions HTTP Trigger (Preview)**](docs/enable-open-api-endpoints.md): This document shows how to enable OpenAPI extension on your Azure Functions applications and render Swagger UI, and OpenAPI v2 and v3 documents on-the-fly. It's currently in preview.
|
||||
* [**Enable OpenAPI documents to your Azure Functions HTTP Trigger**](docs/enable-open-api-endpoints.md): This document shows how to enable OpenAPI extension on your Azure Functions applications and render Swagger UI, and OpenAPI v2 and v3 documents on-the-fly.
|
||||
* [**Microsoft.Azure.Functions.Worker.Extensions.OpenApi**](docs/openapi-out-of-proc.md)
|
||||
* [**Microsoft.Azure.WebJobs.Extensions.OpenApi**](docs/openapi-in-proc.md)
|
||||
* [**Microsoft.Azure.WebJobs.Extensions.OpenApi.Core**](docs/openapi-core.md)
|
||||
|
|
|
|||
|
|
@ -64,8 +64,6 @@ To enable OpenAPI metadata, you will need to install a NuGet package, [Microsoft
|
|||
dotnet add package Microsoft.Azure.WebJobs.Extensions.OpenApi
|
||||
```
|
||||
|
||||
> This extension is currently in preview.
|
||||
|
||||
Add attribute classes on top of the `FunctionName(...)` decorator.
|
||||
|
||||
```csharp
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Enable OpenAPI Endpoints on Azure Functions (Preview) – In-Process Model #
|
||||
# Enable OpenAPI Endpoints on Azure Functions – In-Process Model #
|
||||
|
||||
[OpenAPI metadata][openapi] supports in Azure Functions is now available with this extension, [Azure Functions OpenAPI Extension (In-Process Worker)][az func openapi extension]. With this extension, you can directly let your API endpoints be discoverable.
|
||||
|
||||
|
|
@ -66,12 +66,9 @@ http://localhost:7071/api/MyHttpTrigger?name=OpenApi
|
|||
To enable OpenAPI document, you will need to install a NuGet package, [Microsoft.Azure.WebJobs.Extensions.OpenApi][az func openapi extension].
|
||||
|
||||
```bash
|
||||
dotnet add package Microsoft.Azure.WebJobs.Extensions.OpenApi --prerelease
|
||||
dotnet add package Microsoft.Azure.WebJobs.Extensions.OpenApi
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> This extension is currently in preview.
|
||||
|
||||
With [Visual Studio Code][vs code], open your HTTP trigger, `MyHttpTrigger.cs`, to enable the OpenAPI metadata, and add attribute classes on top of the `FunctionName(...)` decorator.
|
||||
|
||||
```csharp
|
||||
|
|
@ -202,7 +199,7 @@ You have got an Azure Functions app with OpenAPI metadata enabled. In the next a
|
|||
|
||||
* [Configuring OpenAPI Document and Swagger UI Permission and Visibility][docs ui configuration]
|
||||
* [Customising OpenAPI Document and Swagger UI][docs ui customisation]
|
||||
* [Enable OpenAPI Endpoints on Azure Functions (Preview) – Out-of-Process Model][docs out-of-proc]
|
||||
* [Enable OpenAPI Endpoints on Azure Functions – Out-of-Process Model][docs out-of-proc]
|
||||
* [Support Azure Functions v1 with OpenAPI Extension][docs v1 support]
|
||||
* [Integrating OpenAPI-enabled Azure Functions to Azure API Management][docs apim]
|
||||
<!-- * [Integrating OpenAPI-enabled Azure Functions to Power Platform][docs powerplatform] -->
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Enable OpenAPI Endpoints on Azure Functions (Preview) – Out-of-Process Model #
|
||||
# Enable OpenAPI Endpoints on Azure Functions – Out-of-Process Model #
|
||||
|
||||
[OpenAPI metadata][openapi] supports in Azure Functions is now available with this extension, [Azure Functions OpenAPI Extension (Out-of-Process Worker)][az func openapi extension]. With this extension, you can directly let your API endpoints be discoverable.
|
||||
|
||||
|
|
@ -67,12 +67,9 @@ http://localhost:7071/api/MyHttpTrigger
|
|||
To enable OpenAPI document, you will need to install a NuGet package, [Microsoft.Azure.Functions.Worker.Extensions.OpenApi][az func openapi extension].
|
||||
|
||||
```bash
|
||||
dotnet add package Microsoft.Azure.Functions.Worker.Extensions.OpenApi --prerelease
|
||||
dotnet add package Microsoft.Azure.Functions.Worker.Extensions.OpenApi
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> This extension is currently in preview.
|
||||
|
||||
With [Visual Studio Code][vs code], open your HTTP trigger, `MyHttpTrigger.cs`, to enable the OpenAPI metadata, and add attribute classes on top of the `Function(...)` decorator.
|
||||
|
||||
```csharp
|
||||
|
|
@ -230,7 +227,7 @@ You have got an Azure Functions app with OpenAPI metadata enabled. In the next a
|
|||
|
||||
* [Configuring OpenAPI Document and Swagger UI Permission and Visibility][docs ui configuration]
|
||||
* [Customising OpenAPI Document and Swagger UI][docs ui customisation]
|
||||
* [Enable OpenAPI Endpoints on Azure Functions (Preview) – In-Process Model][docs in-proc]
|
||||
* [Enable OpenAPI Endpoints on Azure Functions – In-Process Model][docs in-proc]
|
||||
* [Support Azure Functions v1 with OpenAPI Extension][docs v1 support]
|
||||
* [Integrating OpenAPI-enabled Azure Functions to Azure API Management][docs apim]
|
||||
<!-- * [Integrating OpenAPI-enabled Azure Functions to Power Platform][docs powerplatform] -->
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Enable OpenAPI Endpoints on Azure Functions (Preview) #
|
||||
# Enable OpenAPI Endpoints on Azure Functions #
|
||||
|
||||
* [Enable OpenAPI Endpoints on Azure Functions (Preview) – In-Process Model](./enable-open-api-endpoints-in-proc.md)
|
||||
* [Enable OpenAPI Endpoints on Azure Functions (Preview) – Out-of-Process Model](./enable-open-api-endpoints-out-of-proc.md)
|
||||
* [Enable OpenAPI Endpoints on Azure Functions – In-Process Model](./enable-open-api-endpoints-in-proc.md)
|
||||
* [Enable OpenAPI Endpoints on Azure Functions – Out-of-Process Model](./enable-open-api-endpoints-out-of-proc.md)
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ While using this library, if you find any issue, please raise a ticket on the [I
|
|||
|
||||
## Getting Started ##
|
||||
|
||||
For detailed getting started document, find this [Enable OpenAPI Endpoints on Azure Functions (Preview) – In-Process Model](enable-open-api-endpoints-in-proc.md) page.
|
||||
For detailed getting started document, find this [Enable OpenAPI Endpoints on Azure Functions – In-Process Model](enable-open-api-endpoints-in-proc.md) page.
|
||||
|
||||
|
||||
## Advanced Configuration in General ##
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ While using this library, if you find any issue, please raise a ticket on the [I
|
|||
|
||||
## Getting Started ##
|
||||
|
||||
For detailed getting started document, find this [Enable OpenAPI Endpoints on Azure Functions (Preview) – Out-of-Process Model](enable-open-api-endpoints-out-of-proc.md) page.
|
||||
For detailed getting started document, find this [Enable OpenAPI Endpoints on Azure Functions – Out-of-Process Model](enable-open-api-endpoints-out-of-proc.md) page.
|
||||
|
||||
|
||||
## Advanced Configuration in General ##
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@
|
|||
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
<!-- <ItemGroup>
|
||||
<PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.OpenApi" Version="0.8.1-preview" />
|
||||
<PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.OpenApi" Version="1.0.0" />
|
||||
</ItemGroup> -->
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
<!-- <ItemGroup>
|
||||
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi.Core" Version="0.8.1-preview" />
|
||||
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi.Core" Version="1.0.0" />
|
||||
</ItemGroup> -->
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
<!-- <ItemGroup>
|
||||
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="0.8.1-preview" />
|
||||
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="1.0.0" />
|
||||
</ItemGroup> -->
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
<!-- <ItemGroup>
|
||||
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="0.8.1-preview" />
|
||||
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="1.0.0" />
|
||||
</ItemGroup> -->
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
<!-- <ItemGroup>
|
||||
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="0.8.1-preview" />
|
||||
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="1.0.0" />
|
||||
</ItemGroup> -->
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
<!-- <ItemGroup>
|
||||
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="0.8.1-preview" />
|
||||
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="1.0.0" />
|
||||
</ItemGroup> -->
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
<!-- <ItemGroup>
|
||||
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="0.8.1-preview" />
|
||||
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="1.0.0" />
|
||||
</ItemGroup> -->
|
||||
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
|
||||
|
||||
|
|
|
|||
|
|
@ -17,8 +17,8 @@
|
|||
<RootNamespace>Microsoft.Azure.Functions.Worker.Extensions.OpenApi</RootNamespace>
|
||||
|
||||
<!--Version information-->
|
||||
<!-- <VersionPrefix>0.7.2</VersionPrefix>
|
||||
<VersionSuffix>-preview</VersionSuffix> -->
|
||||
<!-- <VersionPrefix>1.0.0</VersionPrefix>
|
||||
<VersionSuffix></VersionSuffix> -->
|
||||
</PropertyGroup>
|
||||
|
||||
<PropertyGroup Condition="'$(Configuration)'=='Debug'">
|
||||
|
|
|
|||
|
|
@ -3,4 +3,4 @@
|
|||
|
||||
// using Microsoft.Azure.Functions.Worker.Extensions.Abstractions;
|
||||
|
||||
// [assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.OpenApi", "0.7.2-preview")]
|
||||
// [assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.OpenApi", "1.0.0")]
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче