Rename schema DevicePPID to use PascalCase#179
Conversation
|
To say it with the words of Claude (asked to review the PR), but my first thought was the same:
CAMARA's established convention is to treat an acronym as a word — capitalize only the first letter. Precedent across the API set is unambiguous:
So the correct target is |
| allOf: | ||
| - $ref: "#/components/schemas/CommonResponseBody" | ||
| - $ref: "#/components/schemas/DevicePPID" | ||
| - $ref: "#/components/schemas/DevicePeePeeIyeDee" |
There was a problem hiding this comment.
| - $ref: "#/components/schemas/DevicePeePeeIyeDee" | |
| - $ref: "#/components/schemas/DevicePpid" |
| example: "Nokia" | ||
|
|
||
| DevicePPID: | ||
| DevicePeePeeIyeDee: |
There was a problem hiding this comment.
| DevicePeePeeIyeDee: | |
| DevicePpid: |
|
HI @hdamker - that makes sense, but just to note the convention/precedent is not documented (or at least, I can't find it :)) From API Design Guide: Camel Case | It is a kind of define _(sic)_ the fields’ compound name or phrases without whitespaces among words (_sic_). It uses a capital letter at the beginning of each word. There are two different uses:
UpperCamelCase: When the first letter of each word is capital.
lowerCamelCase: Same to (_sic_) that Upper one, but with the first word in lowercase.I'm happy to raise an issue to clarify the established convention (and correct the grammar noted by (sic) above) |
That would make sense. Currently the convention is defined only by case law :-) |
What type of PR is this?
What this PR does / why we need it:
Rename schema DevicePPID to use PascalCase and avoid CAMARA validation error
Which issue(s) this PR fixes:
Fixes #180
Special notes for reviewers:
None
Changelog input
Additional documentation
None