Skip to content

docs(cockpit): document activate and deactivate methods #491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 2, 2023
Merged

docs(cockpit): document activate and deactivate methods #491

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions packages/clients/src/api/cockpit/v1beta1/api.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ const jsonContentHeaders = {
* This API allows to manage Cockpits.
*/
export class API extends ParentAPI {
/**
* Activate a cockpit associated with the given project ID.
*
* @param request - The request {@link ActivateCockpitRequest}
* @returns A Promise of Cockpit
*/
activateCockpit = (request: Readonly<ActivateCockpitRequest> = {}) =>
this.client.fetch<Cockpit>(
{
Expand Down Expand Up @@ -120,6 +126,12 @@ export class API extends ParentAPI {
options,
)

/**
* Deactivate a cockpit associated with the given project ID.
*
* @param request - The request {@link DeactivateCockpitRequest}
* @returns A Promise of Cockpit
*/
deactivateCockpit = (request: Readonly<DeactivateCockpitRequest> = {}) =>
this.client.fetch<Cockpit>(
{
Expand Down