Skip to content

Commit e582c86

Browse files
committed
Update docs - removing "preview"
1 parent e773c76 commit e582c86

File tree

17 files changed

+29
-31
lines changed

17 files changed

+29
-31
lines changed

.vscode/settings.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,11 @@
1717
"azureFunctions.projectRuntime": "~3",
1818
"debug.internalConsoleOptions": "neverOpen",
1919
"azureFunctions.preDeployTask": "publish",
20-
"azureFunctions.showTargetFrameworkWarning": false
20+
"azureFunctions.showTargetFrameworkWarning": false,
21+
"markdownlint.config": {
22+
"MD028": false,
23+
"MD025": {
24+
"front_matter_title": ""
25+
}
26+
}
2127
}

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
## Getting Started ##
99

10-
* [**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.
10+
* [**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.
1111
* [**Microsoft.Azure.Functions.Worker.Extensions.OpenApi**](docs/openapi-out-of-proc.md)
1212
* [**Microsoft.Azure.WebJobs.Extensions.OpenApi**](docs/openapi-in-proc.md)
1313
* [**Microsoft.Azure.WebJobs.Extensions.OpenApi.Core**](docs/openapi-core.md)

docs/azure-functions-v1-support.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ To enable OpenAPI metadata, you will need to install a NuGet package, [Microsoft
6464
dotnet add package Microsoft.Azure.WebJobs.Extensions.OpenApi
6565
```
6666

67-
> This extension is currently in preview.
68-
6967
Add attribute classes on top of the `FunctionName(...)` decorator.
7068

7169
```csharp

docs/enable-open-api-endpoints-in-proc.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Enable OpenAPI Endpoints on Azure Functions (Preview) – In-Process Model #
1+
# Enable OpenAPI Endpoints on Azure Functions – In-Process Model #
22

33
[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.
44

@@ -66,12 +66,9 @@ http://localhost:7071/api/MyHttpTrigger?name=OpenApi
6666
To enable OpenAPI document, you will need to install a NuGet package, [Microsoft.Azure.WebJobs.Extensions.OpenApi][az func openapi extension].
6767

6868
```bash
69-
dotnet add package Microsoft.Azure.WebJobs.Extensions.OpenApi --prerelease
69+
dotnet add package Microsoft.Azure.WebJobs.Extensions.OpenApi
7070
```
7171

72-
> [!NOTE]
73-
> This extension is currently in preview.
74-
7572
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.
7673

7774
```csharp
@@ -202,7 +199,7 @@ You have got an Azure Functions app with OpenAPI metadata enabled. In the next a
202199

203200
* [Configuring OpenAPI Document and Swagger UI Permission and Visibility][docs ui configuration]
204201
* [Customising OpenAPI Document and Swagger UI][docs ui customisation]
205-
* [Enable OpenAPI Endpoints on Azure Functions (Preview) – Out-of-Process Model][docs out-of-proc]
202+
* [Enable OpenAPI Endpoints on Azure Functions – Out-of-Process Model][docs out-of-proc]
206203
* [Support Azure Functions v1 with OpenAPI Extension][docs v1 support]
207204
* [Integrating OpenAPI-enabled Azure Functions to Azure API Management][docs apim]
208205
<!-- * [Integrating OpenAPI-enabled Azure Functions to Power Platform][docs powerplatform] -->

docs/enable-open-api-endpoints-out-of-proc.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Enable OpenAPI Endpoints on Azure Functions (Preview) &ndash; Out-of-Process Model #
1+
# Enable OpenAPI Endpoints on Azure Functions &ndash; Out-of-Process Model #
22

33
[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.
44

@@ -67,12 +67,9 @@ http://localhost:7071/api/MyHttpTrigger
6767
To enable OpenAPI document, you will need to install a NuGet package, [Microsoft.Azure.Functions.Worker.Extensions.OpenApi][az func openapi extension].
6868

6969
```bash
70-
dotnet add package Microsoft.Azure.Functions.Worker.Extensions.OpenApi --prerelease
70+
dotnet add package Microsoft.Azure.Functions.Worker.Extensions.OpenApi
7171
```
7272

73-
> [!NOTE]
74-
> This extension is currently in preview.
75-
7673
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.
7774

7875
```csharp
@@ -230,7 +227,7 @@ You have got an Azure Functions app with OpenAPI metadata enabled. In the next a
230227

231228
* [Configuring OpenAPI Document and Swagger UI Permission and Visibility][docs ui configuration]
232229
* [Customising OpenAPI Document and Swagger UI][docs ui customisation]
233-
* [Enable OpenAPI Endpoints on Azure Functions (Preview) &ndash; In-Process Model][docs in-proc]
230+
* [Enable OpenAPI Endpoints on Azure Functions &ndash; In-Process Model][docs in-proc]
234231
* [Support Azure Functions v1 with OpenAPI Extension][docs v1 support]
235232
* [Integrating OpenAPI-enabled Azure Functions to Azure API Management][docs apim]
236233
<!-- * [Integrating OpenAPI-enabled Azure Functions to Power Platform][docs powerplatform] -->

docs/enable-open-api-endpoints.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Enable OpenAPI Endpoints on Azure Functions (Preview) #
1+
# Enable OpenAPI Endpoints on Azure Functions #
22

3-
* [Enable OpenAPI Endpoints on Azure Functions (Preview) &ndash; In-Process Model](./enable-open-api-endpoints-in-proc.md)
4-
* [Enable OpenAPI Endpoints on Azure Functions (Preview) &ndash; Out-of-Process Model](./enable-open-api-endpoints-out-of-proc.md)
3+
* [Enable OpenAPI Endpoints on Azure Functions &ndash; In-Process Model](./enable-open-api-endpoints-in-proc.md)
4+
* [Enable OpenAPI Endpoints on Azure Functions &ndash; Out-of-Process Model](./enable-open-api-endpoints-out-of-proc.md)

docs/openapi-in-proc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ While using this library, if you find any issue, please raise a ticket on the [I
2525

2626
## Getting Started ##
2727

28-
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.
28+
For detailed getting started document, find this [Enable OpenAPI Endpoints on Azure Functions &ndash; In-Process Model](enable-open-api-endpoints-in-proc.md) page.
2929

3030

3131
## Advanced Configuration in General ##

docs/openapi-out-of-proc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ While using this library, if you find any issue, please raise a ticket on the [I
1919

2020
## Getting Started ##
2121

22-
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.
22+
For detailed getting started document, find this [Enable OpenAPI Endpoints on Azure Functions &ndash; Out-of-Process Model](enable-open-api-endpoints-out-of-proc.md) page.
2323

2424

2525
## Advanced Configuration in General ##

samples/Microsoft.Azure.Functions.Worker.Extensions.OpenApi.FunctionApp.V3Net5/Microsoft.Azure.Functions.Worker.Extensions.OpenApi.FunctionApp.V3Net5.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1212
<!-- <ItemGroup>
13-
<PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.OpenApi" Version="0.8.1-preview" />
13+
<PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.OpenApi" Version="1.0.0" />
1414
</ItemGroup> -->
1515
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1616

samples/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.Models/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.Models.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1010
<!-- <ItemGroup>
11-
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi.Core" Version="0.8.1-preview" />
11+
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi.Core" Version="1.0.0" />
1212
</ItemGroup> -->
1313
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1414

samples/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.V1Proxy/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.V1Proxy.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1111
<!-- <ItemGroup>
12-
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="0.8.1-preview" />
12+
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="1.0.0" />
1313
</ItemGroup> -->
1414
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1515

samples/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.V2IoC/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.V2IoC.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1111
<!-- <ItemGroup>
12-
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="0.8.1-preview" />
12+
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="1.0.0" />
1313
</ItemGroup> -->
1414
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1515

samples/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.V2Static/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.V2Static.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1111
<!-- <ItemGroup>
12-
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="0.8.1-preview" />
12+
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="1.0.0" />
1313
</ItemGroup> -->
1414
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1515

samples/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.V3IoC/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.V3IoC.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1111
<!-- <ItemGroup>
12-
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="0.8.1-preview" />
12+
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="1.0.0" />
1313
</ItemGroup> -->
1414
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1515

samples/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.V3Static/Microsoft.Azure.WebJobs.Extensions.OpenApi.FunctionApp.V3Static.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1111
<!-- <ItemGroup>
12-
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="0.8.1-preview" />
12+
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="1.0.0" />
1313
</ItemGroup> -->
1414
<!-- Uncomment this block if you want to use NuGet package from https://nuget.org -->
1515

src/Microsoft.Azure.Functions.Worker.Extensions.OpenApi/Microsoft.Azure.Functions.Worker.Extensions.OpenApi.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
<RootNamespace>Microsoft.Azure.Functions.Worker.Extensions.OpenApi</RootNamespace>
1818

1919
<!--Version information-->
20-
<!-- <VersionPrefix>0.7.2</VersionPrefix>
21-
<VersionSuffix>-preview</VersionSuffix> -->
20+
<!-- <VersionPrefix>1.0.0</VersionPrefix>
21+
<VersionSuffix></VersionSuffix> -->
2222
</PropertyGroup>
2323

2424
<PropertyGroup Condition="'$(Configuration)'=='Debug'">

src/Microsoft.Azure.Functions.Worker.Extensions.OpenApi/Properties/AssemblyInfo.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33

44
// using Microsoft.Azure.Functions.Worker.Extensions.Abstractions;
55

6-
// [assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.OpenApi", "0.7.2-preview")]
6+
// [assembly: ExtensionInformation("Microsoft.Azure.WebJobs.Extensions.OpenApi", "1.0.0")]

0 commit comments

Comments
 (0)