Skip to content

Summaries and Descriptions Mapping #206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Apr 7, 2022
Merged

Summaries and Descriptions Mapping #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
bce9abd
Handle Summaries and Descriptions from *Restrictions annotations in c…
finsharp Apr 5, 2022
e8733c0
make differentiating changes to test data.
georgend Apr 5, 2022
3a31a69
Differentiate summary from description.
georgend Apr 5, 2022
545d29a
Remove summary handling.
georgend Apr 5, 2022
200a5d3
Update tests.
georgend Apr 5, 2022
cf7b9f3
Use explicity typing.
georgend Apr 5, 2022
0f40d7b
Singleton.
georgend Apr 5, 2022
bea9474
Update CRUD operations summaries and descriptions
irvinesunday Apr 5, 2022
076c3e9
Merge pull request #2 from irvinesunday/is/summaries
georgend Apr 5, 2022
f74f442
Corrections.
georgend Apr 5, 2022
4828a91
update test data.
georgend Apr 5, 2022
f458f45
Update some CRUD operations summaries and descriptions
irvinesunday Apr 6, 2022
960c3c3
Update tests
irvinesunday Apr 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions src/Microsoft.OpenApi.OData.Reader/Operation/ComplexPropertyGetOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,6 @@ protected override void Initialize(ODataContext context, ODataPath path)
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = $"Get {ComplexPropertySegment.Property.Name} property value";

// OperationId
if (Context.Settings.EnableOperationId)
{
Expand All @@ -46,8 +43,10 @@ protected override void SetBasicInfo(OpenApiOperation operation)
operation.OperationId = ComplexPropertySegment.Property.Name + "." + typeName + listOrGet + Utils.UpperFirstChar(typeName);
}

// Description
operation.Description = ReadRestrictions?.Description ?? Context.Model.GetDescriptionAnnotation(ComplexPropertySegment.Property);
// Summary and Description
string placeHolder = $"Get {ComplexPropertySegment.Property.Name} property value";
operation.Summary = ReadRestrictions?.Description ?? placeHolder;
operation.Description = ReadRestrictions?.LongDescription ?? Context.Model.GetDescriptionAnnotation(ComplexPropertySegment.Property);

base.SetBasicInfo(operation);
}
Expand Down
11 changes: 5 additions & 6 deletions src/Microsoft.OpenApi.OData.Reader/Operation/ComplexPropertyPostOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ internal class ComplexPropertyPostOperationHandler : ComplexPropertyBaseOperatio
protected override void Initialize(ODataContext context, ODataPath path)
{
base.Initialize(context, path);
if(!ComplexPropertySegment.Property.Type.IsCollection())
if (!ComplexPropertySegment.Property.Type.IsCollection())
{
throw new InvalidOperationException("OData conventions do not support POSTing to a complex property that is not a collection.");
}
Expand All @@ -39,18 +39,17 @@ protected override void Initialize(ODataContext context, ODataPath path)
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = $"Sets a new value for the collection of {ComplexPropertySegment.ComplexType.Name}.";

// OperationId
if (Context.Settings.EnableOperationId)
{
string typeName = ComplexPropertySegment.ComplexType.Name;
operation.OperationId = ComplexPropertySegment.Property.Name + "." + typeName + ".Set" + Utils.UpperFirstChar(typeName);
}

// Description
operation.Description = InsertRestrictions?.Description;
// Summary and Description
string placeHolder = $"Sets a new value for the collection of {ComplexPropertySegment.ComplexType.Name}.";
operation.Summary = InsertRestrictions?.Description ?? placeHolder;
operation.Description = InsertRestrictions?.LongDescription;

base.SetBasicInfo(operation);
}
Expand Down
9 changes: 4 additions & 5 deletions src/Microsoft.OpenApi.OData.Reader/Operation/ComplexPropertyUpdateOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,10 @@ protected override void Initialize(ODataContext context, ODataPath path)
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = $"Update property {ComplexPropertySegment.Property.Name} value.";

// Description
operation.Description = UpdateRestrictions?.Description;
// Summary and Description
string placeHolder = $"Update property {ComplexPropertySegment.Property.Name} value.";
operation.Summary = UpdateRestrictions?.Description ?? placeHolder;
operation.Description = UpdateRestrictions?.LongDescription;

// OperationId
if (Context.Settings.EnableOperationId)
Expand Down
7 changes: 3 additions & 4 deletions src/Microsoft.OpenApi.OData.Reader/Operation/EntityDeleteOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,12 @@ protected override void Initialize(ODataContext context, ODataPath path)
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Delete entity from " + EntitySet.Name;

