TagApi

All URIs are relative to http://127.0.0.1:8000/api

Method HTTP request Description
tagDestroy DELETE /tag/{tag} Remove the specified resource from storage
tagForItem GET /tag/for-item/{item} Get tags for a specific item
tagIndex GET /tag Display a listing of the resource
tagShow GET /tag/{tag} Display the specified resource
tagStore POST /tag Store a newly created resource in storage
tagUpdate PATCH /tag/{tag} Update the specified resource in storage
tagUpdate2 PUT /tag/{tag} Update the specified resource in storage

tagDestroy

tagDestroy()

Example

import {
    TagApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new TagApi(configuration);

let tag: string; //The tag ID (default to undefined)

const { status, data } = await apiInstance.tagDestroy(
    tag
);

Parameters

Name Type Description Notes
tag [string] The tag ID defaults to undefined

Return type

void (empty response body)

Authorization

http

HTTP request headers

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

tagForItem

TagForItem200Response tagForItem()

Example

import {
    TagApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new TagApi(configuration);

let item: string; //The item ID (default to undefined)
let page: number; // (optional) (default to undefined)
let perPage: number; // (optional) (default to undefined)

const { status, data } = await apiInstance.tagForItem(
    item,
    page,
    perPage
);

Parameters

Name Type Description Notes
item [string] The item ID defaults to undefined
page [number]   (optional) defaults to undefined
perPage [number]   (optional) defaults to undefined

Return type

TagForItem200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Paginated set of `TagResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

tagIndex

TagForItem200Response tagIndex()

Example

import {
    TagApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new TagApi(configuration);

let page: number; // (optional) (default to undefined)
let perPage: number; // (optional) (default to undefined)

const { status, data } = await apiInstance.tagIndex(
    page,
    perPage
);

Parameters

Name Type Description Notes
page [number]   (optional) defaults to undefined
perPage [number]   (optional) defaults to undefined

Return type

TagForItem200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Paginated set of `TagResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

tagShow

TagShow200Response tagShow()

Example

import {
    TagApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new TagApi(configuration);

let tag: string; //The tag ID (default to undefined)

const { status, data } = await apiInstance.tagShow(
    tag
);

Parameters

Name Type Description Notes
tag [string] The tag ID defaults to undefined

Return type

TagShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `TagResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

tagStore

TagShow200Response tagStore(storeTagRequest)

Example

import {
    TagApi,
    Configuration,
    StoreTagRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new TagApi(configuration);

let storeTagRequest: StoreTagRequest; //

const { status, data } = await apiInstance.tagStore(
    storeTagRequest
);

Parameters

Name Type Description Notes
storeTagRequest StoreTagRequest    

Return type

TagShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `TagResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

tagUpdate

TagShow200Response tagUpdate(updateTagRequest)

Example

import {
    TagApi,
    Configuration,
    UpdateTagRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new TagApi(configuration);

let tag: string; //The tag ID (default to undefined)
let updateTagRequest: UpdateTagRequest; //

const { status, data } = await apiInstance.tagUpdate(
    tag,
    updateTagRequest
);

Parameters

Name Type Description Notes
updateTagRequest UpdateTagRequest    
tag [string] The tag ID defaults to undefined

Return type

TagShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `TagResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

tagUpdate2

TagShow200Response tagUpdate2(updateTagRequest)

Example

import {
    TagApi,
    Configuration,
    UpdateTagRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new TagApi(configuration);

let tag: string; //The tag ID (default to undefined)
let updateTagRequest: UpdateTagRequest; //

const { status, data } = await apiInstance.tagUpdate2(
    tag,
    updateTagRequest
);

Parameters

Name Type Description Notes
updateTagRequest UpdateTagRequest    
tag [string] The tag ID defaults to undefined

Return type

TagShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `TagResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

This documentation was automatically generated from the TypeScript API client.