22124 lines
1.1 MiB
22124 lines
1.1 MiB
<!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 Portal 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>
|
||
<link rel="icon" type="image/png" href="../logo.png"/>
|
||
</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="../logo.png" title="Litmus Portal API Documentation" /> </div>
|
||
<nav id="nav" role="navigation">
|
||
<h5>Topics</h5>
|
||
<a href="#introduction">Introduction</a>
|
||
<h5>Operations</h5>
|
||
<section>
|
||
<a href="#tag-Cluster">Cluster</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation-list_cluster-post"> List Cluster </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-register_cluster-post"> Register Cluster </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-delete_cluster-post"> Delete Cluster </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-Chaos-Workflow">Chaos Workflow</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation-create_chaosworkflow-post"> Create ChaosWorkflow </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_chaosworkflow_runs-post"> Get ChaosWorkflow Runs </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-list_chaos_workflow-post"> List Chaos Workflow </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-re_run_chaos_workflow-post"> Re Run Chaos Workflow </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-update_chaosworkflow-post"> Update ChaosWorkflow </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-delete_chaosworkflow-post"> Delete ChaosWorkflow </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-save_template-post"> Save Template </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-list_manifest_template-post"> List Manifest Template </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_template_manifest-post"> Get Template Manifest </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-ChaosHub">ChaosHub</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation-add_chaoshub-post"> Add ChaosHub </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-list_chaoshub-post"> List ChaosHub </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-sync_chaoshub-post"> Sync ChaosHub </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-update_hub-post"> Update Hub </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-delete_hub-post"> Delete Hub </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_charts-post"> Get Charts </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_hub_experiments-post"> Get Hub Experiments </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_experiment_yaml-post"> Get Experiment YAML </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_pre-defined_workflow-post"> Get Pre-defined workflow </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_pre-defined_workflow_manifest-post"> Get Pre-defined Workflow Manifest </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>
|
||
<li>
|
||
<a href="#operation-update_user_state-post"> Update User State </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-list_projects-post"> List Projects </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_projects-post"> Get Projects </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-create_project-post"> Create Project </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-update_project_name-post"> Update Project Name </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-leave_project-post"> Leave Project </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-Workflow-Management">Workflow Management</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation-enable_gitops-post"> Enable GitOps </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-disable_gitops-post"> Disable GitOps </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_gitops_details-post"> Get GitOPs Details </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-update_gitops-post"> Update GitOps </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-list_image_regisry-post"> List Image Regisry </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-create_image_registry-post"> Create Image Registry </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_image__registry-post"> Get Image Registry </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-update_image_registry-post"> Update Image Registry </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-delete_image_registry-post"> Delete Image Registry </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-Analytics">Analytics</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation-get_heatmap_data-post"> Get HeatMap Data </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_workflow_stats-post"> Get Workflow Stats </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_workflow_run_stats-post"> Get Workflow Run Stats </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-list_datasource-post"> List DataSource </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_prom_query-post"> Get Prom Query </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_prom_label_names_and_values-post"> Get Prom Label names and values </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-get_prom_series_list-post"> Get Prom Series List </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-list_dashboard-post"> List Dashboard </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-portal_dashboard_data-post"> Portal Dashboard Data </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-create_datasource-post"> Create DataSource </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-create_dashboard-post"> Create Dashboard </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-update_datasource-post"> Update DataSource </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-update_dashboard-post"> Update Dashboard </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-update_panel-post"> Update Panel </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-delete_dashboard-post"> Delete Dashboard </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation-delete_datasource-post"> Delete DataSource </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="https://litmuschaos.github.io/litmus/auth/v2.0.0/api.html" target="_blank">Authentication</a>
|
||
</section>
|
||
<h5>Schema Definitions</h5>
|
||
<a href="#definition-ActionPayload"> ActionPayload </a>
|
||
<a href="#definition-AgentStat"> AgentStat </a>
|
||
<a href="#definition-Annotation"> Annotation </a>
|
||
<a href="#definition-AuthType"> AuthType </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-DSInput"> DSInput </a>
|
||
<a href="#definition-DSResponse"> DSResponse </a>
|
||
<a href="#definition-DateRange"> DateRange </a>
|
||
<a href="#definition-ExperimentInput"> ExperimentInput </a>
|
||
<a href="#definition-Experiments"> Experiments </a>
|
||
<a href="#definition-Float"> Float </a>
|
||
<a href="#definition-GetWorkflowRunsInput"> GetWorkflowRunsInput </a>
|
||
<a href="#definition-GetWorkflowsOutput"> GetWorkflowsOutput </a>
|
||
<a href="#definition-GitConfig"> GitConfig </a>
|
||
<a href="#definition-GitConfigResponse"> GitConfigResponse </a>
|
||
<a href="#definition-HeatmapData"> HeatmapData </a>
|
||
<a href="#definition-ID"> ID </a>
|
||
<a href="#definition-ImageRegistryResponse"> ImageRegistryResponse </a>
|
||
<a href="#definition-Int"> Int </a>
|
||
<a href="#definition-KubeGVRRequest"> KubeGVRRequest </a>
|
||
<a href="#definition-KubeObjectData"> KubeObjectData </a>
|
||
<a href="#definition-KubeObjectRequest"> KubeObjectRequest </a>
|
||
<a href="#definition-KubeObjectResponse"> KubeObjectResponse </a>
|
||
<a href="#definition-Link"> Link </a>
|
||
<a href="#definition-ListWorkflowsInput"> ListWorkflowsInput </a>
|
||
<a href="#definition-ListWorkflowsOutput"> ListWorkflowsOutput </a>
|
||
<a href="#definition-Maintainer"> Maintainer </a>
|
||
<a href="#definition-ManifestTemplate"> ManifestTemplate </a>
|
||
<a href="#definition-Member"> Member </a>
|
||
<a href="#definition-MemberInput"> MemberInput </a>
|
||
<a href="#definition-MemberRole"> MemberRole </a>
|
||
<a href="#definition-MemberStat"> MemberStat </a>
|
||
<a href="#definition-Metadata"> Metadata </a>
|
||
<a href="#definition-MyHub"> MyHub </a>
|
||
<a href="#definition-MyHubStatus"> MyHubStatus </a>
|
||
<a href="#definition-Owner"> Owner </a>
|
||
<a href="#definition-PackageInformation"> PackageInformation </a>
|
||
<a href="#definition-Pagination"> Pagination </a>
|
||
<a href="#definition-PodLog"> PodLog </a>
|
||
<a href="#definition-PodLogRequest"> PodLogRequest </a>
|
||
<a href="#definition-PodLogResponse"> PodLogResponse </a>
|
||
<a href="#definition-PortalDashboardData"> PortalDashboardData </a>
|
||
<a href="#definition-Project"> Project </a>
|
||
<a href="#definition-ProjectData"> ProjectData </a>
|
||
<a href="#definition-Provider"> Provider </a>
|
||
<a href="#definition-SSHKey"> SSHKey </a>
|
||
<a href="#definition-Spec"> Spec </a>
|
||
<a href="#definition-String"> String </a>
|
||
<a href="#definition-Subscription"> Subscription </a>
|
||
<a href="#definition-TemplateInput"> TemplateInput </a>
|
||
<a href="#definition-TimeFrequency"> TimeFrequency </a>
|
||
<a href="#definition-TotalCount"> TotalCount </a>
|
||
<a href="#definition-UpdateMyHub"> UpdateMyHub </a>
|
||
<a href="#definition-UpdateUserInput"> UpdateUserInput </a>
|
||
<a href="#definition-UsageData"> UsageData </a>
|
||
<a href="#definition-UsageQuery"> UsageQuery </a>
|
||
<a href="#definition-UsageSort"> UsageSort </a>
|
||
<a href="#definition-UsageSortInput"> UsageSortInput </a>
|
||
<a href="#definition-User"> User </a>
|
||
<a href="#definition-WeightagesInput"> WeightagesInput </a>
|
||
<a href="#definition-Workflow"> Workflow </a>
|
||
<a href="#definition-WorkflowFilterInput"> WorkflowFilterInput </a>
|
||
<a href="#definition-WorkflowRun"> WorkflowRun </a>
|
||
<a href="#definition-WorkflowRunDetails"> WorkflowRunDetails </a>
|
||
<a href="#definition-WorkflowRunFilterInput"> WorkflowRunFilterInput </a>
|
||
<a href="#definition-WorkflowRunInput"> WorkflowRunInput </a>
|
||
<a href="#definition-WorkflowRunSortInput"> WorkflowRunSortInput </a>
|
||
<a href="#definition-WorkflowRunStatsRequest"> WorkflowRunStatsRequest </a>
|
||
<a href="#definition-WorkflowRunStatsResponse"> WorkflowRunStatsResponse </a>
|
||
<a href="#definition-WorkflowRunStatus"> WorkflowRunStatus </a>
|
||
<a href="#definition-WorkflowRunsData"> WorkflowRunsData </a>
|
||
<a href="#definition-WorkflowSortInput"> WorkflowSortInput </a>
|
||
<a href="#definition-WorkflowSortingField"> WorkflowSortingField </a>
|
||
<a href="#definition-WorkflowStat"> WorkflowStat </a>
|
||
<a href="#definition-WorkflowStats"> WorkflowStats </a>
|
||
<a href="#definition-annotationsPromResponse"> annotationsPromResponse </a>
|
||
<a href="#definition-annotationsTimeStampValue"> annotationsTimeStampValue </a>
|
||
<a href="#definition-applicationMetadata"> applicationMetadata </a>
|
||
<a href="#definition-applicationMetadataResponse"> applicationMetadataResponse </a>
|
||
<a href="#definition-clusterRegResponse"> clusterRegResponse </a>
|
||
<a href="#definition-createDBInput"> createDBInput </a>
|
||
<a href="#definition-dashboardPromResponse"> dashboardPromResponse </a>
|
||
<a href="#definition-dataVars"> dataVars </a>
|
||
<a href="#definition-deleteDSInput"> deleteDSInput </a>
|
||
<a href="#definition-dsDetails"> dsDetails </a>
|
||
<a href="#definition-imageRegistry"> imageRegistry </a>
|
||
<a href="#definition-imageRegistryInput"> imageRegistryInput </a>
|
||
<a href="#definition-labelValue"> labelValue </a>
|
||
<a href="#definition-listDashboardResponse"> listDashboardResponse </a>
|
||
<a href="#definition-metricDataForPanel"> metricDataForPanel </a>
|
||
<a href="#definition-metricDataForPanelGroup"> metricDataForPanelGroup </a>
|
||
<a href="#definition-metricsPromResponse"> metricsPromResponse </a>
|
||
<a href="#definition-metricsTimeStampValue"> metricsTimeStampValue </a>
|
||
<a href="#definition-option"> option </a>
|
||
<a href="#definition-panel"> panel </a>
|
||
<a href="#definition-panelGroup"> panelGroup </a>
|
||
<a href="#definition-panelGroupResponse"> panelGroupResponse </a>
|
||
<a href="#definition-panelOption"> panelOption </a>
|
||
<a href="#definition-panelOptionResponse"> panelOptionResponse </a>
|
||
<a href="#definition-panelResponse"> panelResponse </a>
|
||
<a href="#definition-promInput"> promInput </a>
|
||
<a href="#definition-promQuery"> promQuery </a>
|
||
<a href="#definition-promQueryInput"> promQueryInput </a>
|
||
<a href="#definition-promQueryResponse"> promQueryResponse </a>
|
||
<a href="#definition-promResponse"> promResponse </a>
|
||
<a href="#definition-promSeriesInput"> promSeriesInput </a>
|
||
<a href="#definition-promSeriesListResponse"> promSeriesListResponse </a>
|
||
<a href="#definition-promSeriesResponse"> promSeriesResponse </a>
|
||
<a href="#definition-queryMapForPanel"> queryMapForPanel </a>
|
||
<a href="#definition-queryMapForPanelGroup"> queryMapForPanelGroup </a>
|
||
<a href="#definition-resource"> resource </a>
|
||
<a href="#definition-resourceResponse"> resourceResponse </a>
|
||
<a href="#definition-subData"> subData </a>
|
||
<a href="#definition-updateDBInput"> updateDBInput </a>
|
||
<a href="#definition-updatePanelGroupInput"> updatePanelGroupInput </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 Portal 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="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>agents</b> page of Litmus Portal.</p>
|
||
</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 class="hljs-symbol">last_workflow_timestamp</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%20%20last_workflow_timestamp%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>,
|
||
<span class="hljs-attr">"last_workflow_timestamp"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</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>cluster_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>description</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</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>
|
||
<tr>
|
||
<td>node_selector</td>
|
||
<td>-</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>,
|
||
<span class="hljs-attr">"node_selector"</span>: <span class="hljs-string">"string"</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-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-Chaos-Workflow" class="swagger-summary-tag" data-traverse-target="tag-Chaos-Workflow">Chaos Workflow</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-Chaos-Workflow">Chaos Workflow</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 Chaos Workflow 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_id</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>workflow_manifest</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</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>weightages</td>
|
||
<td>-</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-get_chaosworkflow_runs-post" class="operation panel" data-traverse-target="operation-get_chaosworkflow_runs-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">Get ChaosWorkflow Runs</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. false
|
||
<br/> This query also supports pagination, filtering and sorting of data according to different parameters.</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>
|
||
<tr>
|
||
<td>workflow_run_ids</td>
|
||
<td>[]</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pagination</td>
|
||
<td>{page: "integer", limit:"integer"}</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>sort</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>filter</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
</table>
|
||
</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">workflowRunsInput:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/GetWorkflowRunsInput">GetWorkflowRunsInput</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">query</span> getWorkflowRuns<span class="hljs-tag">(<span class="hljs-code">$workflowRunsInput</span>:<span class="hljs-type"> GetWorkflowRunsInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">getWorkflowRuns<span class="hljs-tag">(workflowRunsInput: <span class="hljs-code">$workflowRunsInput</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">total_no_of_workflow_runs</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">"workflowRunsInput"</span>: {
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"workflow_run_ids"</span>: [
|
||
<span class="hljs-string">"object"</span>
|
||
],
|
||
<span class="hljs-attr">"workflow_ids"</span>: [
|
||
<span class="hljs-string">"object"</span>
|
||
],
|
||
<span class="hljs-attr">"pagination"</span>: {
|
||
<span class="hljs-attr">"page"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"limit"</span>: <span class="hljs-string">"number"</span>
|
||
},
|
||
<span class="hljs-attr">"sort"</span>: {
|
||
<span class="hljs-attr">"field"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"descending"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"filter"</span>: {
|
||
<span class="hljs-attr">"workflow_name"</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_status"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"date_range"</span>: {
|
||
<span class="hljs-attr">"start_date"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end_date"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20getWorkflowRuns(%24workflowRunsInput%3A%20GetWorkflowRunsInput!)%7B%0A%20%20getWorkflowRuns(workflowRunsInput%3A%20%24workflowRunsInput)%7B%0A%20%20%20%20total_no_of_workflow_runs%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/GetWorkflowsOutput">GetWorkflowsOutput</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">"getWorkflowRuns"</span>: {
|
||
<span class="hljs-attr">"total_no_of_workflow_runs"</span>: <span class="hljs-string">"integer"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-list_chaos_workflow-post" class="operation panel" data-traverse-target="operation-list_chaos_workflow-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">List Chaos Workflow</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to get the list of all the scheduled workflows. Individual schedules can also be extracted by providing the
|
||
<b>workflow_ids</b>
|
||
</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>
|
||
<tr>
|
||
<td>pagination</td>
|
||
<td>{page: "integer", limit:"integer"}</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>sort</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>filter</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
</table>
|
||
</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">workflowInput:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ListWorkflowsInput">ListWorkflowsInput</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">query</span> ListWorkflow<span class="hljs-tag">(<span class="hljs-code">$workflowInput</span>:<span class="hljs-type"> ListWorkflowsInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">ListWorkflow<span class="hljs-tag">(workflowInput: <span class="hljs-code">$workflowInput</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">total_no_of_workflows</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">"workflowInput"</span>: {
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"workflow_ids"</span>: [
|
||
<span class="hljs-string">"object"</span>
|
||
],
|
||
<span class="hljs-attr">"pagination"</span>: {
|
||
<span class="hljs-attr">"page"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"limit"</span>: <span class="hljs-string">"number"</span>
|
||
},
|
||
<span class="hljs-attr">"sort"</span>: {
|
||
<span class="hljs-attr">"field"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"descending"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"filter"</span>: {
|
||
<span class="hljs-attr">"workflow_name"</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> -->
|
||
<a href="http://localhost:8080?query=query%20ListWorkflow(%24workflowInput%3A%20ListWorkflowsInput!)%7B%0A%20%20ListWorkflow(workflowInput%3A%20%24workflowInput)%7B%0A%20%20%20%20total_no_of_workflows%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/ListWorkflowsOutput">ListWorkflowsOutput</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">"total_no_of_workflows"</span>: <span class="hljs-string">"integer"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-re_run_chaos_workflow-post" class="operation panel" data-traverse-target="operation-re_run_chaos_workflow-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">Re Run Chaos Workflow</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This API is used to re-run a particular chaos workflow on the basis of
|
||
<b>workflow_id</b>
|
||
</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>workflow_id</td>
|
||
<td>string</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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> reRunChaosWorkFlow<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">reRunChaosWorkFlow<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%20reRunChaosWorkFlow(%24workflowID%3A%20String!)%7B%0A%20%20reRunChaosWorkFlow(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">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">"reRunChaosWorkFlow"</span>: <span class="hljs-string">"string"</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-Chaos-Workflow">Chaos Workflow</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>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">workflow_run_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> deleteChaosWorkflow<span class="hljs-tag">(<span class="hljs-code">$workflowid</span>:<span class="hljs-type"> String,</span> <span class="hljs-code">$workflow_run_id</span>:<span class="hljs-type"> String)</span>{
|
||
deleteChaosWorkflow(workflowid: <span class="hljs-code">$workflowid</span>, workflow_run_id: <span class="hljs-code">$workflow_run_id</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>,
|
||
<span class="hljs-attr">"workflow_run_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20deleteChaosWorkflow(%24workflowid%3A%20String%2C%20%24workflow_run_id%3A%20String)%7B%0A%20%20deleteChaosWorkflow(workflowid%3A%20%24workflowid%2C%20workflow_run_id%3A%20%24workflow_run_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">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>
|
||
<div id="operation-save_template-post" class="operation panel" data-traverse-target="operation-save_template-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">Save Template</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Save a scheduled workflow as a template. Provide a workflow name and description, and use the scheduled manifest as a template.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>isCustomWorkflow</td>
|
||
<td>true/false/td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>manifest</td>
|
||
<td>"kind: CronWorkflow\napiVersion: argoproj.io/v1alpha1\nmetadata:\n name: bank-of-anthos-1626851266\n namespace: litmus\n ....</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>template_name</td>
|
||
<td>new-saved-template</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>template_description</td>
|
||
<td>Demo Description</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">templateInput:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/TemplateInput">TemplateInput</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> createManifestTemplate<span class="hljs-tag">(<span class="hljs-code">$templateInput</span>:<span class="hljs-type"> TemplateInput)</span>{
|
||
createManifestTemplate(templateInput: <span class="hljs-code">$templateInput</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">template_id</span>
|
||
<span class="hljs-symbol">manifest</span>
|
||
<span class="hljs-symbol">template_name</span>
|
||
<span class="hljs-symbol">template_description</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">project_name</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">is_removed</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">"templateInput"</span>: {
|
||
<span class="hljs-attr">"manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"template_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"template_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isCustomWorkflow"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20createManifestTemplate(%24templateInput%3A%20TemplateInput)%7B%0A%20%20createManifestTemplate(templateInput%3A%20%24templateInput)%7B%0A%20%20%20%20template_id%0A%20%20%20%20manifest%0A%20%20%20%20template_name%0A%20%20%20%20template_description%0A%20%20%20%20project_id%0A%20%20%20%20project_name%0A%20%20%20%20created_at%0A%20%20%20%20is_removed%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/ManifestTemplate">ManifestTemplate</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">"createManifestTemplate"</span>: {
|
||
<span class="hljs-attr">"template_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"template_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"template_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"is_removed"</span>: <span class="hljs-string">"boolean"</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_manifest_template-post" class="operation panel" data-traverse-target="operation-list_manifest_template-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">List Manifest Template</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query lists all the available Templates present in a particular project.</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>
|
||
</table>
|
||
</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>
|
||
</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> ListManifestTemplate<span class="hljs-tag">(<span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">ListManifestTemplate<span class="hljs-tag">(project_id: <span class="hljs-code">$project_id</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">template_id</span>
|
||
<span class="hljs-symbol">manifest</span>
|
||
<span class="hljs-symbol">template_name</span>
|
||
<span class="hljs-symbol">template_description</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">project_name</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">is_removed</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">"project_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20ListManifestTemplate(%24project_id%3A%20String!)%7B%0A%20%20ListManifestTemplate(project_id%3A%20%24project_id)%7B%0A%20%20%20%20template_id%0A%20%20%20%20manifest%0A%20%20%20%20template_name%0A%20%20%20%20template_description%0A%20%20%20%20project_id%0A%20%20%20%20project_name%0A%20%20%20%20created_at%0A%20%20%20%20is_removed%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="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/ManifestTemplate">ManifestTemplate</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">"ListManifestTemplate"</span>: [
|
||
{
|
||
<span class="hljs-attr">"template_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"template_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"template_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"is_removed"</span>: <span class="hljs-string">"boolean"</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-get_template_manifest-post" class="operation panel" data-traverse-target="operation-get_template_manifest-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">Get Template Manifest</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query fetches the manifest from a selected template. It takes the
|
||
<b>template_id</b> as an input.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>template_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">template_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">query</span> GetTemplateManifestByID<span class="hljs-tag">(<span class="hljs-code">$template_id</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">GetTemplateManifestByID<span class="hljs-tag">(template_id: <span class="hljs-code">$template_id</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">template_id</span>
|
||
<span class="hljs-symbol">manifest</span>
|
||
<span class="hljs-symbol">template_name</span>
|
||
<span class="hljs-symbol">template_description</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">project_name</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">is_removed</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">"template_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20GetTemplateManifestByID(%24template_id%3A%20String!)%7B%0A%20%20GetTemplateManifestByID(template_id%3A%20%24template_id)%7B%0A%20%20%20%20template_id%0A%20%20%20%20manifest%0A%20%20%20%20template_name%0A%20%20%20%20template_description%0A%20%20%20%20project_id%0A%20%20%20%20project_name%0A%20%20%20%20created_at%0A%20%20%20%20is_removed%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/ManifestTemplate">ManifestTemplate</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">"GetTemplateManifestByID"</span>: {
|
||
<span class="hljs-attr">"template_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"template_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"template_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"is_removed"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"isCustomWorkflow"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-ChaosHub" class="swagger-summary-tag" data-traverse-target="tag-ChaosHub">ChaosHub</h1>
|
||
<div class="tag-description doc-row">
|
||
<div class="doc-copy">
|
||
<p>ChaosHub 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_chaoshub-post" class="operation panel" data-traverse-target="operation-add_chaoshub-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosHub">ChaosHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Add ChaosHub</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>User can add chaoshub easily via the myhub page of the Litmus Portal dashboard. After adding chaoshub, it will clone the git repository which has the chaos charts. You can connect both Public and Private Repositories. For Private Repositories, user can authenticate using Access Token or SSH for cloning the repository.</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>
|
||
<tr>
|
||
<td>IsPrivate</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>AuthType</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Token</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>UserName</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Password</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>SSHPublicKey</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>SSHPrivateKey</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectID</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">IsPrivate</span>
|
||
<span class="hljs-symbol">AuthType</span>
|
||
<span class="hljs-symbol">Token</span>
|
||
<span class="hljs-symbol">UserName</span>
|
||
<span class="hljs-symbol">Password</span>
|
||
<span class="hljs-symbol">SSHPrivateKey</span>
|
||
<span class="hljs-symbol">IsRemoved</span>
|
||
<span class="hljs-symbol">CreatedAt</span>
|
||
<span class="hljs-symbol">UpdatedAt</span>
|
||
<span class="hljs-symbol">LastSyncedAt</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">"IsPrivate"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"AuthType"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPublicKey"</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%20IsPrivate%0A%20%20%20%20AuthType%0A%20%20%20%20Token%0A%20%20%20%20UserName%0A%20%20%20%20Password%0A%20%20%20%20SSHPrivateKey%0A%20%20%20%20IsRemoved%0A%20%20%20%20CreatedAt%0A%20%20%20%20UpdatedAt%0A%20%20%20%20LastSyncedAt%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">"IsPrivate"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"IsRemoved"</span>: <span class="hljs-string">"boolean"</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>,
|
||
<span class="hljs-attr">"LastSyncedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-list_chaoshub-post" class="operation panel" data-traverse-target="operation-list_chaoshub-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosHub">ChaosHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">List ChaosHub</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Returns a list of ChaosHub connected with Litmus Portal along with the status and the total number of experiments.</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 class="hljs-symbol">IsPrivate</span>
|
||
<span class="hljs-symbol">AuthType</span>
|
||
<span class="hljs-symbol">Token</span>
|
||
<span class="hljs-symbol">UserName</span>
|
||
<span class="hljs-symbol">Password</span>
|
||
<span class="hljs-symbol">IsRemoved</span>
|
||
<span class="hljs-symbol">SSHPrivateKey</span>
|
||
<span class="hljs-symbol">SSHPublicKey</span>
|
||
<span class="hljs-symbol">LastSyncedAt</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%20%20IsPrivate%0A%20%20%20%20AuthType%0A%20%20%20%20Token%0A%20%20%20%20UserName%0A%20%20%20%20Password%0A%20%20%20%20IsRemoved%0A%20%20%20%20SSHPrivateKey%0A%20%20%20%20SSHPublicKey%0A%20%20%20%20LastSyncedAt%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>,
|
||
<span class="hljs-attr">"IsPrivate"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"IsRemoved"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPublicKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"LastSyncedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-sync_chaoshub-post" class="operation panel" data-traverse-target="operation-sync_chaoshub-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosHub">ChaosHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Sync ChaosHub</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>id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"id"</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">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> syncHub<span class="hljs-tag">(<span class="hljs-code">$id</span>: ID!)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">syncHub<span class="hljs-tag">(id: <span class="hljs-code">$id</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 class="hljs-symbol">IsPrivate</span>
|
||
<span class="hljs-symbol">AuthType</span>
|
||
<span class="hljs-symbol">Token</span>
|
||
<span class="hljs-symbol">UserName</span>
|
||
<span class="hljs-symbol">Password</span>
|
||
<span class="hljs-symbol">IsRemoved</span>
|
||
<span class="hljs-symbol">SSHPrivateKey</span>
|
||
<span class="hljs-symbol">SSHPublicKey</span>
|
||
<span class="hljs-symbol">LastSyncedAt</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">"id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20syncHub(%24id%3A%20ID!)%7B%0A%20%20syncHub(id%3A%20%24id)%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%20%20IsPrivate%0A%20%20%20%20AuthType%0A%20%20%20%20Token%0A%20%20%20%20UserName%0A%20%20%20%20Password%0A%20%20%20%20IsRemoved%0A%20%20%20%20SSHPrivateKey%0A%20%20%20%20SSHPublicKey%0A%20%20%20%20LastSyncedAt%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>,
|
||
<span class="hljs-attr">"IsPrivate"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"IsRemoved"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPublicKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"LastSyncedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-update_hub-post" class="operation panel" data-traverse-target="operation-update_hub-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosHub">ChaosHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Update Hub</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Update the hub configuration of a ChaosHub</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>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>
|
||
<tr>
|
||
<td>IsPrivate</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>AuthType</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Token</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>UserName</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Password</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>SSHPublicKey</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>SSHPrivateKey</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectID</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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/UpdateMyHub">UpdateMyHub</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> updateMyHub<span class="hljs-tag">(<span class="hljs-code">$myhubInput</span>:<span class="hljs-type"> UpdateMyHub!</span>, <span class="hljs-code">$projectID</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">updateMyHub<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">IsPrivate</span>
|
||
<span class="hljs-symbol">AuthType</span>
|
||
<span class="hljs-symbol">Token</span>
|
||
<span class="hljs-symbol">UserName</span>
|
||
<span class="hljs-symbol">Password</span>
|
||
<span class="hljs-symbol">SSHPrivateKey</span>
|
||
<span class="hljs-symbol">IsRemoved</span>
|
||
<span class="hljs-symbol">CreatedAt</span>
|
||
<span class="hljs-symbol">UpdatedAt</span>
|
||
<span class="hljs-symbol">LastSyncedAt</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">"id"</span>: <span class="hljs-string">"string"</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">"IsPrivate"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"AuthType"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPublicKey"</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%20updateMyHub(%24myhubInput%3A%20UpdateMyHub!%2C%20%24projectID%3A%20String!)%7B%0A%20%20updateMyHub(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%20IsPrivate%0A%20%20%20%20AuthType%0A%20%20%20%20Token%0A%20%20%20%20UserName%0A%20%20%20%20Password%0A%20%20%20%20SSHPrivateKey%0A%20%20%20%20IsRemoved%0A%20%20%20%20CreatedAt%0A%20%20%20%20UpdatedAt%0A%20%20%20%20LastSyncedAt%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">"updateMyHub"</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">"IsPrivate"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"IsRemoved"</span>: <span class="hljs-string">"boolean"</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>,
|
||
<span class="hljs-attr">"LastSyncedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-delete_hub-post" class="operation panel" data-traverse-target="operation-delete_hub-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosHub">ChaosHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Delete Hub</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Delete a ChaosHub from the project</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>hub_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">hub_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> deleteMyHub<span class="hljs-tag">(<span class="hljs-code">$hub_id</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">deleteMyHub<span class="hljs-tag">(hub_id: <span class="hljs-code">$hub_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">"hub_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20deleteMyHub(%24hub_id%3A%20String!)%7B%0A%20%20deleteMyHub(hub_id%3A%20%24hub_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">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">"deleteMyHub"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_charts-post" class="operation panel" data-traverse-target="operation-get_charts-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosHub">ChaosHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get Charts</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Get all the charts from a hub</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>HubName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>projectID</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">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>
|
||
<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> getCharts<span class="hljs-tag">(<span class="hljs-type">$HubName:</span><span class="hljs-type"> String!</span>, <span class="hljs-code">$projectID</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">getCharts<span class="hljs-tag">(HubName: <span class="hljs-type">$HubName,</span> projectID: <span class="hljs-code">$projectID</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">ApiVersion</span>
|
||
<span class="hljs-symbol">Kind</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">"HubName"</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=query%20getCharts(%24HubName%3A%20String!%2C%20%24projectID%3A%20String!)%7B%0A%20%20getCharts(HubName%3A%20%24HubName%2C%20projectID%3A%20%24projectID)%7B%0A%20%20%20%20ApiVersion%0A%20%20%20%20Kind%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/Chart">Chart</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">"getCharts"</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>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_hub_experiments-post" class="operation panel" data-traverse-target="operation-get_hub_experiments-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosHub">ChaosHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get Hub Experiments</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Get the experiment details from a selected chart</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>ChartName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ExperimentName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>HubName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>FileType</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
</table>
|
||
</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">experimentInput:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ExperimentInput">ExperimentInput</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">query</span> getHubExperiment<span class="hljs-tag">(<span class="hljs-code">$experimentInput</span>:<span class="hljs-type"> ExperimentInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">getHubExperiment<span class="hljs-tag">(experimentInput: <span class="hljs-code">$experimentInput</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">ApiVersion</span>
|
||
<span class="hljs-symbol">Kind</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">"experimentInput"</span>: {
|
||
<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> -->
|
||
<a href="http://localhost:8080?query=query%20getHubExperiment(%24experimentInput%3A%20ExperimentInput!)%7B%0A%20%20getHubExperiment(experimentInput%3A%20%24experimentInput)%7B%0A%20%20%20%20ApiVersion%0A%20%20%20%20Kind%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/Chart">Chart</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">"getHubExperiment"</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>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_experiment_yaml-post" class="operation panel" data-traverse-target="operation-get_experiment_yaml-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosHub">ChaosHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get Experiment YAML</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>With this query, user can fetch engine or experiment manifest from a hub.</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>ChartName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ExperimentName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>HubName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>FileType</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
</table>
|
||
</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">experimentInput:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ExperimentInput">ExperimentInput</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">query</span> getYAMLData<span class="hljs-tag">(<span class="hljs-code">$experimentInput</span>:<span class="hljs-type"> ExperimentInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">getYAMLData<span class="hljs-tag">(experimentInput: <span class="hljs-code">$experimentInput</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">"experimentInput"</span>: {
|
||
<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> -->
|
||
<a href="http://localhost:8080?query=query%20getYAMLData(%24experimentInput%3A%20ExperimentInput!)%7B%0A%20%20getYAMLData(experimentInput%3A%20%24experimentInput)%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">"getYAMLData"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_pre-defined_workflow-post" class="operation panel" data-traverse-target="operation-get_pre-defined_workflow-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosHub">ChaosHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get Pre-defined workflow</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>List of all the pre-defined workflows present in a ChaosHub</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>
|
||
</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">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>
|
||
<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> GetPredefinedWorkflowList<span class="hljs-tag">(<span class="hljs-type">$HubName:</span><span class="hljs-type"> String!</span>, <span class="hljs-code">$projectID</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">GetPredefinedWorkflowList<span class="hljs-tag">(HubName: <span class="hljs-type">$HubName,</span> projectID: <span class="hljs-code">$projectID</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">"HubName"</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=query%20GetPredefinedWorkflowList(%24HubName%3A%20String!%2C%20%24projectID%3A%20String!)%7B%0A%20%20GetPredefinedWorkflowList(HubName%3A%20%24HubName%2C%20projectID%3A%20%24projectID)%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">"GetPredefinedWorkflowList"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_pre-defined_workflow_manifest-post" class="operation panel" data-traverse-target="operation-get_pre-defined_workflow_manifest-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-ChaosHub">ChaosHub</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get Pre-defined Workflow Manifest</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>With this query, user can fetch engine or experiment manifest from a hub.</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>ChartName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ExperimentName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>HubName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>FileType</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
</table>
|
||
</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">experimentInput:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/ExperimentInput">ExperimentInput</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">query</span> GetPredefinedExperimentYAML<span class="hljs-tag">(<span class="hljs-code">$experimentInput</span>:<span class="hljs-type"> ExperimentInput!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">GetPredefinedExperimentYAML<span class="hljs-tag">(experimentInput: <span class="hljs-code">$experimentInput</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">"experimentInput"</span>: {
|
||
<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> -->
|
||
<a href="http://localhost:8080?query=query%20GetPredefinedExperimentYAML(%24experimentInput%3A%20ExperimentInput!)%7B%0A%20%20GetPredefinedExperimentYAML(experimentInput%3A%20%24experimentInput)%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">"GetPredefinedExperimentYAML"</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>
|
||
<tr>
|
||
<td>userID</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">created_at</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">deactivated_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">"userID"</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%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%20created_at%0A%20%20%20%20updated_at%0A%20%20%20%20deactivated_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">"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">"deactivated_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">created_at</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">deactivated_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%20created_at%0A%20%20%20%20updated_at%0A%20%20%20%20deactivated_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">"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">"deactivated_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">created_at</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">deactivated_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%20created_at%0A%20%20%20%20updated_at%0A%20%20%20%20deactivated_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">"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">"deactivated_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 class="hljs-symbol">deactivated_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_id"</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%20%20deactivated_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>,
|
||
<span class="hljs-attr">"deactivated_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_id"</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_id"</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_id"</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-update_user_state-post" class="operation panel" data-traverse-target="operation-update_user_state-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 State</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This api is used to update user state to deactivated or activated.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>uid</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>isDeactivate</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">uid:
|
||
<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">isDeactivate:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">boolean</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> updateUserState<span class="hljs-tag">(<span class="hljs-code">$uid</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$isDeactivate</span>:<span class="hljs-type"> Boolean!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">updateUserState<span class="hljs-tag">(uid: <span class="hljs-code">$uid</span>, isDeactivate: <span class="hljs-code">$isDeactivate</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">"uid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"isDeactivate"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20updateUserState(%24uid%3A%20String!%2C%20%24isDeactivate%3A%20Boolean!)%7B%0A%20%20updateUserState(uid%3A%20%24uid%2C%20isDeactivate%3A%20%24isDeactivate)%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">"updateUserState"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-list_projects-post" class="operation panel" data-traverse-target="operation-list_projects-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 Projects</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query returns the list of projects for the logged in user.</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> listProjects<span class="hljs-tag">{
|
||
<span class="hljs-symbol">listProjects<span class="hljs-tag">{
|
||
<span class="hljs-symbol">id</span>
|
||
<span class="hljs-symbol">name</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%20listProjects%7B%0A%20%20listProjects%7B%0A%20%20%20%20id%0A%20%20%20%20name%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/Project">Project</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">"listProjects"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</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_projects-post" class="operation panel" data-traverse-target="operation-get_projects-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 Projects</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query returns project details based on project ID.</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>
|
||
</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> getProject<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">getProject<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">name</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">"projectID"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20getProject(%24projectID%3A%20String!)%7B%0A%20%20getProject(projectID%3A%20%24projectID)%7B%0A%20%20%20%20id%0A%20%20%20%20name%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/Project">Project</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">"getProject"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</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-create_project-post" class="operation panel" data-traverse-target="operation-create_project-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">Create Project</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This api is used to create a new project.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>projectName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">projectName:
|
||
<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> createProject<span class="hljs-tag">(<span class="hljs-code">$projectName</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">createProject<span class="hljs-tag">(projectName: <span class="hljs-code">$projectName</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">id</span>
|
||
<span class="hljs-symbol">name</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">"projectName"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20createProject(%24projectName%3A%20String!)%7B%0A%20%20createProject(projectName%3A%20%24projectName)%7B%0A%20%20%20%20id%0A%20%20%20%20name%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/Project">Project</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">"createProject"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"name"</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_project_name-post" class="operation panel" data-traverse-target="operation-update_project_name-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 Project Name</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This api is used to update the project name.</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>projectName</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">projectName:
|
||
<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> updateProjectName<span class="hljs-tag">(<span class="hljs-code">$projectID</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$projectName</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">updateProjectName<span class="hljs-tag">(projectID: <span class="hljs-code">$projectID</span>, projectName: <span class="hljs-code">$projectName</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">"projectName"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20updateProjectName(%24projectID%3A%20String!%2C%20%24projectName%3A%20String!)%7B%0A%20%20updateProjectName(projectID%3A%20%24projectID%2C%20projectName%3A%20%24projectName)%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">"updateProjectName"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-leave_project-post" class="operation panel" data-traverse-target="operation-leave_project-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">Leave Project</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This api is used to leave a project.</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_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>role</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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> leaveProject<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">leaveProject<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_id"</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%20leaveProject(%24member%3A%20MemberInput!)%7B%0A%20%20leaveProject(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">"leaveProject"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-Workflow-Management" class="swagger-summary-tag" data-traverse-target="tag-Workflow-Management">Workflow Management</h1>
|
||
<div class="tag-description doc-row">
|
||
<div class="doc-copy">
|
||
<p>Workflow Management APIs are used to manage the workflows with GitOPs. These also allow the user to use custom image registries for the chaos workflows.</p>
|
||
</div>
|
||
</div>
|
||
<div id="operation-enable_gitops-post" class="operation panel" data-traverse-target="operation-enable_gitops-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Workflow-Management">Workflow Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Enable GitOps</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to enable gitops functionality</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>Branch</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>RepoURL</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>AuthType</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Token</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>UserName</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Password</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>SSHPrivateKey</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">config:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/GitConfig">GitConfig</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> enableGitOps<span class="hljs-tag">(<span class="hljs-code">$config</span>:<span class="hljs-type"> GitConfig!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">enableGitOps<span class="hljs-tag">(config: <span class="hljs-code">$config</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">"config"</span>: {
|
||
<span class="hljs-attr">"ProjectID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Branch"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"AuthType"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20enableGitOps(%24config%3A%20GitConfig!)%7B%0A%20%20enableGitOps(config%3A%20%24config)%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">"enableGitOps"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-disable_gitops-post" class="operation panel" data-traverse-target="operation-disable_gitops-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Workflow-Management">Workflow Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Disable GitOps</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to disable gitops functionality</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>
|
||
</table>
|
||
</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>
|
||
</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> disableGitOps<span class="hljs-tag">(<span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">disableGitOps<span class="hljs-tag">(project_id: <span class="hljs-code">$project_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">"project_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20disableGitOps(%24project_id%3A%20String!)%7B%0A%20%20disableGitOps(project_id%3A%20%24project_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">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">"disableGitOps"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_gitops_details-post" class="operation panel" data-traverse-target="operation-get_gitops_details-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Workflow-Management">Workflow Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get GitOPs Details</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to get the gitops details and configurations</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>
|
||
</table>
|
||
</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>
|
||
</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> getGitOpsDetails<span class="hljs-tag">(<span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">getGitOpsDetails<span class="hljs-tag">(project_id: <span class="hljs-code">$project_id</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">Enabled</span>
|
||
<span class="hljs-symbol">ProjectID</span>
|
||
<span class="hljs-symbol">Branch</span>
|
||
<span class="hljs-symbol">RepoURL</span>
|
||
<span class="hljs-symbol">AuthType</span>
|
||
<span class="hljs-symbol">Token</span>
|
||
<span class="hljs-symbol">UserName</span>
|
||
<span class="hljs-symbol">Password</span>
|
||
<span class="hljs-symbol">SSHPrivateKey</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>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20getGitOpsDetails(%24project_id%3A%20String!)%7B%0A%20%20getGitOpsDetails(project_id%3A%20%24project_id)%7B%0A%20%20%20%20Enabled%0A%20%20%20%20ProjectID%0A%20%20%20%20Branch%0A%20%20%20%20RepoURL%0A%20%20%20%20AuthType%0A%20%20%20%20Token%0A%20%20%20%20UserName%0A%20%20%20%20Password%0A%20%20%20%20SSHPrivateKey%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/GitConfigResponse">GitConfigResponse</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">"getGitOpsDetails"</span>: {
|
||
<span class="hljs-attr">"Enabled"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"ProjectID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Branch"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-update_gitops-post" class="operation panel" data-traverse-target="operation-update_gitops-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Workflow-Management">Workflow Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Update GitOps</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to update the gitops details and configurations</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>Branch</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>RepoURL</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>AuthType</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Token</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>UserName</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Password</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>SSHPrivateKey</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">config:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/GitConfig">GitConfig</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> updateGitOps<span class="hljs-tag">(<span class="hljs-code">$config</span>:<span class="hljs-type"> GitConfig!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">updateGitOps<span class="hljs-tag">(config: <span class="hljs-code">$config</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">"config"</span>: {
|
||
<span class="hljs-attr">"ProjectID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Branch"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"AuthType"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20updateGitOps(%24config%3A%20GitConfig!)%7B%0A%20%20updateGitOps(config%3A%20%24config)%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">"updateGitOps"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-list_image_regisry-post" class="operation panel" data-traverse-target="operation-list_image_regisry-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Workflow-Management">Workflow Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">List Image Regisry</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to list all the image registries.</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>
|
||
</table>
|
||
</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>
|
||
</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> ListImageRegistry<span class="hljs-tag">(<span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">ListImageRegistry<span class="hljs-tag">(project_id: <span class="hljs-code">$project_id</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">is_default</span>
|
||
<span class="hljs-symbol">image_registry_id</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">is_removed</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>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20ListImageRegistry(%24project_id%3A%20String!)%7B%0A%20%20ListImageRegistry(project_id%3A%20%24project_id)%7B%0A%20%20%20%20is_default%0A%20%20%20%20image_registry_id%0A%20%20%20%20project_id%0A%20%20%20%20updated_at%0A%20%20%20%20created_at%0A%20%20%20%20is_removed%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/ImageRegistryResponse">ImageRegistryResponse</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">"ListImageRegistry"</span>: [
|
||
{
|
||
<span class="hljs-attr">"is_default"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"image_registry_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">"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">"is_removed"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-create_image_registry-post" class="operation panel" data-traverse-target="operation-create_image_registry-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Workflow-Management">Workflow Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Create Image Registry</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to create a new image registry.</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>is_default</td>
|
||
<td>true/false</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>image_registry_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>image_repo_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>image_registry_type</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>secret_name</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>secret_namespace</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>enable_registry</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
</table>
|
||
</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">imageRegistryInfo:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/imageRegistryInput">imageRegistryInput</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> createImageRegistry<span class="hljs-tag">(<span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$imageRegistryInfo</span>: imageRegistryInput!)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">createImageRegistry<span class="hljs-tag">(project_id: <span class="hljs-code">$project_id</span>, imageRegistryInfo: <span class="hljs-code">$imageRegistryInfo</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">is_default</span>
|
||
<span class="hljs-symbol">image_registry_id</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">is_removed</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">"imageRegistryInfo"</span>: {
|
||
<span class="hljs-attr">"is_default"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"image_registry_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"image_repo_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"image_registry_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"secret_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"secret_namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"enable_registry"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20createImageRegistry(%24project_id%3A%20String!%2C%20%24imageRegistryInfo%3A%20imageRegistryInput!)%7B%0A%20%20createImageRegistry(project_id%3A%20%24project_id%2C%20imageRegistryInfo%3A%20%24imageRegistryInfo)%7B%0A%20%20%20%20is_default%0A%20%20%20%20image_registry_id%0A%20%20%20%20project_id%0A%20%20%20%20updated_at%0A%20%20%20%20created_at%0A%20%20%20%20is_removed%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/ImageRegistryResponse">ImageRegistryResponse</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">"createImageRegistry"</span>: {
|
||
<span class="hljs-attr">"is_default"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"image_registry_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">"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">"is_removed"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_image__registry-post" class="operation panel" data-traverse-target="operation-get_image__registry-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Workflow-Management">Workflow Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get Image Registry</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to get the the image registry from the project_id and image_registry_id</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>image_registry_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">image_registry_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">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>
|
||
</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> GetImageRegistry<span class="hljs-tag">(<span class="hljs-code">$image_registry_id</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">GetImageRegistry<span class="hljs-tag">(image_registry_id: <span class="hljs-code">$image_registry_id</span>, project_id: <span class="hljs-code">$project_id</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">is_default</span>
|
||
<span class="hljs-symbol">image_registry_id</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">is_removed</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">"image_registry_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20GetImageRegistry(%24image_registry_id%3A%20String!%2C%20%24project_id%3A%20String!)%7B%0A%20%20GetImageRegistry(image_registry_id%3A%20%24image_registry_id%2C%20project_id%3A%20%24project_id)%7B%0A%20%20%20%20is_default%0A%20%20%20%20image_registry_id%0A%20%20%20%20project_id%0A%20%20%20%20updated_at%0A%20%20%20%20created_at%0A%20%20%20%20is_removed%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/ImageRegistryResponse">ImageRegistryResponse</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">"GetImageRegistry"</span>: {
|
||
<span class="hljs-attr">"is_default"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"image_registry_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">"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">"is_removed"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-update_image_registry-post" class="operation panel" data-traverse-target="operation-update_image_registry-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Workflow-Management">Workflow Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Update Image Registry</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to update the image registry. </p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>image_registry_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>is_default</td>
|
||
<td>true/false</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>image_registry_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>image_repo_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>image_registry_type</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>secret_name</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>secret_namespace</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
<tr>
|
||
<td>enable_registry</td>
|
||
<td>-</td>
|
||
<td>Optional</td>
|
||
</tr>
|
||
</table>
|
||
</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">image_registry_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">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">imageRegistryInfo:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/imageRegistryInput">imageRegistryInput</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> updateImageRegistry<span class="hljs-tag">(<span class="hljs-code">$image_registry_id</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$imageRegistryInfo</span>: imageRegistryInput!)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">updateImageRegistry<span class="hljs-tag">(image_registry_id: <span class="hljs-code">$image_registry_id</span>, project_id: <span class="hljs-code">$project_id</span>, imageRegistryInfo: <span class="hljs-code">$imageRegistryInfo</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">is_default</span>
|
||
<span class="hljs-symbol">image_registry_id</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">is_removed</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">"image_registry_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">"imageRegistryInfo"</span>: {
|
||
<span class="hljs-attr">"is_default"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"image_registry_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"image_repo_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"image_registry_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"secret_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"secret_namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"enable_registry"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20updateImageRegistry(%24image_registry_id%3A%20String!%2C%20%24project_id%3A%20String!%2C%20%24imageRegistryInfo%3A%20imageRegistryInput!)%7B%0A%20%20updateImageRegistry(image_registry_id%3A%20%24image_registry_id%2C%20project_id%3A%20%24project_id%2C%20imageRegistryInfo%3A%20%24imageRegistryInfo)%7B%0A%20%20%20%20is_default%0A%20%20%20%20image_registry_id%0A%20%20%20%20project_id%0A%20%20%20%20updated_at%0A%20%20%20%20created_at%0A%20%20%20%20is_removed%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/ImageRegistryResponse">ImageRegistryResponse</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">"updateImageRegistry"</span>: {
|
||
<span class="hljs-attr">"is_default"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"image_registry_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">"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">"is_removed"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-delete_image_registry-post" class="operation panel" data-traverse-target="operation-delete_image_registry-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Workflow-Management">Workflow Management</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Delete Image Registry</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to delete the image registry </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>image_registry_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">image_registry_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">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>
|
||
</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> deleteImageRegistry<span class="hljs-tag">(<span class="hljs-code">$image_registry_id</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">deleteImageRegistry<span class="hljs-tag">(image_registry_id: <span class="hljs-code">$image_registry_id</span>, project_id: <span class="hljs-code">$project_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">"image_registry_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20deleteImageRegistry(%24image_registry_id%3A%20String!%2C%20%24project_id%3A%20String!)%7B%0A%20%20deleteImageRegistry(image_registry_id%3A%20%24image_registry_id%2C%20project_id%3A%20%24project_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">"deleteImageRegistry"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-Analytics" class="swagger-summary-tag" data-traverse-target="tag-Analytics">Analytics</h1>
|
||
<div class="tag-description doc-row">
|
||
<div class="doc-copy">
|
||
<p>Analytics allows user to visualize the chaos metrics with the help of different dashboards and graphs present in the Litmus Portal.</p>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_heatmap_data-post" class="operation panel" data-traverse-target="operation-get_heatmap_data-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get HeatMap Data</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to get year-wise calendar heatmap of daily average resilience scores for workflow runs.</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_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>year</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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_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">year:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">integer</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> getHeatmapData<span class="hljs-tag">(<span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$workflow_id</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$year</span>:<span class="hljs-type"> Int!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">getHeatmapData<span class="hljs-tag">(project_id: <span class="hljs-code">$project_id</span>, workflow_id: <span class="hljs-code">$workflow_id</span>, year: <span class="hljs-code">$year</span>)</span><span class="hljs-tag">{
|
||
}</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_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"year"</span>: <span class="hljs-string">"integer"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20getHeatmapData(%24project_id%3A%20String!%2C%20%24workflow_id%3A%20String!%2C%20%24year%3A%20Int!)%7B%0A%20%20getHeatmapData(project_id%3A%20%24project_id%2C%20workflow_id%3A%20%24workflow_id%2C%20year%3A%20%24year)%7B%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/HeatmapData">HeatmapData</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">"getHeatmapData"</span>: [
|
||
{}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_workflow_stats-post" class="operation panel" data-traverse-target="operation-get_workflow_stats-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get Workflow Stats</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to get monthly, daily and hourly workflow schedule and run statistics as a time series.</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>filter</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>show_workflow_runs</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">filter:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/TimeFrequency">TimeFrequency</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">show_workflow_runs:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">boolean</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> getWorkflowStats<span class="hljs-tag">(<span class="hljs-code">$project_id</span>: ID!, <span class="hljs-code">$filter</span>:<span class="hljs-type"> TimeFrequency!</span>, <span class="hljs-code">$show_workflow_runs</span>:<span class="hljs-type"> Boolean!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">getWorkflowStats<span class="hljs-tag">(project_id: <span class="hljs-code">$project_id</span>, filter: <span class="hljs-code">$filter</span>, show_workflow_runs: <span class="hljs-code">$show_workflow_runs</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">date</span>
|
||
<span class="hljs-symbol">value</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">"filter"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"show_workflow_runs"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20getWorkflowStats(%24project_id%3A%20ID!%2C%20%24filter%3A%20TimeFrequency!%2C%20%24show_workflow_runs%3A%20Boolean!)%7B%0A%20%20getWorkflowStats(project_id%3A%20%24project_id%2C%20filter%3A%20%24filter%2C%20show_workflow_runs%3A%20%24show_workflow_runs)%7B%0A%20%20%20%20date%0A%20%20%20%20value%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/WorkflowStats">WorkflowStats</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">"getWorkflowStats"</span>: [
|
||
{
|
||
<span class="hljs-attr">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"integer"</span>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_workflow_run_stats-post" class="operation panel" data-traverse-target="operation-get_workflow_run_stats-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get Workflow Run Stats</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to get aggregated workflow and experiment statistics for completed runs of selected schedules.</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>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">workflowRunStatsRequest:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowRunStatsRequest">WorkflowRunStatsRequest</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">query</span> getWorkflowRunStats<span class="hljs-tag">(<span class="hljs-code">$workflowRunStatsRequest</span>:<span class="hljs-type"> WorkflowRunStatsRequest!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">getWorkflowRunStats<span class="hljs-tag">(workflowRunStatsRequest: <span class="hljs-code">$workflowRunStatsRequest</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">total_workflow_runs</span>
|
||
<span class="hljs-symbol">succeeded_workflow_runs</span>
|
||
<span class="hljs-symbol">failed_workflow_runs</span>
|
||
<span class="hljs-symbol">running_workflow_runs</span>
|
||
<span class="hljs-symbol">average_resiliency_score</span>
|
||
<span class="hljs-symbol">total_experiments</span>
|
||
<span class="hljs-symbol">experiments_passed</span>
|
||
<span class="hljs-symbol">experiments_failed</span>
|
||
<span class="hljs-symbol">experiments_awaited</span>
|
||
<span class="hljs-symbol">experiments_stopped</span>
|
||
<span class="hljs-symbol">experiments_na</span>
|
||
<span class="hljs-symbol">passed_percentage</span>
|
||
<span class="hljs-symbol">failed_percentage</span>
|
||
<span class="hljs-symbol">workflow_run_succeeded_percentage</span>
|
||
<span class="hljs-symbol">workflow_run_failed_percentage</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">"workflowRunStatsRequest"</span>: {
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"workflow_ids"</span>: [
|
||
<span class="hljs-string">"object"</span>
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20getWorkflowRunStats(%24workflowRunStatsRequest%3A%20WorkflowRunStatsRequest!)%7B%0A%20%20getWorkflowRunStats(workflowRunStatsRequest%3A%20%24workflowRunStatsRequest)%7B%0A%20%20%20%20total_workflow_runs%0A%20%20%20%20succeeded_workflow_runs%0A%20%20%20%20failed_workflow_runs%0A%20%20%20%20running_workflow_runs%0A%20%20%20%20average_resiliency_score%0A%20%20%20%20total_experiments%0A%20%20%20%20experiments_passed%0A%20%20%20%20experiments_failed%0A%20%20%20%20experiments_awaited%0A%20%20%20%20experiments_stopped%0A%20%20%20%20experiments_na%0A%20%20%20%20passed_percentage%0A%20%20%20%20failed_percentage%0A%20%20%20%20workflow_run_succeeded_percentage%0A%20%20%20%20workflow_run_failed_percentage%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/WorkflowRunStatsResponse">WorkflowRunStatsResponse</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">"getWorkflowRunStats"</span>: {
|
||
<span class="hljs-attr">"total_workflow_runs"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"succeeded_workflow_runs"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"failed_workflow_runs"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"running_workflow_runs"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"average_resiliency_score"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"total_experiments"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"experiments_passed"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"experiments_failed"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"experiments_awaited"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"experiments_stopped"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"experiments_na"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"passed_percentage"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"failed_percentage"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"workflow_run_succeeded_percentage"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"workflow_run_failed_percentage"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-list_datasource-post" class="operation panel" data-traverse-target="operation-list_datasource-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">List DataSource</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to list all connected data sources in a project.</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>
|
||
</table>
|
||
</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>
|
||
</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> ListDataSource<span class="hljs-tag">(<span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">ListDataSource<span class="hljs-tag">(project_id: <span class="hljs-code">$project_id</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">ds_id</span>
|
||
<span class="hljs-symbol">ds_name</span>
|
||
<span class="hljs-symbol">ds_type</span>
|
||
<span class="hljs-symbol">ds_url</span>
|
||
<span class="hljs-symbol">access_type</span>
|
||
<span class="hljs-symbol">auth_type</span>
|
||
<span class="hljs-symbol">basic_auth_username</span>
|
||
<span class="hljs-symbol">basic_auth_password</span>
|
||
<span class="hljs-symbol">scrape_interval</span>
|
||
<span class="hljs-symbol">query_timeout</span>
|
||
<span class="hljs-symbol">http_method</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">health_status</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">updated_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">"project_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20ListDataSource(%24project_id%3A%20String!)%7B%0A%20%20ListDataSource(project_id%3A%20%24project_id)%7B%0A%20%20%20%20ds_id%0A%20%20%20%20ds_name%0A%20%20%20%20ds_type%0A%20%20%20%20ds_url%0A%20%20%20%20access_type%0A%20%20%20%20auth_type%0A%20%20%20%20basic_auth_username%0A%20%20%20%20basic_auth_password%0A%20%20%20%20scrape_interval%0A%20%20%20%20query_timeout%0A%20%20%20%20http_method%0A%20%20%20%20project_id%0A%20%20%20%20health_status%0A%20%20%20%20created_at%0A%20%20%20%20updated_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/DSResponse">DSResponse</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">"ListDataSource"</span>: [
|
||
{
|
||
<span class="hljs-attr">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"auth_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"scrape_interval"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"query_timeout"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"http_method"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"health_status"</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>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_prom_query-post" class="operation panel" data-traverse-target="operation-get_prom_query-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get Prom Query</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to get prometheus time series data from promQL queries and data source details.</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">query:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/promInput">promInput</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">query</span> GetPromQuery<span class="hljs-tag">(<span class="hljs-code">$query</span>: promInput)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">GetPromQuery<span class="hljs-tag">(query: <span class="hljs-code">$query</span>)</span><span class="hljs-tag">{
|
||
}</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">"query"</span>: {
|
||
<span class="hljs-attr">"queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"query"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"ds_details"</span>: {
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20GetPromQuery(%24query%3A%20promInput)%7B%0A%20%20GetPromQuery(query%3A%20%24query)%7B%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/promResponse">promResponse</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">"GetPromQuery"</span>: {}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_prom_label_names_and_values-post" class="operation panel" data-traverse-target="operation-get_prom_label_names_and_values-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get Prom Label names and values</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to get labels and values associated with a prometheus metric and a given data source.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>series</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ds_details.url</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ds_details.start</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ds_details.end</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">series:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/promSeriesInput">promSeriesInput</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">query</span> GetPromLabelNamesAndValues<span class="hljs-tag">(<span class="hljs-code">$series</span>: promSeriesInput)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">GetPromLabelNamesAndValues<span class="hljs-tag">(series: <span class="hljs-code">$series</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">series</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">"series"</span>: {
|
||
<span class="hljs-attr">"series"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_details"</span>: {
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20GetPromLabelNamesAndValues(%24series%3A%20promSeriesInput)%7B%0A%20%20GetPromLabelNamesAndValues(series%3A%20%24series)%7B%0A%20%20%20%20series%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/promSeriesResponse">promSeriesResponse</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">"GetPromLabelNamesAndValues"</span>: {
|
||
<span class="hljs-attr">"series"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-get_prom_series_list-post" class="operation panel" data-traverse-target="operation-get_prom_series_list-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get Prom Series List</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to get a list of all time series metric names available on a prometheus data source.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>url</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>start</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>end</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">ds_details:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/dsDetails">dsDetails</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">query</span> GetPromSeriesList<span class="hljs-tag">(<span class="hljs-code">$ds_details</span>: dsDetails)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">GetPromSeriesList<span class="hljs-tag">(ds_details: <span class="hljs-code">$ds_details</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">seriesList</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">"ds_details"</span>: {
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20GetPromSeriesList(%24ds_details%3A%20dsDetails)%7B%0A%20%20GetPromSeriesList(ds_details%3A%20%24ds_details)%7B%0A%20%20%20%20seriesList%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/promSeriesListResponse">promSeriesListResponse</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">"GetPromSeriesList"</span>: {
|
||
<span class="hljs-attr">"seriesList"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-list_dashboard-post" class="operation panel" data-traverse-target="operation-list_dashboard-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">List Dashboard</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to list all dashboards created in a project.</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_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>db_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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_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">db_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">query</span> ListDashboard<span class="hljs-tag">(<span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$cluster_id</span>:<span class="hljs-type"> String,</span> <span class="hljs-code">$db_id</span>:<span class="hljs-type"> String)</span>{
|
||
<span class="hljs-type"> ListDashboard(</span>project_id: <span class="hljs-code">$project_id</span>, cluster_id: <span class="hljs-code">$cluster_id</span>, db_id: <span class="hljs-code">$db_id</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">ds_id</span>
|
||
<span class="hljs-symbol">db_id</span>
|
||
<span class="hljs-symbol">db_name</span>
|
||
<span class="hljs-symbol">db_type_id</span>
|
||
<span class="hljs-symbol">db_type_name</span>
|
||
<span class="hljs-symbol">db_information</span>
|
||
<span class="hljs-symbol">chaos_event_query_template</span>
|
||
<span class="hljs-symbol">chaos_verdict_query_template</span>
|
||
<span class="hljs-symbol">cluster_name</span>
|
||
<span class="hljs-symbol">ds_name</span>
|
||
<span class="hljs-symbol">ds_type</span>
|
||
<span class="hljs-symbol">ds_url</span>
|
||
<span class="hljs-symbol">ds_health_status</span>
|
||
<span class="hljs-symbol">end_time</span>
|
||
<span class="hljs-symbol">start_time</span>
|
||
<span class="hljs-symbol">refresh_rate</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">cluster_id</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">viewed_at</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_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20ListDashboard(%24project_id%3A%20String!%2C%20%24cluster_id%3A%20String%2C%20%24db_id%3A%20String)%7B%0A%20%20ListDashboard(project_id%3A%20%24project_id%2C%20cluster_id%3A%20%24cluster_id%2C%20db_id%3A%20%24db_id)%7B%0A%20%20%20%20ds_id%0A%20%20%20%20db_id%0A%20%20%20%20db_name%0A%20%20%20%20db_type_id%0A%20%20%20%20db_type_name%0A%20%20%20%20db_information%0A%20%20%20%20chaos_event_query_template%0A%20%20%20%20chaos_verdict_query_template%0A%20%20%20%20cluster_name%0A%20%20%20%20ds_name%0A%20%20%20%20ds_type%0A%20%20%20%20ds_url%0A%20%20%20%20ds_health_status%0A%20%20%20%20end_time%0A%20%20%20%20start_time%0A%20%20%20%20refresh_rate%0A%20%20%20%20project_id%0A%20%20%20%20cluster_id%0A%20%20%20%20created_at%0A%20%20%20%20updated_at%0A%20%20%20%20viewed_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/listDashboardResponse">listDashboardResponse</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">"ListDashboard"</span>: [
|
||
{
|
||
<span class="hljs-attr">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_information"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_event_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_verdict_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_health_status"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end_time"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start_time"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"refresh_rate"</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">"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">"viewed_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-portal_dashboard_data-post" class="operation panel" data-traverse-target="operation-portal_dashboard_data-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Portal Dashboard Data</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This query is used to list all pre-configured dashboard templates available in litmus center.</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>hub_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">hub_name:
|
||
<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> PortalDashboardData<span class="hljs-tag">(<span class="hljs-code">$project_id</span>:<span class="hljs-type"> String!</span>, <span class="hljs-code">$hub_name</span>:<span class="hljs-type"> String!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">PortalDashboardData<span class="hljs-tag">(project_id: <span class="hljs-code">$project_id</span>, hub_name: <span class="hljs-code">$hub_name</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">name</span>
|
||
<span class="hljs-symbol">dashboard_data</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">"hub_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=query%20PortalDashboardData(%24project_id%3A%20String!%2C%20%24hub_name%3A%20String!)%7B%0A%20%20PortalDashboardData(project_id%3A%20%24project_id%2C%20hub_name%3A%20%24hub_name)%7B%0A%20%20%20%20name%0A%20%20%20%20dashboard_data%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/PortalDashboardData">PortalDashboardData</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">"PortalDashboardData"</span>: [
|
||
{
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"dashboard_data"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-create_datasource-post" class="operation panel" data-traverse-target="operation-create_datasource-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Create DataSource</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This mutation is used to add a prometheus data source to the project which serves as a metrics collector for agent clusters.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>ds_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ds_type</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ds_url</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>access_type</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>auth_type</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>basic_auth_username</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>basic_auth_password</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>scrape_interval</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>query_timeout</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>http_method</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"ds_name"</b>: "sample data source",
|
||
<br/>
|
||
<b>"ds_type"</b>: "Prometheus",
|
||
<br/>
|
||
<b>"access_type"</b>: "Server (Default)",
|
||
<br/>
|
||
<b>"auth_type"</b>: "no auth",
|
||
<br/>
|
||
<b>"basic_auth_password"</b>: "",
|
||
<br/>
|
||
<b>"basic_auth_username"</b>: "",
|
||
<br/>
|
||
<b>"ds_url"</b>: "https://demo.com:9090",
|
||
<br/>
|
||
<b>"http_method"</b>: "POST",
|
||
<br/>
|
||
<b>"project_id"</b>: "4c3d0513-5988-446e-8ce5-1a4c6fb274f3",
|
||
<br/>
|
||
<b>"query_timeout"</b>: "30",
|
||
<br/>
|
||
<b>"scrape_interval"</b>: "15",
|
||
<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">datasource:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/DSInput">DSInput</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> createDataSource<span class="hljs-tag">(<span class="hljs-code">$datasource</span>: DSInput)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">createDataSource<span class="hljs-tag">(datasource: <span class="hljs-code">$datasource</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">ds_id</span>
|
||
<span class="hljs-symbol">ds_name</span>
|
||
<span class="hljs-symbol">ds_type</span>
|
||
<span class="hljs-symbol">ds_url</span>
|
||
<span class="hljs-symbol">access_type</span>
|
||
<span class="hljs-symbol">auth_type</span>
|
||
<span class="hljs-symbol">basic_auth_username</span>
|
||
<span class="hljs-symbol">basic_auth_password</span>
|
||
<span class="hljs-symbol">scrape_interval</span>
|
||
<span class="hljs-symbol">query_timeout</span>
|
||
<span class="hljs-symbol">http_method</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">health_status</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">updated_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">"datasource"</span>: {
|
||
<span class="hljs-attr">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"auth_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"scrape_interval"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"query_timeout"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"http_method"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20createDataSource(%24datasource%3A%20DSInput)%7B%0A%20%20createDataSource(datasource%3A%20%24datasource)%7B%0A%20%20%20%20ds_id%0A%20%20%20%20ds_name%0A%20%20%20%20ds_type%0A%20%20%20%20ds_url%0A%20%20%20%20access_type%0A%20%20%20%20auth_type%0A%20%20%20%20basic_auth_username%0A%20%20%20%20basic_auth_password%0A%20%20%20%20scrape_interval%0A%20%20%20%20query_timeout%0A%20%20%20%20http_method%0A%20%20%20%20project_id%0A%20%20%20%20health_status%0A%20%20%20%20created_at%0A%20%20%20%20updated_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/DSResponse">DSResponse</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">"createDataSource"</span>: {
|
||
<span class="hljs-attr">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"auth_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"scrape_interval"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"query_timeout"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"http_method"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"health_status"</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>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-create_dashboard-post" class="operation panel" data-traverse-target="operation-create_dashboard-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Create Dashboard</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This mutation is used to create an application dashboard providing agent information, data source details and prometheus queries.</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">dashboard:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/createDBInput">createDBInput</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> createDashBoard<span class="hljs-tag">(<span class="hljs-code">$dashboard</span>: createDBInput)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">createDashBoard<span class="hljs-tag">(dashboard: <span class="hljs-code">$dashboard</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">ds_id</span>
|
||
<span class="hljs-symbol">db_id</span>
|
||
<span class="hljs-symbol">db_name</span>
|
||
<span class="hljs-symbol">db_type_id</span>
|
||
<span class="hljs-symbol">db_type_name</span>
|
||
<span class="hljs-symbol">db_information</span>
|
||
<span class="hljs-symbol">chaos_event_query_template</span>
|
||
<span class="hljs-symbol">chaos_verdict_query_template</span>
|
||
<span class="hljs-symbol">cluster_name</span>
|
||
<span class="hljs-symbol">ds_name</span>
|
||
<span class="hljs-symbol">ds_type</span>
|
||
<span class="hljs-symbol">ds_url</span>
|
||
<span class="hljs-symbol">ds_health_status</span>
|
||
<span class="hljs-symbol">end_time</span>
|
||
<span class="hljs-symbol">start_time</span>
|
||
<span class="hljs-symbol">refresh_rate</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">cluster_id</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">updated_at</span>
|
||
<span class="hljs-symbol">viewed_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">"dashboard"</span>: {
|
||
<span class="hljs-attr">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_information"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_event_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_verdict_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"application_metadata_map"</span>: [
|
||
{
|
||
<span class="hljs-attr">"namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"applications"</span>: [
|
||
{
|
||
<span class="hljs-attr">"kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"names"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
]
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_groups"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panels"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panel_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_left"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_right"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"x_axis_down"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"unit"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_options"</span>: {
|
||
<span class="hljs-attr">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"panel_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_group_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"end_time"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start_time"</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">"refresh_rate"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20createDashBoard(%24dashboard%3A%20createDBInput)%7B%0A%20%20createDashBoard(dashboard%3A%20%24dashboard)%7B%0A%20%20%20%20ds_id%0A%20%20%20%20db_id%0A%20%20%20%20db_name%0A%20%20%20%20db_type_id%0A%20%20%20%20db_type_name%0A%20%20%20%20db_information%0A%20%20%20%20chaos_event_query_template%0A%20%20%20%20chaos_verdict_query_template%0A%20%20%20%20cluster_name%0A%20%20%20%20ds_name%0A%20%20%20%20ds_type%0A%20%20%20%20ds_url%0A%20%20%20%20ds_health_status%0A%20%20%20%20end_time%0A%20%20%20%20start_time%0A%20%20%20%20refresh_rate%0A%20%20%20%20project_id%0A%20%20%20%20cluster_id%0A%20%20%20%20created_at%0A%20%20%20%20updated_at%0A%20%20%20%20viewed_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/listDashboardResponse">listDashboardResponse</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">"createDashBoard"</span>: {
|
||
<span class="hljs-attr">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_information"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_event_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_verdict_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_health_status"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end_time"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start_time"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"refresh_rate"</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">"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">"viewed_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-update_datasource-post" class="operation panel" data-traverse-target="operation-update_datasource-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Update DataSource</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This mutation is used to update a conncted data source's information.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>ds_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ds_name</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ds_type</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ds_url</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>access_type</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>auth_type</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>basic_auth_username</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>basic_auth_password</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>scrape_interval</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>query_timeout</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>http_method</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
<h6>Example Body:</h6> {
|
||
<br/>
|
||
<p style="margin-left: 40px">
|
||
<b>"ds_id"</b>: "sample data source",
|
||
<br/>
|
||
<b>"ds_name"</b>: "sample data source",
|
||
<br/>
|
||
<b>"ds_type"</b>: "Prometheus",
|
||
<br/>
|
||
<b>"access_type"</b>: "Server (Default)",
|
||
<br/>
|
||
<b>"auth_type"</b>: "no auth",
|
||
<br/>
|
||
<b>"basic_auth_password"</b>: "",
|
||
<br/>
|
||
<b>"basic_auth_username"</b>: "",
|
||
<br/>
|
||
<b>"ds_url"</b>: "https://demo.com:9090",
|
||
<br/>
|
||
<b>"http_method"</b>: "POST",
|
||
<br/>
|
||
<b>"project_id"</b>: "4c3d0513-5988-446e-8ce5-1a4c6fb274f3",
|
||
<br/>
|
||
<b>"query_timeout"</b>: "30",
|
||
<br/>
|
||
<b>"scrape_interval"</b>: "15",
|
||
<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">datasource:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/DSInput">DSInput</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> updateDataSource<span class="hljs-tag">(<span class="hljs-code">$datasource</span>: DSInput!)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">updateDataSource<span class="hljs-tag">(datasource: <span class="hljs-code">$datasource</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">ds_id</span>
|
||
<span class="hljs-symbol">ds_name</span>
|
||
<span class="hljs-symbol">ds_type</span>
|
||
<span class="hljs-symbol">ds_url</span>
|
||
<span class="hljs-symbol">access_type</span>
|
||
<span class="hljs-symbol">auth_type</span>
|
||
<span class="hljs-symbol">basic_auth_username</span>
|
||
<span class="hljs-symbol">basic_auth_password</span>
|
||
<span class="hljs-symbol">scrape_interval</span>
|
||
<span class="hljs-symbol">query_timeout</span>
|
||
<span class="hljs-symbol">http_method</span>
|
||
<span class="hljs-symbol">project_id</span>
|
||
<span class="hljs-symbol">health_status</span>
|
||
<span class="hljs-symbol">created_at</span>
|
||
<span class="hljs-symbol">updated_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">"datasource"</span>: {
|
||
<span class="hljs-attr">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"auth_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"scrape_interval"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"query_timeout"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"http_method"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20updateDataSource(%24datasource%3A%20DSInput!)%7B%0A%20%20updateDataSource(datasource%3A%20%24datasource)%7B%0A%20%20%20%20ds_id%0A%20%20%20%20ds_name%0A%20%20%20%20ds_type%0A%20%20%20%20ds_url%0A%20%20%20%20access_type%0A%20%20%20%20auth_type%0A%20%20%20%20basic_auth_username%0A%20%20%20%20basic_auth_password%0A%20%20%20%20scrape_interval%0A%20%20%20%20query_timeout%0A%20%20%20%20http_method%0A%20%20%20%20project_id%0A%20%20%20%20health_status%0A%20%20%20%20created_at%0A%20%20%20%20updated_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/DSResponse">DSResponse</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">"updateDataSource"</span>: {
|
||
<span class="hljs-attr">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"auth_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"scrape_interval"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"query_timeout"</span>: <span class="hljs-string">"integer"</span>,
|
||
<span class="hljs-attr">"http_method"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"health_status"</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>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-update_dashboard-post" class="operation panel" data-traverse-target="operation-update_dashboard-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Update Dashboard</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This mutation is used to update a dashboard's information and details.</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">dashboard:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/updateDBInput">updateDBInput</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">chaosQueryUpdate:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">boolean</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> updateDashboard<span class="hljs-tag">(<span class="hljs-code">$dashboard</span>: updateDBInput!, <span class="hljs-code">$chaosQueryUpdate</span>:<span class="hljs-type"> Boolean!</span>)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">updateDashboard<span class="hljs-tag">(dashboard: <span class="hljs-code">$dashboard</span>, chaosQueryUpdate: <span class="hljs-code">$chaosQueryUpdate</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">"dashboard"</span>: {
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_information"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_event_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_verdict_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"application_metadata_map"</span>: [
|
||
{
|
||
<span class="hljs-attr">"namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"applications"</span>: [
|
||
{
|
||
<span class="hljs-attr">"kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"names"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
]
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_groups"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panel_group_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panels"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panel_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_left"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_right"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"x_axis_down"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"unit"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_options"</span>: {
|
||
<span class="hljs-attr">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"panel_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
],
|
||
<span class="hljs-attr">"end_time"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start_time"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"refresh_rate"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"chaosQueryUpdate"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20updateDashboard(%24dashboard%3A%20updateDBInput!%2C%20%24chaosQueryUpdate%3A%20Boolean!)%7B%0A%20%20updateDashboard(dashboard%3A%20%24dashboard%2C%20chaosQueryUpdate%3A%20%24chaosQueryUpdate)%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">"updateDashboard"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-update_panel-post" class="operation panel" data-traverse-target="operation-update_panel-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Update Panel</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This mutation is used to update prometheus queries and panel details for selected panels.</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">panelInput:
|
||
<span class="prop-type">
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/panel">panel</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> updatePanel<span class="hljs-tag">(<span class="hljs-code">$panelInput</span>: [panel])</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">updatePanel<span class="hljs-tag">(panelInput: <span class="hljs-code">$panelInput</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">"panelInput"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panel_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_left"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_right"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"x_axis_down"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"unit"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_options"</span>: {
|
||
<span class="hljs-attr">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"panel_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20updatePanel(%24panelInput%3A%20%5Bpanel%5D)%7B%0A%20%20updatePanel(panelInput%3A%20%24panelInput)%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">"updatePanel"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-delete_dashboard-post" class="operation panel" data-traverse-target="operation-delete_dashboard-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Delete Dashboard</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This mutation is used to delete a dashboard from a project.</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>db_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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">db_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> deleteDashboard<span class="hljs-tag">(<span class="hljs-code">$db_id</span>:<span class="hljs-type"> String)</span>{
|
||
deleteDashboard(db_id: <span class="hljs-code">$db_id</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">"db_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20deleteDashboard(%24db_id%3A%20String)%7B%0A%20%20deleteDashboard(db_id%3A%20%24db_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">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">"deleteDashboard"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation-delete_datasource-post" class="operation panel" data-traverse-target="operation-delete_datasource-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Analytics">Analytics</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Delete DataSource</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Disconnect a data source from a project</p>
|
||
<table>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Possible values</th>
|
||
<th>Mandatory/Optional</th>
|
||
</tr>
|
||
<tr>
|
||
<td>force_delete</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ds_id</td>
|
||
<td>-</td>
|
||
<td>Mandatory</td>
|
||
</tr>
|
||
</table>
|
||
</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/deleteDSInput">deleteDSInput</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> deleteDataSource<span class="hljs-tag">(<span class="hljs-code">$input</span>: deleteDSInput!)</span><span class="hljs-tag">{
|
||
<span class="hljs-symbol">deleteDataSource<span class="hljs-tag">(input: <span class="hljs-code">$input</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">"force_delete"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"ds_id"</span>: <span class="hljs-string">"object"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
<a href="http://localhost:8080?query=mutation%20deleteDataSource(%24input%3A%20deleteDSInput!)%7B%0A%20%20deleteDataSource(input%3A%20%24input)%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">"deleteDataSource"</span>: <span class="hljs-string">"boolean"</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-AgentStat" class="definition panel" data-traverse-target="definition-AgentStat">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/AgentStat"></a>AgentStat: 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="Ns">
|
||
<span class="json-property-name">Ns:</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>
|
||
<dt data-property-name="Cluster">
|
||
<span class="json-property-name">Cluster:</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>
|
||
<dt data-property-name="Total">
|
||
<span class="json-property-name">Total:</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>
|
||
<dt data-property-name="Active">
|
||
<span class="json-property-name">Active:</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">"Ns"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Cluster"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Total"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Active"</span>: <span class="hljs-string">"number"</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-AuthType" class="definition panel" data-traverse-target="definition-AuthType">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/AuthType"></a>AuthType: 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">none</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">basic</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">token</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">ssh</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd> </dd>
|
||
</dl>
|
||
</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>
|
||
</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>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
</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>
|
||
}
|
||
]
|
||
}
|
||
}
|
||
]
|
||
}
|
||
</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>
|
||
<dt data-property-name="IsPrivate">
|
||
<span class="json-property-name">IsPrivate:</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="AuthType">
|
||
<span class="json-property-name">AuthType:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/AuthType">AuthType</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></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>
|
||
</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>
|
||
</dt>
|
||
<dt data-property-name="Password">
|
||
<span class="json-property-name">Password:</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="SSHPrivateKey">
|
||
<span class="json-property-name">SSHPrivateKey:</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">"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>,
|
||
<span class="hljs-attr">"IsPrivate"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"AuthType"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</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>
|
||
<dt data-property-name="last_workflow_timestamp">
|
||
<span class="json-property-name">last_workflow_timestamp:</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">"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">"last_workflow_timestamp"</span>: <span class="hljs-string">"string"</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="newAccessKey">
|
||
<span class="json-property-name">newAccessKey:</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">"newAccessKey"</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>,
|
||
<span class="hljs-attr">"last_workflow_timestamp"</span>: <span class="hljs-string">"string"</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>
|
||
<dt data-property-name="node_selector">
|
||
<span class="json-property-name">node_selector:</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_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>,
|
||
<span class="hljs-attr">"node_selector"</span>: <span class="hljs-string">"string"</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>
|
||
<dt data-property-name="IsPrivate">
|
||
<span class="json-property-name">IsPrivate:</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="AuthType">
|
||
<span class="json-property-name">AuthType:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/AuthType">AuthType</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></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>
|
||
</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>
|
||
</dt>
|
||
<dt data-property-name="Password">
|
||
<span class="json-property-name">Password:</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="SSHPrivateKey">
|
||
<span class="json-property-name">SSHPrivateKey:</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="SSHPublicKey">
|
||
<span class="json-property-name">SSHPublicKey:</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">"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">"IsPrivate"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"AuthType"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPublicKey"</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="userID">
|
||
<span class="json-property-name">userID:</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="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">"userID"</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-DSInput" class="definition panel" data-traverse-target="definition-DSInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/DSInput"></a>DSInput: 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="ds_id">
|
||
<span class="json-property-name">ds_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="ds_name">
|
||
<span class="json-property-name">ds_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="ds_type">
|
||
<span class="json-property-name">ds_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="ds_url">
|
||
<span class="json-property-name">ds_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>
|
||
<dt data-property-name="access_type">
|
||
<span class="json-property-name">access_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="auth_type">
|
||
<span class="json-property-name">auth_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="basic_auth_username">
|
||
<span class="json-property-name">basic_auth_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>
|
||
</dt>
|
||
<dt data-property-name="basic_auth_password">
|
||
<span class="json-property-name">basic_auth_password:</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="scrape_interval">
|
||
<span class="json-property-name">scrape_interval:</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>
|
||
<dt data-property-name="query_timeout">
|
||
<span class="json-property-name">query_timeout:</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>
|
||
<dt data-property-name="http_method">
|
||
<span class="json-property-name">http_method:</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="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">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"auth_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"scrape_interval"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"query_timeout"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"http_method"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-DSResponse" class="definition panel" data-traverse-target="definition-DSResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/DSResponse"></a>DSResponse: 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="ds_id">
|
||
<span class="json-property-name">ds_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="ds_name">
|
||
<span class="json-property-name">ds_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="ds_type">
|
||
<span class="json-property-name">ds_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="ds_url">
|
||
<span class="json-property-name">ds_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>
|
||
</dt>
|
||
<dt data-property-name="access_type">
|
||
<span class="json-property-name">access_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="auth_type">
|
||
<span class="json-property-name">auth_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="basic_auth_username">
|
||
<span class="json-property-name">basic_auth_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>
|
||
</dt>
|
||
<dt data-property-name="basic_auth_password">
|
||
<span class="json-property-name">basic_auth_password:</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="scrape_interval">
|
||
<span class="json-property-name">scrape_interval:</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="query_timeout">
|
||
<span class="json-property-name">query_timeout:</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="http_method">
|
||
<span class="json-property-name">http_method:</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_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="health_status">
|
||
<span class="json-property-name">health_status:</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>
|
||
</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>
|
||
</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">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"access_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"auth_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"basic_auth_password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"scrape_interval"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"query_timeout"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"http_method"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"health_status"</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>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-DateRange" class="definition panel" data-traverse-target="definition-DateRange">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/DateRange"></a>DateRange: 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="start_date">
|
||
<span class="json-property-name">start_date:</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="end_date">
|
||
<span class="json-property-name">end_date:</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">"start_date"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end_date"</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-GetWorkflowRunsInput" class="definition panel" data-traverse-target="definition-GetWorkflowRunsInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/GetWorkflowRunsInput"></a>GetWorkflowRunsInput: 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="workflow_run_ids">
|
||
<span class="json-property-name">workflow_run_ids:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="workflow_ids">
|
||
<span class="json-property-name">workflow_ids:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="pagination">
|
||
<span class="json-property-name">pagination:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/Pagination">Pagination</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="sort">
|
||
<span class="json-property-name">sort:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowRunSortInput">WorkflowRunSortInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="filter">
|
||
<span class="json-property-name">filter:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowRunFilterInput">WorkflowRunFilterInput</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">"workflow_run_ids"</span>: [
|
||
<span class="hljs-string">"object"</span>
|
||
],
|
||
<span class="hljs-attr">"workflow_ids"</span>: [
|
||
<span class="hljs-string">"object"</span>
|
||
],
|
||
<span class="hljs-attr">"pagination"</span>: {
|
||
<span class="hljs-attr">"page"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"limit"</span>: <span class="hljs-string">"number"</span>
|
||
},
|
||
<span class="hljs-attr">"sort"</span>: {
|
||
<span class="hljs-attr">"field"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"descending"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"filter"</span>: {
|
||
<span class="hljs-attr">"workflow_name"</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_status"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"date_range"</span>: {
|
||
<span class="hljs-attr">"start_date"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end_date"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-GetWorkflowsOutput" class="definition panel" data-traverse-target="definition-GetWorkflowsOutput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/GetWorkflowsOutput"></a>GetWorkflowsOutput: 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="total_no_of_workflow_runs">
|
||
<span class="json-property-name">total_no_of_workflow_runs:</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>
|
||
<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/WorkflowRun">WorkflowRun</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">"total_no_of_workflow_runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"workflow_runs"</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">"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">"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">"phase"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resiliency_score"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_passed"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_failed"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_awaited"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_stopped"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_na"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"total_experiments"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"execution_data"</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-GitConfig" class="definition panel" data-traverse-target="definition-GitConfig">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/GitConfig"></a>GitConfig: 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="Branch">
|
||
<span class="json-property-name">Branch:</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="AuthType">
|
||
<span class="json-property-name">AuthType:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/AuthType">AuthType</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></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>
|
||
</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>
|
||
</dt>
|
||
<dt data-property-name="Password">
|
||
<span class="json-property-name">Password:</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="SSHPrivateKey">
|
||
<span class="json-property-name">SSHPrivateKey:</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">"Branch"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"AuthType"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-GitConfigResponse" class="definition panel" data-traverse-target="definition-GitConfigResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/GitConfigResponse"></a>GitConfigResponse: 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="Enabled">
|
||
<span class="json-property-name">Enabled:</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="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="Branch">
|
||
<span class="json-property-name">Branch:</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="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>
|
||
</dt>
|
||
<dt data-property-name="AuthType">
|
||
<span class="json-property-name">AuthType:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/AuthType">AuthType</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>
|
||
</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>
|
||
</dt>
|
||
<dt data-property-name="Password">
|
||
<span class="json-property-name">Password:</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="SSHPrivateKey">
|
||
<span class="json-property-name">SSHPrivateKey:</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">"Enabled"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"ProjectID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Branch"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"RepoURL"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"AuthType"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-HeatmapData" class="definition panel" data-traverse-target="definition-HeatmapData">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/HeatmapData"></a>HeatmapData: 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="bins">
|
||
<span class="json-property-name">bins:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowRunsData">WorkflowRunsData</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">"bins"</span>: [
|
||
{
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"workflowRunDetail"</span>: {
|
||
<span class="hljs-attr">"no_of_runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"date_stamp"</span>: <span class="hljs-string">"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-ImageRegistryResponse" class="definition panel" data-traverse-target="definition-ImageRegistryResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ImageRegistryResponse"></a>ImageRegistryResponse: 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="is_default">
|
||
<span class="json-property-name">is_default:</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="image_registry_info">
|
||
<span class="json-property-name">image_registry_info:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/imageRegistry">imageRegistry</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="image_registry_id">
|
||
<span class="json-property-name">image_registry_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="project_id">
|
||
<span class="json-property-name">project_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="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>
|
||
</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>
|
||
</dt>
|
||
<dt data-property-name="is_removed">
|
||
<span class="json-property-name">is_removed:</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">"is_default"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"image_registry_info"</span>: {
|
||
<span class="hljs-attr">"is_default"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"image_registry_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"image_repo_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"image_registry_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"secret_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"secret_namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"enable_registry"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"image_registry_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">"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">"is_removed"</span>: <span class="hljs-string">"boolean"</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-KubeGVRRequest" class="definition panel" data-traverse-target="definition-KubeGVRRequest">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/KubeGVRRequest"></a>KubeGVRRequest: 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="group">
|
||
<span class="json-property-name">group:</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="resource">
|
||
<span class="json-property-name">resource:</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">"group"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"version"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resource"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-KubeObjectData" class="definition panel" data-traverse-target="definition-KubeObjectData">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/KubeObjectData"></a>KubeObjectData: 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_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="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="kube_obj">
|
||
<span class="json-property-name">kube_obj:</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">"request_id"</span>: <span class="hljs-string">"object"</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">"kube_obj"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-KubeObjectRequest" class="definition panel" data-traverse-target="definition-KubeObjectRequest">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/KubeObjectRequest"></a>KubeObjectRequest: 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="object_type">
|
||
<span class="json-property-name">object_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="kube_obj_request">
|
||
<span class="json-property-name">kube_obj_request:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/KubeGVRRequest">KubeGVRRequest</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">"object_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"kube_obj_request"</span>: {
|
||
<span class="hljs-attr">"group"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"version"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resource"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-KubeObjectResponse" class="definition panel" data-traverse-target="definition-KubeObjectResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/KubeObjectResponse"></a>KubeObjectResponse: 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="kube_obj">
|
||
<span class="json-property-name">kube_obj:</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">"kube_obj"</span>: <span class="hljs-string">"string"</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-ListWorkflowsInput" class="definition panel" data-traverse-target="definition-ListWorkflowsInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ListWorkflowsInput"></a>ListWorkflowsInput: 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="workflow_ids">
|
||
<span class="json-property-name">workflow_ids:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="pagination">
|
||
<span class="json-property-name">pagination:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/Pagination">Pagination</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="sort">
|
||
<span class="json-property-name">sort:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowSortInput">WorkflowSortInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="filter">
|
||
<span class="json-property-name">filter:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowFilterInput">WorkflowFilterInput</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">"workflow_ids"</span>: [
|
||
<span class="hljs-string">"object"</span>
|
||
],
|
||
<span class="hljs-attr">"pagination"</span>: {
|
||
<span class="hljs-attr">"page"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"limit"</span>: <span class="hljs-string">"number"</span>
|
||
},
|
||
<span class="hljs-attr">"sort"</span>: {
|
||
<span class="hljs-attr">"field"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"descending"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"filter"</span>: {
|
||
<span class="hljs-attr">"workflow_name"</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-ListWorkflowsOutput" class="definition panel" data-traverse-target="definition-ListWorkflowsOutput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ListWorkflowsOutput"></a>ListWorkflowsOutput: 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="total_no_of_workflows">
|
||
<span class="json-property-name">total_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>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="workflows">
|
||
<span class="json-property-name">workflows:</span>
|
||
<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>
|
||
</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">"total_no_of_workflows"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"workflows"</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">"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-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-ManifestTemplate" class="definition panel" data-traverse-target="definition-ManifestTemplate">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ManifestTemplate"></a>ManifestTemplate: 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="template_id">
|
||
<span class="json-property-name">template_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="manifest">
|
||
<span class="json-property-name">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="template_name">
|
||
<span class="json-property-name">template_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="template_description">
|
||
<span class="json-property-name">template_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="project_id">
|
||
<span class="json-property-name">project_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="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>
|
||
<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="is_removed">
|
||
<span class="json-property-name">is_removed:</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="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">"template_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"template_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"template_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"is_removed"</span>: <span class="hljs-string">"boolean"</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-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>
|
||
<dt data-property-name="deactivated_at">
|
||
<span class="json-property-name">deactivated_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>,
|
||
<span class="hljs-attr">"deactivated_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_id">
|
||
<span class="json-property-name">user_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="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_id"</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-MemberStat" class="definition panel" data-traverse-target="definition-MemberStat">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/MemberStat"></a>MemberStat: 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="Owner">
|
||
<span class="json-property-name">Owner:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/Owner">Owner</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Total">
|
||
<span class="json-property-name">Total:</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">"Owner"</span>: {
|
||
<span class="hljs-attr">"UserId"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"Username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"Total"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</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="IsPrivate">
|
||
<span class="json-property-name">IsPrivate:</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="AuthType">
|
||
<span class="json-property-name">AuthType:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/AuthType">AuthType</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></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>
|
||
</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>
|
||
</dt>
|
||
<dt data-property-name="Password">
|
||
<span class="json-property-name">Password:</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="SSHPrivateKey">
|
||
<span class="json-property-name">SSHPrivateKey:</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="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="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>
|
||
<dt data-property-name="LastSyncedAt">
|
||
<span class="json-property-name">LastSyncedAt:</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">"IsPrivate"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"AuthType"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"IsRemoved"</span>: <span class="hljs-string">"boolean"</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>,
|
||
<span class="hljs-attr">"LastSyncedAt"</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>
|
||
<dt data-property-name="IsPrivate">
|
||
<span class="json-property-name">IsPrivate:</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="AuthType">
|
||
<span class="json-property-name">AuthType:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/AuthType">AuthType</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></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>
|
||
</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>
|
||
</dt>
|
||
<dt data-property-name="Password">
|
||
<span class="json-property-name">Password:</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="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="SSHPrivateKey">
|
||
<span class="json-property-name">SSHPrivateKey:</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="SSHPublicKey">
|
||
<span class="json-property-name">SSHPublicKey:</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="LastSyncedAt">
|
||
<span class="json-property-name">LastSyncedAt:</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>,
|
||
<span class="hljs-attr">"IsPrivate"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"AuthType"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"IsRemoved"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPublicKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"LastSyncedAt"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Owner" class="definition panel" data-traverse-target="definition-Owner">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Owner"></a>Owner: 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="UserId">
|
||
<span class="json-property-name">UserId:</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="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">"UserId"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"Username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Name"</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-Pagination" class="definition panel" data-traverse-target="definition-Pagination">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Pagination"></a>Pagination: 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="page">
|
||
<span class="json-property-name">page:</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>
|
||
<dt data-property-name="limit">
|
||
<span class="json-property-name">limit:</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">"page"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"limit"</span>: <span class="hljs-string">"number"</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-PortalDashboardData" class="definition panel" data-traverse-target="definition-PortalDashboardData">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/PortalDashboardData"></a>PortalDashboardData: 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="dashboard_data">
|
||
<span class="json-property-name">dashboard_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">"name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"dashboard_data"</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">"deactivated_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-ProjectData" class="definition panel" data-traverse-target="definition-ProjectData">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ProjectData"></a>ProjectData: 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="Workflows">
|
||
<span class="json-property-name">Workflows:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowStat">WorkflowStat</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Agents">
|
||
<span class="json-property-name">Agents:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/AgentStat">AgentStat</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="Members">
|
||
<span class="json-property-name">Members:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/MemberStat">MemberStat</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">"Workflows"</span>: {
|
||
<span class="hljs-attr">"Schedules"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"ExpRuns"</span>: <span class="hljs-string">"number"</span>
|
||
},
|
||
<span class="hljs-attr">"Agents"</span>: {
|
||
<span class="hljs-attr">"Ns"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Cluster"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Total"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Active"</span>: <span class="hljs-string">"number"</span>
|
||
},
|
||
<span class="hljs-attr">"ProjectId"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Members"</span>: {
|
||
<span class="hljs-attr">"Owner"</span>: {
|
||
<span class="hljs-attr">"UserId"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"Username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"Total"</span>: <span class="hljs-string">"number"</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-SSHKey" class="definition panel" data-traverse-target="definition-SSHKey">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/SSHKey"></a>SSHKey: 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="publicKey">
|
||
<span class="json-property-name">publicKey:</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="privateKey">
|
||
<span class="json-property-name">privateKey:</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">"publicKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"privateKey"</span>: <span class="hljs-string">"string"</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>
|
||
<dt data-property-name="getKubeObject">
|
||
<span class="json-property-name">getKubeObject:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/KubeObjectResponse">KubeObjectResponse</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="viewDashboard">
|
||
<span class="json-property-name">viewDashboard:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/dashboardPromResponse">dashboardPromResponse</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">"last_workflow_timestamp"</span>: <span class="hljs-string">"string"</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">"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">"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">"phase"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resiliency_score"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_passed"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_failed"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_awaited"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_stopped"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_na"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"total_experiments"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"execution_data"</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-TemplateInput" class="definition panel" data-traverse-target="definition-TemplateInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/TemplateInput"></a>TemplateInput: 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="manifest">
|
||
<span class="json-property-name">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="template_name">
|
||
<span class="json-property-name">template_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="template_description">
|
||
<span class="json-property-name">template_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="project_id">
|
||
<span class="json-property-name">project_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="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">"manifest"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"template_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"template_description"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"project_id"</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-TimeFrequency" class="definition panel" data-traverse-target="definition-TimeFrequency">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/TimeFrequency"></a>TimeFrequency: 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">Monthly</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">Daily</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">Hourly</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd> </dd>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-TotalCount" class="definition panel" data-traverse-target="definition-TotalCount">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/TotalCount"></a>TotalCount: 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="Projects">
|
||
<span class="json-property-name">Projects:</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>
|
||
<dt data-property-name="Users">
|
||
<span class="json-property-name">Users:</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>
|
||
<dt data-property-name="Agents">
|
||
<span class="json-property-name">Agents:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/AgentStat">AgentStat</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Workflows">
|
||
<span class="json-property-name">Workflows:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowStat">WorkflowStat</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">"Projects"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Users"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Agents"</span>: {
|
||
<span class="hljs-attr">"Ns"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Cluster"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Total"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Active"</span>: <span class="hljs-string">"number"</span>
|
||
},
|
||
<span class="hljs-attr">"Workflows"</span>: {
|
||
<span class="hljs-attr">"Schedules"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"ExpRuns"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-UpdateMyHub" class="definition panel" data-traverse-target="definition-UpdateMyHub">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/UpdateMyHub"></a>UpdateMyHub: 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="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="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="IsPrivate">
|
||
<span class="json-property-name">IsPrivate:</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="AuthType">
|
||
<span class="json-property-name">AuthType:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/AuthType">AuthType</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></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>
|
||
</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>
|
||
</dt>
|
||
<dt data-property-name="Password">
|
||
<span class="json-property-name">Password:</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="SSHPrivateKey">
|
||
<span class="json-property-name">SSHPrivateKey:</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="SSHPublicKey">
|
||
<span class="json-property-name">SSHPublicKey:</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">"string"</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">"IsPrivate"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"AuthType"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Token"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"UserName"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Password"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPrivateKey"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"SSHPublicKey"</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-UsageData" class="definition panel" data-traverse-target="definition-UsageData">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/UsageData"></a>UsageData: 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="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/ProjectData">ProjectData</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="TotalEntries">
|
||
<span class="json-property-name">TotalEntries:</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>
|
||
<dt data-property-name="TotalCount">
|
||
<span class="json-property-name">TotalCount:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/TotalCount">TotalCount</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">"Projects"</span>: [
|
||
{
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Workflows"</span>: {
|
||
<span class="hljs-attr">"Schedules"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"ExpRuns"</span>: <span class="hljs-string">"number"</span>
|
||
},
|
||
<span class="hljs-attr">"Agents"</span>: {
|
||
<span class="hljs-attr">"Ns"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Cluster"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Total"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Active"</span>: <span class="hljs-string">"number"</span>
|
||
},
|
||
<span class="hljs-attr">"ProjectId"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Members"</span>: {
|
||
<span class="hljs-attr">"Owner"</span>: {
|
||
<span class="hljs-attr">"UserId"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"Username"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Name"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"Total"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
}
|
||
],
|
||
<span class="hljs-attr">"TotalEntries"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"TotalCount"</span>: {
|
||
<span class="hljs-attr">"Projects"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Users"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Agents"</span>: {
|
||
<span class="hljs-attr">"Ns"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Cluster"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Total"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Active"</span>: <span class="hljs-string">"number"</span>
|
||
},
|
||
<span class="hljs-attr">"Workflows"</span>: {
|
||
<span class="hljs-attr">"Schedules"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"ExpRuns"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-UsageQuery" class="definition panel" data-traverse-target="definition-UsageQuery">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/UsageQuery"></a>UsageQuery: 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="Pagination">
|
||
<span class="json-property-name">Pagination:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/Pagination">Pagination</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="DateRange">
|
||
<span class="json-property-name">DateRange:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/DateRange">DateRange</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Sort">
|
||
<span class="json-property-name">Sort:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/UsageSortInput">UsageSortInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="SearchProject">
|
||
<span class="json-property-name">SearchProject:</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">"Pagination"</span>: {
|
||
<span class="hljs-attr">"page"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"limit"</span>: <span class="hljs-string">"number"</span>
|
||
},
|
||
<span class="hljs-attr">"DateRange"</span>: {
|
||
<span class="hljs-attr">"start_date"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end_date"</span>: <span class="hljs-string">"string"</span>
|
||
},
|
||
<span class="hljs-attr">"Sort"</span>: {
|
||
<span class="hljs-attr">"Field"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Descending"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"SearchProject"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-UsageSort" class="definition panel" data-traverse-target="definition-UsageSort">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/UsageSort"></a>UsageSort: 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">Project</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">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">Agents</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">Schedules</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">WorkflowRuns</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">ExperimentRuns</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">TeamMembers</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd> </dd>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-UsageSortInput" class="definition panel" data-traverse-target="definition-UsageSortInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/UsageSortInput"></a>UsageSortInput: 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="Field">
|
||
<span class="json-property-name">Field:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/UsageSort">UsageSort</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Descending">
|
||
<span class="json-property-name">Descending:</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">"Field"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"Descending"</span>: <span class="hljs-string">"boolean"</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="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="deactivated_at">
|
||
<span class="json-property-name">deactivated_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">"deactivated_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">"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">"deactivated_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>
|
||
</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-WorkflowFilterInput" class="definition panel" data-traverse-target="definition-WorkflowFilterInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowFilterInput"></a>WorkflowFilterInput: 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_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>
|
||
</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>
|
||
</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_name"</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-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="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="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="phase">
|
||
<span class="json-property-name">phase:</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="resiliency_score">
|
||
<span class="json-property-name">resiliency_score:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="experiments_passed">
|
||
<span class="json-property-name">experiments_passed:</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="experiments_failed">
|
||
<span class="json-property-name">experiments_failed:</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="experiments_awaited">
|
||
<span class="json-property-name">experiments_awaited:</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="experiments_stopped">
|
||
<span class="json-property-name">experiments_stopped:</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="experiments_na">
|
||
<span class="json-property-name">experiments_na:</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="total_experiments">
|
||
<span class="json-property-name">total_experiments:</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="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="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>
|
||
</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">"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">"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">"phase"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resiliency_score"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_passed"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_failed"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_awaited"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_stopped"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_na"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"total_experiments"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"execution_data"</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-WorkflowRunDetails" class="definition panel" data-traverse-target="definition-WorkflowRunDetails">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowRunDetails"></a>WorkflowRunDetails: 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="no_of_runs">
|
||
<span class="json-property-name">no_of_runs:</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>
|
||
<dt data-property-name="date_stamp">
|
||
<span class="json-property-name">date_stamp:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</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">"no_of_runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"date_stamp"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowRunFilterInput" class="definition panel" data-traverse-target="definition-WorkflowRunFilterInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowRunFilterInput"></a>WorkflowRunFilterInput: 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_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>
|
||
</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>
|
||
</dt>
|
||
<dt data-property-name="workflow_status">
|
||
<span class="json-property-name">workflow_status:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowRunStatus">WorkflowRunStatus</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="date_range">
|
||
<span class="json-property-name">date_range:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/DateRange">DateRange</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_name"</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_status"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"date_range"</span>: {
|
||
<span class="hljs-attr">"start_date"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end_date"</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>
|
||
<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>
|
||
</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>,
|
||
<span class="hljs-attr">"isRemoved"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowRunSortInput" class="definition panel" data-traverse-target="definition-WorkflowRunSortInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowRunSortInput"></a>WorkflowRunSortInput: 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="field">
|
||
<span class="json-property-name">field:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowSortingField">WorkflowSortingField</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="descending">
|
||
<span class="json-property-name">descending:</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">"field"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"descending"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowRunStatsRequest" class="definition panel" data-traverse-target="definition-WorkflowRunStatsRequest">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowRunStatsRequest"></a>WorkflowRunStatsRequest: 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="workflow_ids">
|
||
<span class="json-property-name">workflow_ids:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</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">"workflow_ids"</span>: [
|
||
<span class="hljs-string">"object"</span>
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowRunStatsResponse" class="definition panel" data-traverse-target="definition-WorkflowRunStatsResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowRunStatsResponse"></a>WorkflowRunStatsResponse: 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="total_workflow_runs">
|
||
<span class="json-property-name">total_workflow_runs:</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>
|
||
<dt data-property-name="succeeded_workflow_runs">
|
||
<span class="json-property-name">succeeded_workflow_runs:</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>
|
||
<dt data-property-name="failed_workflow_runs">
|
||
<span class="json-property-name">failed_workflow_runs:</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>
|
||
<dt data-property-name="running_workflow_runs">
|
||
<span class="json-property-name">running_workflow_runs:</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>
|
||
<dt data-property-name="average_resiliency_score">
|
||
<span class="json-property-name">average_resiliency_score:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="total_experiments">
|
||
<span class="json-property-name">total_experiments:</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>
|
||
<dt data-property-name="experiments_passed">
|
||
<span class="json-property-name">experiments_passed:</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>
|
||
<dt data-property-name="experiments_failed">
|
||
<span class="json-property-name">experiments_failed:</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>
|
||
<dt data-property-name="experiments_awaited">
|
||
<span class="json-property-name">experiments_awaited:</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>
|
||
<dt data-property-name="experiments_stopped">
|
||
<span class="json-property-name">experiments_stopped:</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>
|
||
<dt data-property-name="experiments_na">
|
||
<span class="json-property-name">experiments_na:</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>
|
||
<dt data-property-name="passed_percentage">
|
||
<span class="json-property-name">passed_percentage:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="failed_percentage">
|
||
<span class="json-property-name">failed_percentage:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</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_succeeded_percentage">
|
||
<span class="json-property-name">workflow_run_succeeded_percentage:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</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_failed_percentage">
|
||
<span class="json-property-name">workflow_run_failed_percentage:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</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">"total_workflow_runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"succeeded_workflow_runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"failed_workflow_runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"running_workflow_runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"average_resiliency_score"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"total_experiments"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_passed"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_failed"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_awaited"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_stopped"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"experiments_na"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"passed_percentage"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"failed_percentage"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"workflow_run_succeeded_percentage"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"workflow_run_failed_percentage"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowRunStatus" class="definition panel" data-traverse-target="definition-WorkflowRunStatus">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowRunStatus"></a>WorkflowRunStatus: 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">All</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">Failed</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">Running</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">Succeeded</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd> </dd>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowRunsData" class="definition panel" data-traverse-target="definition-WorkflowRunsData">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowRunsData"></a>WorkflowRunsData: 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="value">
|
||
<span class="json-property-name">value:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="workflowRunDetail">
|
||
<span class="json-property-name">workflowRunDetail:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowRunDetails">WorkflowRunDetails</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">"value"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"workflowRunDetail"</span>: {
|
||
<span class="hljs-attr">"no_of_runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"date_stamp"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowSortInput" class="definition panel" data-traverse-target="definition-WorkflowSortInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowSortInput"></a>WorkflowSortInput: 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="field">
|
||
<span class="json-property-name">field:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/WorkflowSortingField">WorkflowSortingField</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="descending">
|
||
<span class="json-property-name">descending:</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">"field"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"descending"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowSortingField" class="definition panel" data-traverse-target="definition-WorkflowSortingField">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowSortingField"></a>WorkflowSortingField: 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">Name</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">Time</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd> </dd>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowStat" class="definition panel" data-traverse-target="definition-WorkflowStat">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowStat"></a>WorkflowStat: 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="Schedules">
|
||
<span class="json-property-name">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>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="Runs">
|
||
<span class="json-property-name">Runs:</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>
|
||
<dt data-property-name="ExpRuns">
|
||
<span class="json-property-name">ExpRuns:</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">"Schedules"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"Runs"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"ExpRuns"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-WorkflowStats" class="definition panel" data-traverse-target="definition-WorkflowStats">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/WorkflowStats"></a>WorkflowStats: 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="date">
|
||
<span class="json-property-name">date:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="value">
|
||
<span class="json-property-name">value:</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">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-annotationsPromResponse" class="definition panel" data-traverse-target="definition-annotationsPromResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/annotationsPromResponse"></a>annotationsPromResponse: 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="queryid">
|
||
<span class="json-property-name">queryid:</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="legends">
|
||
<span class="json-property-name">legends:</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="tsvs">
|
||
<span class="json-property-name">tsvs:</span>
|
||
<div class="json-property-type">object[][]</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="subDataArray">
|
||
<span class="json-property-name">subDataArray:</span>
|
||
<div class="json-property-type">object[][]</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">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legends"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"tsvs"</span>: [
|
||
[
|
||
{
|
||
<span class="hljs-attr">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
]
|
||
],
|
||
<span class="hljs-attr">"subDataArray"</span>: [
|
||
[
|
||
{
|
||
<span class="hljs-attr">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"subDataName"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-annotationsTimeStampValue" class="definition panel" data-traverse-target="definition-annotationsTimeStampValue">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/annotationsTimeStampValue"></a>annotationsTimeStampValue: 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="date">
|
||
<span class="json-property-name">date:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="value">
|
||
<span class="json-property-name">value:</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>
|
||
</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">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-applicationMetadata" class="definition panel" data-traverse-target="definition-applicationMetadata">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/applicationMetadata"></a>applicationMetadata: 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="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="applications">
|
||
<span class="json-property-name">applications:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/resource">resource</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">"namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"applications"</span>: [
|
||
{
|
||
<span class="hljs-attr">"kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"names"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-applicationMetadataResponse" class="definition panel" data-traverse-target="definition-applicationMetadataResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/applicationMetadataResponse"></a>applicationMetadataResponse: 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="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="applications">
|
||
<span class="json-property-name">applications:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/resourceResponse">resourceResponse</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">"namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"applications"</span>: [
|
||
{
|
||
<span class="hljs-attr">"kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"names"</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-createDBInput" class="definition panel" data-traverse-target="definition-createDBInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/createDBInput"></a>createDBInput: 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="ds_id">
|
||
<span class="json-property-name">ds_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="db_name">
|
||
<span class="json-property-name">db_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="db_type_name">
|
||
<span class="json-property-name">db_type_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="db_type_id">
|
||
<span class="json-property-name">db_type_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="db_information">
|
||
<span class="json-property-name">db_information:</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_event_query_template">
|
||
<span class="json-property-name">chaos_event_query_template:</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="chaos_verdict_query_template">
|
||
<span class="json-property-name">chaos_verdict_query_template:</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="application_metadata_map">
|
||
<span class="json-property-name">application_metadata_map:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/applicationMetadata">applicationMetadata</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="panel_groups">
|
||
<span class="json-property-name">panel_groups:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/panelGroup">panelGroup</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="end_time">
|
||
<span class="json-property-name">end_time:</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="start_time">
|
||
<span class="json-property-name">start_time:</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="refresh_rate">
|
||
<span class="json-property-name">refresh_rate:</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">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_information"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_event_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_verdict_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"application_metadata_map"</span>: [
|
||
{
|
||
<span class="hljs-attr">"namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"applications"</span>: [
|
||
{
|
||
<span class="hljs-attr">"kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"names"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
]
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_groups"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panels"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panel_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_left"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_right"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"x_axis_down"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"unit"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_options"</span>: {
|
||
<span class="hljs-attr">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"panel_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_group_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"end_time"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start_time"</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">"refresh_rate"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-dashboardPromResponse" class="definition panel" data-traverse-target="definition-dashboardPromResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/dashboardPromResponse"></a>dashboardPromResponse: 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="dashboardMetricsResponse">
|
||
<span class="json-property-name">dashboardMetricsResponse:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/metricDataForPanelGroup">metricDataForPanelGroup</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="annotationsResponse">
|
||
<span class="json-property-name">annotationsResponse:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/annotationsPromResponse">annotationsPromResponse</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">"dashboardMetricsResponse"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panelGroupID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panelGroupMetricsResponse"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panelID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"PanelMetricsResponse"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legends"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"tsvs"</span>: [
|
||
[
|
||
{
|
||
<span class="hljs-attr">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
]
|
||
]
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
],
|
||
<span class="hljs-attr">"annotationsResponse"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legends"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"tsvs"</span>: [
|
||
[
|
||
{
|
||
<span class="hljs-attr">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
]
|
||
],
|
||
<span class="hljs-attr">"subDataArray"</span>: [
|
||
[
|
||
{
|
||
<span class="hljs-attr">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"subDataName"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
]
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-dataVars" class="definition panel" data-traverse-target="definition-dataVars">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/dataVars"></a>dataVars: 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="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>
|
||
<dt data-property-name="start">
|
||
<span class="json-property-name">start:</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="end">
|
||
<span class="json-property-name">end:</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="relative_time">
|
||
<span class="json-property-name">relative_time:</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>
|
||
<dt data-property-name="refresh_interval">
|
||
<span class="json-property-name">refresh_interval:</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">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"relative_time"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"refresh_interval"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-deleteDSInput" class="definition panel" data-traverse-target="definition-deleteDSInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/deleteDSInput"></a>deleteDSInput: 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="force_delete">
|
||
<span class="json-property-name">force_delete:</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="ds_id">
|
||
<span class="json-property-name">ds_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">"force_delete"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"ds_id"</span>: <span class="hljs-string">"object"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-dsDetails" class="definition panel" data-traverse-target="definition-dsDetails">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/dsDetails"></a>dsDetails: 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="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>
|
||
<dt data-property-name="start">
|
||
<span class="json-property-name">start:</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="end">
|
||
<span class="json-property-name">end:</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">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-imageRegistry" class="definition panel" data-traverse-target="definition-imageRegistry">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/imageRegistry"></a>imageRegistry: 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="is_default">
|
||
<span class="json-property-name">is_default:</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="image_registry_name">
|
||
<span class="json-property-name">image_registry_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="image_repo_name">
|
||
<span class="json-property-name">image_repo_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="image_registry_type">
|
||
<span class="json-property-name">image_registry_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="secret_name">
|
||
<span class="json-property-name">secret_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="secret_namespace">
|
||
<span class="json-property-name">secret_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="enable_registry">
|
||
<span class="json-property-name">enable_registry:</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">"is_default"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"image_registry_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"image_repo_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"image_registry_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"secret_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"secret_namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"enable_registry"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-imageRegistryInput" class="definition panel" data-traverse-target="definition-imageRegistryInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/imageRegistryInput"></a>imageRegistryInput: 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="is_default">
|
||
<span class="json-property-name">is_default:</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="image_registry_name">
|
||
<span class="json-property-name">image_registry_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="image_repo_name">
|
||
<span class="json-property-name">image_repo_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="image_registry_type">
|
||
<span class="json-property-name">image_registry_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="secret_name">
|
||
<span class="json-property-name">secret_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="secret_namespace">
|
||
<span class="json-property-name">secret_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="enable_registry">
|
||
<span class="json-property-name">enable_registry:</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">"is_default"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"image_registry_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"image_repo_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"image_registry_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"secret_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"secret_namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"enable_registry"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-labelValue" class="definition panel" data-traverse-target="definition-labelValue">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/labelValue"></a>labelValue: 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="label">
|
||
<span class="json-property-name">label:</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="values">
|
||
<span class="json-property-name">values:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/option">option</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">"label"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"values"</span>: [
|
||
{
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-listDashboardResponse" class="definition panel" data-traverse-target="definition-listDashboardResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/listDashboardResponse"></a>listDashboardResponse: 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="ds_id">
|
||
<span class="json-property-name">ds_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="db_id">
|
||
<span class="json-property-name">db_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="db_name">
|
||
<span class="json-property-name">db_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="db_type_id">
|
||
<span class="json-property-name">db_type_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="db_type_name">
|
||
<span class="json-property-name">db_type_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="db_information">
|
||
<span class="json-property-name">db_information:</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_event_query_template">
|
||
<span class="json-property-name">chaos_event_query_template:</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="chaos_verdict_query_template">
|
||
<span class="json-property-name">chaos_verdict_query_template:</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="application_metadata_map">
|
||
<span class="json-property-name">application_metadata_map:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/applicationMetadataResponse">applicationMetadataResponse</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></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>
|
||
</dt>
|
||
<dt data-property-name="ds_name">
|
||
<span class="json-property-name">ds_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="ds_type">
|
||
<span class="json-property-name">ds_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="ds_url">
|
||
<span class="json-property-name">ds_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>
|
||
</dt>
|
||
<dt data-property-name="ds_health_status">
|
||
<span class="json-property-name">ds_health_status:</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="panel_groups">
|
||
<span class="json-property-name">panel_groups:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/panelGroupResponse">panelGroupResponse</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="end_time">
|
||
<span class="json-property-name">end_time:</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="start_time">
|
||
<span class="json-property-name">start_time:</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="refresh_rate">
|
||
<span class="json-property-name">refresh_rate:</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="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>
|
||
</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>
|
||
</dt>
|
||
<dt data-property-name="viewed_at">
|
||
<span class="json-property-name">viewed_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>
|
||
</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">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_information"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_event_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_verdict_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"application_metadata_map"</span>: [
|
||
{
|
||
<span class="hljs-attr">"namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"applications"</span>: [
|
||
{
|
||
<span class="hljs-attr">"kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"names"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
]
|
||
}
|
||
],
|
||
<span class="hljs-attr">"cluster_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_type"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_health_status"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_groups"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panels"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panel_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_left"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_right"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"x_axis_down"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"unit"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_options"</span>: {
|
||
<span class="hljs-attr">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"panel_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_group_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"end_time"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start_time"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"refresh_rate"</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>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-metricDataForPanel" class="definition panel" data-traverse-target="definition-metricDataForPanel">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/metricDataForPanel"></a>metricDataForPanel: 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="panelID">
|
||
<span class="json-property-name">panelID:</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="PanelMetricsResponse">
|
||
<span class="json-property-name">PanelMetricsResponse:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/metricsPromResponse">metricsPromResponse</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">"panelID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"PanelMetricsResponse"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legends"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"tsvs"</span>: [
|
||
[
|
||
{
|
||
<span class="hljs-attr">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
]
|
||
]
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-metricDataForPanelGroup" class="definition panel" data-traverse-target="definition-metricDataForPanelGroup">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/metricDataForPanelGroup"></a>metricDataForPanelGroup: 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="panelGroupID">
|
||
<span class="json-property-name">panelGroupID:</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="panelGroupMetricsResponse">
|
||
<span class="json-property-name">panelGroupMetricsResponse:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/metricDataForPanel">metricDataForPanel</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">"panelGroupID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panelGroupMetricsResponse"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panelID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"PanelMetricsResponse"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legends"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"tsvs"</span>: [
|
||
[
|
||
{
|
||
<span class="hljs-attr">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
]
|
||
]
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-metricsPromResponse" class="definition panel" data-traverse-target="definition-metricsPromResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/metricsPromResponse"></a>metricsPromResponse: 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="queryid">
|
||
<span class="json-property-name">queryid:</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="legends">
|
||
<span class="json-property-name">legends:</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="tsvs">
|
||
<span class="json-property-name">tsvs:</span>
|
||
<div class="json-property-type">object[][]</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">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legends"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"tsvs"</span>: [
|
||
[
|
||
{
|
||
<span class="hljs-attr">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
]
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-metricsTimeStampValue" class="definition panel" data-traverse-target="definition-metricsTimeStampValue">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/metricsTimeStampValue"></a>metricsTimeStampValue: 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="date">
|
||
<span class="json-property-name">date:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="value">
|
||
<span class="json-property-name">value:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</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">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-option" class="definition panel" data-traverse-target="definition-option">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/option"></a>option: 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-panel" class="definition panel" data-traverse-target="definition-panel">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/panel"></a>panel: 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="panel_id">
|
||
<span class="json-property-name">panel_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="db_id">
|
||
<span class="json-property-name">db_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="y_axis_left">
|
||
<span class="json-property-name">y_axis_left:</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="y_axis_right">
|
||
<span class="json-property-name">y_axis_right:</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="x_axis_down">
|
||
<span class="json-property-name">x_axis_down:</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="unit">
|
||
<span class="json-property-name">unit:</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="panel_group_id">
|
||
<span class="json-property-name">panel_group_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="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>
|
||
</dt>
|
||
<dt data-property-name="prom_queries">
|
||
<span class="json-property-name">prom_queries:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/promQuery">promQuery</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="panel_options">
|
||
<span class="json-property-name">panel_options:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/panelOption">panelOption</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="panel_name">
|
||
<span class="json-property-name">panel_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">"panel_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_left"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_right"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"x_axis_down"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"unit"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_options"</span>: {
|
||
<span class="hljs-attr">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"panel_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-panelGroup" class="definition panel" data-traverse-target="definition-panelGroup">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/panelGroup"></a>panelGroup: 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="panels">
|
||
<span class="json-property-name">panels:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/panel">panel</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="panel_group_name">
|
||
<span class="json-property-name">panel_group_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">"panels"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panel_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_left"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_right"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"x_axis_down"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"unit"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_options"</span>: {
|
||
<span class="hljs-attr">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"panel_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_group_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-panelGroupResponse" class="definition panel" data-traverse-target="definition-panelGroupResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/panelGroupResponse"></a>panelGroupResponse: 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="panels">
|
||
<span class="json-property-name">panels:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/panelResponse">panelResponse</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="panel_group_name">
|
||
<span class="json-property-name">panel_group_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="panel_group_id">
|
||
<span class="json-property-name">panel_group_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">"panels"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panel_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_left"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_right"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"x_axis_down"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"unit"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_options"</span>: {
|
||
<span class="hljs-attr">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"panel_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_group_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-panelOption" class="definition panel" data-traverse-target="definition-panelOption">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/panelOption"></a>panelOption: 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="points">
|
||
<span class="json-property-name">points:</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="grids">
|
||
<span class="json-property-name">grids:</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="left_axis">
|
||
<span class="json-property-name">left_axis:</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">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-panelOptionResponse" class="definition panel" data-traverse-target="definition-panelOptionResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/panelOptionResponse"></a>panelOptionResponse: 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="points">
|
||
<span class="json-property-name">points:</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="grids">
|
||
<span class="json-property-name">grids:</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="left_axis">
|
||
<span class="json-property-name">left_axis:</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">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-panelResponse" class="definition panel" data-traverse-target="definition-panelResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/panelResponse"></a>panelResponse: 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="panel_id">
|
||
<span class="json-property-name">panel_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="y_axis_left">
|
||
<span class="json-property-name">y_axis_left:</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="y_axis_right">
|
||
<span class="json-property-name">y_axis_right:</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="x_axis_down">
|
||
<span class="json-property-name">x_axis_down:</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="unit">
|
||
<span class="json-property-name">unit:</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="prom_queries">
|
||
<span class="json-property-name">prom_queries:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/promQueryResponse">promQueryResponse</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="panel_options">
|
||
<span class="json-property-name">panel_options:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/panelOptionResponse">panelOptionResponse</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="panel_name">
|
||
<span class="json-property-name">panel_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="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>
|
||
</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">"panel_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_left"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_right"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"x_axis_down"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"unit"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_options"</span>: {
|
||
<span class="hljs-attr">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"panel_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-promInput" class="definition panel" data-traverse-target="definition-promInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/promInput"></a>promInput: 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="queries">
|
||
<span class="json-property-name">queries:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/promQueryInput">promQueryInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="ds_details">
|
||
<span class="json-property-name">ds_details:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/dsDetails">dsDetails</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">"queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"query"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"ds_details"</span>: {
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-promQuery" class="definition panel" data-traverse-target="definition-promQuery">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/promQuery"></a>promQuery: 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="queryid">
|
||
<span class="json-property-name">queryid:</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="prom_query_name">
|
||
<span class="json-property-name">prom_query_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="legend">
|
||
<span class="json-property-name">legend:</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="resolution">
|
||
<span class="json-property-name">resolution:</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="minstep">
|
||
<span class="json-property-name">minstep:</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="line">
|
||
<span class="json-property-name">line:</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="close_area">
|
||
<span class="json-property-name">close_area:</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">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-promQueryInput" class="definition panel" data-traverse-target="definition-promQueryInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/promQueryInput"></a>promQueryInput: 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="queryid">
|
||
<span class="json-property-name">queryid:</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="query">
|
||
<span class="json-property-name">query:</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="legend">
|
||
<span class="json-property-name">legend:</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="resolution">
|
||
<span class="json-property-name">resolution:</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="minstep">
|
||
<span class="json-property-name">minstep:</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">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"query"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-promQueryResponse" class="definition panel" data-traverse-target="definition-promQueryResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/promQueryResponse"></a>promQueryResponse: 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="queryid">
|
||
<span class="json-property-name">queryid:</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="prom_query_name">
|
||
<span class="json-property-name">prom_query_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="legend">
|
||
<span class="json-property-name">legend:</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="resolution">
|
||
<span class="json-property-name">resolution:</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="minstep">
|
||
<span class="json-property-name">minstep:</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="line">
|
||
<span class="json-property-name">line:</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="close_area">
|
||
<span class="json-property-name">close_area:</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">"queryid"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-promResponse" class="definition panel" data-traverse-target="definition-promResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/promResponse"></a>promResponse: 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="metricsResponse">
|
||
<span class="json-property-name">metricsResponse:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/metricsPromResponse">metricsPromResponse</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="annotationsResponse">
|
||
<span class="json-property-name">annotationsResponse:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/annotationsPromResponse">annotationsPromResponse</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">"metricsResponse"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legends"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"tsvs"</span>: [
|
||
[
|
||
{
|
||
<span class="hljs-attr">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
]
|
||
]
|
||
}
|
||
],
|
||
<span class="hljs-attr">"annotationsResponse"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legends"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
],
|
||
<span class="hljs-attr">"tsvs"</span>: [
|
||
[
|
||
{
|
||
<span class="hljs-attr">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"number"</span>
|
||
}
|
||
]
|
||
],
|
||
<span class="hljs-attr">"subDataArray"</span>: [
|
||
[
|
||
{
|
||
<span class="hljs-attr">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"subDataName"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
]
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-promSeriesInput" class="definition panel" data-traverse-target="definition-promSeriesInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/promSeriesInput"></a>promSeriesInput: 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="series">
|
||
<span class="json-property-name">series:</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="ds_details">
|
||
<span class="json-property-name">ds_details:</span>
|
||
<div class="json-property-type">
|
||
<div class="">
|
||
<a class="json-schema-ref" href="#/definitions/dsDetails">dsDetails</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">"series"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_details"</span>: {
|
||
<span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"end"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-promSeriesListResponse" class="definition panel" data-traverse-target="definition-promSeriesListResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/promSeriesListResponse"></a>promSeriesListResponse: 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="seriesList">
|
||
<span class="json-property-name">seriesList:</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>
|
||
</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">"seriesList"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-promSeriesResponse" class="definition panel" data-traverse-target="definition-promSeriesResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/promSeriesResponse"></a>promSeriesResponse: 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="series">
|
||
<span class="json-property-name">series:</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="labelValues">
|
||
<span class="json-property-name">labelValues:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/labelValue">labelValue</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">"series"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"labelValues"</span>: [
|
||
{
|
||
<span class="hljs-attr">"label"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"values"</span>: [
|
||
{
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-queryMapForPanel" class="definition panel" data-traverse-target="definition-queryMapForPanel">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/queryMapForPanel"></a>queryMapForPanel: 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="panelID">
|
||
<span class="json-property-name">panelID:</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="queryIDs">
|
||
<span class="json-property-name">queryIDs:</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>
|
||
</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">"panelID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"queryIDs"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-queryMapForPanelGroup" class="definition panel" data-traverse-target="definition-queryMapForPanelGroup">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/queryMapForPanelGroup"></a>queryMapForPanelGroup: 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="panelGroupID">
|
||
<span class="json-property-name">panelGroupID:</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="panelQueryMap">
|
||
<span class="json-property-name">panelQueryMap:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/queryMapForPanel">queryMapForPanel</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">"panelGroupID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panelQueryMap"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panelID"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"queryIDs"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-resource" class="definition panel" data-traverse-target="definition-resource">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/resource"></a>resource: 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="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="names">
|
||
<span class="json-property-name">names:</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>
|
||
</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">"kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"names"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-resourceResponse" class="definition panel" data-traverse-target="definition-resourceResponse">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/resourceResponse"></a>resourceResponse: 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="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="names">
|
||
<span class="json-property-name">names:</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>
|
||
</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">"kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"names"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-subData" class="definition panel" data-traverse-target="definition-subData">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/subData"></a>subData: 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="date">
|
||
<span class="json-property-name">date:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-number">
|
||
<a class="json-schema-ref" href="#/definitions/Float">Float</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="value">
|
||
<span class="json-property-name">value:</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="subDataName">
|
||
<span class="json-property-name">subDataName:</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">"date"</span>: <span class="hljs-string">"number"</span>,
|
||
<span class="hljs-attr">"value"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"subDataName"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-updateDBInput" class="definition panel" data-traverse-target="definition-updateDBInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/updateDBInput"></a>updateDBInput: 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="db_id">
|
||
<span class="json-property-name">db_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="ds_id">
|
||
<span class="json-property-name">ds_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="db_name">
|
||
<span class="json-property-name">db_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="db_type_name">
|
||
<span class="json-property-name">db_type_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="db_type_id">
|
||
<span class="json-property-name">db_type_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="db_information">
|
||
<span class="json-property-name">db_information:</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_event_query_template">
|
||
<span class="json-property-name">chaos_event_query_template:</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_verdict_query_template">
|
||
<span class="json-property-name">chaos_verdict_query_template:</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="application_metadata_map">
|
||
<span class="json-property-name">application_metadata_map:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/applicationMetadata">applicationMetadata</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="panel_groups">
|
||
<span class="json-property-name">panel_groups:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/updatePanelGroupInput">updatePanelGroupInput</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="end_time">
|
||
<span class="json-property-name">end_time:</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="start_time">
|
||
<span class="json-property-name">start_time:</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="">
|
||
<a class="json-schema-ref" href="#/definitions/ID">ID</a>
|
||
</div>
|
||
</div>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="refresh_rate">
|
||
<span class="json-property-name">refresh_rate:</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">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"ds_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_type_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_information"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_event_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"chaos_verdict_query_template"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"application_metadata_map"</span>: [
|
||
{
|
||
<span class="hljs-attr">"namespace"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"applications"</span>: [
|
||
{
|
||
<span class="hljs-attr">"kind"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"names"</span>: [
|
||
<span class="hljs-string">"string"</span>
|
||
]
|
||
}
|
||
]
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_groups"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panel_group_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panels"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panel_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_left"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_right"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"x_axis_down"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"unit"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_options"</span>: {
|
||
<span class="hljs-attr">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"panel_name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
]
|
||
}
|
||
],
|
||
<span class="hljs-attr">"end_time"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"start_time"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"cluster_id"</span>: <span class="hljs-string">"object"</span>,
|
||
<span class="hljs-attr">"refresh_rate"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre> </body>
|
||
</html>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-updatePanelGroupInput" class="definition panel" data-traverse-target="definition-updatePanelGroupInput">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/updatePanelGroupInput"></a>updatePanelGroupInput: 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="panel_group_name">
|
||
<span class="json-property-name">panel_group_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="panel_group_id">
|
||
<span class="json-property-name">panel_group_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="panels">
|
||
<span class="json-property-name">panels:</span>
|
||
<div class="json-property-type">
|
||
<div class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/panel">panel</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">"panel_group_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panels"</span>: [
|
||
{
|
||
<span class="hljs-attr">"panel_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"db_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_left"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"y_axis_right"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"x_axis_down"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"unit"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"panel_group_id"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"created_at"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_queries"</span>: [
|
||
{
|
||
<span class="hljs-attr">"queryid"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"prom_query_name"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"legend"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"resolution"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"minstep"</span>: <span class="hljs-string">"string"</span>,
|
||
<span class="hljs-attr">"line"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"close_area"</span>: <span class="hljs-string">"boolean"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"panel_options"</span>: {
|
||
<span class="hljs-attr">"points"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"grids"</span>: <span class="hljs-string">"boolean"</span>,
|
||
<span class="hljs-attr">"left_axis"</span>: <span class="hljs-string">"boolean"</span>
|
||
},
|
||
<span class="hljs-attr">"panel_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> |