Skip to content

Commit 57ca8c5

Browse files
committed
update docs and samples
1 parent 017440e commit 57ca8c5

48 files changed

Lines changed: 4095 additions & 1295 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

samples/client/petstore/typescript-fetch/builds/allOf-nullable/apis/DefaultApi.ts

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,9 @@ export interface ListRequest {
3232
export class DefaultApi extends runtime.BaseAPI {
3333

3434
/**
35+
* Creates request configuration for list without sending the request
3536
*/
36-
async listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Club>> {
37+
async listRequestConfig(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.RequestOpts> {
3738
if (requestParameters['personId'] == null) {
3839
throw new runtime.RequiredError(
3940
'personId',
@@ -49,12 +50,20 @@ export class DefaultApi extends runtime.BaseAPI {
4950
let urlPath = `/person/display/{personId}`;
5051
urlPath = urlPath.replace(`{${"personId"}}`, encodeURIComponent(String(requestParameters['personId'])));
5152

52-
const response = await this.request({
53+
const requestOpts: runtime.RequestOpts = {
5354
path: urlPath,
5455
method: 'GET',
5556
headers: headerParameters,
5657
query: queryParameters,
57-
}, initOverrides);
58+
};
59+
return requestOpts;
60+
}
61+
62+
/**
63+
*/
64+
async listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Club>> {
65+
const requestConfig = await this.listRequestConfig(requestParameters, initOverrides);
66+
const response = await this.request(requestConfig, initOverrides);
5867

5968
return new runtime.JSONApiResponse(response, (jsonValue) => ClubFromJSON(jsonValue));
6069
}

samples/client/petstore/typescript-fetch/builds/allOf-readonly/apis/DefaultApi.ts

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,9 @@ export interface ListRequest {
3232
export class DefaultApi extends runtime.BaseAPI {
3333

3434
/**
35+
* Creates request configuration for list without sending the request
3536
*/
36-
async listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Club>> {
37+
async listRequestConfig(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.RequestOpts> {
3738
if (requestParameters['personId'] == null) {
3839
throw new runtime.RequiredError(
3940
'personId',
@@ -49,12 +50,20 @@ export class DefaultApi extends runtime.BaseAPI {
4950
let urlPath = `/person/display/{personId}`;
5051
urlPath = urlPath.replace(`{${"personId"}}`, encodeURIComponent(String(requestParameters['personId'])));
5152

52-
const response = await this.request({
53+
const requestOpts: runtime.RequestOpts = {
5354
path: urlPath,
5455
method: 'GET',
5556
headers: headerParameters,
5657
query: queryParameters,
57-
}, initOverrides);
58+
};
59+
return requestOpts;
60+
}
61+
62+
/**
63+
*/
64+
async listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Club>> {
65+
const requestConfig = await this.listRequestConfig(requestParameters, initOverrides);
66+
const response = await this.request(requestConfig, initOverrides);
5867

5968
return new runtime.JSONApiResponse(response, (jsonValue) => ClubFromJSON(jsonValue));
6069
}

samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/AnotherFakeApi.ts

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,9 @@ export interface 123testSpecialTagsRequest {
3232
export class AnotherFakeApi extends runtime.BaseAPI {
3333

3434
/**
35-
* To test special tags and operation ID starting with number
36-
* To test special tags
35+
* Creates request configuration for _123testSpecialTags without sending the request
3736
*/
38-
async _123testSpecialTagsRaw(requestParameters: 123testSpecialTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Client>> {
37+
async _123testSpecialTagsRequestConfig(requestParameters: 123testSpecialTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.RequestOpts> {
3938
if (requestParameters['client'] == null) {
4039
throw new runtime.RequiredError(
4140
'client',
@@ -52,13 +51,23 @@ export class AnotherFakeApi extends runtime.BaseAPI {
5251

5352
let urlPath = `/another-fake/dummy`;
5453

55-
const response = await this.request({
54+
const requestOpts: runtime.RequestOpts = {
5655
path: urlPath,
5756
method: 'PATCH',
5857
headers: headerParameters,
5958
query: queryParameters,
6059
body: ClientToJSON(requestParameters['client']),
61-
}, initOverrides);
60+
};
61+
return requestOpts;
62+
}
63+
64+
/**
65+
* To test special tags and operation ID starting with number
66+
* To test special tags
67+
*/
68+
async _123testSpecialTagsRaw(requestParameters: 123testSpecialTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Client>> {
69+
const requestConfig = await this._123testSpecialTagsRequestConfig(requestParameters, initOverrides);
70+
const response = await this.request(requestConfig, initOverrides);
6271

6372
return new runtime.JSONApiResponse(response, (jsonValue) => ClientFromJSON(jsonValue));
6473
}

samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/DefaultApi.ts

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,21 +28,30 @@ import {
2828
export class DefaultApi extends runtime.BaseAPI {
2929

3030
/**
31+
* Creates request configuration for fooGet without sending the request
3132
*/
32-
async fooGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FooGetDefaultResponse>> {
33+
async fooGetRequestConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.RequestOpts> {
3334
const queryParameters: any = {};
3435

3536
const headerParameters: runtime.HTTPHeaders = {};
3637

3738

3839
let urlPath = `/foo`;
3940

40-
const response = await this.request({
41+
const requestOpts: runtime.RequestOpts = {
4142
path: urlPath,
4243
method: 'GET',
4344
headers: headerParameters,
4445
query: queryParameters,
45-
}, initOverrides);
46+
};
47+
return requestOpts;
48+
}
49+
50+
/**
51+
*/
52+
async fooGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FooGetDefaultResponse>> {
53+
const requestConfig = await this.fooGetRequestConfig(initOverrides);
54+
const response = await this.request(requestConfig, initOverrides);
4655

4756
return new runtime.JSONApiResponse(response, (jsonValue) => FooGetDefaultResponseFromJSON(jsonValue));
4857
}

0 commit comments

Comments
 (0)