Skip to content

Commit dd18afe

Browse files
e-krebsshortcuts
andauthoredNov 14, 2024··
fix(specs): rename composition run endpoint [skip-bc] (#4099)
Co-authored-by: shortcuts <vannicattec@gmail.com>
1 parent 12c6244 commit dd18afe

File tree

5 files changed

+14
-8
lines changed

5 files changed

+14
-8
lines changed
 

‎specs/composition/common/schemas/SearchParams.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
searchParams:
1+
params:
22
title: Composition Search parameters as object
33
type: object
44
additionalProperties: false

‎specs/composition/paths/search/run.yml ‎specs/composition/paths/search/search.yml

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
post:
22
tags:
33
- Search
4-
operationId: runSingleComposition
4+
operationId: search
55
x-use-read-transporter: true
66
x-cacheable: true
77
x-acl:
@@ -11,10 +11,16 @@ post:
1111
parameters:
1212
- $ref: '../../common/parameters.yml#/compositionID'
1313
requestBody:
14+
required: true
1415
content:
1516
application/json:
1617
schema:
17-
$ref: '../../../common/schemas/SearchParams.yml#/searchParams'
18+
title: requestBody
19+
type: object
20+
additionalProperties: false
21+
properties:
22+
params:
23+
$ref: '../../common/schemas/SearchParams.yml#/params'
1824
responses:
1925
'200':
2026
description: OK

‎specs/composition/paths/search/searchForFacetValues.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ post:
4141
maxFacetHits:
4242
$ref: '../../../common/schemas/IndexSettings.yml#/maxFacetHits'
4343
searchQuery:
44-
$ref: '../../common/schemas/SearchParams.yml#/searchParams'
44+
$ref: '../../common/schemas/SearchParams.yml#/params'
4545
responses:
4646
'200':
4747
description: OK

‎specs/composition/spec.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ paths:
5757
# ### Search Endpoints ###
5858
# ########################
5959
/1/compositions/{compositionID}/run:
60-
$ref: 'paths/search/run.yml'
60+
$ref: 'paths/search/search.yml'
6161
/1/compositions/{compositionID}/facets/{facetName}/query:
6262
$ref: 'paths/search/searchForFacetValues.yml'
6363

‎tests/CTS/requests/composition/runSingleComposition.json ‎tests/CTS/requests/composition/search.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
{
33
"parameters": {
44
"compositionID": "foo",
5-
"searchParams": {
6-
"query": "batman"
5+
"requestBody": {
6+
"params": { "query": "batman" }
77
}
88
},
99
"request": {
1010
"path": "/1/compositions/foo/run",
1111
"method": "POST",
1212
"body": {
13-
"query": "batman"
13+
"params": { "query": "batman" }
1414
}
1515
}
1616
}

0 commit comments

Comments
 (0)
Please sign in to comment.