Skip to content

Commit 6b20b98

Browse files
.Net: Make OpenApi model classes experimental (#9568)
### Motivation, Context and Description Taking into account that the OpenAPI model classes have become exposed through the `KernelFunction.Metadata` property and that there could be requests to change their public API surface, it makes sense to label them as experimental to communicate the potential changes to the consumers of the classes. Related task: #6884
1 parent c8b4094 commit 6b20b98

10 files changed

+25
-0
lines changed

dotnet/src/Functions/Functions.OpenApi/Model/RestApiInfo.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
// Copyright (c) Microsoft. All rights reserved.
22

3+
using System.Diagnostics.CodeAnalysis;
4+
35
namespace Microsoft.SemanticKernel.Plugins.OpenApi;
46

57
/// <summary>
68
/// The REST API information.
79
/// </summary>
10+
[Experimental("SKEXP0040")]
811
public sealed class RestApiInfo
912
{
1013
/// <summary>

dotnet/src/Functions/Functions.OpenApi/Model/RestApiOperation.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
using System;
44
using System.Collections.Generic;
5+
using System.Diagnostics.CodeAnalysis;
56
using System.Linq;
67
using System.Net.Http;
78
using System.Text.Json.Nodes;
@@ -12,6 +13,7 @@ namespace Microsoft.SemanticKernel.Plugins.OpenApi;
1213
/// <summary>
1314
/// The REST API operation.
1415
/// </summary>
16+
[Experimental("SKEXP0040")]
1517
public sealed class RestApiOperation
1618
{
1719
/// <summary>

dotnet/src/Functions/Functions.OpenApi/Model/RestApiOperationExpectedResponse.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
// Copyright (c) Microsoft. All rights reserved.
22

3+
using System.Diagnostics.CodeAnalysis;
4+
35
namespace Microsoft.SemanticKernel.Plugins.OpenApi;
46

57
/// <summary>
68
/// The REST API operation response.
79
/// </summary>
10+
[Experimental("SKEXP0040")]
811
public sealed class RestApiOperationExpectedResponse
912
{
1013
/// <summary>

dotnet/src/Functions/Functions.OpenApi/Model/RestApiOperationParameter.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
// Copyright (c) Microsoft. All rights reserved.
22

3+
using System.Diagnostics.CodeAnalysis;
4+
35
namespace Microsoft.SemanticKernel.Plugins.OpenApi;
46

57
/// <summary>
68
/// The REST API operation parameter.
79
/// </summary>
10+
[Experimental("SKEXP0040")]
811
public sealed class RestApiOperationParameter
912
{
1013
/// <summary>

dotnet/src/Functions/Functions.OpenApi/Model/RestApiOperationParameterLocation.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
// Copyright (c) Microsoft. All rights reserved.
22

3+
using System.Diagnostics.CodeAnalysis;
4+
35
namespace Microsoft.SemanticKernel.Plugins.OpenApi;
46

57
/// <summary>
68
/// The REST API operation parameter location.
79
/// </summary>
10+
[Experimental("SKEXP0040")]
811
public enum RestApiOperationParameterLocation
912
{
1013
/// <summary>

dotnet/src/Functions/Functions.OpenApi/Model/RestApiOperationParameterStyle.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
// Copyright (c) Microsoft. All rights reserved.
22

3+
using System.Diagnostics.CodeAnalysis;
4+
35
namespace Microsoft.SemanticKernel.Plugins.OpenApi;
46

57
/// <summary>
68
/// The REST API operation parameter style.
79
/// </summary>
10+
[Experimental("SKEXP0040")]
811
public enum RestApiOperationParameterStyle
912
{
1013
/// <summary>

dotnet/src/Functions/Functions.OpenApi/Model/RestApiOperationPayload.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
// Copyright (c) Microsoft. All rights reserved.
22

33
using System.Collections.Generic;
4+
using System.Diagnostics.CodeAnalysis;
45

56
namespace Microsoft.SemanticKernel.Plugins.OpenApi;
67

78
/// <summary>
89
/// The REST API operation payload.
910
/// </summary>
11+
[Experimental("SKEXP0040")]
1012
public sealed class RestApiOperationPayload
1113
{
1214
/// <summary>

dotnet/src/Functions/Functions.OpenApi/Model/RestApiOperationPayloadProperty.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
// Copyright (c) Microsoft. All rights reserved.
22

33
using System.Collections.Generic;
4+
using System.Diagnostics.CodeAnalysis;
45

56
namespace Microsoft.SemanticKernel.Plugins.OpenApi;
67

78
/// <summary>
89
/// The REST API operation payload property.
910
/// </summary>
11+
[Experimental("SKEXP0040")]
1012
public sealed class RestApiOperationPayloadProperty
1113
{
1214
/// <summary>

dotnet/src/Functions/Functions.OpenApi/Model/RestApiOperationServer.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
// Copyright (c) Microsoft. All rights reserved.
22

33
using System.Collections.Generic;
4+
using System.Diagnostics.CodeAnalysis;
45

56
namespace Microsoft.SemanticKernel.Plugins.OpenApi;
67

78
/// <summary>
89
/// REST API Operation Server.
910
/// </summary>
11+
[Experimental("SKEXP0040")]
1012
public sealed class RestApiOperationServer
1113
{
1214
/// <summary>

dotnet/src/Functions/Functions.OpenApi/Model/RestApiOperationServerVariable.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
// Copyright (c) Microsoft. All rights reserved.
22

33
using System.Collections.Generic;
4+
using System.Diagnostics.CodeAnalysis;
45
using System.Linq;
56

67
namespace Microsoft.SemanticKernel.Plugins.OpenApi;
78

89
/// <summary>
910
/// REST API Operation Server Variable.
1011
/// </summary>
12+
[Experimental("SKEXP0040")]
1113
public sealed class RestApiOperationServerVariable
1214
{
1315
/// <summary>

0 commit comments

Comments
 (0)