IEdmEntityType entityType = EntitySet.EntityType();

// Description
operation.Description = DeleteRestrictions?.Description;
string placeHolder = "Delete entity from " + EntitySet.Name;
operation.Summary = DeleteRestrictions?.Description ?? placeHolder;
operation.Description = DeleteRestrictions?.LongDescription;

// OperationId
if (Context.Settings.EnableOperationId)
Expand Down
9 changes: 4 additions & 5 deletions src/Microsoft.OpenApi.OData.Reader/Operation/EntityGetOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,12 @@ protected override void Initialize(ODataContext context, ODataPath path)
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Get entity from " + EntitySet.Name + " by key";

IEdmEntityType entityType = EntitySet.EntityType();

// Description
operation.Description = ReadRestrictions?.ReadByKeyRestrictions?.Description ?? Context.Model.GetDescriptionAnnotation(entityType);
string placeHolder = "Get entity from " + EntitySet.Name + " by key";
operation.Summary = ReadRestrictions?.ReadByKeyRestrictions?.Description ?? placeHolder;
operation.Description = ReadRestrictions?.ReadByKeyRestrictions?.LongDescription ?? Context.Model.GetDescriptionAnnotation(entityType);

// OperationId
if (Context.Settings.EnableOperationId)
Expand Down Expand Up @@ -132,7 +131,7 @@ protected override void SetResponses(OpenApiOperation operation)
}

protected override void SetSecurity(OpenApiOperation operation)
{
{
if (ReadRestrictions == null)
{
return;
Expand Down
9 changes: 4 additions & 5 deletions src/Microsoft.OpenApi.OData.Reader/Operation/EntitySetGetOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,17 @@ protected override void Initialize(ODataContext context, ODataPath path)
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Get entities from " + EntitySet.Name;
// Summary and Descriptions
string placeHolder = "Get entities from " + EntitySet.Name;
operation.Summary = ReadRestrictions?.Description ?? placeHolder;
operation.Description = ReadRestrictions?.LongDescription ?? Context.Model.GetDescriptionAnnotation(EntitySet);

// OperationId
if (Context.Settings.EnableOperationId)
{
string typeName = EntitySet.EntityType().Name;
operation.OperationId = EntitySet.Name + "." + typeName + ".List" + Utils.UpperFirstChar(typeName);
}

// Description
operation.Description = ReadRestrictions?.Description ?? Context.Model.GetDescriptionAnnotation(EntitySet);
}

protected override void SetExtensions(OpenApiOperation operation)
Expand Down
9 changes: 4 additions & 5 deletions src/Microsoft.OpenApi.OData.Reader/Operation/EntitySetPostOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,17 @@ protected override void Initialize(ODataContext context, ODataPath path)
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Add new entity to " + EntitySet.Name;
// Summary and Description
string placeHolder = "Add new entity to " + EntitySet.Name;
operation.Summary = InsertRestrictions?.Description ?? placeHolder;
operation.Description = InsertRestrictions?.LongDescription;

// OperationId
if (Context.Settings.EnableOperationId)
{
string typeName = EntitySet.EntityType().Name;
operation.OperationId = EntitySet.Name + "." + typeName + ".Create" + Utils.UpperFirstChar(typeName);
}

// Description
operation.Description = InsertRestrictions?.Description;
}

/// <inheritdoc/>
Expand Down
9 changes: 4 additions & 5 deletions src/Microsoft.OpenApi.OData.Reader/Operation/EntityUpdateOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,12 @@ protected override void Initialize(ODataContext context, ODataPath path)
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Update entity in " + EntitySet.Name;

IEdmEntityType entityType = EntitySet.EntityType();

// Description
operation.Description = UpdateRestrictions?.Description;
// Summary and Description
string placeHolder = "Update entity in " + EntitySet.Name;
operation.Summary = UpdateRestrictions?.Description ?? placeHolder;
operation.Description = UpdateRestrictions?.LongDescription;

// OperationId
if (Context.Settings.EnableOperationId)
Expand Down
11 changes: 5 additions & 6 deletions src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyDeleteOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,17 @@ internal class NavigationPropertyDeleteOperationHandler : NavigationPropertyOper
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Delete navigation property " + NavigationProperty.Name + " for " + NavigationSource.Name;
// Summary and Description
string placeHolder = "Delete navigation property " + NavigationProperty.Name + " for " + NavigationSource.Name;
operation.Summary = Restriction?.DeleteRestrictions?.Description ?? placeHolder;
operation.Description = Restriction?.DeleteRestrictions?.LongDescription;

// OperationId
if (Context.Settings.EnableOperationId)
{
string prefix = "Delete";
operation.OperationId = GetOperationId(prefix);
}

// Description
operation.Description = Restriction?.DeleteRestrictions?.Description;
}

