cycleplatform / api-spec

OpenAPI spec files for Cycle APIs
Other
3 stars 0 forks source link

Inconsistent casing in property names #68

Closed naturalethic closed 1 year ago

naturalethic commented 1 year ago

There are some properties written in kebab-case, or camelCase. They should likely concord with the more usual snake_case.

mattoni commented 1 year ago

I'll do a search through some properties later, though if you have some specific ones let me know. API should only be snake_case

naturalethic commented 1 year ago

I found these with \w-\w+::

resource-density
high-availability
first-available
auth-failure
brute-force
exploit-vulnerability
social-engineer
service-interruption
access-elevation
image-source
provider-location
mattoni commented 1 year ago

I believe every incidence of kebab-case is correct. Internally, Cycle has quite a few things that are values in a list or used as descriptors on notifications. Those are kept as kebab-case to separate them out from static properties in the API. In every instance, they are part of a report exported from the database and it is implied that the list of values there could grow over time.

Since this is accurate regarding how the API returns things, I'm going to close this.