Add OpenAPI
This commit is contained in:
58
src/api/openapi/docs/JobControllerService.md
Normal file
58
src/api/openapi/docs/JobControllerService.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# JobControllerService
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**apiJobsNameGet**](#apijobsnameget) | **GET** /api/jobs/{name} | Get Deck By Name|
|
||||
|
||||
# **apiJobsNameGet**
|
||||
> string apiJobsNameGet()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
JobControllerService,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new JobControllerService(configuration);
|
||||
|
||||
let name: string; // (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.apiJobsNameGet(
|
||||
name
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **name** | [**string**] | | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | OK | - |
|
||||
|
||||
[[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