base.SetBasicInfo(operation);
}
Expand Down
15 changes: 7 additions & 8 deletions src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyGetOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,12 @@ internal class NavigationPropertyGetOperationHandler : NavigationPropertyOperati
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Get " + NavigationProperty.Name + " from " + NavigationSource.Name;
// Summary and Description
ReadRestrictionsType readRestriction = Restriction?.ReadRestrictions;
string placeHolder = "Get " + NavigationProperty.Name + " from " + NavigationSource.Name;
operation.Summary = (LastSegmentIsKeySegment ? readRestriction?.ReadByKeyRestrictions?.Description : readRestriction?.Description) ?? placeHolder;
operation.Description = (LastSegmentIsKeySegment ? readRestriction?.ReadByKeyRestrictions?.LongDescription : readRestriction?.LongDescription)
?? Context.Model.GetDescriptionAnnotation(NavigationProperty);

// OperationId
if (Context.Settings.EnableOperationId)
Expand All @@ -41,12 +45,7 @@ protected override void SetBasicInfo(OpenApiOperation operation)

operation.OperationId = GetOperationId(prefix);
}

// Description
ReadRestrictionsType readRestriction = Restriction?.ReadRestrictions;
operation.Description = (LastSegmentIsKeySegment ? readRestriction?.ReadByKeyRestrictions?.Description : readRestriction?.Description)
?? Context.Model.GetDescriptionAnnotation(NavigationProperty);


base.SetBasicInfo(operation);
}

Expand Down
9 changes: 4 additions & 5 deletions src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyPostOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,10 @@ internal class NavigationPropertyPostOperationHandler : NavigationPropertyOperat
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Create new navigation property to " + NavigationProperty.Name + " for " + NavigationSource.Name;
// Summary and Description
string placeHolder = "Create new navigation property to " + NavigationProperty.Name + " for " + NavigationSource.Name;
operation.Summary = Restriction?.InsertRestrictions?.Description ?? placeHolder;
operation.Description = Restriction?.InsertRestrictions?.LongDescription;

// OperationId
if (Context.Settings.EnableOperationId)
Expand All @@ -35,9 +37,6 @@ protected override void SetBasicInfo(OpenApiOperation operation)
operation.OperationId = GetOperationId(prefix);
}

// Description
operation.Description = Restriction?.InsertRestrictions?.Description;

base.SetBasicInfo(operation);
}

Expand Down
9 changes: 4 additions & 5 deletions src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyUpdateOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ internal abstract class NavigationPropertyUpdateOperationHandler : NavigationPro
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Update the navigation property " + NavigationProperty.Name + " in " + NavigationSource.Name;
// Summary and Description
string placeHolder = "Update the navigation property " + NavigationProperty.Name + " in " + NavigationSource.Name;
operation.Summary = Restriction?.UpdateRestrictions?.Description ?? placeHolder;
operation.Description = Restriction?.UpdateRestrictions?.LongDescription;

// OperationId
if (Context.Settings.EnableOperationId)
Expand All @@ -32,9 +34,6 @@ protected override void SetBasicInfo(OpenApiOperation operation)
operation.OperationId = GetOperationId(prefix);
}

// Description
operation.Description = Restriction?.UpdateRestrictions?.Description;

base.SetBasicInfo(operation);
}

Expand Down
11 changes: 5 additions & 6 deletions src/Microsoft.OpenApi.OData.Reader/Operation/RefDeleteOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,17 @@ internal class RefDeleteOperationHandler : NavigationPropertyOperationHandler
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Delete ref of navigation property " + NavigationProperty.Name + " for " + NavigationSource.Name;
// Summary and Description
string placeHolder = "Delete ref of navigation property " + NavigationProperty.Name + " for " + NavigationSource.Name;
operation.Summary = Restriction?.DeleteRestrictions?.Description ?? placeHolder;
operation.Description = Restriction?.DeleteRestrictions?.LongDescription;

// OperationId
if (Context.Settings.EnableOperationId)
{
string prefix = "DeleteRef";
operation.OperationId = GetOperationId(prefix);
}

