Skip to content

Commit 2a10cd9

Browse files
committed
feat: splits described and summarized interfaces
Signed-off-by: Vincent Biret <[email protected]>
1 parent af3038a commit 2a10cd9

File tree

3 files changed

+15
-7
lines changed

3 files changed

+15
-7
lines changed

src/Microsoft.OpenApi/Models/Interfaces/IOpenApiDescribedElement.cs

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,10 @@
33
namespace Microsoft.OpenApi.Models.Interfaces;
44

55
/// <summary>
6-
/// Describes an element that has a summary and description.
6+
/// Describes an element that has a description.
77
/// </summary>
88
public interface IOpenApiDescribedElement : IOpenApiElement
99
{
10-
/// <summary>
11-
/// Short description for the example.
12-
/// </summary>
13-
public string Summary { get; set; }
14-
1510
/// <summary>
1611
/// Long description for the example.
1712
/// CommonMark syntax MAY be used for rich text representation.

src/Microsoft.OpenApi/Models/Interfaces/IOpenApiExample.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ namespace Microsoft.OpenApi.Models.Interfaces;
77
/// Defines the base properties for the example object.
88
/// This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
99
/// </summary>
10-
public interface IOpenApiExample : IOpenApiDescribedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible
10+
public interface IOpenApiExample : IOpenApiDescribedElement, IOpenApiSummarizedElement, IOpenApiSerializable, IOpenApiReadOnlyExtensible
1111
{
1212
/// <summary>
1313
/// Embedded literal example. The value field and externalValue field are mutually
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
using Microsoft.OpenApi.Interfaces;
2+
3+
namespace Microsoft.OpenApi.Models.Interfaces;
4+
/// <summary>
5+
/// Describes an element that has a summary.
6+
/// </summary>
7+
public interface IOpenApiSummarizedElement : IOpenApiElement
8+
{
9+
/// <summary>
10+
/// Short description for the example.
11+
/// </summary>
12+
public string Summary { get; set; }
13+
}

0 commit comments

Comments
 (0)