Skip to content

Commit 0b7dc08

Browse files
authored
docs(cockpit): document activate and deactivate methods (#491)
1 parent d0e72cc commit 0b7dc08

File tree

1 file changed

+12
-0
lines changed
  • packages/clients/src/api/cockpit/v1beta1

1 file changed

+12
-0
lines changed

packages/clients/src/api/cockpit/v1beta1/api.gen.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,12 @@ const jsonContentHeaders = {
6868
* This API allows to manage Cockpits.
6969
*/
7070
export class API extends ParentAPI {
71+
/**
72+
* Activate a cockpit associated with the given project ID.
73+
*
74+
* @param request - The request {@link ActivateCockpitRequest}
75+
* @returns A Promise of Cockpit
76+
*/
7177
activateCockpit = (request: Readonly<ActivateCockpitRequest> = {}) =>
7278
this.client.fetch<Cockpit>(
7379
{
@@ -120,6 +126,12 @@ export class API extends ParentAPI {
120126
options,
121127
)
122128

129+
/**
130+
* Deactivate a cockpit associated with the given project ID.
131+
*
132+
* @param request - The request {@link DeactivateCockpitRequest}
133+
* @returns A Promise of Cockpit
134+
*/
123135
deactivateCockpit = (request: Readonly<DeactivateCockpitRequest> = {}) =>
124136
this.client.fetch<Cockpit>(
125137
{

0 commit comments

Comments
 (0)