Skip to content

Commit ee5542a

Browse files
gazconroyGary Conroymillotp
authored
fix(specs): Add title values to key oneOfs (#5581)
Co-authored-by: Gary Conroy <gary.conroy@LON-M3P-GConroy.local> Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
1 parent 939337c commit ee5542a

File tree

8 files changed

+24
-11
lines changed

8 files changed

+24
-11
lines changed

specs/abtesting-v3/common/schemas/AddABTestsVariant.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
AddABTestsVariant:
22
oneOf:
3-
- $ref: '#/abTestsVariant'
4-
- $ref: '#/abTestsVariantSearchParams'
5-
3+
- title: Variant
4+
$ref: '#/abTestsVariant'
5+
- title: Variant with search parameters
6+
$ref: '#/abTestsVariantSearchParams'
67
abTestsVariantSearchParams:
78
allOf:
89
- $ref: '#/abTestsVariant'

specs/abtesting/common/schemas/AddABTestsVariant.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
AddABTestsVariant:
22
oneOf:
3-
- $ref: '#/abTestsVariant'
4-
- $ref: '#/abTestsVariantSearchParams'
3+
- title: Variant
4+
$ref: '#/abTestsVariant'
5+
- title: Variant with search parameters
6+
$ref: '#/abTestsVariantSearchParams'
57

68
abTestsVariantSearchParams:
79
allOf:

specs/composition/common/schemas/requestBodies/BatchCompositionAction.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,7 @@ deleteCompositionAction:
1010

1111
batchCompositionAction:
1212
oneOf:
13-
- $ref: '../components/Composition.yml#/composition'
14-
- $ref: '#/deleteCompositionAction'
13+
- title: Upsert (update and insert)
14+
$ref: '../components/Composition.yml#/composition'
15+
- title: Delete
16+
$ref: '#/deleteCompositionAction'

specs/composition/common/schemas/requestBodies/RulesBatchCompositionAction.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,7 @@ deleteCompositionRuleAction:
1010

1111
rulesBatchCompositionAction:
1212
oneOf:
13-
- $ref: '../components/CompositionRule.yml#/compositionRule'
14-
- $ref: '#/deleteCompositionRuleAction'
13+
- title: Upsert (update and insert)
14+
$ref: '../components/CompositionRule.yml#/compositionRule'
15+
- title: Delete
16+
$ref: '#/deleteCompositionRuleAction'

specs/composition/paths/compositions/composition.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ put:
3232
operationId: putComposition
3333
x-acl:
3434
- editSettings
35-
summary: Upsert a composition
35+
summary: Update and insert (upsert) a composition
3636
description: |
37-
Upsert a composition in the current Algolia application.
37+
Update and insert a composition in the current Algolia application.
3838
parameters:
3939
- $ref: '../urlParams.yml#/compositionID'
4040
requestBody:

specs/ingestion/common/schemas/task.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,7 @@ MappingInput:
509509
- actions
510510

511511
StreamingInput:
512+
title: Streaming input
512513
type: object
513514
additionalProperties: false
514515
description: Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
@@ -521,6 +522,7 @@ StreamingInput:
521522
- mapping
522523

523524
DockerStreamsInput:
525+
title: Docker streams
524526
description: The selected streams of an airbyte connector.
525527
type: object
526528
properties:
@@ -562,6 +564,7 @@ failureThreshold:
562564
description: Maximum accepted percentage of failures for a task run to finish successfully.
563565

564566
ShopifyInput:
567+
title: Shopify input
565568
type: object
566569
additionalProperties: false
567570
description: Represents the required elements of the task input when using a `shopify` source.

specs/ingestion/common/schemas/transformation.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ TransformationInput:
4343
- $ref: '#/TransformationNoCode'
4444

4545
TransformationCode:
46+
title: Code
4647
type: object
4748
additionalProperties: false
4849
description: Input for a transformation that contains the source code of the transformation.
@@ -54,6 +55,7 @@ TransformationCode:
5455
- code
5556

5657
TransformationNoCode:
58+
title: No-code
5759
type: object
5860
additionalProperties: false
5961
description: Input for a no-code transformation that contains a series of steps.

specs/recommend/common/schemas/RecommendationsResponse.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ recommendHit:
4545

4646
trendingFacetHit:
4747
type: object
48+
title: Trending facet hit
4849
description: Trending facet hit.
4950
required:
5051
- facetName

0 commit comments

Comments
 (0)