7692 lines
387 KiB
HTML
7692 lines
387 KiB
HTML
<!doctype html>
|
||
<html class="no-js" lang="en">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Litmus API Documentation | API Reference</title>
|
||
<link rel="stylesheet" href="stylesheets/foundation.min.css" />
|
||
<link rel="stylesheet" href="stylesheets/spectacle.min.css" />
|
||
<script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
|
||
<!-- <script src="javascripts/foundation.js"></script> -->
|
||
<script src="javascripts/spectacle.min.js"></script>
|
||
</head>
|
||
<body id="spectacle">
|
||
<div id="page" class="drawer-layout drawer-slide-right-large">
|
||
<div id="sidebar">
|
||
<button class="close-button" aria-label="Close menu" type="button" data-drawer-close>
|
||
<span aria-hidden="true">×</span>
|
||
</button>
|
||
<div id="logo">
|
||
<img src="images/logo.png" title="Litmus API Documentation" /> </div>
|
||
<nav id="nav" role="navigation">
|
||
<h5>Topics</h5>
|
||
<a href="#introduction">Introduction</a>
|
||
<a href="#authentication">Authentication</a>
|
||
<h5>Operations</h5>
|
||
<section>
|
||
<a href="#tag-Cluster">Cluster</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation-register_cluster-post"> Register Cluster </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-list_cluster-post"> List Cluster </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-delete_cluster-post"> Delete Cluster </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-ChaosWorkflow">ChaosWorkflow</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation-create_chaosworkflow-post"> Create ChaosWorkflow </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-list_chaosworkflow-post"> List ChaosWorkflow </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-update_chaosworkflow-post"> Update ChaosWorkflow </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-delete_chaosworkflow-post"> Delete ChaosWorkflow </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-MyHub">MyHub</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation-add_myhub-post"> Add Myhub </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-list_myhub-post"> List MyHub </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-sync_myhub-post"> Sync MyHub </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-User-Management">User Management</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation-add_user-post"> Add User </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-list_user-post"> List User </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_user-post"> Get User </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-update_user-post"> Update User </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-send_invitation-post"> Send Invitation </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-accept_invitation-post"> Accept Invitation </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-decline_invitation-post"> Decline Invitation </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-remove_invitation-post"> Remove Invitation </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<h5>Schema Definitions</h5>
|
||
<a href="#definition-ActionPayload"> ActionPayload </a>
|
||
<a href="#definition-Annotation"> Annotation </a>
|
||
<a href="#definition-Boolean"> Boolean </a>
|
||
<a href="#definition-ChaosWorkFlowInput"> ChaosWorkFlowInput </a>
|
||
<a href="#definition-ChaosWorkFlowResponse"> ChaosWorkFlowResponse </a>
|
||
<a href="#definition-Chart"> Chart </a>
|
||
<a href="#definition-Charts"> Charts </a>
|
||
<a href="#definition-CloningInput"> CloningInput </a>
|
||
<a href="#definition-Cluster"> Cluster </a>
|
||
<a href="#definition-ClusterAction"> ClusterAction </a>
|
||
<a href="#definition-ClusterActionInput"> ClusterActionInput </a>
|
||
<a href="#definition-ClusterConfirmResponse"> ClusterConfirmResponse </a>
|
||
<a href="#definition-ClusterEvent"> ClusterEvent </a>
|
||
<a href="#definition-ClusterEventInput"> ClusterEventInput </a>
|
||
<a href="#definition-ClusterIdentity"> ClusterIdentity </a>
|
||
<a href="#definition-ClusterInput"> ClusterInput </a>
|
||
<a href="#definition-CreateMyHub"> CreateMyHub </a>
|
||
<a href="#definition-CreateUserInput"> CreateUserInput </a>
|
||
<a href="#definition-ExperimentInput"> ExperimentInput </a>
|
||
<a href="#definition-Experiments"> Experiments </a>
|
||
<a href="#definition-Float"> Float </a>
|
||
<a href="#definition-ID"> ID </a>
|
||
<a href="#definition-Int"> Int </a>
|
||
<a href="#definition-Link"> Link </a>
|
||
<a href="#definition-Maintainer"> Maintainer </a>
|
||
<a href="#definition-Member"> Member </a>
|
||
<a href="#definition-MemberInput"> MemberInput </a>
|
||
<a href="#definition-MemberRole"> MemberRole </a>
|
||
<a href="#definition-Metadata"> Metadata </a>
|
||
<a href="#definition-MyHub"> MyHub </a>
|
||
<a href="#definition-MyHubStatus"> MyHubStatus </a>
|
||
<a href="#definition-PackageInformation"> PackageInformation </a>
|
||
<a href="#definition-PodLog"> PodLog </a>
|
||
<a href="#definition-PodLogRequest"> PodLogRequest </a>
|
||
<a href="#definition-PodLogResponse"> PodLogResponse </a>
|
||
<a href="#definition-Project"> Project </a>
|
||
<a href="#definition-Provider"> Provider </a>
|
||
<a href="#definition-ScheduledWorkflows"> ScheduledWorkflows </a>
|
||
<a href="#definition-Spec"> Spec </a>
|
||
<a href="#definition-String"> String </a>
|
||
<a href="#definition-Subscription"> Subscription </a>
|
||
<a href="#definition-UpdateUserInput"> UpdateUserInput </a>
|
||
<a href="#definition-User"> User </a>
|
||
<a href="#definition-WeightagesInput"> WeightagesInput </a>
|
||
<a href="#definition-Workflow"> Workflow </a>
|
||
<a href="#definition-WorkflowRun"> WorkflowRun </a>
|
||
<a href="#definition-WorkflowRunInput"> WorkflowRunInput </a>
|
||
<a href="#definition-WorkflowRuns"> WorkflowRuns </a>
|
||
<a href="#definition-clusterRegResponse"> clusterRegResponse </a>
|
||
<a href="#definition-weightages"> weightages </a>
|
||
</nav>
|
||
</div>
|
||
<div id="docs" class="row collapse expanded drawer" data-drawer>
|
||
<button class="floating-menu-icon" type="button" data-drawer-slide="right">
|
||
<span class="hamburger"></span>
|
||
</button>
|
||
<div class="example-box doc-content"></div>
|
||
<article>
|
||
<h1 class="doc-title">Litmus API Documentation
|
||
<span>API Reference</span>
|
||
</h1>
|
||
<div id="introduction" data-traverse-target="introduction">
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<p>Litmus Portal provides console and UI experience for managing, monitoring, and events around chaos workflows. Chaos workflows consist of a sequence of experiments run together to achieve the objective of introducing some kind of fault into an application or the Kubernetes platform.</p>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>API Endpoints</h5>
|
||
<!-- <div class="hljs"> --><pre><code>Dev:
|
||
http://localhost:8080
|
||
Prod:
|
||
http://localhost:8080/query
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="authentication" data-traverse-target="authentication">Authentication</h1>
|
||
<div class="tag-description doc-row">
|
||
<div class="doc-copy">
|
||
<p>
|
||
Litmus Portal API uses API keys to authenticate requests. API keys carry many privileges, so be sure to keep them secure! Do not share the API key in publicly accessible areas such as GitHub, client-side code and so forth. <br/>
|
||
Authentication to the API is performed via HTTP Basic Auth. Provide your username and password to generate a JWT token and set that token in the header of the API. <br/><br/>
|
||
All API requests must be made over HTTP or HTTPS. API requests without authentication will also fail.
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<div id="security-definition-api_key" class="panel">
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<h3 class="security-definition-title">
|
||
<span class="security-name">API KEYS</span>
|
||
<span class="swagger-security-definition-apiKey"></span>
|
||
</h3>
|
||
<section class="swagger-security-definition-properties">
|
||
<div class="prop-row security-definition-property">
|
||
<div class="prop-name">
|
||
<div class="prop-title security-definition-property-name">name</div>
|
||
</div>
|
||
<div class="prop-value security-definition-property-type"> Authorization </div>
|
||
</div>
|
||
<div class="prop-row security-definition-property">
|
||
<div class="prop-name">
|
||
<div class="prop-title security-definition-property-name">in</div>
|
||
</div>
|
||
<div class="prop-value security-definition-property-type"> header </div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request to generate API KEYS</h5>
|
||
<pre><code>curl -H 'Content-Type: application/json' -X POST --data '{"username": "admin", "password": "litmus"}' http://localhost:3000/login </code></pre>
|
||
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<h1 id="tag-Cluster" class="swagger-summary-tag" data-traverse-target="tag-Cluster">Cluster</h1>
|
||
<div class="tag-description doc-row">
|
||
<div class="doc-copy">
|
||
<p>Litmus Portal gives the ability to run chaos on remote Kubernetes cluster. Self cluster is automatically getting connected after submitting the welcome model. To connect an external cluster, use the following APIs for cluster operations.
|
||
<br/> User can access connected clusters via
|
||
<b>targets</b> page of Litmus Portal.</p>
|
||
</div>
|
||
</div>
|
||
<div id="operation-register_cluster-post" class="operation panel" data-traverse-target="operation-register_cluster-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Cluster">Cluster</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Register Cluster</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>User can make requests to connect their kubernetes cluster and get a token as response, that token can be used to get the subscriber manifest which needs to apply in their cluster.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>platform_name</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>cluster_type</td>
|
||
<td>external/internal</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>agent_namespace</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>serviceaccount</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>agent_scope</td>
|
||
<td>cluster/namespace</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>agent_ns_exists</td>
|
||
<td>true/false</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>agent_sa_exists</td>
|
||
<td>true/false</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"cluster_name"</b>: "Litmus-cluster",
|
||
<br/>
|
||
<b>"description"</b>: "New Litmus Portal Cluster",
|
||
<br/>
|
||
<b>"platform_name"</b>: "AWS",
|
||
<br/>
|
||
<b>"project_id"</b>: "5fd7d9212c9f32447e28317b",
|
||
<br/>
|
||
<b>"cluster_type"</b>: "external",
|
||
<br/>
|
||
<b>"agent_namespace"</b>: "",
|
||
<br/>
|
||
<b>"agent_namespace"</b>: "",
|
||
<br/>
|
||
<b>"agent_scope"</b>: cluster,
|
||
<br/>
|
||
<b>"agent_ns_exists"</b>: false,
|
||
<br/>
|
||
<b>"agent_sa_exists"</b>: false, </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">clusterInput:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ClusterInput">ClusterInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">mutation</span> userClusterReg<span class="hljs-tag">(<span class="hljs-code">$clusterInput</span>:<span class="hljs-type"> ClusterInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">userClusterReg<span class="hljs-tag">(clusterInput: <span class="hljs-code">$clusterInput</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">token</span>
|
||
<span class="hljs-symbol">cluster_id</span>
|
||
<span class="hljs-symbol">cluster_name</span>
|
||
}</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"clusterInput"</span>: {
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"platform_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"serviceaccount"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_scope"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_ns_exists"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"agent_sa_exists"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20userClusterReg(%24clusterInput%3A%20ClusterInput!)%7B%0A%20%20userClusterReg(clusterInput%3A%20%24clusterInput)%7B%0A%20%20%20%20token%0A%20%20%20%20cluster_id%0A%20%20%20%20cluster_name%0A%20%20%7D%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/clusterRegResponse">clusterRegResponse</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"userClusterReg"</span>: {
|
||
<span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-list_cluster-post" class="operation panel" data-traverse-target="operation-list_cluster-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Cluster">Cluster</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">List Cluster</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Returns a list of cluster with Litmus Portal. It includes pending, active and inactive clusters.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>cluster_type</td>
|
||
<td>external/internal</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"project_id"</b>: "5fd7d9212c9f32447e28317b",
|
||
<br/>
|
||
<b>"cluster_type"</b>: "external",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">project_id:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">cluster_type:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> getCluster<span class="hljs-tag">(<span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$cluster_type</span>:<span class="hljs-type"> String)</span>{
|
||
getCluster(project_id: <span class="hljs-code">$project_id</span>, cluster_type: <span class="hljs-code">$cluster_type</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">cluster_id</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">cluster_name</span>
|
||
<span class="hljs-symbol">description</span>
|
||
<span class="hljs-symbol">platform_name</span>
|
||
<span class="hljs-symbol">access_key</span>
|
||
<span class="hljs-symbol">is_registered</span>
|
||
<span class="hljs-symbol">is_cluster_confirmed</span>
|
||
<span class="hljs-symbol">is_active</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">cluster_type</span>
|
||
<span class="hljs-symbol">no_of_schedules</span>
|
||
<span class="hljs-symbol">no_of_workflows</span>
|
||
<span class="hljs-symbol">token</span>
|
||
<span class="hljs-symbol">agent_namespace</span>
|
||
<span class="hljs-symbol">serviceaccount</span>
|
||
<span class="hljs-symbol">agent_scope</span>
|
||
<span class="hljs-symbol">agent_ns_exists</span>
|
||
<span class="hljs-symbol">agent_sa_exists</span>
|
||
}</span></span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_type"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20getCluster(%24project_id%3A%20String!%2C%20%24cluster_type%3A%20String)%7B%0A%20%20getCluster(project_id%3A%20%24project_id%2C%20cluster_type%3A%20%24cluster_type)%7B%0A%20%20%20%20cluster_id%0A%20%20%20%20project_id%0A%20%20%20%20cluster_name%0A%20%20%20%20description%0A%20%20%20%20platform_name%0A%20%20%20%20access_key%0A%20%20%20%20is_registered%0A%20%20%20%20is_cluster_confirmed%0A%20%20%20%20is_active%0A%20%20%20%20updated_at%0A%20%20%20%20created_at%0A%20%20%20%20cluster_type%0A%20%20%20%20no_of_schedules%0A%20%20%20%20no_of_workflows%0A%20%20%20%20token%0A%20%20%20%20agent_namespace%0A%20%20%20%20serviceaccount%0A%20%20%20%20agent_scope%0A%20%20%20%20agent_ns_exists%0A%20%20%20%20agent_sa_exists%0A%20%20%7D%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Cluster">Cluster</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"getCluster"</span>: [
|
||
{
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"platform_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_key"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"is_registered"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"is_cluster_confirmed"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"is_active"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"no_of_schedules"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"no_of_workflows"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"serviceaccount"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_scope"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_ns_exists"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"agent_sa_exists"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-delete_cluster-post" class="operation panel" data-traverse-target="operation-delete_cluster-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Cluster">Cluster</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Delete Cluster</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query can be used to delete a cluster from litmus portal. It cannot be undone.
|
||
<br/>
|
||
<b>Note:</b> User can access the details of deleted cluster inside MongoDB, which are being marked as removed.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>cluster_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"cluster_id"</b>: "2df3212c9f32447e28317b",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">cluster_id:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">mutation</span> deleteClusterReg<span class="hljs-tag">(<span class="hljs-code">$cluster_id</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">deleteClusterReg<span class="hljs-tag">(cluster_id: <span class="hljs-code">$cluster_id</span>)</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20deleteClusterReg(%24cluster_id%3A%20String!)%7B%0A%20%20deleteClusterReg(cluster_id%3A%20%24cluster_id)%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"deleteClusterReg"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-ChaosWorkflow" class="swagger-summary-tag" data-traverse-target="tag-ChaosWorkflow">ChaosWorkflow</h1>
|
||
<div class="tag-description doc-row">
|
||
<div class="doc-copy">
|
||
<p>Chaos workflows consist of a sequence of experiments run together to introduce chaos in the Kubernetes platform.
|
||
<br/>
|
||
<b>Note:</b> Target cluster should be in active state before scheduling the workflow</p>
|
||
</div>
|
||
</div>
|
||
<div id="operation-create_chaosworkflow-post" class="operation panel" data-traverse-target="operation-create_chaosworkflow-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosWorkflow">ChaosWorkflow</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Create ChaosWorkflow</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>User can create chaosworkflow easily via the workflow page of the Litmus Portal dashboard. </p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>workflow_manifest</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>cronSyntax</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>workflow_name</td>
|
||
<td>external/internal</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>workflow_description</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>isCustomWorkflow</td>
|
||
<td>true/false</td>
|
||
<td>Madatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td></td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>cluster_id</td>
|
||
<td></td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"workflow_name"</b>: "Pod-networkloss-chaos",
|
||
<br/>
|
||
<b>"workflow_manifest"</b>: "{ apiVersion: v1 ......}",
|
||
<br/>
|
||
<b>"cronSyntax"</b>: "***/2",
|
||
<br/>
|
||
<b>"project_id"</b>: "5fd7d9212c9f32447e28317b",
|
||
<br/>
|
||
<b>"cluster_id"</b>: "3gr3f492146f53d4g3e283re",
|
||
<br/>
|
||
<b>"workflow_description"</b>: "Pod networkloss-experiment",
|
||
<br/>
|
||
<b>"isCustomWorkflow"</b>: false,
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">input:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ChaosWorkFlowInput">ChaosWorkFlowInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">mutation</span> createChaosWorkFlow<span class="hljs-tag">(<span class="hljs-code">$input</span>:<span class="hljs-type"> ChaosWorkFlowInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">createChaosWorkFlow<span class="hljs-tag">(input: <span class="hljs-code">$input</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">workflow_id</span>
|
||
<span class="hljs-symbol">cronSyntax</span>
|
||
<span class="hljs-symbol">workflow_name</span>
|
||
<span class="hljs-symbol">workflow_description</span>
|
||
<span class="hljs-symbol">isCustomWorkflow</span>
|
||
}</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"input"</span>: {
|
||
<span class="hljs-attr">"workflow_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cronSyntax"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"weightages"</span>: [
|
||
{
|
||
<span class="hljs-attr">"experiment_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"weightage"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"isCustomWorkflow"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20createChaosWorkFlow(%24input%3A%20ChaosWorkFlowInput!)%7B%0A%20%20createChaosWorkFlow(input%3A%20%24input)%7B%0A%20%20%20%20workflow_id%0A%20%20%20%20cronSyntax%0A%20%20%20%20workflow_name%0A%20%20%20%20workflow_description%0A%20%20%20%20isCustomWorkflow%0A%20%20%7D%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ChaosWorkFlowResponse">ChaosWorkFlowResponse</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"createChaosWorkFlow"</span>: {
|
||
<span class="hljs-attr">"workflow_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cronSyntax"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isCustomWorkflow"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-list_chaosworkflow-post" class="operation panel" data-traverse-target="operation-list_chaosworkflow-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosWorkflow">ChaosWorkflow</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">List ChaosWorkflow</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Returns a list of chaos workflow and details of particular using a same endpoint. It can fetch both cron and non-cron workflow present in the Litmus Portal.
|
||
<br/> User can get a particular workflow by appending
|
||
<b>workflow_id</b> inside an array of
|
||
<b>workflow_ids</b>, if the array is empty it will return a list of chaos workflow.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>workflow_ids</td>
|
||
<td>[]</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"project_id"</b>: "5fd7d9212c9f32447e28317b",
|
||
<br/>
|
||
<b>"workflow_ids"</b>: ["3gr3f492146f53d4g3e283re"],
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">project_id:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">workflow_ids:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">string[]</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> ListWorkflow<span class="hljs-tag">(<span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$workflow_ids</span>: [ID])</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">ListWorkflow<span class="hljs-tag">(project_id: <span class="hljs-code">$project_id</span>, workflow_ids: <span class="hljs-code">$workflow_ids</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">workflow_id</span>
|
||
<span class="hljs-symbol">workflow_manifest</span>
|
||
<span class="hljs-symbol">cronSyntax</span>
|
||
<span class="hljs-symbol">cluster_name</span>
|
||
<span class="hljs-symbol">workflow_name</span>
|
||
<span class="hljs-symbol">workflow_description</span>
|
||
<span class="hljs-symbol">isCustomWorkflow</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">cluster_id</span>
|
||
<span class="hljs-symbol">cluster_type</span>
|
||
<span class="hljs-symbol">isRemoved</span>
|
||
}</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_ids"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20ListWorkflow(%24project_id%3A%20String!%2C%20%24workflow_ids%3A%20%5BID%5D)%7B%0A%20%20ListWorkflow(project_id%3A%20%24project_id%2C%20workflow_ids%3A%20%24workflow_ids)%7B%0A%20%20%20%20workflow_id%0A%20%20%20%20workflow_manifest%0A%20%20%20%20cronSyntax%0A%20%20%20%20cluster_name%0A%20%20%20%20workflow_name%0A%20%20%20%20workflow_description%0A%20%20%20%20isCustomWorkflow%0A%20%20%20%20updated_at%0A%20%20%20%20created_at%0A%20%20%20%20project_id%0A%20%20%20%20cluster_id%0A%20%20%20%20cluster_type%0A%20%20%20%20isRemoved%0A%20%20%7D%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Workflow">Workflow</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"ListWorkflow"</span>: [
|
||
{
|
||
<span class="hljs-attr">"workflow_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cronSyntax"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isCustomWorkflow"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isRemoved"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-update_chaosworkflow-post" class="operation panel" data-traverse-target="operation-update_chaosworkflow-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosWorkflow">ChaosWorkflow</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Update ChaosWorkflow</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Update the specified chaos workflow by setting the values of the parameters passed. Any parameters not provided will change with its empty value.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>workflow_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>cronSyntax</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>workflow_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>workflow_description</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>isCustomWorkflow</td>
|
||
<td>true/false</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"workflow_id"</b>: "5fd7d9212c9f32447e28317b",
|
||
<br/>
|
||
<b>"cronSyntax"</b>: "****",
|
||
<br/>
|
||
<b>"workflow_name"</b>: "New-network-chaos",
|
||
<br/>
|
||
<b>"workflow_description"</b>: "Update Chaos workflow",
|
||
<br/>
|
||
<b>"isCustomWorkflow"</b>: false
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">input:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ChaosWorkFlowInput">ChaosWorkFlowInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">mutation</span> updateChaosWorkflow<span class="hljs-tag">(<span class="hljs-code">$input</span>:<span class="hljs-type"> ChaosWorkFlowInput)</span>{
|
||
updateChaosWorkflow(input: <span class="hljs-code">$input</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">workflow_id</span>
|
||
<span class="hljs-symbol">cronSyntax</span>
|
||
<span class="hljs-symbol">workflow_name</span>
|
||
<span class="hljs-symbol">workflow_description</span>
|
||
<span class="hljs-symbol">isCustomWorkflow</span>
|
||
}</span></span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"input"</span>: {
|
||
<span class="hljs-attr">"workflow_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cronSyntax"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"weightages"</span>: [
|
||
{
|
||
<span class="hljs-attr">"experiment_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"weightage"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"isCustomWorkflow"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20updateChaosWorkflow(%24input%3A%20ChaosWorkFlowInput)%7B%0A%20%20updateChaosWorkflow(input%3A%20%24input)%7B%0A%20%20%20%20workflow_id%0A%20%20%20%20cronSyntax%0A%20%20%20%20workflow_name%0A%20%20%20%20workflow_description%0A%20%20%20%20isCustomWorkflow%0A%20%20%7D%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ChaosWorkFlowResponse">ChaosWorkFlowResponse</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"updateChaosWorkflow"</span>: {
|
||
<span class="hljs-attr">"workflow_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cronSyntax"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isCustomWorkflow"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-delete_chaosworkflow-post" class="operation panel" data-traverse-target="operation-delete_chaosworkflow-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Chaos-Workflow">Chaos Workflow</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Delete ChaosWorkflow</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Delete chaos workflow will permanently delete schedule workflow from the cluster. It cannot be undone.
|
||
<b>Note:</b> User can access the details of deleted workflow inside MongoDB, which are being marked as removed.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>workflowid</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"workflowid"</b>: "2df3212c9f32447e28317b",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">workflowid:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">mutation</span> deleteChaosWorkflow<span class="hljs-tag">(<span class="hljs-code">$workflowid</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">deleteChaosWorkflow<span class="hljs-tag">(workflowid: <span class="hljs-code">$workflowid</span>)</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"workflowid"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20deleteChaosWorkflow(%24workflowid%3A%20String!)%7B%0A%20%20deleteChaosWorkflow(workflowid%3A%20%24workflowid)%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">boolean</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"deleteChaosWorkflow"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-MyHub" class="swagger-summary-tag" data-traverse-target="tag-MyHub">MyHub</h1>
|
||
<div class="tag-description doc-row">
|
||
<div class="doc-copy">
|
||
<p>MyHub constructs workflow from a set of experiments from Chaos Hub or the Git Repo. There is a public hub which get cloned during the installation by default.</p>
|
||
</div>
|
||
</div>
|
||
<div id="operation-add_myhub-post" class="operation panel" data-traverse-target="operation-add_myhub-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-MyHub">MyHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Add Myhub</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>User can add myhub easily via the myhub page of the Litmus Portal dashboard. After adding myhub, it will clone the git repository which has the chaos charts. </p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>RepoURL</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>RepoBranch</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>HubName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"RepoURL"</b>: "https://github.com/litmuschaos/chaos-charts",
|
||
<br/>
|
||
<b>"RepoBranch"</b>: "master",
|
||
<br/>
|
||
<b>"HubName"</b>: "my-chaos-hub",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">myhubInput:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/CreateMyHub">CreateMyHub</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">projectID:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">mutation</span> addMyHub<span class="hljs-tag">(<span class="hljs-code">$myhubInput</span>:<span class="hljs-type"> CreateMyHub!</span>, <span class="hljs-code">$projectID</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">addMyHub<span class="hljs-tag">(myhubInput: <span class="hljs-code">$myhubInput</span>, projectID: <span class="hljs-code">$projectID</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">id</span>
|
||
<span class="hljs-symbol">RepoURL</span>
|
||
<span class="hljs-symbol">RepoBranch</span>
|
||
<span class="hljs-symbol">ProjectID</span>
|
||
<span class="hljs-symbol">HubName</span>
|
||
<span class="hljs-symbol">CreatedAt</span>
|
||
<span class="hljs-symbol">UpdatedAt</span>
|
||
}</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"myhubInput"</span>: {
|
||
<span class="hljs-attr">"HubName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoBranch"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"projectID"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20addMyHub(%24myhubInput%3A%20CreateMyHub!%2C%20%24projectID%3A%20String!)%7B%0A%20%20addMyHub(myhubInput%3A%20%24myhubInput%2C%20projectID%3A%20%24projectID)%7B%0A%20%20%20%20id%0A%20%20%20%20RepoURL%0A%20%20%20%20RepoBranch%0A%20%20%20%20ProjectID%0A%20%20%20%20HubName%0A%20%20%20%20CreatedAt%0A%20%20%20%20UpdatedAt%0A%20%20%7D%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/MyHub">MyHub</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"addMyHub"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoBranch"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ProjectID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"HubName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CreatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UpdatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-list_myhub-post" class="operation panel" data-traverse-target="operation-list_myhub-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-MyHub">MyHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">List MyHub</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Returns a list of myhub connected with Litmus Portal</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>projectID</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"projectID"</b>: "5fd7d9212c9f32447e28317b",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">projectID:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> getHubStatus<span class="hljs-tag">(<span class="hljs-code">$projectID</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">getHubStatus<span class="hljs-tag">(projectID: <span class="hljs-code">$projectID</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">id</span>
|
||
<span class="hljs-symbol">RepoURL</span>
|
||
<span class="hljs-symbol">RepoBranch</span>
|
||
<span class="hljs-symbol">IsAvailable</span>
|
||
<span class="hljs-symbol">TotalExp</span>
|
||
<span class="hljs-symbol">HubName</span>
|
||
}</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"projectID"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20getHubStatus(%24projectID%3A%20String!)%7B%0A%20%20getHubStatus(projectID%3A%20%24projectID)%7B%0A%20%20%20%20id%0A%20%20%20%20RepoURL%0A%20%20%20%20RepoBranch%0A%20%20%20%20IsAvailable%0A%20%20%20%20TotalExp%0A%20%20%20%20HubName%0A%20%20%7D%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/MyHubStatus">MyHubStatus</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"getHubStatus"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoBranch"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"IsAvailable"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"TotalExp"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"HubName"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-sync_myhub-post" class="operation panel" data-traverse-target="operation-sync_myhub-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-MyHub">MyHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Sync MyHub</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Sync hub will pull the latest commits from the git repository. </p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>projectID</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>HubName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"project_id"</b>: "5fd7d9212c9f32447e28317b",
|
||
<br/>
|
||
<b>"HubName"</b>: "my-chaos-hub",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">projectID:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">HubName:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">mutation</span> syncHub<span class="hljs-tag">(<span class="hljs-code">$projectID</span>:<span class="hljs-type"> String!</span>, <span class="hljs-type">$HubName:</span><span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">syncHub<span class="hljs-tag">(projectID: <span class="hljs-code">$projectID</span>,<span class="hljs-type"> HubName:</span> <span class="hljs-type">$HubName)</span>{
|
||
id
|
||
<span class="hljs-type"> RepoURL
|
||
</span> <span class="hljs-type"> RepoBranch
|
||
</span> <span class="hljs-type"> IsAvailable
|
||
</span> <span class="hljs-type"> TotalExp
|
||
</span> <span class="hljs-type"> HubName
|
||
</span> }
|
||
}</span></span></span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"projectID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"HubName"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20syncHub(%24projectID%3A%20String!%2C%20%24HubName%3A%20String!)%7B%0A%20%20syncHub(projectID%3A%20%24projectID%2C%20HubName%3A%20%24HubName)%7B%0A%20%20%20%20id%0A%20%20%20%20RepoURL%0A%20%20%20%20RepoBranch%0A%20%20%20%20IsAvailable%0A%20%20%20%20TotalExp%0A%20%20%20%20HubName%0A%20%20%7D%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/MyHubStatus">MyHubStatus</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"syncHub"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoBranch"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"IsAvailable"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"TotalExp"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"HubName"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-User-Management" class="swagger-summary-tag" data-traverse-target="tag-User-Management">User Management</h1>
|
||
<div class="tag-description doc-row">
|
||
<div class="doc-copy">
|
||
<p>User Management APIs manages user accessibility with Litmus Portal</p>
|
||
</div>
|
||
</div>
|
||
<div id="operation-add_user-post" class="operation panel" data-traverse-target="operation-add_user-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User-Management">User Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Add User</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Admin can add their team members via the user management panel of settings page. After that, user can login with their credentials to litmus portal.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>username</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>email</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>company_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"username"</b>: "litmus-user",
|
||
<br/>
|
||
<b>"email"</b>: "litmuschaos@gmail.com",
|
||
<br/>
|
||
<b>"company_name"</b>: "CNCF",
|
||
<br/>
|
||
<b>"name"</b>: "Litmus User",
|
||
<br/>
|
||
<b>"project_name"</b>: "my-project",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">user:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/CreateUserInput">CreateUserInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">mutation</span> createUser<span class="hljs-tag">(<span class="hljs-code">$user</span>:<span class="hljs-type"> CreateUserInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">createUser<span class="hljs-tag">(user: <span class="hljs-code">$user</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">id</span>
|
||
<span class="hljs-symbol">username</span>
|
||
<span class="hljs-symbol">email</span>
|
||
<span class="hljs-symbol">is_email_verified</span>
|
||
<span class="hljs-symbol">company_name</span>
|
||
<span class="hljs-symbol">name</span>
|
||
<span class="hljs-symbol">role</span>
|
||
<span class="hljs-symbol">state</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">removed_at</span>
|
||
}</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"user"</span>: {
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"company_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20createUser(%24user%3A%20CreateUserInput!)%7B%0A%20%20createUser(user%3A%20%24user)%7B%0A%20%20%20%20id%0A%20%20%20%20username%0A%20%20%20%20email%0A%20%20%20%20is_email_verified%0A%20%20%20%20company_name%0A%20%20%20%20name%0A%20%20%20%20role%0A%20%20%20%20state%0A%20%20%20%20created_at%0A%20%20%20%20updated_at%0A%20%20%20%20removed_at%0A%20%20%7D%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/User">User</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"createUser"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"is_email_verified"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"company_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"removed_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-list_user-post" class="operation panel" data-traverse-target="operation-list_user-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User-Management">User Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">List User</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Returns a list of user within the Litmus Portal</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> users<span class="hljs-tag">{
|
||
<span class="hljs-symbol">users<span class="hljs-tag">{
|
||
<span class="hljs-symbol">id</span>
|
||
<span class="hljs-symbol">username</span>
|
||
<span class="hljs-symbol">email</span>
|
||
<span class="hljs-symbol">is_email_verified</span>
|
||
<span class="hljs-symbol">company_name</span>
|
||
<span class="hljs-symbol">name</span>
|
||
<span class="hljs-symbol">role</span>
|
||
<span class="hljs-symbol">state</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">removed_at</span>
|
||
}</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20users%7B%0A%20%20users%7B%0A%20%20%20%20id%0A%20%20%20%20username%0A%20%20%20%20email%0A%20%20%20%20is_email_verified%0A%20%20%20%20company_name%0A%20%20%20%20name%0A%20%20%20%20role%0A%20%20%20%20state%0A%20%20%20%20created_at%0A%20%20%20%20updated_at%0A%20%20%20%20removed_at%0A%20%20%7D%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/User">User</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"users"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"is_email_verified"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"company_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"removed_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_user-post" class="operation panel" data-traverse-target="operation-get_user-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User-Management">User Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get User</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Returns a specified user within the Litmus Portal</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>username</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"username"</b>: "litmus-user",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">username:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">query</span> getUser<span class="hljs-tag">(<span class="hljs-code">$username</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">getUser<span class="hljs-tag">(username: <span class="hljs-code">$username</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">id</span>
|
||
<span class="hljs-symbol">username</span>
|
||
<span class="hljs-symbol">email</span>
|
||
<span class="hljs-symbol">is_email_verified</span>
|
||
<span class="hljs-symbol">company_name</span>
|
||
<span class="hljs-symbol">name</span>
|
||
<span class="hljs-symbol">role</span>
|
||
<span class="hljs-symbol">state</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">removed_at</span>
|
||
}</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20getUser(%24username%3A%20String!)%7B%0A%20%20getUser(username%3A%20%24username)%7B%0A%20%20%20%20id%0A%20%20%20%20username%0A%20%20%20%20email%0A%20%20%20%20is_email_verified%0A%20%20%20%20company_name%0A%20%20%20%20name%0A%20%20%20%20role%0A%20%20%20%20state%0A%20%20%20%20created_at%0A%20%20%20%20updated_at%0A%20%20%20%20removed_at%0A%20%20%7D%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/User">User</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"getUser"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"is_email_verified"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"company_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"removed_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-update_user-post" class="operation panel" data-traverse-target="operation-update_user-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User-Management">User Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Update User</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>User can update its details details by providing the following parameters:</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>email</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>company_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"id"</b>: "5fd7d9212c9f32447e28317b",
|
||
<br/>
|
||
<b>"name"</b>: "litmus-user",
|
||
<br/>
|
||
<b>"email"</b>: "litmususer@yahoo.com",
|
||
<br/>
|
||
<b>"company_name"</b>: "CNCF",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">user:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/UpdateUserInput">UpdateUserInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol">muatation updateUser<span class="hljs-tag">(<span class="hljs-code">$user</span>:<span class="hljs-type"> UpdateUserInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">updateUser<span class="hljs-tag">(user: <span class="hljs-code">$user</span>)</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"user"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"company_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=muatation%20updateUser(%24user%3A%20UpdateUserInput!)%7B%0A%20%20updateUser(user%3A%20%24user)%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"updateUser"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-send_invitation-post" class="operation panel" data-traverse-target="operation-send_invitation-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User-Management">User Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Send Invitation</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Admin can invite registered user to their project and assign them with viewer or editor access. Following are the parameters for this mutation:</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>role</td>
|
||
<td>Viewer/Editor</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"project_id"</b>: "5fd7d9212c9f32447e28317b",
|
||
<br/>
|
||
<b>"username"</b>: "litmus-user",
|
||
<br/>
|
||
<b>"role"</b>: "Editor",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">member:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/MemberInput">MemberInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">mutation</span> sendInvitation<span class="hljs-tag">(<span class="hljs-code">$member</span>:<span class="hljs-type"> MemberInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">sendInvitation<span class="hljs-tag">(member: <span class="hljs-code">$member</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">user_id</span>
|
||
<span class="hljs-symbol">user_name</span>
|
||
<span class="hljs-symbol">name</span>
|
||
<span class="hljs-symbol">email</span>
|
||
<span class="hljs-symbol">role</span>
|
||
<span class="hljs-symbol">invitation</span>
|
||
<span class="hljs-symbol">joined_at</span>
|
||
}</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"member"</span>: {
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"user_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20sendInvitation(%24member%3A%20MemberInput!)%7B%0A%20%20sendInvitation(member%3A%20%24member)%7B%0A%20%20%20%20user_id%0A%20%20%20%20user_name%0A%20%20%20%20name%0A%20%20%20%20email%0A%20%20%20%20role%0A%20%20%20%20invitation%0A%20%20%20%20joined_at%0A%20%20%7D%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/Member">Member</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"sendInvitation"</span>: {
|
||
<span class="hljs-attr">"user_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"user_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"invitation"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"joined_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-accept_invitation-post" class="operation panel" data-traverse-target="operation-accept_invitation-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User-Management">User Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Accept Invitation</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>User can accept the invitation by invoking this endpoint.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>role</td>
|
||
<td>Viewer/Editor</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"project_id"</b>: "5fd7d9212c9f32447e28317b",
|
||
<br/>
|
||
<b>"username"</b>: "litmus-user",
|
||
<br/>
|
||
<b>"role"</b>: "Viewer",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">member:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/MemberInput">MemberInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">mutation</span> acceptInvitation<span class="hljs-tag">(<span class="hljs-code">$member</span>:<span class="hljs-type"> MemberInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">acceptInvitation<span class="hljs-tag">(member: <span class="hljs-code">$member</span>)</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"member"</span>: {
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"user_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20acceptInvitation(%24member%3A%20MemberInput!)%7B%0A%20%20acceptInvitation(member%3A%20%24member)%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"acceptInvitation"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-decline_invitation-post" class="operation panel" data-traverse-target="operation-decline_invitation-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User-Management">User Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Decline Invitation</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>User can decline the invitation by invoking this endpoint.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>role</td>
|
||
<td>Viewer/Editor</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"project_id"</b>: "5fd7d9212c9f32447e28317b",
|
||
<br/>
|
||
<b>"username"</b>: "litmus-user",
|
||
<br/>
|
||
<b>"role"</b>: "Viewer",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">member:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/MemberInput">MemberInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">mutation</span> declineInvitation<span class="hljs-tag">(<span class="hljs-code">$member</span>:<span class="hljs-type"> MemberInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">declineInvitation<span class="hljs-tag">(member: <span class="hljs-code">$member</span>)</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"member"</span>: {
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"user_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20declineInvitation(%24member%3A%20MemberInput!)%7B%0A%20%20declineInvitation(member%3A%20%24member)%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"declineInvitation"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-remove_invitation-post" class="operation panel" data-traverse-target="operation-remove_invitation-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-User-Management">User Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Remove Invitation</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>User can remove the invitation by invoking this endpoint.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>role</td>
|
||
<td>Viewer/Editor</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"project_id"</b>: "5fd7d9212c9f32447e28317b",
|
||
<br/>
|
||
<b>"username"</b>: "litmus-user",
|
||
<br/>
|
||
<b>"role"</b>: "Viewer",
|
||
<br/> </p> } </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body"> </section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">member:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/MemberInput">MemberInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h4>Example</h3>
|
||
<h5>Request Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<h5>Query</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol"><span class="hljs-keyword">mutation</span> declineInvitation<span class="hljs-tag">(<span class="hljs-code">$member</span>:<span class="hljs-type"> MemberInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">declineInvitation<span class="hljs-tag">(member: <span class="hljs-code">$member</span>)</span></span>
|
||
}</span></span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<h5>Variables</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"member"</span>: {
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"user_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20declineInvitation(%24member%3A%20MemberInput!)%7B%0A%20%20declineInvitation(member%3A%20%24member)%0A%7D" target="_blank">Try it now
|
||
<a/> </section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"data"</span>: {
|
||
<span class="hljs-attr">"declineInvitation"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1>Schema Definitions</h1>
|
||
<div id="definition-ActionPayload" class="definition panel" data-traverse-target="definition-ActionPayload">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ActionPayload"></a>ActionPayload: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="request_type">
|
||
<span class="json-property-name">request_type:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="k8s_manifest">
|
||
<span class="json-property-name">k8s_manifest:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="namespace">
|
||
<span class="json-property-name">namespace:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="external_data">
|
||
<span class="json-property-name">external_data:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"request_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"k8s_manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"external_data"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Annotation" class="definition panel" data-traverse-target="definition-Annotation">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Annotation"></a>Annotation: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="Categories">
|
||
<span class="json-property-name">Categories:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Vendor">
|
||
<span class="json-property-name">Vendor:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="CreatedAt">
|
||
<span class="json-property-name">CreatedAt:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Repository">
|
||
<span class="json-property-name">Repository:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Support">
|
||
<span class="json-property-name">Support:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="ChartDescription">
|
||
<span class="json-property-name">ChartDescription:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"Categories"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Vendor"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CreatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Repository"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Support"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ChartDescription"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Boolean" class="definition panel" data-traverse-target="definition-Boolean">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Boolean"></a>Boolean: boolean
|
||
<!-- <span class="json-property-type"><div class="json-property-type">boolean</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-description">
|
||
<p>The <code>Boolean</code> scalar type represents <code>true</code> or <code>false</code>.</p>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol">boolean</span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ChaosWorkFlowInput" class="definition panel" data-traverse-target="definition-ChaosWorkFlowInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ChaosWorkFlowInput"></a>ChaosWorkFlowInput: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="workflow_id">
|
||
<span class="json-property-name">workflow_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_manifest">
|
||
<span class="json-property-name">workflow_manifest:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cronSyntax">
|
||
<span class="json-property-name">cronSyntax:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_name">
|
||
<span class="json-property-name">workflow_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_description">
|
||
<span class="json-property-name">workflow_description:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="weightages">
|
||
<span class="json-property-name">weightages:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/WeightagesInput">WeightagesInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="isCustomWorkflow">
|
||
<span class="json-property-name">isCustomWorkflow:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="project_id">
|
||
<span class="json-property-name">project_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"workflow_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cronSyntax"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"weightages"</span>: [
|
||
{
|
||
<span class="hljs-attr">"experiment_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"weightage"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"isCustomWorkflow"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ChaosWorkFlowResponse" class="definition panel" data-traverse-target="definition-ChaosWorkFlowResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ChaosWorkFlowResponse"></a>ChaosWorkFlowResponse: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="workflow_id">
|
||
<span class="json-property-name">workflow_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cronSyntax">
|
||
<span class="json-property-name">cronSyntax:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_name">
|
||
<span class="json-property-name">workflow_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_description">
|
||
<span class="json-property-name">workflow_description:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="isCustomWorkflow">
|
||
<span class="json-property-name">isCustomWorkflow:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"workflow_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cronSyntax"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isCustomWorkflow"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Chart" class="definition panel" data-traverse-target="definition-Chart">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Chart"></a>Chart: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="ApiVersion">
|
||
<span class="json-property-name">ApiVersion:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Kind">
|
||
<span class="json-property-name">Kind:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Metadata">
|
||
<span class="json-property-name">Metadata:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/Metadata">Metadata</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Spec">
|
||
<span class="json-property-name">Spec:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/Spec">Spec</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="PackageInfo">
|
||
<span class="json-property-name">PackageInfo:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/PackageInformation">PackageInformation</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Experiments">
|
||
<span class="json-property-name">Experiments:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Chart">Chart</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"ApiVersion"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Metadata"</span>: {
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Version"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Annotations"</span>: {
|
||
<span class="hljs-attr">"Categories"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Vendor"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CreatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Repository"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Support"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ChartDescription"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"Spec"</span>: {
|
||
<span class="hljs-attr">"DisplayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CategoryDescription"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Keywords"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"Maturity"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Maintainers"</span>: [
|
||
{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Email"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"MinKubeVersion"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Provider"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Links"</span>: [
|
||
{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Url"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"Experiments"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"ChaosExpCRDLink"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Platforms"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"ChaosType"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"PackageInfo"</span>: {
|
||
<span class="hljs-attr">"PackageName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Experiments"</span>: [
|
||
{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CSV"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Desc"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
},
|
||
<span class="hljs-attr">"Experiments"</span>: [
|
||
{
|
||
<span class="hljs-attr">"ApiVersion"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Metadata"</span>: {
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Version"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Annotations"</span>: {
|
||
<span class="hljs-attr">"Categories"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Vendor"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CreatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Repository"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Charts" class="definition panel" data-traverse-target="definition-Charts">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Charts"></a>Charts: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="Charts">
|
||
<span class="json-property-name">Charts:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Chart">Chart</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"Charts"</span>: [
|
||
{
|
||
<span class="hljs-attr">"ApiVersion"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Metadata"</span>: {
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Version"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Annotations"</span>: {
|
||
<span class="hljs-attr">"Categories"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Vendor"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CreatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Repository"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Support"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ChartDescription"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"Spec"</span>: {
|
||
<span class="hljs-attr">"DisplayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CategoryDescription"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Keywords"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"Maturity"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Maintainers"</span>: [
|
||
{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Email"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"MinKubeVersion"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Provider"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Links"</span>: [
|
||
{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Url"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"Experiments"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"ChaosExpCRDLink"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Platforms"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"ChaosType"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"PackageInfo"</span>: {
|
||
<span class="hljs-attr">"PackageName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Experiments"</span>: [
|
||
{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CSV"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Desc"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
},
|
||
<span class="hljs-attr">"Experiments"</span>: [
|
||
{
|
||
<span class="hljs-attr">"ApiVersion"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Metadata"</span>: {
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Version"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Annotations"</span>: {
|
||
<span class="hljs-attr">"Categories"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Vendor"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-CloningInput" class="definition panel" data-traverse-target="definition-CloningInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/CloningInput"></a>CloningInput: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="HubName">
|
||
<span class="json-property-name">HubName:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="ProjectID">
|
||
<span class="json-property-name">ProjectID:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="RepoBranch">
|
||
<span class="json-property-name">RepoBranch:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="RepoURL">
|
||
<span class="json-property-name">RepoURL:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"HubName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ProjectID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoBranch"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Cluster" class="definition panel" data-traverse-target="definition-Cluster">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Cluster"></a>Cluster: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="project_id">
|
||
<span class="json-property-name">project_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_name">
|
||
<span class="json-property-name">cluster_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="description">
|
||
<span class="json-property-name">description:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="platform_name">
|
||
<span class="json-property-name">platform_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="access_key">
|
||
<span class="json-property-name">access_key:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="is_registered">
|
||
<span class="json-property-name">is_registered:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="is_cluster_confirmed">
|
||
<span class="json-property-name">is_cluster_confirmed:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="is_active">
|
||
<span class="json-property-name">is_active:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="updated_at">
|
||
<span class="json-property-name">updated_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="created_at">
|
||
<span class="json-property-name">created_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_type">
|
||
<span class="json-property-name">cluster_type:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="no_of_schedules">
|
||
<span class="json-property-name">no_of_schedules:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Int">Int</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="no_of_workflows">
|
||
<span class="json-property-name">no_of_workflows:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Int">Int</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="token">
|
||
<span class="json-property-name">token:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="agent_namespace">
|
||
<span class="json-property-name">agent_namespace:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="serviceaccount">
|
||
<span class="json-property-name">serviceaccount:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="agent_scope">
|
||
<span class="json-property-name">agent_scope:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="agent_ns_exists">
|
||
<span class="json-property-name">agent_ns_exists:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="agent_sa_exists">
|
||
<span class="json-property-name">agent_sa_exists:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"platform_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_key"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"is_registered"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"is_cluster_confirmed"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"is_active"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"no_of_schedules"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"no_of_workflows"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"serviceaccount"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_scope"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_ns_exists"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"agent_sa_exists"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ClusterAction" class="definition panel" data-traverse-target="definition-ClusterAction">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ClusterAction"></a>ClusterAction: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="project_id">
|
||
<span class="json-property-name">project_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="action">
|
||
<span class="json-property-name">action:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ActionPayload">ActionPayload</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"action"</span>: {
|
||
<span class="hljs-attr">"request_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"k8s_manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"external_data"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ClusterActionInput" class="definition panel" data-traverse-target="definition-ClusterActionInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ClusterActionInput"></a>ClusterActionInput: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="action">
|
||
<span class="json-property-name">action:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"action"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ClusterConfirmResponse" class="definition panel" data-traverse-target="definition-ClusterConfirmResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ClusterConfirmResponse"></a>ClusterConfirmResponse: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="isClusterConfirmed">
|
||
<span class="json-property-name">isClusterConfirmed:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="newClusterKey">
|
||
<span class="json-property-name">newClusterKey:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"isClusterConfirmed"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"newClusterKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ClusterEvent" class="definition panel" data-traverse-target="definition-ClusterEvent">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ClusterEvent"></a>ClusterEvent: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="event_id">
|
||
<span class="json-property-name">event_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="event_type">
|
||
<span class="json-property-name">event_type:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="event_name">
|
||
<span class="json-property-name">event_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="description">
|
||
<span class="json-property-name">description:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster">
|
||
<span class="json-property-name">cluster:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/Cluster">Cluster</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"event_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"event_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"event_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster"</span>: {
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"platform_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_key"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"is_registered"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"is_cluster_confirmed"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"is_active"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"no_of_schedules"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"no_of_workflows"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"serviceaccount"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_scope"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_ns_exists"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"agent_sa_exists"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ClusterEventInput" class="definition panel" data-traverse-target="definition-ClusterEventInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ClusterEventInput"></a>ClusterEventInput: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="event_name">
|
||
<span class="json-property-name">event_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="description">
|
||
<span class="json-property-name">description:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="access_key">
|
||
<span class="json-property-name">access_key:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"event_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_key"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ClusterIdentity" class="definition panel" data-traverse-target="definition-ClusterIdentity">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ClusterIdentity"></a>ClusterIdentity: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="access_key">
|
||
<span class="json-property-name">access_key:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_key"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ClusterInput" class="definition panel" data-traverse-target="definition-ClusterInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ClusterInput"></a>ClusterInput: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="cluster_name">
|
||
<span class="json-property-name">cluster_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="description">
|
||
<span class="json-property-name">description:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="platform_name">
|
||
<span class="json-property-name">platform_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="project_id">
|
||
<span class="json-property-name">project_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_type">
|
||
<span class="json-property-name">cluster_type:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="agent_namespace">
|
||
<span class="json-property-name">agent_namespace:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="serviceaccount">
|
||
<span class="json-property-name">serviceaccount:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="agent_scope">
|
||
<span class="json-property-name">agent_scope:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="agent_ns_exists">
|
||
<span class="json-property-name">agent_ns_exists:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="agent_sa_exists">
|
||
<span class="json-property-name">agent_sa_exists:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"platform_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"serviceaccount"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_scope"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_ns_exists"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"agent_sa_exists"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-CreateMyHub" class="definition panel" data-traverse-target="definition-CreateMyHub">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/CreateMyHub"></a>CreateMyHub: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="HubName">
|
||
<span class="json-property-name">HubName:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="RepoURL">
|
||
<span class="json-property-name">RepoURL:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="RepoBranch">
|
||
<span class="json-property-name">RepoBranch:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"HubName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoBranch"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-CreateUserInput" class="definition panel" data-traverse-target="definition-CreateUserInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/CreateUserInput"></a>CreateUserInput: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="username">
|
||
<span class="json-property-name">username:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="email">
|
||
<span class="json-property-name">email:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="company_name">
|
||
<span class="json-property-name">company_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="name">
|
||
<span class="json-property-name">name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="project_name">
|
||
<span class="json-property-name">project_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"company_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ExperimentInput" class="definition panel" data-traverse-target="definition-ExperimentInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ExperimentInput"></a>ExperimentInput: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="ProjectID">
|
||
<span class="json-property-name">ProjectID:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="ChartName">
|
||
<span class="json-property-name">ChartName:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="ExperimentName">
|
||
<span class="json-property-name">ExperimentName:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="HubName">
|
||
<span class="json-property-name">HubName:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="FileType">
|
||
<span class="json-property-name">FileType:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"ProjectID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ChartName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ExperimentName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"HubName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"FileType"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Experiments" class="definition panel" data-traverse-target="definition-Experiments">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Experiments"></a>Experiments: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="Name">
|
||
<span class="json-property-name">Name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="CSV">
|
||
<span class="json-property-name">CSV:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Desc">
|
||
<span class="json-property-name">Desc:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CSV"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Desc"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Float" class="definition panel" data-traverse-target="definition-Float">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Float"></a>Float: number
|
||
<!-- <span class="json-property-type"><div class="json-property-type">number</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-description">
|
||
<p>The <code>Float</code> scalar type represents signed double-precision fractional values as specified by
|
||
<a href="http://en.wikipedia.org/wiki/IEEE_floating_point">IEEE 754</a>.</p>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol">number</span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ID" class="definition panel" data-traverse-target="definition-ID">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ID"></a>ID: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-description">
|
||
<p>The <code>ID</code> scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.</p>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol">object</span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Int" class="definition panel" data-traverse-target="definition-Int">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Int"></a>Int: number
|
||
<!-- <span class="json-property-type"><div class="json-property-type">number</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-description">
|
||
<p>The <code>Int</code> scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.</p>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-gql"><span class="hljs-symbol">number</span>
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Link" class="definition panel" data-traverse-target="definition-Link">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Link"></a>Link: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="Name">
|
||
<span class="json-property-name">Name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Url">
|
||
<span class="json-property-name">Url:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Url"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Maintainer" class="definition panel" data-traverse-target="definition-Maintainer">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Maintainer"></a>Maintainer: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="Name">
|
||
<span class="json-property-name">Name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Email">
|
||
<span class="json-property-name">Email:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Email"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Member" class="definition panel" data-traverse-target="definition-Member">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Member"></a>Member: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="user_id">
|
||
<span class="json-property-name">user_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="user_name">
|
||
<span class="json-property-name">user_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="name">
|
||
<span class="json-property-name">name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="email">
|
||
<span class="json-property-name">email:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="role">
|
||
<span class="json-property-name">role:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/MemberRole">MemberRole</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="invitation">
|
||
<span class="json-property-name">invitation:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="joined_at">
|
||
<span class="json-property-name">joined_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"user_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"user_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"invitation"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"joined_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-MemberInput" class="definition panel" data-traverse-target="definition-MemberInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/MemberInput"></a>MemberInput: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="project_id">
|
||
<span class="json-property-name">project_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="user_name">
|
||
<span class="json-property-name">user_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="role">
|
||
<span class="json-property-name">role:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/MemberRole">MemberRole</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"user_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-MemberRole" class="definition panel" data-traverse-target="definition-MemberRole">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/MemberRole"></a>MemberRole: string
|
||
<!-- <span class="json-property-type"><div class="json-property-type"></div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-anyOf">
|
||
<dl>
|
||
<dt>
|
||
<div class="json-property-type">object</div>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">Owner</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd> </dd>
|
||
<dt>
|
||
<div class="json-property-type">object</div>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">Editor</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd> </dd>
|
||
<dt>
|
||
<div class="json-property-type">object</div>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">Viewer</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd> </dd>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Metadata" class="definition panel" data-traverse-target="definition-Metadata">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Metadata"></a>Metadata: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="Name">
|
||
<span class="json-property-name">Name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Version">
|
||
<span class="json-property-name">Version:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Annotations">
|
||
<span class="json-property-name">Annotations:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/Annotation">Annotation</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Version"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Annotations"</span>: {
|
||
<span class="hljs-attr">"Categories"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Vendor"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CreatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Repository"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Support"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ChartDescription"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-MyHub" class="definition panel" data-traverse-target="definition-MyHub">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/MyHub"></a>MyHub: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="RepoURL">
|
||
<span class="json-property-name">RepoURL:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="RepoBranch">
|
||
<span class="json-property-name">RepoBranch:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="ProjectID">
|
||
<span class="json-property-name">ProjectID:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="HubName">
|
||
<span class="json-property-name">HubName:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="CreatedAt">
|
||
<span class="json-property-name">CreatedAt:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="UpdatedAt">
|
||
<span class="json-property-name">UpdatedAt:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoBranch"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ProjectID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"HubName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CreatedAt"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UpdatedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-MyHubStatus" class="definition panel" data-traverse-target="definition-MyHubStatus">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/MyHubStatus"></a>MyHubStatus: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="RepoURL">
|
||
<span class="json-property-name">RepoURL:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="RepoBranch">
|
||
<span class="json-property-name">RepoBranch:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="IsAvailable">
|
||
<span class="json-property-name">IsAvailable:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="TotalExp">
|
||
<span class="json-property-name">TotalExp:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="HubName">
|
||
<span class="json-property-name">HubName:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoBranch"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"IsAvailable"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"TotalExp"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"HubName"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-PackageInformation" class="definition panel" data-traverse-target="definition-PackageInformation">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/PackageInformation"></a>PackageInformation: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="PackageName">
|
||
<span class="json-property-name">PackageName:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Experiments">
|
||
<span class="json-property-name">Experiments:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Experiments">Experiments</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"PackageName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Experiments"</span>: [
|
||
{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CSV"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Desc"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-PodLog" class="definition panel" data-traverse-target="definition-PodLog">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/PodLog"></a>PodLog: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ClusterIdentity">ClusterIdentity</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="request_id">
|
||
<span class="json-property-name">request_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_run_id">
|
||
<span class="json-property-name">workflow_run_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="pod_name">
|
||
<span class="json-property-name">pod_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="pod_type">
|
||
<span class="json-property-name">pod_type:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="log">
|
||
<span class="json-property-name">log:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"cluster_id"</span>: {
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_key"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"request_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"workflow_run_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"pod_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"pod_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"log"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-PodLogRequest" class="definition panel" data-traverse-target="definition-PodLogRequest">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/PodLogRequest"></a>PodLogRequest: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_run_id">
|
||
<span class="json-property-name">workflow_run_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="pod_name">
|
||
<span class="json-property-name">pod_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="pod_namespace">
|
||
<span class="json-property-name">pod_namespace:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="pod_type">
|
||
<span class="json-property-name">pod_type:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="exp_pod">
|
||
<span class="json-property-name">exp_pod:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="runner_pod">
|
||
<span class="json-property-name">runner_pod:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="chaos_namespace">
|
||
<span class="json-property-name">chaos_namespace:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"workflow_run_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"pod_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"pod_namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"pod_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"exp_pod"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"runner_pod"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_namespace"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-PodLogResponse" class="definition panel" data-traverse-target="definition-PodLogResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/PodLogResponse"></a>PodLogResponse: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="workflow_run_id">
|
||
<span class="json-property-name">workflow_run_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="pod_name">
|
||
<span class="json-property-name">pod_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="pod_type">
|
||
<span class="json-property-name">pod_type:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="log">
|
||
<span class="json-property-name">log:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"workflow_run_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"pod_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"pod_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"log"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Project" class="definition panel" data-traverse-target="definition-Project">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Project"></a>Project: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="name">
|
||
<span class="json-property-name">name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="members">
|
||
<span class="json-property-name">members:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Member">Member</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="state">
|
||
<span class="json-property-name">state:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="created_at">
|
||
<span class="json-property-name">created_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="updated_at">
|
||
<span class="json-property-name">updated_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="removed_at">
|
||
<span class="json-property-name">removed_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"members"</span>: [
|
||
{
|
||
<span class="hljs-attr">"user_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"user_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"invitation"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"joined_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"removed_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Provider" class="definition panel" data-traverse-target="definition-Provider">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Provider"></a>Provider: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="Name">
|
||
<span class="json-property-name">Name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ScheduledWorkflows" class="definition panel" data-traverse-target="definition-ScheduledWorkflows">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ScheduledWorkflows"></a>ScheduledWorkflows: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="workflow_id">
|
||
<span class="json-property-name">workflow_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_manifest">
|
||
<span class="json-property-name">workflow_manifest:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cronSyntax">
|
||
<span class="json-property-name">cronSyntax:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_name">
|
||
<span class="json-property-name">cluster_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_name">
|
||
<span class="json-property-name">workflow_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_description">
|
||
<span class="json-property-name">workflow_description:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="weightages">
|
||
<span class="json-property-name">weightages:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/weightages">weightages</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="isCustomWorkflow">
|
||
<span class="json-property-name">isCustomWorkflow:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="updated_at">
|
||
<span class="json-property-name">updated_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="created_at">
|
||
<span class="json-property-name">created_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="project_id">
|
||
<span class="json-property-name">project_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_type">
|
||
<span class="json-property-name">cluster_type:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="isRemoved">
|
||
<span class="json-property-name">isRemoved:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"workflow_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cronSyntax"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"weightages"</span>: [
|
||
{
|
||
<span class="hljs-attr">"experiment_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"weightage"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"isCustomWorkflow"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isRemoved"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Spec" class="definition panel" data-traverse-target="definition-Spec">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Spec"></a>Spec: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="DisplayName">
|
||
<span class="json-property-name">DisplayName:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="CategoryDescription">
|
||
<span class="json-property-name">CategoryDescription:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Keywords">
|
||
<span class="json-property-name">Keywords:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="Maturity">
|
||
<span class="json-property-name">Maturity:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Maintainers">
|
||
<span class="json-property-name">Maintainers:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Maintainer">Maintainer</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="MinKubeVersion">
|
||
<span class="json-property-name">MinKubeVersion:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Provider">
|
||
<span class="json-property-name">Provider:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Links">
|
||
<span class="json-property-name">Links:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Link">Link</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="Experiments">
|
||
<span class="json-property-name">Experiments:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="ChaosExpCRDLink">
|
||
<span class="json-property-name">ChaosExpCRDLink:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Platforms">
|
||
<span class="json-property-name">Platforms:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="ChaosType">
|
||
<span class="json-property-name">ChaosType:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"DisplayName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"CategoryDescription"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Keywords"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"Maturity"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Maintainers"</span>: [
|
||
{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Email"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"MinKubeVersion"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Provider"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Links"</span>: [
|
||
{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Url"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"Experiments"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"ChaosExpCRDLink"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Platforms"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"ChaosType"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-String" class="definition panel" data-traverse-target="definition-String">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/String"></a>String: string
|
||
<!-- <span class="json-property-type"><div class="json-property-type">string</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-description">
|
||
<p>The <code>String</code>scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Subscription" class="definition panel" data-traverse-target="definition-Subscription">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Subscription"></a>Subscription: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="clusterEventListener">
|
||
<span class="json-property-name">clusterEventListener:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ClusterEvent">ClusterEvent</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflowEventListener">
|
||
<span class="json-property-name">workflowEventListener:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowRun">WorkflowRun</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="getPodLog">
|
||
<span class="json-property-name">getPodLog:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/PodLogResponse">PodLogResponse</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="clusterConnect">
|
||
<span class="json-property-name">clusterConnect:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ClusterAction">ClusterAction</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"clusterEventListener"</span>: {
|
||
<span class="hljs-attr">"event_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"event_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"event_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster"</span>: {
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"platform_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_key"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"is_registered"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"is_cluster_confirmed"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"is_active"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"no_of_schedules"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"no_of_workflows"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"serviceaccount"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_scope"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"agent_ns_exists"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"agent_sa_exists"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
},
|
||
<span class="hljs-attr">"workflowEventListener"</span>: {
|
||
<span class="hljs-attr">"workflow_run_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"workflow_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"last_updated"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"workflow_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"execution_data"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"getPodLog"</span>: {
|
||
<span class="hljs-attr">"workflow_run_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"pod_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"pod_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"log"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"clusterConnect"</span>: {
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"action"</span>: {
|
||
<span class="hljs-attr">"request_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"k8s_manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"external_data"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-UpdateUserInput" class="definition panel" data-traverse-target="definition-UpdateUserInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/UpdateUserInput"></a>UpdateUserInput: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="name">
|
||
<span class="json-property-name">name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="email">
|
||
<span class="json-property-name">email:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="company_name">
|
||
<span class="json-property-name">company_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"company_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-User" class="definition panel" data-traverse-target="definition-User">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/User"></a>User: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="username">
|
||
<span class="json-property-name">username:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="email">
|
||
<span class="json-property-name">email:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="is_email_verified">
|
||
<span class="json-property-name">is_email_verified:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="company_name">
|
||
<span class="json-property-name">company_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="name">
|
||
<span class="json-property-name">name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="projects">
|
||
<span class="json-property-name">projects:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Project">Project</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="role">
|
||
<span class="json-property-name">role:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="state">
|
||
<span class="json-property-name">state:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="created_at">
|
||
<span class="json-property-name">created_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="updated_at">
|
||
<span class="json-property-name">updated_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="removed_at">
|
||
<span class="json-property-name">removed_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"is_email_verified"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"company_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"projects"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"members"</span>: [
|
||
{
|
||
<span class="hljs-attr">"user_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"user_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"invitation"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"joined_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"removed_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"role"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"state"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"removed_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WeightagesInput" class="definition panel" data-traverse-target="definition-WeightagesInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WeightagesInput"></a>WeightagesInput: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="experiment_name">
|
||
<span class="json-property-name">experiment_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="weightage">
|
||
<span class="json-property-name">weightage:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Int">Int</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"experiment_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"weightage"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Workflow" class="definition panel" data-traverse-target="definition-Workflow">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Workflow"></a>Workflow: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="workflow_id">
|
||
<span class="json-property-name">workflow_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_manifest">
|
||
<span class="json-property-name">workflow_manifest:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cronSyntax">
|
||
<span class="json-property-name">cronSyntax:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_name">
|
||
<span class="json-property-name">cluster_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_name">
|
||
<span class="json-property-name">workflow_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_description">
|
||
<span class="json-property-name">workflow_description:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="weightages">
|
||
<span class="json-property-name">weightages:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/weightages">weightages</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="isCustomWorkflow">
|
||
<span class="json-property-name">isCustomWorkflow:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="updated_at">
|
||
<span class="json-property-name">updated_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="created_at">
|
||
<span class="json-property-name">created_at:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="project_id">
|
||
<span class="json-property-name">project_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_type">
|
||
<span class="json-property-name">cluster_type:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="isRemoved">
|
||
<span class="json-property-name">isRemoved:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_runs">
|
||
<span class="json-property-name">workflow_runs:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowRuns">WorkflowRuns</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"workflow_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cronSyntax"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"weightages"</span>: [
|
||
{
|
||
<span class="hljs-attr">"experiment_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"weightage"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"isCustomWorkflow"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"updated_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isRemoved"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"workflow_runs"</span>: [
|
||
{
|
||
<span class="hljs-attr">"execution_data"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_run_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"last_updated"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowRun" class="definition panel" data-traverse-target="definition-WorkflowRun">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowRun"></a>WorkflowRun: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="workflow_run_id">
|
||
<span class="json-property-name">workflow_run_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_id">
|
||
<span class="json-property-name">workflow_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_name">
|
||
<span class="json-property-name">cluster_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="last_updated">
|
||
<span class="json-property-name">last_updated:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="project_id">
|
||
<span class="json-property-name">project_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_name">
|
||
<span class="json-property-name">workflow_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_type">
|
||
<span class="json-property-name">cluster_type:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="execution_data">
|
||
<span class="json-property-name">execution_data:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"workflow_run_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"workflow_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"last_updated"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"workflow_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"execution_data"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowRunInput" class="definition panel" data-traverse-target="definition-WorkflowRunInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowRunInput"></a>WorkflowRunInput: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="workflow_id">
|
||
<span class="json-property-name">workflow_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_run_id">
|
||
<span class="json-property-name">workflow_run_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_name">
|
||
<span class="json-property-name">workflow_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="execution_data">
|
||
<span class="json-property-name">execution_data:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ClusterIdentity">ClusterIdentity</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="completed">
|
||
<span class="json-property-name">completed:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-boolean">
|
||
<a class="json-schema-ref" href="#/definitions/Boolean">Boolean</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"workflow_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"workflow_run_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"workflow_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"execution_data"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: {
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_key"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"completed"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowRuns" class="definition panel" data-traverse-target="definition-WorkflowRuns">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowRuns"></a>WorkflowRuns: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="execution_data">
|
||
<span class="json-property-name">execution_data:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_run_id">
|
||
<span class="json-property-name">workflow_run_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="last_updated">
|
||
<span class="json-property-name">last_updated:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"execution_data"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"workflow_run_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"last_updated"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-clusterRegResponse" class="definition panel" data-traverse-target="definition-clusterRegResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/clusterRegResponse"></a>clusterRegResponse: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="token">
|
||
<span class="json-property-name">token:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_id">
|
||
<span class="json-property-name">cluster_id:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="cluster_name">
|
||
<span class="json-property-name">cluster_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-weightages" class="definition panel" data-traverse-target="definition-weightages">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/weightages"></a>weightages: object
|
||
<!-- <span class="json-property-type"><div class="json-property-type">object</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="experiment_name">
|
||
<span class="json-property-name">experiment_name:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-string">
|
||
<a class="json-schema-ref" href="#/definitions/String">String</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="weightage">
|
||
<span class="json-property-name">weightage:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Int">Int</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> -->
|
||
<html>
|
||
<head></head>
|
||
<body><pre><code class="hljs language-json">{
|
||
<span class="hljs-attr">"experiment_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"weightage"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row no-margin">
|
||
<div class="doc-copy doc-separator">
|
||
<a class="powered-by" href="https://github.com/wayfair/dociql">Documentation by
|
||
<span>DociQL</span>
|
||
</a>
|
||
</div>
|
||
</div>
|
||
</article>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html>
|