ContextApi

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

Method HTTP request Description
contextDestroy DELETE /context/{context} Remove the specified resource from storage
contextGetDefault GET /context/default Get the default context
contextIndex GET /context Display a listing of the resource
contextSetDefault PATCH /context/{context}/default Set a context as the default one
contextShow GET /context/{context} Display the specified resource
contextStore POST /context Store a newly created resource in storage
contextUpdate PUT /context/{context} Update the specified resource in storage

contextDestroy

contextDestroy()

Example

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

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

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

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

Parameters

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

contextGetDefault

ContextSetDefault200Response contextGetDefault()

Example

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

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

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

Parameters

This endpoint does not have any parameters.

Return type

ContextSetDefault200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `ContextResource` | - | |404 | | - | |401 | Unauthenticated | - |

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

contextIndex

ContextIndex200Response contextIndex()

Example

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

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

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

Parameters

This endpoint does not have any parameters.

Return type

ContextIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

contextSetDefault

ContextSetDefault200Response contextSetDefault(contextSetDefaultRequest)

Example

import {
    ContextApi,
    Configuration,
    ContextSetDefaultRequest
} from './api';

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

let context: string; //The context ID (default to undefined)
let contextSetDefaultRequest: ContextSetDefaultRequest; //

const { status, data } = await apiInstance.contextSetDefault(
    context,
    contextSetDefaultRequest
);

Parameters

Name Type Description Notes
contextSetDefaultRequest ContextSetDefaultRequest    
context [string] The context ID defaults to undefined

Return type

ContextSetDefault200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

contextShow

ContextSetDefault200Response contextShow()

Example

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

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

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

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

Parameters

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

Return type

ContextSetDefault200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

contextStore

ContextSetDefault200Response contextStore(contextStoreRequest)

Example

import {
    ContextApi,
    Configuration,
    ContextStoreRequest
} from './api';

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

let contextStoreRequest: ContextStoreRequest; //

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

Parameters

Name Type Description Notes
contextStoreRequest ContextStoreRequest    

Return type

ContextSetDefault200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

contextUpdate

ContextSetDefault200Response contextUpdate(contextStoreRequest)

Example

import {
    ContextApi,
    Configuration,
    ContextStoreRequest
} from './api';

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

let context: string; //The context ID (default to undefined)
let contextStoreRequest: ContextStoreRequest; //

const { status, data } = await apiInstance.contextUpdate(
    context,
    contextStoreRequest
);

Parameters

Name Type Description Notes
contextStoreRequest ContextStoreRequest    
context [string] The context ID defaults to undefined

Return type

ContextSetDefault200Response

Authorization

http

HTTP request headers

HTTP response details

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