Skip to content

Commit 39579f8

Browse files
elasticmachineelasticmachine
authored
Auto-generated API code (#3067)
1 parent 5c2972d commit 39579f8

File tree

9 files changed

+869
-188
lines changed

9 files changed

+869
-188
lines changed

‎docs/reference/api-reference.md‎

Lines changed: 259 additions & 25 deletions
Large diffs are not rendered by default.

‎src/api/api/capabilities.ts‎

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,25 @@ const acceptedParams: Record<string, { path: string[], body: string[], query: st
3030
capabilities: {
3131
path: [],
3232
body: [],
33-
query: []
33+
query: [
34+
'method',
35+
'path',
36+
'parameters',
37+
'capabilities',
38+
'local_only',
39+
'timeout'
40+
]
3441
}
3542
}
3643

3744
/**
38-
* Checks if the specified combination of method, API, parameters, and arbitrary capabilities are supported
45+
* Checks if the specified combination of method, API, parameters, and arbitrary capabilities are supported.
3946
* @see {@link https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/README.asciidoc#require-or-skip-api-capabilities | Elasticsearch API documentation}
4047
*/
41-
export default async function CapabilitiesApi (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
42-
export default async function CapabilitiesApi (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
43-
export default async function CapabilitiesApi (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>
44-
export default async function CapabilitiesApi (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<any> {
48+
export default async function CapabilitiesApi (this: That, params?: T.CapabilitiesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CapabilitiesResponse>
49+
export default async function CapabilitiesApi (this: That, params?: T.CapabilitiesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CapabilitiesResponse, unknown>>
50+
export default async function CapabilitiesApi (this: That, params?: T.CapabilitiesRequest, options?: TransportRequestOptions): Promise<T.CapabilitiesResponse>
51+
export default async function CapabilitiesApi (this: That, params?: T.CapabilitiesRequest, options?: TransportRequestOptions): Promise<any> {
4552
const {
4653
path: acceptedPath
4754
} = acceptedParams.capabilities
@@ -64,6 +71,7 @@ export default async function CapabilitiesApi (this: That, params?: T.TODO, opti
6471
if (acceptedPath.includes(key)) {
6572
continue
6673
} else if (key !== 'body' && key !== 'querystring') {
74+
// @ts-expect-error
6775
querystring[key] = params[key]
6876
}
6977
}
@@ -73,6 +81,12 @@ export default async function CapabilitiesApi (this: That, params?: T.TODO, opti
7381
const meta: TransportRequestMetadata = {
7482
name: 'capabilities',
7583
acceptedParams: [
84+
'method',
85+
'path',
86+
'parameters',
87+
'capabilities',
88+
'local_only',
89+
'timeout'
7690
]
7791
}
7892
return await this.transport.request({ path, method, querystring, body, meta }, options)

‎src/api/api/connector.ts‎

Lines changed: 63 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -137,14 +137,18 @@ export default class Connector {
137137
},
138138
'connector.secret_post': {
139139
path: [],
140-
body: [],
140+
body: [
141+
'value'
142+
],
141143
query: []
142144
},
143145
'connector.secret_put': {
144146
path: [
145147
'id'
146148
],
147-
body: [],
149+
body: [
150+
'value'
151+
],
148152
query: []
149153
},
150154
'connector.sync_job_cancel': {
@@ -769,12 +773,12 @@ export default class Connector {
769773
}
770774

771775
/**
772-
* Deletes a connector secret
776+
* Deletes a connector secret.
773777
*/
774-
async secretDelete (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
775-
async secretDelete (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
776-
async secretDelete (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>
777-
async secretDelete (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<any> {
778+
async secretDelete (this: That, params: T.ConnectorSecretDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSecretDeleteResponse>
779+
async secretDelete (this: That, params: T.ConnectorSecretDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSecretDeleteResponse, unknown>>
780+
async secretDelete (this: That, params: T.ConnectorSecretDeleteRequest, options?: TransportRequestOptions): Promise<T.ConnectorSecretDeleteResponse>
781+
async secretDelete (this: That, params: T.ConnectorSecretDeleteRequest, options?: TransportRequestOptions): Promise<any> {
778782
const {
779783
path: acceptedPath
780784
} = this[kAcceptedParams]['connector.secret_delete']
@@ -792,11 +796,11 @@ export default class Connector {
792796
}
793797
}
794798

795-
params = params ?? {}
796799
for (const key in params) {
797800
if (acceptedPath.includes(key)) {
798801
continue
799802
} else if (key !== 'body' && key !== 'querystring') {
803+
// @ts-expect-error
800804
querystring[key] = params[key]
801805
}
802806
}
@@ -816,12 +820,12 @@ export default class Connector {
816820
}
817821

818822
/**
819-
* Retrieves a secret stored by Connectors
823+
* Retrieves a secret stored by Connectors.
820824
*/
821-
async secretGet (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
822-
async secretGet (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
823-
async secretGet (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>
824-
async secretGet (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<any> {
825+
async secretGet (this: That, params: T.ConnectorSecretGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSecretGetResponse>
826+
async secretGet (this: That, params: T.ConnectorSecretGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSecretGetResponse, unknown>>
827+
async secretGet (this: That, params: T.ConnectorSecretGetRequest, options?: TransportRequestOptions): Promise<T.ConnectorSecretGetResponse>
828+
async secretGet (this: That, params: T.ConnectorSecretGetRequest, options?: TransportRequestOptions): Promise<any> {
825829
const {
826830
path: acceptedPath
827831
} = this[kAcceptedParams]['connector.secret_get']
@@ -839,11 +843,11 @@ export default class Connector {
839843
}
840844
}
841845

842-
params = params ?? {}
843846
for (const key in params) {
844847
if (acceptedPath.includes(key)) {
845848
continue
846849
} else if (key !== 'body' && key !== 'querystring') {
850+
// @ts-expect-error
847851
querystring[key] = params[key]
848852
}
849853
}
@@ -863,14 +867,16 @@ export default class Connector {
863867
}
864868

865869
/**
866-
* Creates a secret for a Connector
870+
* Creates a secret for a Connector.
867871
*/
868-
async secretPost (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
869-
async secretPost (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
870-
async secretPost (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>
871-
async secretPost (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<any> {
872+
async secretPost (this: That, params?: T.ConnectorSecretPostRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSecretPostResponse>
873+
async secretPost (this: That, params?: T.ConnectorSecretPostRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSecretPostResponse, unknown>>
874+
async secretPost (this: That, params?: T.ConnectorSecretPostRequest, options?: TransportRequestOptions): Promise<T.ConnectorSecretPostResponse>
875+
async secretPost (this: That, params?: T.ConnectorSecretPostRequest, options?: TransportRequestOptions): Promise<any> {
872876
const {
873-
path: acceptedPath
877+
path: acceptedPath,
878+
body: acceptedBody,
879+
query: acceptedQuery
874880
} = this[kAcceptedParams]['connector.secret_post']
875881

876882
const userQuery = params?.querystring
@@ -888,10 +894,21 @@ export default class Connector {
888894

889895
params = params ?? {}
890896
for (const key in params) {
891-
if (acceptedPath.includes(key)) {
897+
if (acceptedBody.includes(key)) {
898+
body = body ?? {}
899+
// @ts-expect-error
900+
body[key] = params[key]
901+
} else if (acceptedPath.includes(key)) {
892902
continue
893903
} else if (key !== 'body' && key !== 'querystring') {
894-
querystring[key] = params[key]
904+
if (acceptedQuery.includes(key) || commonQueryParams.includes(key)) {
905+
// @ts-expect-error
906+
querystring[key] = params[key]
907+
} else {
908+
body = body ?? {}
909+
// @ts-expect-error
910+
body[key] = params[key]
911+
}
895912
}
896913
}
897914

@@ -900,20 +917,23 @@ export default class Connector {
900917
const meta: TransportRequestMetadata = {
901918
name: 'connector.secret_post',
902919
acceptedParams: [
920+
'value'
903921
]
904922
}
905923
return await this.transport.request({ path, method, querystring, body, meta }, options)
906924
}
907925

908926
/**
909-
* Creates or updates a secret for a Connector
927+
* Creates or updates a secret for a Connector.
910928
*/
911-
async secretPut (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
912-
async secretPut (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
913-
async secretPut (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>
914-
async secretPut (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<any> {
929+
async secretPut (this: That, params: T.ConnectorSecretPutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSecretPutResponse>
930+
async secretPut (this: That, params: T.ConnectorSecretPutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSecretPutResponse, unknown>>
931+
async secretPut (this: That, params: T.ConnectorSecretPutRequest, options?: TransportRequestOptions): Promise<T.ConnectorSecretPutResponse>
932+
async secretPut (this: That, params: T.ConnectorSecretPutRequest, options?: TransportRequestOptions): Promise<any> {
915933
const {
916-
path: acceptedPath
934+
path: acceptedPath,
935+
body: acceptedBody,
936+
query: acceptedQuery
917937
} = this[kAcceptedParams]['connector.secret_put']
918938

919939
const userQuery = params?.querystring
@@ -929,12 +949,22 @@ export default class Connector {
929949
}
930950
}
931951

932-
params = params ?? {}
933952
for (const key in params) {
934-
if (acceptedPath.includes(key)) {
953+
if (acceptedBody.includes(key)) {
954+
body = body ?? {}
955+
// @ts-expect-error
956+
body[key] = params[key]
957+
} else if (acceptedPath.includes(key)) {
935958
continue
936959
} else if (key !== 'body' && key !== 'querystring') {
937-
querystring[key] = params[key]
960+
if (acceptedQuery.includes(key) || commonQueryParams.includes(key)) {
961+
// @ts-expect-error
962+
querystring[key] = params[key]
963+
} else {
964+
body = body ?? {}
965+
// @ts-expect-error
966+
body[key] = params[key]
967+
}
938968
}
939969
}
940970

@@ -946,7 +976,8 @@ export default class Connector {
946976
id: params.id
947977
},
948978
acceptedParams: [
949-
'id'
979+
'id',
980+
'value'
950981
]
951982
}
952983
return await this.transport.request({ path, method, querystring, body, meta }, options)

‎src/api/api/fleet.ts‎

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,9 @@ export default class Fleet {
8787
},
8888
'fleet.post_secret': {
8989
path: [],
90-
body: [],
90+
body: [
91+
'value'
92+
],
9193
query: []
9294
},
9395
'fleet.search': {
@@ -178,12 +180,12 @@ export default class Fleet {
178180
}
179181

180182
/**
181-
* Deletes a secret stored by Fleet
183+
* Deletes a secret stored by Fleet.
182184
*/
183-
async deleteSecret (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
184-
async deleteSecret (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
185-
async deleteSecret (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>
186-
async deleteSecret (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<any> {
185+
async deleteSecret (this: That, params: T.FleetDeleteSecretRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.FleetDeleteSecretResponse>
186+
async deleteSecret (this: That, params: T.FleetDeleteSecretRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.FleetDeleteSecretResponse, unknown>>
187+
async deleteSecret (this: That, params: T.FleetDeleteSecretRequest, options?: TransportRequestOptions): Promise<T.FleetDeleteSecretResponse>
188+
async deleteSecret (this: That, params: T.FleetDeleteSecretRequest, options?: TransportRequestOptions): Promise<any> {
187189
const {
188190
path: acceptedPath
189191
} = this[kAcceptedParams]['fleet.delete_secret']
@@ -201,11 +203,11 @@ export default class Fleet {
201203
}
202204
}
203205

204-
params = params ?? {}
205206
for (const key in params) {
206207
if (acceptedPath.includes(key)) {
207208
continue
208209
} else if (key !== 'body' && key !== 'querystring') {
210+
// @ts-expect-error
209211
querystring[key] = params[key]
210212
}
211213
}
@@ -225,12 +227,12 @@ export default class Fleet {
225227
}
226228

227229
/**
228-
* Retrieves a secret stored by Fleet
230+
* Retrieves a secret stored by Fleet.
229231
*/
230-
async getSecret (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
231-
async getSecret (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
232-
async getSecret (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>
233-
async getSecret (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<any> {
232+
async getSecret (this: That, params: T.FleetGetSecretRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.FleetGetSecretResponse>
233+
async getSecret (this: That, params: T.FleetGetSecretRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.FleetGetSecretResponse, unknown>>
234+
async getSecret (this: That, params: T.FleetGetSecretRequest, options?: TransportRequestOptions): Promise<T.FleetGetSecretResponse>
235+
async getSecret (this: That, params: T.FleetGetSecretRequest, options?: TransportRequestOptions): Promise<any> {
234236
const {
235237
path: acceptedPath
236238
} = this[kAcceptedParams]['fleet.get_secret']
@@ -248,11 +250,11 @@ export default class Fleet {
248250
}
249251
}
250252

251-
params = params ?? {}
252253
for (const key in params) {
253254
if (acceptedPath.includes(key)) {
254255
continue
255256
} else if (key !== 'body' && key !== 'querystring') {
257+
// @ts-expect-error
256258
querystring[key] = params[key]
257259
}
258260
}
@@ -395,14 +397,16 @@ export default class Fleet {
395397
}
396398

397399
/**
398-
* Creates a secret stored by Fleet
400+
* Creates a secret stored by Fleet.
399401
*/
400-
async postSecret (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
401-
async postSecret (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
402-
async postSecret (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>
403-
async postSecret (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<any> {
402+
async postSecret (this: That, params: T.FleetPostSecretRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.FleetPostSecretResponse>
403+
async postSecret (this: That, params: T.FleetPostSecretRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.FleetPostSecretResponse, unknown>>
404+
async postSecret (this: That, params: T.FleetPostSecretRequest, options?: TransportRequestOptions): Promise<T.FleetPostSecretResponse>
405+
async postSecret (this: That, params: T.FleetPostSecretRequest, options?: TransportRequestOptions): Promise<any> {
404406
const {
405-
path: acceptedPath
407+
path: acceptedPath,
408+
body: acceptedBody,
409+
query: acceptedQuery
406410
} = this[kAcceptedParams]['fleet.post_secret']
407411

408412
const userQuery = params?.querystring
@@ -418,12 +422,22 @@ export default class Fleet {
418422
}
419423
}
420424

421-
params = params ?? {}
422425
for (const key in params) {
423-
if (acceptedPath.includes(key)) {
426+
if (acceptedBody.includes(key)) {
427+
body = body ?? {}
428+
// @ts-expect-error
429+
body[key] = params[key]
430+
} else if (acceptedPath.includes(key)) {
424431
continue
425432
} else if (key !== 'body' && key !== 'querystring') {
426-
querystring[key] = params[key]
433+
if (acceptedQuery.includes(key) || commonQueryParams.includes(key)) {
434+
// @ts-expect-error
435+
querystring[key] = params[key]
436+
} else {
437+
body = body ?? {}
438+
// @ts-expect-error
439+
body[key] = params[key]
440+
}
427441
}
428442
}
429443

@@ -432,6 +446,7 @@ export default class Fleet {
432446
const meta: TransportRequestMetadata = {
433447
name: 'fleet.post_secret',
434448
acceptedParams: [
449+
'value'
435450
]
436451
}
437452
return await this.transport.request({ path, method, querystring, body, meta }, options)

0 commit comments

Comments
 (0)