Skip to content

Commit 8551044

Browse files
oejoej
authored
Merge pull request #138 from ppkarwasz/fix/snake_case-to-camelCase
feat: use `camelCase` for property and parameter names
2 parents d36672d + 71b6983 commit 8551044

File tree

2 files changed

+31
-31
lines changed

2 files changed

+31
-31
lines changed

‎spec/openapi.yaml‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -345,10 +345,10 @@ components:
345345
version:
346346
description: Version number
347347
type: string
348-
release_date:
348+
releaseDate:
349349
description: Timestamp of the release (for sorting purposes)
350350
"$ref": "#/components/schemas/date-time"
351-
pre_release:
351+
preRelease:
352352
type: boolean
353353
description: |
354354
A flag indicating pre-release (or beta) status.
@@ -362,27 +362,27 @@ components:
362362
required:
363363
- uuid
364364
- version
365-
- release_date
365+
- releaseDate
366366
examples:
367367
# Apache Tomcat 11.0.6
368368
- uuid: 605d0ecb-1057-40e4-9abf-c400b10f0345
369369
version: "11.0.6"
370-
release_date: 2025-04-01T15:43:00Z
370+
releaseDate: 2025-04-01T15:43:00Z
371371
identifiers:
372372
- idType: purl
373373
idValue: pkg:maven/org.apache.tomcat/tomcat@11.0.6
374374
# Different release of Apache Tomcat
375375
- uuid: da89e38e-95e7-44ca-aa7d-f3b6b34c7fab
376376
version: "10.1.40"
377-
release_date: 2025-04-01T18:20:00Z
377+
releaseDate: 2025-04-01T18:20:00Z
378378
identifiers:
379379
- idType: purl
380380
idValue: pkg:maven/org.apache.tomcat/tomcat@10.1.40
381381
# A pre-release of Apache Tomcat
382382
- uuid: 95f481df-f760-47f4-b2f2-f8b76d858450
383383
version: "11.0.0-M26"
384-
release_date: 2024-09-13T17:49:00Z
385-
pre_release: true
384+
releaseDate: 2024-09-13T17:49:00Z
385+
preRelease: true
386386
identifiers:
387387
- idType: purl
388388
idValue: pkg:maven/org.apache.tomcat/tomcat@11.0.0-M26
@@ -405,10 +405,10 @@ components:
405405
description: |
406406
TEA Collection version, incremented each time its content changes.
407407
Versions start with 1.
408-
release_date:
408+
releaseDate:
409409
description: TEA Collection version release date.
410410
"$ref": "#/components/schemas/date-time"
411-
update_reason:
411+
updateReason:
412412
description: Reason for the update/release of the TEA Collection object.
413413
"$ref": "#/components/schemas/collection-update-reason"
414414
artifacts:
@@ -420,8 +420,8 @@ components:
420420
# Documents in the latest release of Log4j Core
421421
- uuid: 4c72fe22-9d83-4c2f-8eba-d6db484f32c8
422422
version: 1
423-
release_date: 2024-12-13T00:00:00Z
424-
update_reason:
423+
releaseDate: 2024-12-13T00:00:00Z
424+
updateReason:
425425
type: ARTIFACT_UPDATED
426426
comment: VDR file updated
427427
artifacts:
@@ -570,7 +570,7 @@ components:
570570
type: string
571571
description: Direct download URL for the artifact
572572
format: url
573-
signature_url:
573+
signatureUrl:
574574
type: string
575575
description: Direct download URL for an external signature of the artifact
576576
format: url
@@ -614,22 +614,22 @@ components:
614614
type: string
615615
format: date-time
616616
example: '2024-03-20T15:30:00Z'
617-
page_start_index:
617+
pageStartIndex:
618618
type: number
619619
format: int64
620620
default: 0
621-
page_size:
621+
pageSize:
622622
type: number
623623
format: int64
624624
default: 100
625-
total_results:
625+
totalResults:
626626
type: number
627627
format: int64
628628
required:
629629
- timestamp
630-
- page_start_index
631-
- page_size
632-
- total_results
630+
- pageStartIndex
631+
- pageSize
632+
- totalResults
633633
responses:
634634
204-common-delete:
635635
description: Object deleted successfully
@@ -663,7 +663,7 @@ components:
663663
parameters:
664664
# Pagination
665665
page-offset:
666-
name: page-offset
666+
name: pageOffset
667667
description: Pagination offset
668668
in: query
669669
required: false
@@ -672,7 +672,7 @@ components:
672672
format: int64
673673
default: 0
674674
page-size:
675-
name: page-size
675+
name: pageSize
676676
description: Pagination offset
677677
in: query
678678
required: false
@@ -682,7 +682,7 @@ components:
682682
default: 100
683683
# Identifiers
684684
tei_urn:
685-
name: tei_urn
685+
name: teiUrn
686686
description: Transparency Exchange Identifier (URN)
687687
in: query
688688
required: true

