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

Update the rate attribute within the rate object to be rate_in_cents #106

Open
michael-danko-passport opened this issue Jul 26, 2022 · 2 comments
Milestone

Comments

@michael-danko-passport
Copy link
Collaborator

Is your feature request related to a problem? Please describe.

While discussiing #103 in the 7/26 CDS WG meeting, we highlighted that within the rate object, we have a field called rate. This can be confusing to API documentation consumers since the rate field within the rate object represents a subset of information and not the entirety of a rate.

Describe the solution you'd like

Since the rate field within the rate object does not entirely describe what a rate is, it would be more clearer to rename the field rate_in_cents.

Is this a breaking change

Yes this would be a breaking change.

Impacted Spec

For which spec is this feature being requested?

  • Curbs
@schnuerle
Copy link
Member

We need to keep the names international and not all counties use cents as their base unit. I agree it's a bit confusing to have a rate field in a rate object, but It's not too bad and we do it elsewhere in MDS I believe. But we could come up with a more universal but clear field name, like rate_amount or rate_sub_unit. Most counties have sub units of 100, though a few have it based on 10s or 1000s.

@schnuerle schnuerle added this to the 2.0 milestone May 30, 2023
@schnuerle
Copy link
Member

This came up tangentially in Issue #120 and latest comment has MDS links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants