Skip to content

Commit 7e42527

Browse files
ckoegelckoegel
committed
generate samples
1 parent 8a79c46 commit 7e42527

285 files changed

Lines changed: 22995 additions & 0 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/echo_api/typescript-axios/build/.openapi-generator/FILES‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,24 @@ api.ts
55
base.ts
66
common.ts
77
configuration.ts
8+
docs/AuthApi.md
9+
docs/Bird.md
10+
docs/BodyApi.md
11+
docs/Category.md
12+
docs/DataQuery.md
13+
docs/DefaultValue.md
14+
docs/FormApi.md
15+
docs/HeaderApi.md
16+
docs/NumberPropertiesOnly.md
17+
docs/PathApi.md
18+
docs/Pet.md
19+
docs/Query.md
20+
docs/QueryApi.md
21+
docs/StringEnumRef.md
22+
docs/Tag.md
23+
docs/TestFormObjectMultipartRequestMarker.md
24+
docs/TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.md
25+
docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md
826
git_push.sh
927
index.ts
1028
package.json

‎samples/client/echo_api/typescript-axios/build/README.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,70 @@ _unPublished (not recommended):_
4444
```
4545
npm install PATH_TO_GENERATED_PACKAGE --save
4646
```
47+
48+
### Documentation for API Endpoints
49+
50+
All URIs are relative to *http://localhost:3000*
51+
52+
Class | Method | HTTP request | Description
53+
------------ | ------------- | ------------- | -------------
54+
*AuthApi* | [**testAuthHttpBasic**](docs/AuthApi.md#testauthhttpbasic) | **POST** /auth/http/basic | To test HTTP basic authentication
55+
*AuthApi* | [**testAuthHttpBearer**](docs/AuthApi.md#testauthhttpbearer) | **POST** /auth/http/bearer | To test HTTP bearer authentication
56+
*BodyApi* | [**testBinaryGif**](docs/BodyApi.md#testbinarygif) | **POST** /binary/gif | Test binary (gif) response body
57+
*BodyApi* | [**testBodyApplicationOctetstreamBinary**](docs/BodyApi.md#testbodyapplicationoctetstreambinary) | **POST** /body/application/octetstream/binary | Test body parameter(s)
58+
*BodyApi* | [**testBodyMultipartFormdataArrayOfBinary**](docs/BodyApi.md#testbodymultipartformdataarrayofbinary) | **POST** /body/application/octetstream/array_of_binary | Test array of binary in multipart mime
59+
*BodyApi* | [**testBodyMultipartFormdataSingleBinary**](docs/BodyApi.md#testbodymultipartformdatasinglebinary) | **POST** /body/application/octetstream/single_binary | Test single binary in multipart mime
60+
*BodyApi* | [**testEchoBodyAllOfPet**](docs/BodyApi.md#testechobodyallofpet) | **POST** /echo/body/allOf/Pet | Test body parameter(s)
61+
*BodyApi* | [**testEchoBodyFreeFormObjectResponseString**](docs/BodyApi.md#testechobodyfreeformobjectresponsestring) | **POST** /echo/body/FreeFormObject/response_string | Test free form object
62+
*BodyApi* | [**testEchoBodyPet**](docs/BodyApi.md#testechobodypet) | **POST** /echo/body/Pet | Test body parameter(s)
63+
*BodyApi* | [**testEchoBodyPetResponseString**](docs/BodyApi.md#testechobodypetresponsestring) | **POST** /echo/body/Pet/response_string | Test empty response body
64+
*BodyApi* | [**testEchoBodyStringEnum**](docs/BodyApi.md#testechobodystringenum) | **POST** /echo/body/string_enum | Test string enum response body
65+
*BodyApi* | [**testEchoBodyTagResponseString**](docs/BodyApi.md#testechobodytagresponsestring) | **POST** /echo/body/Tag/response_string | Test empty json (request body)
66+
*FormApi* | [**testFormIntegerBooleanString**](docs/FormApi.md#testformintegerbooleanstring) | **POST** /form/integer/boolean/string | Test form parameter(s)
67+
*FormApi* | [**testFormObjectMultipart**](docs/FormApi.md#testformobjectmultipart) | **POST** /form/object/multipart | Test form parameter(s) for multipart schema
68+
*FormApi* | [**testFormOneof**](docs/FormApi.md#testformoneof) | **POST** /form/oneof | Test form parameter(s) for oneOf schema
69+
*HeaderApi* | [**testHeaderIntegerBooleanStringEnums**](docs/HeaderApi.md#testheaderintegerbooleanstringenums) | **GET** /header/integer/boolean/string/enums | Test header parameter(s)
70+
*PathApi* | [**testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath**](docs/PathApi.md#testspathstringpathstringintegerpathintegerenumnonrefstringpathenumrefstringpath) | **GET** /path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path} | Test path parameter(s)
71+
*QueryApi* | [**testEnumRefString**](docs/QueryApi.md#testenumrefstring) | **GET** /query/enum_ref_string | Test query parameter(s)
72+
*QueryApi* | [**testQueryDatetimeDateString**](docs/QueryApi.md#testquerydatetimedatestring) | **GET** /query/datetime/date/string | Test query parameter(s)
73+
*QueryApi* | [**testQueryIntegerBooleanString**](docs/QueryApi.md#testqueryintegerbooleanstring) | **GET** /query/integer/boolean/string | Test query parameter(s)
74+
*QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObject**](docs/QueryApi.md#testquerystyledeepobjectexplodetrueobject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s)
75+
*QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/QueryApi.md#testquerystyledeepobjectexplodetrueobjectallof) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s)
76+
*QueryApi* | [**testQueryStyleFormExplodeFalseArrayInteger**](docs/QueryApi.md#testquerystyleformexplodefalsearrayinteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s)
77+
*QueryApi* | [**testQueryStyleFormExplodeFalseArrayString**](docs/QueryApi.md#testquerystyleformexplodefalsearraystring) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s)
78+
*QueryApi* | [**testQueryStyleFormExplodeTrueArrayString**](docs/QueryApi.md#testquerystyleformexplodetruearraystring) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s)
79+
*QueryApi* | [**testQueryStyleFormExplodeTrueObject**](docs/QueryApi.md#testquerystyleformexplodetrueobject) | **GET** /query/style_form/explode_true/object | Test query parameter(s)
80+
*QueryApi* | [**testQueryStyleFormExplodeTrueObjectAllOf**](docs/QueryApi.md#testquerystyleformexplodetrueobjectallof) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s)
81+
82+
83+
### Documentation For Models
84+
85+
- [Bird](docs/Bird.md)
86+
- [Category](docs/Category.md)
87+
- [DataQuery](docs/DataQuery.md)
88+
- [DefaultValue](docs/DefaultValue.md)
89+
- [NumberPropertiesOnly](docs/NumberPropertiesOnly.md)
90+
- [Pet](docs/Pet.md)
91+
- [Query](docs/Query.md)
92+
- [StringEnumRef](docs/StringEnumRef.md)
93+
- [Tag](docs/Tag.md)
94+
- [TestFormObjectMultipartRequestMarker](docs/TestFormObjectMultipartRequestMarker.md)
95+
- [TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter](docs/TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.md)
96+
- [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md)
97+
98+
99+
<a id="documentation-for-authorization"></a>
100+
## Documentation For Authorization
101+
102+
103+
Authentication schemes defined for the API:
104+
<a id="http_auth"></a>
105+
### http_auth
106+
107+
- **Type**: HTTP basic authentication
108+
109+
<a id="http_bearer_auth"></a>
110+
### http_bearer_auth
111+
112+
- **Type**: Bearer authentication
113+

‎samples/client/echo_api/typescript-axios/build/docs/AuthApi.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# AuthApi
2+
3+
All URIs are relative to *http://localhost:3000*
4+
5+
|Method | HTTP request | Description|
6+
|------------- | ------------- | -------------|
7+
|[**testAuthHttpBasic**](#testauthhttpbasic) | **POST** /auth/http/basic | To test HTTP basic authentication|
8+
|[**testAuthHttpBearer**](#testauthhttpbearer) | **POST** /auth/http/bearer | To test HTTP bearer authentication|
9+
10+
# **testAuthHttpBasic**
11+
> string testAuthHttpBasic()
12+
13+
To test HTTP basic authentication
14+
15+
### Example
16+
17+
```typescript
18+
import {
19+
AuthApi,
20+
Configuration
21+
} from '@openapitools/typescript-axios-echo-api';
22+
23+
const configuration = new Configuration();
24+
const apiInstance = new AuthApi(configuration);
25+
26+
const { status, data } = await apiInstance.testAuthHttpBasic();
27+
```
28+
29+
### Parameters
30+
This endpoint does not have any parameters.
31+
32+
33+
### Return type
34+
35+
**string**
36+
37+
### Authorization
38+
39+
[http_auth](../README.md#http_auth)
40+
41+
### HTTP request headers
42+
43+
- **Content-Type**: Not defined
44+
- **Accept**: text/plain
45+
46+
47+
### HTTP response details
48+
| Status code | Description | Response headers |
49+
|-------------|-------------|------------------|
50+
|**200** | Successful operation | - |
51+
52+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
53+
54+
# **testAuthHttpBearer**
55+
> string testAuthHttpBearer()
56+
57+
To test HTTP bearer authentication
58+
59+
### Example
60+
61+
```typescript
62+
import {
63+
AuthApi,
64+
Configuration
65+
} from '@openapitools/typescript-axios-echo-api';
66+
67+
const configuration = new Configuration();
68+
const apiInstance = new AuthApi(configuration);
69+
70+
const { status, data } = await apiInstance.testAuthHttpBearer();
71+
```
72+
73+
### Parameters
74+
This endpoint does not have any parameters.
75+
76+
77+
### Return type
78+
79+
**string**
80+
81+
### Authorization
82+
83+
[http_bearer_auth](../README.md#http_bearer_auth)
84+
85+
### HTTP request headers
86+
87+
- **Content-Type**: Not defined
88+
- **Accept**: text/plain
89+
90+
91+
### HTTP response details
92+
| Status code | Description | Response headers |
93+
|-------------|-------------|------------------|
94+
|**200** | Successful operation | - |
95+
96+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
97+

‎samples/client/echo_api/typescript-axios/build/docs/Bird.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Bird
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**size** | **string** | | [optional] [default to undefined]
9+
**color** | **string** | | [optional] [default to undefined]
10+
11+
## Example
12+
13+
```typescript
14+
import { Bird } from '@openapitools/typescript-axios-echo-api';
15+
16+
const instance: Bird = {
17+
size,
18+
color,
19+
};
20+
```
21+
22+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

0 commit comments

Comments
 (0)