Skip to content

Commit 0221318

Browse files
millotpshortcuts
andauthored
fix(specs): correct query params for ingestion [skip-bc] (#3830)
Co-authored-by: shortcuts <[email protected]>
1 parent a480893 commit 0221318

File tree

8 files changed

+34
-24
lines changed

8 files changed

+34
-24
lines changed

clients/algoliasearch-client-javascript/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
"packages/*"
77
],
88
"scripts": {
9-
"build:all": "lerna run build --skip-nx-cache --include-dependencies",
10-
"build:many": "lerna run build --skip-nx-cache --include-dependencies --scope ${0:-'{@algolia/*,algoliasearch}'}",
11-
"clean": "lerna run clean --include-dependencies",
9+
"build:all": "lerna run build --include-dependencies",
10+
"build:many": "lerna run build --scope '@algolia/requester-testing' --scope ${0:-'{@algolia/*,algoliasearch}'} --include-dependencies",
11+
"clean": "lerna run clean",
1212
"release:bump": "lerna version ${0:-patch} --no-changelog --no-git-tag-version --no-push --exact --force-publish --yes",
1313
"release:publish": "tsc --project scripts/tsconfig.json && node scripts/dist/scripts/publish.js",
1414
"test": "lerna run test $*",
1515
"test:size": "bundlesize",
16-
"test:bundle": "lerna run test:bundle --verbose --skip-nx-cache --include-dependencies"
16+
"test:bundle": "lerna run test:bundle --verbose --include-dependencies"
1717
},
1818
"devDependencies": {
1919
"@types/node": "22.5.5",

specs/ingestion/common/authenticationParameters.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ type:
1414
platform:
1515
name: platform
1616
in: query
17-
description: Ecommerce platform for which to retrieve authentication resources.
17+
description: Ecommerce platform for which to retrieve authentications.
1818
required: false
1919
style: form
2020
explode: false
@@ -37,13 +37,13 @@ platformWithNone:
3737
sort:
3838
name: sort
3939
in: query
40-
description: Property by which to sort the list of authentication resources.
40+
description: Property by which to sort the list of authentications.
4141
required: false
4242
schema:
4343
$ref: '#/authenticationSortKeys'
4444

4545
authenticationSortKeys:
4646
type: string
47-
description: Property by which to sort the list of authentication resources.
47+
description: Property by which to sort the list of authentications.
4848
default: createdAt
49-
enum: [name, auth_type, platform, updatedAt, createdAt]
49+
enum: [name, type, platform, updatedAt, createdAt]

specs/ingestion/common/destinationParameters.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@ authenticationID:
2323
items:
2424
$ref: './schemas/common.yml#/authenticationID'
2525

26+
transformationID:
27+
name: transformationID
28+
in: query
29+
description: Get the list of destinations used by a transformation.
30+
required: false
31+
style: form
32+
explode: false
33+
schema:
34+
$ref: './schemas/common.yml#/transformationID'
35+
2636
sort:
2737
name: sort
2838
in: query

specs/ingestion/common/parameters.yml

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -83,17 +83,3 @@ orderKeys:
8383
description: Ascending or descending sort order.
8484
default: desc
8585
enum: [asc, desc]
86-
87-
sort:
88-
name: sort
89-
in: query
90-
description: Property by which to sort the list.
91-
required: false
92-
schema:
93-
$ref: '#/sortKeys'
94-
95-
sortKeys:
96-
type: string
97-
description: Property by which to sort the list.
98-
default: desc
99-
enum: [name, type, updatedAt, createdAt]

specs/ingestion/common/sourceParameters.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ authenticationID:
1616
in: query
1717
description: |
1818
Authentication IDs of the sources to retrieve.
19-
'none' returns sources that doesn't have an authentication resource.
19+
'none' returns sources that doesn't have an authentication.
2020
required: false
2121
style: form
2222
explode: false
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
sort:
2+
name: sort
3+
in: query
4+
description: Property by which to sort the list of transformations.
5+
required: false
6+
schema:
7+
$ref: '#/transformationSortKeys'
8+
9+
transformationSortKeys:
10+
type: string
11+
description: Property by which to sort the list of transformations.
12+
default: createdAt
13+
enum: [name, updatedAt, createdAt]

specs/ingestion/paths/destinations/destinations.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ get:
1313
- $ref: '../../common/parameters.yml#/page'
1414
- $ref: '../../common/destinationParameters.yml#/type'
1515
- $ref: '../../common/destinationParameters.yml#/authenticationID'
16+
- $ref: '../../common/destinationParameters.yml#/transformationID'
1617
- $ref: '../../common/destinationParameters.yml#/sort'
1718
- $ref: '../../common/parameters.yml#/order'
1819
responses:

specs/ingestion/paths/transformations/transformations.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ get:
1111
parameters:
1212
- $ref: '../../common/parameters.yml#/itemsPerPage'
1313
- $ref: '../../common/parameters.yml#/page'
14-
- $ref: '../../common/parameters.yml#/sort'
14+
- $ref: '../../common/transformationParameters.yml#/sort'
1515
- $ref: '../../common/parameters.yml#/order'
1616
responses:
1717
'200':

0 commit comments

Comments
 (0)