TagApi

All URIs are relative to http://localhost: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 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

TagIndex200Response 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)

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

Parameters

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

Return type

TagIndex200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `TagResource` | - | |404 | Not found | - | |401 | Unauthenticated | - |

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

tagIndex

TagIndex200Response tagIndex()

Example

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

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

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

Parameters

This endpoint does not have any parameters.

Return type

TagIndex200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `TagResource` | - | |401 | Unauthenticated | - |

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

tagShow

TagStore200Response 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

TagStore200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `TagResource` | - | |404 | Not found | - | |401 | Unauthenticated | - |

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

tagStore

TagStore200Response tagStore(tagStoreRequest)

Example

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

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

let tagStoreRequest: TagStoreRequest; //

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

Parameters

Name Type Description Notes
tagStoreRequest TagStoreRequest    

Return type

TagStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

tagUpdate

TagStore200Response tagUpdate(tagStoreRequest)

Example

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

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

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

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

Parameters

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

Return type

TagStore200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `TagResource` | - | |422 | Validation error | - | |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.