// Description
operation.Description = Restriction?.DeleteRestrictions?.Description;
}
}

/// <inheritdoc/>
Expand Down
13 changes: 6 additions & 7 deletions src/Microsoft.OpenApi.OData.Reader/Operation/RefGetOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,12 @@ internal class RefGetOperationHandler : NavigationPropertyOperationHandler
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Get ref of " + NavigationProperty.Name + " from " + NavigationSource.Name;
// Summary and Description
ReadRestrictionsType readRestriction = Restriction?.ReadRestrictions;
string placeHolder = "Get ref of " + NavigationProperty.Name + " from " + NavigationSource.Name;
operation.Summary = (LastSegmentIsKeySegment ? readRestriction?.ReadByKeyRestrictions?.Description : readRestriction?.Description) ?? placeHolder;
operation.Description = (LastSegmentIsKeySegment ? readRestriction?.ReadByKeyRestrictions?.LongDescription : readRestriction?.LongDescription)
?? Context.Model.GetDescriptionAnnotation(NavigationProperty);

// OperationId
if (Context.Settings.EnableOperationId)
Expand All @@ -39,11 +43,6 @@ protected override void SetBasicInfo(OpenApiOperation operation)

operation.OperationId = GetOperationId(prefix);
}

// Description
ReadRestrictionsType readRestriction = Restriction?.ReadRestrictions;
operation.Description = (LastSegmentIsKeySegment ? readRestriction?.ReadByKeyRestrictions?.Description : readRestriction?.Description)
?? Context.Model.GetDescriptionAnnotation(NavigationProperty);
}

protected override void SetExtensions(OpenApiOperation operation)
Expand Down
9 changes: 5 additions & 4 deletions src/Microsoft.OpenApi.OData.Reader/Operation/RefPostOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ internal class RefPostOperationHandler : NavigationPropertyOperationHandler
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Create new navigation property ref to " + NavigationProperty.Name + " for " + NavigationSource.Name;
// Summary and Description
string placeHolder = "Create new navigation property ref to " + NavigationProperty.Name + " for " + NavigationSource.Name;
operation.Summary = Restriction?.InsertRestrictions?.Description ?? placeHolder;
operation.Description = Restriction?.InsertRestrictions?.LongDescription;

// OperationId
if (Context.Settings.EnableOperationId)
Expand All @@ -32,8 +34,7 @@ protected override void SetBasicInfo(OpenApiOperation operation)
operation.OperationId = GetOperationId(prefix);
}

// Description
operation.Description = Restriction?.InsertRestrictions?.Description;

}

/// <inheritdoc/>
Expand Down
8 changes: 4 additions & 4 deletions src/Microsoft.OpenApi.OData.Reader/Operation/RefPutOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ internal class RefPutOperationHandler : NavigationPropertyOperationHandler
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Update the ref of navigation property " + NavigationProperty.Name + " in " + NavigationSource.Name;
// Summary and Description
string placeHolder = "Update the ref of navigation property " + NavigationProperty.Name + " in " + NavigationSource.Name;
operation.Summary = Restriction?.UpdateRestrictions?.Description ?? placeHolder;
operation.Description = Restriction?.UpdateRestrictions?.LongDescription;

// OperationId
if (Context.Settings.EnableOperationId)
{
string prefix = "UpdateRef";
operation.OperationId = GetOperationId(prefix);
}

operation.Description = Restriction?.UpdateRestrictions?.Description;
}

/// <inheritdoc/>
Expand Down
9 changes: 4 additions & 5 deletions src/Microsoft.OpenApi.OData.Reader/Operation/SingletonGetOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,17 @@ protected override void Initialize(ODataContext context, ODataPath path)
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary, this summary maybe update in the base function call.
operation.Summary = "Get " + Singleton.Name;
// Summary and Descriptions
string placeHolder = "Get " + Singleton.Name;
operation.Summary = ReadRestrictions?.Description ?? placeHolder;
operation.Description = ReadRestrictions?.LongDescription ?? Context.Model.GetDescriptionAnnotation(Singleton);

// OperationId, it should be unique among all operations described in the API.
if (Context.Settings.EnableOperationId)
{
string typeName = Singleton.EntityType().Name;
operation.OperationId = Singleton.Name + "." + typeName + ".Get" + Utils.UpperFirstChar(typeName);
}

// Description
operation.Description = ReadRestrictions?.Description ?? Context.Model.GetDescriptionAnnotation(Singleton);
}

/// <inheritdoc/>
Expand Down
Loading