Skip to content

Commit 278a9e6

Browse files
authored
fix(specs): cleanup for composition API clients (#5119)
1 parent a9f804a commit 278a9e6

File tree

13 files changed

+33
-38
lines changed

13 files changed

+33
-38
lines changed

specs/composition-full/common/schemas/batchCompositionAction.yml renamed to specs/composition-full/common/schemas/BatchCompositionAction.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ deleteCompositionAction:
1010

1111
batchCompositionAction:
1212
oneOf:
13-
- $ref: './listCompositionsResponse.yml#/composition'
13+
- $ref: './Composition.yml#/composition'
1414
- $ref: '#/deleteCompositionAction'
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
composition:
2+
type: object
3+
additionalProperties: false
4+
properties:
5+
objectID:
6+
$ref: '../../../common/parameters.yml#/objectID'
7+
name:
8+
type: string
9+
description: Composition name.
10+
example: 'my lovely crafted composition'
11+
description:
12+
type: string
13+
description: Composition description.
14+
example: 'my lovely crafted composition that is used for X purpose'
15+
behavior:
16+
$ref: './CompositionBehavior.yml#/compositionBehavior'
17+
required:
18+
- objectID
19+
- behavior
20+
- name

specs/composition-full/common/schemas/compositionRule.yml renamed to specs/composition-full/common/schemas/CompositionRule.yml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ compositionRule:
1818
additionalProperties: false
1919
properties:
2020
behavior:
21-
$ref: './compositionBehavior.yml#/compositionBehavior'
21+
$ref: './CompositionBehavior.yml#/compositionBehavior'
2222
required:
2323
- behavior
2424
description:
@@ -54,10 +54,6 @@ condition:
5454
example: '{facet:genre}'
5555
anchoring:
5656
$ref: '#/anchoring'
57-
alternatives:
58-
type: boolean
59-
description: Whether the pattern should match plurals, synonyms, and typos.
60-
default: false
6157
context:
6258
$ref: '../../../common/schemas/Rule.yml#/context'
6359
filters:

specs/composition-full/common/schemas/listCompositionsResponse.yml renamed to specs/composition-full/common/schemas/ListCompositionsResponse.yml

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ listCompositionsResponse:
66
type: array
77
description: All compositions in your Algolia application.
88
items:
9-
$ref: '#/composition'
9+
$ref: './Composition.yml#/composition'
1010
nbPages:
1111
type: integer
1212
description: Number of pages.
@@ -29,24 +29,3 @@ listCompositionsResponse:
2929
- nbHits
3030
- nbPages
3131
- page
32-
33-
composition:
34-
type: object
35-
additionalProperties: false
36-
properties:
37-
objectID:
38-
$ref: '../../../common/parameters.yml#/objectID'
39-
name:
40-
type: string
41-
description: Composition name.
42-
example: 'my lovely crafted composition'
43-
description:
44-
type: string
45-
description: Composition description.
46-
example: 'my lovely crafted composition that is used for X purpose'
47-
behavior:
48-
$ref: './compositionBehavior.yml#/compositionBehavior'
49-
required:
50-
- objectID
51-
- behavior
52-
- name

specs/composition-full/common/schemas/rulesBatchCompositionAction.yml renamed to specs/composition-full/common/schemas/RulesBatchCompositionAction.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ deleteCompositionRuleAction:
1010

1111
rulesBatchCompositionAction:
1212
oneOf:
13-
- $ref: './compositionRule.yml#/compositionRule'
13+
- $ref: './CompositionRule.yml#/compositionRule'
1414
- $ref: '#/deleteCompositionRuleAction'

specs/composition-full/common/schemas/SearchParams.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ mainInjectionQueryParameters:
240240
type: array
241241
items:
242242
type: string
243-
example: [author, title, conten, content]
243+
example: [author, title, content]
244244
description: |
245245
Attributes to highlight.
246246
@@ -705,7 +705,7 @@ injectedItemsQueryParameters:
705705
type: array
706706
items:
707707
type: string
708-
example: [author, title, conten, content]
708+
example: [author, title, content]
709709
description: |
710710
Attributes to highlight.
711711

specs/composition-full/paths/manage_compositions/listCompositions.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ get:
1717
content:
1818
application/json:
1919
schema:
20-
$ref: '../../common/schemas/listCompositionsResponse.yml#/listCompositionsResponse'
20+
$ref: '../../common/schemas/ListCompositionsResponse.yml#/listCompositionsResponse'
2121
'400':
2222
$ref: '../../../common/responses/BadRequest.yml'
2323
'402':

specs/composition-full/paths/objects/multipleBatch.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ post:
2727
action:
2828
$ref: '../../common/schemas/Batch.yml#/action'
2929
body:
30-
$ref: '../../common/schemas/batchCompositionAction.yml#/batchCompositionAction'
30+
$ref: '../../common/schemas/BatchCompositionAction.yml#/batchCompositionAction'
3131
required:
3232
- action
3333
- body

specs/composition-full/paths/objects/objects.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ get:
1616
content:
1717
application/json:
1818
schema:
19-
$ref: '../../common/schemas/listCompositionsResponse.yml#/composition'
19+
$ref: '../../common/schemas/Composition.yml#/composition'
2020
'400':
2121
$ref: '../../../common/responses/BadRequest.yml'
2222
'402':

0 commit comments

Comments
 (0)