Add OpenAPI
This commit is contained in:
64
src/api/openapi/docs/CardPrintService.md
Normal file
64
src/api/openapi/docs/CardPrintService.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# CardPrintService
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**getCardPrintPage**](#getcardprintpage) | **GET** /api/prints | Get a page of Card Prints with optional name query parameter|
|
||||
|
||||
# **getCardPrintPage**
|
||||
> PageCardPrintDto getCardPrintPage()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
CardPrintService,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new CardPrintService(configuration);
|
||||
|
||||
let name: string; // (optional) (default to undefined)
|
||||
let page: number; // (optional) (default to undefined)
|
||||
let pageSize: number; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.getCardPrintPage(
|
||||
name,
|
||||
page,
|
||||
pageSize
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **name** | [**string**] | | (optional) defaults to undefined|
|
||||
| **page** | [**number**] | | (optional) defaults to undefined|
|
||||
| **pageSize** | [**number**] | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**PageCardPrintDto**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Card Prints Page retrieved | - |
|
||||
|
||||
[[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)
|
||||
|
||||
Reference in New Issue
Block a user