Skip to content

Commit 21bd8d5

Browse files
committed
refactor(specs): create composition-full/schemas/responses directory
1 parent ba2e18b commit 21bd8d5

File tree

10 files changed

+23
-23
lines changed

10 files changed

+23
-23
lines changed

specs/composition-full/common/schemas/GetTaskResponse.yml renamed to specs/composition-full/common/schemas/responses/GetTaskResponse.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ type: object
33
additionalProperties: false
44
properties:
55
status:
6-
$ref: '../../../common/responses/common.yml#/taskStatus'
6+
$ref: '../../../../common/responses/common.yml#/taskStatus'
77
required:
88
- status

specs/composition-full/common/schemas/Hit.yml renamed to specs/composition-full/common/schemas/responses/Hit.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ hit:
1010
- objectID
1111
properties:
1212
objectID:
13-
$ref: '../../../common/parameters.yml#/objectID'
13+
$ref: '../../../../common/parameters.yml#/objectID'
1414
_highlightResult:
15-
$ref: '../../../common/schemas/HighlightResult.yml#/highlightResultMap'
15+
$ref: '../../../../common/schemas/HighlightResult.yml#/highlightResultMap'
1616
_snippetResult:
17-
$ref: '../../../common/schemas/SnippetResult.yml#/snippetResultMap'
17+
$ref: '../../../../common/schemas/SnippetResult.yml#/snippetResultMap'
1818
_rankingInfo:
1919
$ref: '#/rankingInfo'
2020
_distinctSeqID:
21-
$ref: '../../../common/schemas/Hit.yml#/distinctSeqID'
21+
$ref: '../../../../common/schemas/Hit.yml#/distinctSeqID'
2222

2323
rankingInfo:
2424
allOf:
25-
- $ref: '../../../common/schemas/Hit.yml#/rankingInfo'
25+
- $ref: '../../../../common/schemas/Hit.yml#/rankingInfo'
2626
- $ref: '#/compositionRankingInfo'
2727

2828
compositionRankingInfo:

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

Lines changed: 1 addition & 1 deletion
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: './components/Composition.yml#/composition'
9+
$ref: '../components/Composition.yml#/composition'
1010
nbPages:
1111
type: integer
1212
description: Number of pages.

specs/composition-full/common/schemas/SearchForFacetValuesResponse.yml renamed to specs/composition-full/common/schemas/responses/SearchForFacetValuesResponse.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ searchForFacetValuesResults:
3737
example: 'Mobile phone'
3838
type: string
3939
highlighted:
40-
$ref: '../../../common/schemas/HighlightResult.yml#/highlightedValue'
40+
$ref: '../../../../common/schemas/HighlightResult.yml#/highlightedValue'
4141
count:
4242
description: Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
4343
type: integer
@@ -47,4 +47,4 @@ searchForFacetValuesResults:
4747
Whether the facet count is exhaustive (true) or approximate (false).
4848
For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
4949
processingTimeMS:
50-
$ref: '../../../common/schemas/SearchResponse.yml#/processingTimeMS'
50+
$ref: '../../../../common/schemas/SearchResponse.yml#/processingTimeMS'

specs/composition-full/common/schemas/SearchResponse.yml renamed to specs/composition-full/common/schemas/responses/SearchResponse.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ searchResults:
1818

1919
searchResultsItem:
2020
allOf:
21-
- $ref: '../../../common/schemas/SearchResponse.yml#/baseSearchResponse'
21+
- $ref: '../../../../common/schemas/SearchResponse.yml#/baseSearchResponse'
2222
- $ref: '#/SearchPagination'
2323
- $ref: '#/searchHits'
2424
- $ref: '#/resultsCompositionsResponse'
@@ -28,13 +28,13 @@ SearchPagination:
2828
additionalProperties: false
2929
properties:
3030
page:
31-
$ref: '../../../common/schemas/SearchParams.yml#/page'
31+
$ref: '../../../../common/schemas/SearchParams.yml#/page'
3232
nbHits:
33-
$ref: '../../../common/schemas/SearchResponse.yml#/nbHits'
33+
$ref: '../../../../common/schemas/SearchResponse.yml#/nbHits'
3434
nbPages:
35-
$ref: '../../../common/schemas/SearchResponse.yml#/nbPages'
35+
$ref: '../../../../common/schemas/SearchResponse.yml#/nbPages'
3636
hitsPerPage:
37-
$ref: '../../../common/schemas/IndexSettings.yml#/hitsPerPage'
37+
$ref: '../../../../common/schemas/IndexSettings.yml#/hitsPerPage'
3838
required:
3939
- page
4040
- nbHits
@@ -54,7 +54,7 @@ searchHits:
5454
items:
5555
$ref: 'Hit.yml#/hit'
5656
query:
57-
$ref: '../../../common/schemas/SearchParams.yml#/query'
57+
$ref: '../../../../common/schemas/SearchParams.yml#/query'
5858
params:
5959
type: string
6060
description: URL-encoded string of all search parameters.
@@ -98,7 +98,7 @@ resultsInjectedItemInfoResponse:
9898
type: object
9999
properties:
100100
objectID:
101-
$ref: '../../../common/parameters.yml#/objectID'
101+
$ref: '../../../../common/parameters.yml#/objectID'
102102
required:
103103
- objectID
104104
required:
@@ -130,15 +130,15 @@ compositionRunSearchResponse:
130130
additionalProperties: true
131131
properties:
132132
objectID:
133-
$ref: '../../../common/parameters.yml#/objectID'
133+
$ref: '../../../../common/parameters.yml#/objectID'
134134
appliedRules:
135135
type: array
136136
items:
137137
title: compositionRunAppliedRules
138138
type: object
139139
properties:
140140
objectID:
141-
$ref: '../../../common/parameters.yml#/objectID'
141+
$ref: '../../../../common/parameters.yml#/objectID'
142142
required:
143143
- objectID
144144
required:

specs/composition-full/helpers/waitForCompositionTask.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ method:
2929
content:
3030
application/json:
3131
schema:
32-
$ref: '../common/schemas/GetTaskResponse.yml'
32+
$ref: '../common/schemas/responses/GetTaskResponse.yml'
3333
'400':
3434
$ref: '../../common/responses/CompositionNotFound.yml'

specs/composition-full/paths/advanced/getTask.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ get:
2727
content:
2828
application/json:
2929
schema:
30-
$ref: '../../common/schemas/GetTaskResponse.yml'
30+
$ref: '../../common/schemas/responses/GetTaskResponse.yml'
3131
'400':
3232
$ref: '../../../common/responses/BadRequest.yml'
3333
'402':

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/responses/ListCompositionsResponse.yml#/listCompositionsResponse'
2121
'400':
2222
$ref: '../../../common/responses/BadRequest.yml'
2323
'402':

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ post:
2727
content:
2828
application/json:
2929
schema:
30-
$ref: '../../common/schemas/SearchResponse.yml#/searchResponse'
30+
$ref: '../../common/schemas/responses/SearchResponse.yml#/searchResponse'
3131
'400':
3232
$ref: '../../../common/responses/BadRequest.yml'
3333
'402':

specs/composition-full/paths/search/searchForFacetValues.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ post:
4848
content:
4949
application/json:
5050
schema:
51-
$ref: '../../common/schemas/SearchForFacetValuesResponse.yml#/searchForFacetValuesResponse'
51+
$ref: '../../common/schemas/responses/SearchForFacetValuesResponse.yml#/searchForFacetValuesResponse'
5252
'400':
5353
$ref: '../../../common/responses/BadRequest.yml'
5454
'402':

0 commit comments

Comments
 (0)