‎tea-collection/tea-collection.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ A TEA Component Release object has the following parts:
1111

1212
- __uuid__: A unique identifier for the TEA Component Release
1313
- __version__: Version number
14-
- __release_date__: Timestamp of the release (for sorting purposes)
15-
- __pre_release__: A flag indicating pre-release (or beta) status.
14+
- __releaseDate__: Timestamp of the release (for sorting purposes)
15+
- __preRelease__: A flag indicating pre-release (or beta) status.
1616
May be disabled after the creation of the release object, but can't be enabled after creation of an object.
1717
- __identifiers__: List of identifiers for the component
1818
- __idType__: Type of identifier, e.g. `tei`, `purl`, `cpe`
@@ -26,7 +26,7 @@ A TEA Component Release object of the binary distribution of Apache Tomcat 11.0.
2626
{
2727
"uuid": "605d0ecb-1057-40e4-9abf-c400b10f0345",
2828
"version": "11.0.6",
29-
"release_date": "2025-04-01T15:43:00Z",
29+
"releaseDate": "2025-04-01T15:43:00Z",
3030
"identifiers": [
3131
{
3232
"idType": "purl",
@@ -42,7 +42,7 @@ Different versions of Apache Tomcat should have separate TEA Component Release o
4242
{
4343
"uuid": "da89e38e-95e7-44ca-aa7d-f3b6b34c7fab",
4444
"version": "10.1.4",
45-
"release_date": "2025-04-01T18:20:00Z",
45+
"releaseDate": "2025-04-01T18:20:00Z",
4646
"identifiers": [
4747
{
4848
"idType": "purl",
@@ -59,8 +59,8 @@ and does not require users to know the version naming scheme adopted by the proj
5959
{
6060
"uuid": "95f481df-f760-47f4-b2f2-f8b76d858450",
6161
"version": "11.0.0-M26",
62-
"release_date": "2024-09-13T17:49:00Z",
63-
"pre_release": true,
62+
"releaseDate": "2024-09-13T17:49:00Z",
63+
"preRelease": true,
6464
"identifiers": [
6565
{
6666
"idType": "purl",
@@ -113,8 +113,8 @@ The TEA Collection object has the following parts:
113113
When updating a collection, only the `version` is changed.
114114
- __version__: TEA Collection version, incremented each time its content changes.
115115
Versions start with 1.
116-
- __release_date__: TEA Collection version release date.
117-
- __update_reason__: Reason for the update/release of the TEA Collection object.
116+
- __releaseDate__: TEA Collection version release date.
117+
- __updateReason__: Reason for the update/release of the TEA Collection object.
118118
- __type__: Type of update reason.
119119
See [reasons for TEA Collection update](#the-reason-for-tco-update-enum) below.
120120
- __comment__: Free text description.
@@ -163,8 +163,8 @@ producing different alerts than other changes of a collection.
163163
{
164164
"uuid": "4c72fe22-9d83-4c2f-8eba-d6db484f32c8",
165165
"version": 1,
166-
"release_date": "2024-12-13T00:00:00Z",
167-
"update_reason": {
166+
"releaseDate": "2024-12-13T00:00:00Z",
167+
"updateReason": {
168168
"type": "ARTIFACT_UPDATED",
169169
"comment": "VDR file updated"
170170
},

0 commit comments

Comments
 (0)