Skip to content

Rename schema DevicePPID to use PascalCase#179

Open
eric-murray wants to merge 1 commit into
camaraproject:mainfrom
eric-murray:eric-murray-patch-2
Open

Rename schema DevicePPID to use PascalCase#179
eric-murray wants to merge 1 commit into
camaraproject:mainfrom
eric-murray:eric-murray-patch-2

Conversation

@eric-murray

@eric-murray eric-murray commented Jun 11, 2026

Copy link
Copy Markdown
Collaborator

What type of PR is this?

  • correction

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

 release-note
 - Rename schema DevicePPID to use PascalCase

Additional documentation

None

@eric-murray eric-murray requested a review from Kevsy as a code owner June 11, 2026 15:28
@hdamker

hdamker commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

@eric-murray 😂

To say it with the words of Claude (asked to review the PR), but my first thought was the same:

DevicePeePeeIyeDee is the phonetic spelling of P-P-I-D ("Pee-Pee-Eye-Dee"). It technically satisfies the PascalCase rule (hence the green Validation run), but it's unreadable and discards the recognizable PPID acronym. This reads as malicious-compliance / a joke rather than a real fix — it should not merge as-is.

CAMARA's established convention is to treat an acronym as a word — capitalize only the first letter. Precedent across the API set is unambiguous:

  • Id (not ID), Uri (not URI), WebhookUrl (not WebhookURL), AppId, SessionId, …

So the correct target is DevicePpid — it passes the same PascalCase check, stays readable, and keeps the acronym recognizable. The PPID meaning is already preserved in the schema description ("expressed as a PPID (Pairwise Pseudonymous Identifier)"), so no semantic loss either way.

@hdamker hdamker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See comment

allOf:
- $ref: "#/components/schemas/CommonResponseBody"
- $ref: "#/components/schemas/DevicePPID"
- $ref: "#/components/schemas/DevicePeePeeIyeDee"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
- $ref: "#/components/schemas/DevicePeePeeIyeDee"
- $ref: "#/components/schemas/DevicePpid"

example: "Nokia"

DevicePPID:
DevicePeePeeIyeDee:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
DevicePeePeeIyeDee:
DevicePpid:

@Kevsy

Kevsy commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator

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)

@hdamker

hdamker commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

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 :-)

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename schema DevicePPID to use PascalCase

3 participants