Skip to content
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

[PROPOSAL] Move OpenSearch.Client Request/Descriptor classes into namespaces #196

Closed
Xtansia opened this issue Apr 21, 2023 · 0 comments
Closed
Labels
enhancement New feature or request

Comments

@Xtansia
Copy link
Collaborator

Xtansia commented Apr 21, 2023

What/Why

What are you proposing?

Currently the RequestParameter types in OpenSearch.Net are in specific namespaces such as OpenSearch.Net.Specification.SnapshotApi, however in OpenSearch.Client all Request and Descriptor types are directly placed in the OpenSearch.Client namespace. This is prone to collisions in naming as some have very generic names such as RestoreRequest which will collide with remote store's restore operation. As such I propose moving the Request/Descriptor classes in OpenSearch.Client into matching respective namespaces as is done in OpenSearch.Net.

What users have asked for this feature?

What problems are you trying to solve?

Collisions of type names due to placing all requests into the same namespace.

Are there any security considerations?

No

What is the user experience going to be?

User experience is unchanged other than needing to add new usings for specific namespaces.

Are there breaking changes to the User Experience?

Yes, namespaces will change, as such users will have to update their usings, otherwise API remains identical.

Why should it be built? Any reason not to?

  • Unifies namespace layout between OpenSearch.Net and OpenSearch.Client
  • Reduces chances of type name collisions, and is less invasive than renaming the types or ambiguously appending a number etc.
  • It's a breaking change and will require a major version bump

What will it take to execute?

Reasonably low-effort changing namespaces of all request and descriptor types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant