-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
174 additions
and
0 deletions.
There are no files selected for viewing
1 change: 1 addition & 0 deletions
1
samples/openapi3/client/petstore/typescript/builds/composed-schemas/.openapi-generator/FILES
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
.gitignore | ||
DefaultApi.md | ||
README.md | ||
apis/DefaultApi.ts | ||
apis/baseapi.ts | ||
|
173 changes: 173 additions & 0 deletions
173
samples/openapi3/client/petstore/typescript/builds/composed-schemas/DefaultApi.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,173 @@ | ||
# .DefaultApi | ||
|
||
All URIs are relative to *http://api.example.xyz/v1* | ||
|
||
Method | HTTP request | Description | ||
------------- | ------------- | ------------- | ||
[**filePost**](DefaultApi.md#filePost) | **POST** /file | | ||
[**petsFilteredPatch**](DefaultApi.md#petsFilteredPatch) | **PATCH** /pets-filtered | | ||
[**petsPatch**](DefaultApi.md#petsPatch) | **PATCH** /pets | | ||
|
||
|
||
# **filePost** | ||
> void filePost() | ||
|
||
### Example | ||
|
||
|
||
```typescript | ||
import { } from ''; | ||
import * as fs from 'fs'; | ||
|
||
const configuration = .createConfiguration(); | ||
const apiInstance = new .DefaultApi(configuration); | ||
|
||
let body:.DefaultApiFilePostRequest = { | ||
// InlineObject (optional) | ||
inlineObject: { | ||
file: , | ||
}, | ||
}; | ||
|
||
apiInstance.filePost(body).then((data:any) => { | ||
console.log('API called successfully. Returned data: ' + data); | ||
}).catch((error:any) => console.error(error)); | ||
``` | ||
|
||
|
||
### Parameters | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**inlineObject** | **InlineObject**| | | ||
|
||
|
||
### Return type | ||
|
||
**void** | ||
|
||
### Authorization | ||
|
||
No authorization required | ||
|
||
### HTTP request headers | ||
|
||
- **Content-Type**: application/json | ||
- **Accept**: Not defined | ||
|
||
|
||
### HTTP response details | ||
| Status code | Description | Response headers | | ||
|-------------|-------------|------------------| | ||
**200** | File uploaded | - | | ||
|
||
[[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) | ||
|
||
# **petsFilteredPatch** | ||
> void petsFilteredPatch() | ||
|
||
### Example | ||
|
||
|
||
```typescript | ||
import { } from ''; | ||
import * as fs from 'fs'; | ||
|
||
const configuration = .createConfiguration(); | ||
const apiInstance = new .DefaultApi(configuration); | ||
|
||
let body:.DefaultApiPetsFilteredPatchRequest = { | ||
// PetByAge | PetByType (optional) | ||
petByAgePetByType: , | ||
}; | ||
|
||
apiInstance.petsFilteredPatch(body).then((data:any) => { | ||
console.log('API called successfully. Returned data: ' + data); | ||
}).catch((error:any) => console.error(error)); | ||
``` | ||
|
||
|
||
### Parameters | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**petByAgePetByType** | **PetByAge | PetByType**| | | ||
|
||
|
||
### Return type | ||
|
||
**void** | ||
|
||
### Authorization | ||
|
||
No authorization required | ||
|
||
### HTTP request headers | ||
|
||
- **Content-Type**: application/json | ||
- **Accept**: Not defined | ||
|
||
|
||
### HTTP response details | ||
| Status code | Description | Response headers | | ||
|-------------|-------------|------------------| | ||
**200** | Updated | - | | ||
|
||
[[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) | ||
|
||
# **petsPatch** | ||
> void petsPatch() | ||
|
||
### Example | ||
|
||
|
||
```typescript | ||
import { } from ''; | ||
import * as fs from 'fs'; | ||
|
||
const configuration = .createConfiguration(); | ||
const apiInstance = new .DefaultApi(configuration); | ||
|
||
let body:.DefaultApiPetsPatchRequest = { | ||
// Cat | Dog (optional) | ||
catDog: , | ||
}; | ||
|
||
apiInstance.petsPatch(body).then((data:any) => { | ||
console.log('API called successfully. Returned data: ' + data); | ||
}).catch((error:any) => console.error(error)); | ||
``` | ||
|
||
|
||
### Parameters | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**catDog** | **Cat | Dog**| | | ||
|
||
|
||
### Return type | ||
|
||
**void** | ||
|
||
### Authorization | ||
|
||
No authorization required | ||
|
||
### HTTP request headers | ||
|
||
- **Content-Type**: application/json | ||
- **Accept**: Not defined | ||
|
||
|
||
### HTTP response details | ||
| Status code | Description | Response headers | | ||
|-------------|-------------|------------------| | ||
**200** | Updated | - | | ||
|
||
[[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) | ||
|
||
|