ProjectApi
All URIs are relative to http://localhost:8000/api
Method | HTTP request | Description |
---|---|---|
projectDestroy | DELETE /project/{project} | Remove the specified resource from storage |
projectEnabled | GET /project/enabled | Get all enabled projects (Enabled + launched) |
projectIndex | GET /project | Display a listing of the resource |
projectSetEnabled | PATCH /project/{project}/enabled | Toggle Enable/disable on a project |
projectSetLaunched | PATCH /project/{project}/launched | Toggle Launched/not-launched on a project |
projectShow | GET /project/{project} | Display the specified resource |
projectStore | POST /project | Store a newly created resource in storage |
projectUpdate | PUT /project/{project} | Update the specified resource in storage |
projectDestroy
projectDestroy()
Example
import {
ProjectApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let project: string; //The project ID (default to undefined)
const { status, data } = await apiInstance.projectDestroy(
project
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
project | [string] | The project 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
projectEnabled
ProjectEnabled200Response projectEnabled()
Example
import {
ProjectApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
const { status, data } = await apiInstance.projectEnabled();
Parameters
This endpoint does not have any parameters.
Return type
ProjectEnabled200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ProjectResource` | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
projectIndex
ProjectEnabled200Response projectIndex()
Example
import {
ProjectApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
const { status, data } = await apiInstance.projectIndex();
Parameters
This endpoint does not have any parameters.
Return type
ProjectEnabled200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `ProjectResource` | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
projectSetEnabled
ProjectSetLaunched200Response projectSetEnabled(projectSetEnabledRequest)
Example
import {
ProjectApi,
Configuration,
ProjectSetEnabledRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let project: string; //The project ID (default to undefined)
let projectSetEnabledRequest: ProjectSetEnabledRequest; //
const { status, data } = await apiInstance.projectSetEnabled(
project,
projectSetEnabledRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
projectSetEnabledRequest | ProjectSetEnabledRequest | ||
project | [string] | The project ID | defaults to undefined |
Return type
ProjectSetLaunched200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ProjectResource` | - | |422 | Validation error | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
projectSetLaunched
ProjectSetLaunched200Response projectSetLaunched()
Example
import {
ProjectApi,
Configuration,
ProjectSetLaunchedRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let project: string; //The project ID (default to undefined)
let projectSetLaunchedRequest: ProjectSetLaunchedRequest; // (optional)
const { status, data } = await apiInstance.projectSetLaunched(
project,
projectSetLaunchedRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
projectSetLaunchedRequest | ProjectSetLaunchedRequest | ||
project | [string] | The project ID | defaults to undefined |
Return type
ProjectSetLaunched200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ProjectResource` | - | |422 | Validation error | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
projectShow
ProjectSetLaunched200Response projectShow()
Example
import {
ProjectApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let project: string; //The project ID (default to undefined)
const { status, data } = await apiInstance.projectShow(
project
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
project | [string] | The project ID | defaults to undefined |
Return type
ProjectSetLaunched200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ProjectResource` | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
projectStore
ProjectSetLaunched200Response projectStore(projectStoreRequest)
Example
import {
ProjectApi,
Configuration,
ProjectStoreRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectStoreRequest: ProjectStoreRequest; //
const { status, data } = await apiInstance.projectStore(
projectStoreRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
projectStoreRequest | ProjectStoreRequest |
Return type
ProjectSetLaunched200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ProjectResource` | - | |422 | Validation error | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
projectUpdate
ProjectSetLaunched200Response projectUpdate(projectStoreRequest)
Example
import {
ProjectApi,
Configuration,
ProjectStoreRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let project: string; //The project ID (default to undefined)
let projectStoreRequest: ProjectStoreRequest; //
const { status, data } = await apiInstance.projectUpdate(
project,
projectStoreRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
projectStoreRequest | ProjectStoreRequest | ||
project | [string] | The project ID | defaults to undefined |
Return type
ProjectSetLaunched200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ProjectResource` | - | |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.