ceph / ceph/go-ceph

Deprecate `GetOmapValues` in favour of `GetOmapValuesOrdered`

Open
#1,327 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
691
Forks
296
Avg merge
2d 16h
Merged PRs (30d)
11

Description

> If we deprecate we can consider removing it in the future. That lowers our "surface area" that we need to maintain. Plus converting to a map is like 3 lines. So I prefer deprecation but I won't require it for approval.

Fair enough. Since _GetOmapValuesOrdered_/_GetAllOmapValuesOrdered_ are being introduced as preview APIs, I think it's premature to deprecate _GetOmapValues_ in favour of something that isn't stable yet. I hope we create an issue similar to https://github.com/ceph/go-ceph/issues/1306 in this case.

_Originally posted by @anoopcs9 in https://github.com/ceph/go-ceph/issues/1326#issuecomment-5481676908_

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the GetOmapValues, GetOmapValuesOrdered, and GetAllOmapValuesOrdered APIs and review their current status. Resolve whether the preview APIs are stable enough for deprecation; done means the chosen deprecation direction is reflected consistently in the Go bindings and its supporting checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.