Skip to content

fix(specs): rename composition run endpoint [skip-bc] #4099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Nov 14, 2024
Merged

fix(specs): rename composition run endpoint [skip-bc] #4099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
8d227e4
fix: run endpoint
e-krebs Nov 13, 2024
4e6de2a
fix: tests
shortcuts Nov 13, 2024
569735e
trigger
shortcuts Nov 13, 2024
92ea7c6
fix: param name
shortcuts Nov 13, 2024
985a40b
fix: use params from composition specs and remove 1 level
shortcuts Nov 13, 2024
eed7745
fix: 1up
shortcuts Nov 13, 2024
78c7233
chore: rename searchCompositionParams to body
e-krebs Nov 13, 2024
80afc3d
chore: rename to request
e-krebs Nov 14, 2024
b4da8a1
fix: test parameter
shortcuts Nov 14, 2024
d175b41
fix
e-krebs Nov 14, 2024
531cc62
Merge branch 'main' into fix/composition-alpha-2
shortcuts Nov 14, 2024
ee5d5aa
fix: everything conflicts
shortcuts Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion specs/composition/common/schemas/SearchParams.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
searchParams:
params:
title: Composition Search parameters as object
type: object
additionalProperties: false
Expand Down
10 changes: 8 additions & 2 deletions specs/composition/paths/search/run.yml → specs/composition/paths/search/search.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
post:
tags:
- Search
operationId: runSingleComposition
operationId: search
x-use-read-transporter: true
x-cacheable: true
x-acl:
Expand All @@ -11,10 +11,16 @@ post:
parameters:
- $ref: '../../common/parameters.yml#/compositionID'
requestBody:
required: true
content:
application/json:
schema:
$ref: '../../../common/schemas/SearchParams.yml#/searchParams'
title: requestBody
type: object
additionalProperties: false
properties:
params:
$ref: '../../common/schemas/SearchParams.yml#/params'
responses:
'200':
description: OK
Expand Down
2 changes: 1 addition & 1 deletion specs/composition/paths/search/searchForFacetValues.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ post:
maxFacetHits:
$ref: '../../../common/schemas/IndexSettings.yml#/maxFacetHits'
searchQuery:
$ref: '../../common/schemas/SearchParams.yml#/searchParams'
$ref: '../../common/schemas/SearchParams.yml#/params'
responses:
'200':
description: OK
Expand Down
2 changes: 1 addition & 1 deletion specs/composition/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ paths:
# ### Search Endpoints ###
# ########################
/1/compositions/{compositionID}/run:
$ref: 'paths/search/run.yml'
$ref: 'paths/search/search.yml'
/1/compositions/{compositionID}/facets/{facetName}/query:
$ref: 'paths/search/searchForFacetValues.yml'

Expand Down
6 changes: 3 additions & 3 deletions ...sts/composition/runSingleComposition.json → tests/CTS/requests/composition/search.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
{
"parameters": {
"compositionID": "foo",
"searchParams": {
"query": "batman"
"requestBody": {
"params": { "query": "batman" }
}
},
"request": {
"path": "/1/compositions/foo/run",
"method": "POST",
"body": {
"query": "batman"
"params": { "query": "batman" }
}
}
}
Expand Down
Loading