AvailableImageApi
All URIs are relative to http://localhost:8000/api
Method | HTTP request | Description |
---|---|---|
availableImageDestroy | DELETE /available-image/{availableImage} | Remove the specified resource from storage |
availableImageDownload | GET /available-image/{availableImage}/download | Returns the file to the caller |
availableImageIndex | GET /available-image | Display a listing of the resource |
availableImageShow | GET /available-image/{availableImage} | Display the specified resource |
availableImageUpdate | PUT /available-image/{availableImage} | Update the specified resource in storage |
availableImageView | GET /available-image/{availableImage}/view | Returns the image file for direct viewing (e.g., for use in <img> src attribute) |
availableImageDestroy
availableImageDestroy()
Example
import {
AvailableImageApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new AvailableImageApi(configuration);
let availableImage: string; //The available image ID (default to undefined)
const { status, data } = await apiInstance.availableImageDestroy(
availableImage
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
availableImage | [string] | The available image ID | defaults to undefined |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |204 | No content | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
availableImageDownload
string availableImageDownload()
Example
import {
AvailableImageApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new AvailableImageApi(configuration);
let availableImage: string; //The available image ID (default to undefined)
const { status, data } = await apiInstance.availableImageDownload(
availableImage
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
availableImage | [string] | The available image ID | defaults to undefined |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
availableImageIndex
AvailableImageIndex200Response availableImageIndex()
Example
import {
AvailableImageApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new AvailableImageApi(configuration);
const { status, data } = await apiInstance.availableImageIndex();
Parameters
This endpoint does not have any parameters.
Return type
AvailableImageIndex200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `AvailableImageResource` | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
availableImageShow
AvailableImageShow200Response availableImageShow()
Example
import {
AvailableImageApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new AvailableImageApi(configuration);
let availableImage: string; //The available image ID (default to undefined)
const { status, data } = await apiInstance.availableImageShow(
availableImage
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
availableImage | [string] | The available image ID | defaults to undefined |
Return type
AvailableImageShow200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `AvailableImageResource` | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
availableImageUpdate
AvailableImageShow200Response availableImageUpdate()
Example
import {
AvailableImageApi,
Configuration,
AvailableImageUpdateRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new AvailableImageApi(configuration);
let availableImage: string; //The available image ID (default to undefined)
let availableImageUpdateRequest: AvailableImageUpdateRequest; // (optional)
const { status, data } = await apiInstance.availableImageUpdate(
availableImage,
availableImageUpdateRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
availableImageUpdateRequest | AvailableImageUpdateRequest | ||
availableImage | [string] | The available image ID | defaults to undefined |
Return type
AvailableImageShow200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `AvailableImageResource` | - | |422 | Validation error | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
availableImageView
string availableImageView()
Example
import {
AvailableImageApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new AvailableImageApi(configuration);
let availableImage: string; //The available image ID (default to undefined)
const { status, data } = await apiInstance.availableImageView(
availableImage
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
availableImage | [string] | The available image ID | defaults to undefined |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
This documentation was automatically generated from the TypeScript API client.