Skip to content

Commit e9e5af8

Browse files
committed
Add summary and description properties to the OpenApiReference object
1 parent 177456c commit e9e5af8

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/Microsoft.OpenApi/Models/OpenApiReference.cs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@ namespace Microsoft.OpenApi.Models
1313
public class OpenApiReference : IOpenApiSerializable
1414
{
1515
/// <summary>
16-
/// A short summary of the Reference
16+
/// A short summary which by default SHOULD override that of the referenced component.
17+
/// If the referenced object-type does not allow a summary field, then this field has no effect.
1718
/// </summary>
1819
public string Summary { get; set; }
1920

2021
/// <summary>
21-
/// A short description of the reference
22+
/// A description which by default SHOULD override that of the referenced component.
23+
/// CommonMark syntax MAY be used for rich text representation.
24+
/// If the referenced object-type does not allow a description field, then this field has no effect.
2225
/// </summary>
2326
public string Description { get; set; }
2427

0 commit comments

Comments
 (0)