-
Notifications
You must be signed in to change notification settings - Fork 60
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.
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
[Feature Request] Standardize operationIds to ensure uniqueness #361
Comments
I like this:
@peombwa I have a few questions on this:
|
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. |
@peombwa based on this concern, can we put a hold on this request? |
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:
functionall paths..
or second from last.
for OData cast paths.{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).
The text was updated successfully, but these errors were encountered: