Skip to content

Commit 4efa26e

Browse files
Merge pull request #136 from Software-Hardware-Integration-Lab/LAB-1711-update-open-api-spec-to-align-with-latest-schema-version-5-0-14
LAB-1711:- Inline nullable schemas and add examples
2 parents 0609093 + c1dc961 commit 4efa26e

1 file changed

Lines changed: 72 additions & 16 deletions

File tree

specs/Data-Gateway.json

Lines changed: 72 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2492,12 +2492,12 @@
24922492
"properties": {
24932493
"value": {
24942494
"type": [
2495-
"number",
2495+
"string",
24962496
"null"
24972497
],
2498-
"description": "Numeric assessment value for this year phase (e.g., score/percentage) or null.",
2498+
"description": "Assessment value label for this year phase (for example, \"Full\") or null.",
24992499
"examples": [
2500-
1.0,
2500+
"Full",
25012501
null
25022502
]
25032503
},
@@ -2531,7 +2531,8 @@
25312531
],
25322532
"description": "Alternate product, if any, or null.",
25332533
"examples": [
2534-
"Other Product"
2534+
"Other Product",
2535+
null
25352536
]
25362537
},
25372538
"publisher": {
@@ -2577,7 +2578,7 @@
25772578
"additionalProperties": false,
25782579
"examples": [
25792580
{
2580-
"value": 1.0,
2581+
"value": "Full",
25812582
"userProfileIds": [
25822583
"0d8e0c84-c0b4-4459-8b23-11ccff5ae319"
25832584
],
@@ -2601,8 +2602,16 @@
26012602
]
26022603
},
26032604
"breakoutId": {
2604-
"$ref": "#/components/schemas/NullableUuid",
2605-
"description": "Optional breakout identifier, may be null."
2605+
"type": [
2606+
"string",
2607+
"null"
2608+
],
2609+
"format": "uuid",
2610+
"description": "Optional breakout identifier, may be null.",
2611+
"examples": [
2612+
"fd9a6a53-594d-41aa-950a-b21ff41d4688",
2613+
null
2614+
]
26062615
},
26072616
"category": {
26082617
"type": "string",
@@ -3114,8 +3123,16 @@
31143123
]
31153124
},
31163125
"expiryDate": {
3117-
"$ref": "#/components/schemas/NullableDateTimeStringType",
3118-
"description": "Contract expiry date string."
3126+
"type": [
3127+
"string",
3128+
"null"
3129+
],
3130+
"format": "date-time",
3131+
"examples": [
3132+
"2026-01-01T00:00:00Z",
3133+
null
3134+
],
3135+
"description": "Contract expiry date as an ISO 8601 date-time string, or null."
31193136
}
31203137
},
31213138
"required": [
@@ -3194,8 +3211,16 @@
31943211
]
31953212
},
31963213
"replacementDate": {
3197-
"$ref": "#/components/schemas/NullableDateTimeStringType",
3198-
"description": "Planned replacement date string."
3214+
"type": [
3215+
"string",
3216+
"null"
3217+
],
3218+
"format": "date-time",
3219+
"examples": [
3220+
"2026-01-01T00:00:00Z",
3221+
null
3222+
],
3223+
"description": "Planned replacement date as an ISO 8601 date-time string, or null."
31993224
}
32003225
},
32013226
"required": [
@@ -3304,7 +3329,15 @@
33043329
]
33053330
},
33063331
"discoveryDate": {
3307-
"$ref": "#/components/schemas/NullableDateTimeStringType",
3332+
"type": [
3333+
"string",
3334+
"null"
3335+
],
3336+
"format": "date-time",
3337+
"examples": [
3338+
"2026-01-01T00:00:00Z",
3339+
null
3340+
],
33083341
"description": "Date the discovery occurred (string); Default: null."
33093342
},
33103343
"accountManager": {
@@ -3374,11 +3407,27 @@
33743407
]
33753408
},
33763409
"createdDate": {
3377-
"$ref": "#/components/schemas/NullableDateTimeStringType",
3410+
"type": [
3411+
"string",
3412+
"null"
3413+
],
3414+
"format": "date-time",
3415+
"examples": [
3416+
"2026-01-01T00:00:00Z",
3417+
null
3418+
],
33783419
"description": "ISO 8601 date-time string when created; Default: null."
33793420
},
33803421
"modifiedDate": {
3381-
"$ref": "#/components/schemas/NullableDateTimeStringType",
3422+
"type": [
3423+
"string",
3424+
"null"
3425+
],
3426+
"format": "date-time",
3427+
"examples": [
3428+
"2026-01-01T00:00:00Z",
3429+
null
3430+
],
33823431
"description": "ISO 8601 date-time string when last modified; Default: null."
33833432
},
33843433
"primaryPublisher": {
@@ -3904,8 +3953,15 @@
39043953
]
39053954
},
39063955
"breakoutId": {
3907-
"$ref": "#/components/schemas/NullableUuid",
3908-
"description": "Breakout identifier or null."
3956+
"type": [
3957+
"string",
3958+
"null"
3959+
],
3960+
"description": "Breakout identifier or null.",
3961+
"examples": [
3962+
"fd9a6a53-594d-41aa-950a-b21ff41d4688",
3963+
null
3964+
]
39093965
},
39103966
"breakoutName": {
39113967
"type": [

0 commit comments

Comments
 (0)