Resolves operationId and tag names for OData cast paths
#338
Conversation
irvinesunday
requested review from
xuzhg,
darrelmiller,
peombwa,
zengin,
baywet and
millicentachieng
as code owners
|
SonarCloud Quality Gate failed. |
| /// <param name="navigationSource">The <see cref="IEdmNavigationSource"/> of the target path.</param> | ||
| /// <param name="prefix">Identifier indicating whether it is a collection-valued non-indexed navigation property.</param> | ||
| /// <returns>The operation id name.</returns> | ||
| internal static string GenerateNavigationPropertyPathOperationId(ODataPath path, IEdmNavigationSource navigationSource, string prefix = null) |
There was a problem hiding this comment.
Can we standardize the naming convention of operationIds to what we have in DevX API - https://github.com/microsoftgraph/microsoft-graph-devx-api/blob/dev/OpenAPIService/PowershellFormatter.cs?
For example:
- Remove hash suffix values from operationIds of function paths.
- Add '_' to separate verb (action) in an operationId. This typically the last
.or second.for OData cast paths. - PUT operations should have Set as the verb in an operationId
{xxx}_Set{yyy}.
In PowerShell, we use operationIds to form command names.
There was a problem hiding this comment.
See my comments at #324 (comment) on operationIds and tags for count and complex property paths.
There was a problem hiding this comment.
Can we standardize the naming convention of operationIds to what we have in DevX API - https://github.com/microsoftgraph/microsoft-graph-devx-api/blob/dev/OpenAPIService/PowershellFormatter.cs? For example:
- Remove hash suffix values from operationIds of function paths.
- Add '_' to separate verb (action) in an operationId. This typically the last
.or second.for OData cast paths.- PUT operations should have Set as the verb in an operationId
{xxx}_Set{yyy}.In PowerShell, we use operationIds to form command names.
There are other clients who rely on the operation ids, not sure it will be a good idea to handle that in this library. See this issue.
There was a problem hiding this comment.
They are also using AutoREST in the referenced issue - microsoftgraph/msgraph-metadata#289. Standardizing the operationIds here and ensuring uniqueness will have the net effect of fixing their issue.
To unblock this change, I've created an issue at #361 for us to discuss this further.
|
Kudos, SonarCloud Quality Gate passed! |
Fixes #324
This PR:
operationIdandtagnames for OData cast paths to conform with other no non-OData cast paths.NB: The PR is currently in draft because:
$countpaths currently don't have tags generated for them. We need to agree on a format before these can be updated into this fix. The discussion can be found here.