CollectionApi

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

Method HTTP request Description
collectionDestroy DELETE /collection/{collection} Remove the specified collection from storage
collectionIndex GET /collection Display a listing of the collections
collectionShow GET /collection/{collection} Display the specified collection
collectionStore POST /collection Store a newly created collection in storage
collectionUpdate PUT /collection/{collection} Update the specified collection in storage

collectionDestroy

collectionDestroy()

Example

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

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

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

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

Parameters

Name Type Description Notes
collection [string] The collection 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

collectionIndex

CollectionIndex200Response collectionIndex()

Example

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

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

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

Parameters

This endpoint does not have any parameters.

Return type

CollectionIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

collectionShow

CollectionStore200Response collectionShow()

Example

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

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

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

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

Parameters

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

Return type

CollectionStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

collectionStore

CollectionStore200Response collectionStore(collectionStoreRequest)

Example

import {
    CollectionApi,
    Configuration,
    CollectionStoreRequest
} from './api';

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

let collectionStoreRequest: CollectionStoreRequest; //

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

Parameters

Name Type Description Notes
collectionStoreRequest CollectionStoreRequest    

Return type

CollectionStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

collectionUpdate

CollectionStore200Response collectionUpdate()

Example

import {
    CollectionApi,
    Configuration,
    CollectionUpdateRequest
} from './api';

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

let collection: string; //The collection ID (default to undefined)
let collectionUpdateRequest: CollectionUpdateRequest; // (optional)

const { status, data } = await apiInstance.collectionUpdate(
    collection,
    collectionUpdateRequest
);

Parameters

Name Type Description Notes
collectionUpdateRequest CollectionUpdateRequest    
collection [string] The collection ID defaults to undefined

Return type

CollectionStore200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `CollectionResource` | - | |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.