Skip to content

Commit 17adf92

Browse files
committed
feat: use camelCase for property and parameter names
This PR tries to uniformize the naming strategy for JSON properties and parameter names. Since CycloneDX mostly uses `camelCase` instead of `snake_case` or `kebab-case`, I settled to convert everything to camel case. **Note**: The names that are used internally (e.g., JSON schemas and parameter references) were not modified. Signed-off-by: Piotr P. Karwasz <piotr@github.copernik.eu>
1 parent 61b9cf9 commit 17adf92

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

spec/openapi.yaml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -343,9 +343,9 @@ components:
343343
"$ref": "#/components/schemas/uuid"
344344
version:
345345
type: string
346-
release_date:
346+
releaseDate:
347347
"$ref": "#/components/schemas/date-time"
348-
pre_release:
348+
preRelease:
349349
type: boolean
350350
description: Marks if the version is a pre-release version
351351
identifiers:
@@ -371,9 +371,9 @@ components:
371371
version:
372372
type: integer
373373
description: Collection version, incremented each time its content changes.
374-
release_date:
374+
releaseDate:
375375
"$ref": "#/components/schemas/date-time"
376-
update_reason:
376+
updateReason:
377377
"$ref": "#/components/schemas/collection-update-reason"
378378
artifacts:
379379
type: array
@@ -493,7 +493,7 @@ components:
493493
type: string
494494
description: A download URL for the artifact
495495
format: url
496-
signature_url:
496+
signatureUrl:
497497
type: string
498498
description: A download URL for an external signature of the artifact
499499
format: url
@@ -536,22 +536,22 @@ components:
536536
type: string
537537
format: date-time
538538
example: '2024-03-20T15:30:00Z'
539-
page_start_index:
539+
pageStartIndex:
540540
type: number
541541
format: int64
542542
default: 0
543-
page_size:
543+
pageSize:
544544
type: number
545545
format: int64
546546
default: 100
547-
total_results:
547+
totalResults:
548548
type: number
549549
format: int64
550550
required:
551551
- timestamp
552-
- page_start_index
553-
- page_size
554-
- total_results
552+
- pageStartIndex
553+
- pageSize
554+
- totalResults
555555
responses:
556556
204-common-delete:
557557
description: Object deleted successfully
@@ -585,7 +585,7 @@ components:
585585
parameters:
586586
# Pagination
587587
page-offset:
588-
name: page-offset
588+
name: pageOffset
589589
description: Pagination offset
590590
in: query
591591
required: false
@@ -594,7 +594,7 @@ components:
594594
format: int64
595595
default: 0
596596
page-size:
597-
name: page-size
597+
name: pageSize
598598
description: Pagination offset
599599
in: query
600600
required: false
@@ -604,7 +604,7 @@ components:
604604
default: 100
605605
# Identifiers
606606
tei_urn:
607-
name: tei_urn
607+
name: teiUrn
608608
description: Transparency Exchange Identifier (URN)
609609
in: query
610610
required: true

0 commit comments

Comments
 (0)