Repository navigation
[Feature Request] Standardize operationIds to ensure uniqueness #361
Description
We should consider standardizing the naming convention of operationIds to what we currently have in DevX API (PowerShell style) - https://github.com/microsoftgraph/microsoft-graph-devx-api/blob/dev/OpenAPIService/PowershellFormatter.cs? For example:
- Remove hash suffix values from operationIds for
functionall paths. - Add '_' to separate verb (action) in an operationId. This typically the last
.or second from last.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.
As part of this exercise, we should add validation to ensure operationIds are unique for a given document.
Edit: This is a continuation of #338 (comment).
Activity
irvinesunday commentedon May 3, 2023
I like this:
Peter Ombwa (@peombwa) I have a few questions on this:
peombwa commentedon May 22, 2023
Not that I’m aware of. All Microsoft Graph OpenAPI-based SDKs use paths and operation names to construct request builders/command names except for PowerShell, which uses AutoREST. AutoREST uses operationIds to construct command names; uniqueness is key. If a breaking change is a concern, I think it’s best to assume that there is probably a tool out there that takes a dependency on the current OperationId naming convention.
This is based on a customer comment in the metadata repo at microsoftgraph/msgraph-metadata#289:
Based on the customer issue, they are using the OpenAPI YAML file in the metadata repo that’s generated using this library.
irvinesunday commentedon May 30, 2023
Peter Ombwa (@peombwa) based on this concern, can we put a hold on this request?