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

Uppercase db types in db types endpoint #1176

Merged
merged 3 commits into from
Mar 17, 2022

Conversation

dmos62
Copy link
Contributor

@dmos62 dmos62 commented Mar 15, 2022

Related #1036

Uppercases the DB type names in the db/v0/databases/1/types endpoint. That way, casing matches with the rest of our API.

Technical details

Initially, the idea in #1036 was to find the root cause of the inconsistent casing in our code, but casing presumptions turned out more ingrained than first thought. Retreated to just uppercasing the endpoint's output, so as to conform with current policy to avoid doing technical debt work where possible.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the master branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dmos62 dmos62 added the pr-status: review A PR awaiting review label Mar 15, 2022
@dmos62 dmos62 added this to the [07] Initial Data Types milestone Mar 15, 2022
@dmos62 dmos62 self-assigned this Mar 15, 2022
@dmos62 dmos62 marked this pull request as ready for review March 15, 2022 16:49
@dmos62 dmos62 requested review from a team and mathemancer March 15, 2022 16:49
@kgodey
Copy link
Contributor

kgodey commented Mar 15, 2022

@dmos62 can you verify that spacing/underscore usage for multi-word types is also consistent? the type representation has to be identical wherever it shows up in the API.

@kgodey
Copy link
Contributor

kgodey commented Mar 15, 2022

Also, I assume you'll make a new issue for the technical debt root cause to be handled at a later date.

Copy link
Contributor

@mathemancer mathemancer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. @dmos62 Please merge this yourself once you've dealt with the question from @kgodey (or we can make that a separate issue/PR).

@kgodey kgodey added pr-status: revision A PR awaiting follow-up work from its author after review and removed pr-status: review A PR awaiting review labels Mar 16, 2022
@dmos62
Copy link
Contributor Author

dmos62 commented Mar 17, 2022

Also, I assume you'll make a new issue for the technical debt root cause to be handled at a later date.

The related issue #1036 is for the root cause. I presume that it won't be closed by this PR automatically (since I replaced 'fixed' with 'related').

Edit: yep, 'related' shouldn't close the issue: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue

@dmos62
Copy link
Contributor Author

dmos62 commented Mar 17, 2022

@dmos62 can you verify that spacing/underscore usage for multi-word types is also consistent? the type representation has to be identical wherever it shows up in the API.

I've not managed to find any inconsistencies. All places I thought to check use spaces in multi-word ids.

@dmos62 dmos62 enabled auto-merge March 17, 2022 14:12
@dmos62 dmos62 merged commit fbdfe75 into master Mar 17, 2022
@dmos62 dmos62 deleted the uppercase-db-types-in-db-types-endpoint branch March 17, 2022 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: revision A PR awaiting follow-up work from its author after review
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants