api: refresh docs for Tilt v0.25.0 (#33)

milas · web-flow · commit a6912b9f8d3f · 2022-02-15T13:18:55.000-05:00
diff --git a/docs/core/cmd-v1alpha1.md b/docs/core/cmd-v1alpha1.md
@@ -159,7 +159,7 @@ Based loosely on ContainerStatus in Kubernetes
 
   - **disableStatus.disabled** (boolean), required
 
-    Whether this is currently disabled.
+    Whether this is currently disabled. Deprecated in favor of `State`.
 
   - **disableStatus.lastUpdateTime** (Time), required
 
@@ -172,6 +172,10 @@ Based loosely on ContainerStatus in Kubernetes
 
     The reason this status was updated.
 
+  - **disableStatus.state** (string), required
+
+    Whether this is currently disabled (if known)
+
 - **ready** (boolean)
 
   Specifies whether the command has passed its readiness probe.
diff --git a/docs/core/file-watch-v1alpha1.md b/docs/core/file-watch-v1alpha1.md
@@ -115,7 +115,7 @@ FileWatchStatus defines the observed state of FileWatch
 
   - **disableStatus.disabled** (boolean), required
 
-    Whether this is currently disabled.
+    Whether this is currently disabled. Deprecated in favor of `State`.
 
   - **disableStatus.lastUpdateTime** (Time), required
 
@@ -128,6 +128,10 @@ FileWatchStatus defines the observed state of FileWatch
 
     The reason this status was updated.
 
+  - **disableStatus.state** (string), required
+
+    Whether this is currently disabled (if known)
+
 - **error** (string)
 
   Error is set if there is a problem with the filesystem watch. If non-empty, consumers should assume that no filesystem events will be seen and that the file watcher is in a failed state.
diff --git a/docs/core/session-v1alpha1.md b/docs/core/session-v1alpha1.md
@@ -108,7 +108,7 @@ SessionStatus defines the observed state of Session
     <a name="TargetState"></a>
     *TargetState describes the current execution status for a target.
     
-    Either EXACTLY one of Waiting, Active, or Terminated will be populated or NONE of them will be. In the event that all states are null, the target is currently inactive or disabled and should not be expected to execute.*
+    Either EXACTLY one of Waiting, Active, Disabled, or Terminated will be populated or NONE of them will be. In the event that all states are null, the target is currently inactive or disabled and should not be expected to execute.*
 
   - **targets.state.active** (TargetStateActive)
 
@@ -130,6 +130,13 @@ SessionStatus defines the observed state of Session
     <a name="MicroTime"></a>
     *MicroTime is version of Time with microsecond level precision.*
 
+  - **targets.state.disabled** (TargetStateDisabled)
+
+    Disabled being non-nil indicates that the target is disabled.
+
+    <a name="TargetStateDisabled"></a>
+    *TargetStateDisabled is a target that has been disabled.*
+
   - **targets.state.terminated** (TargetStateTerminated)
 
     Terminated being non-nil indicates that the target finished execution either normally or due to failure.
diff --git a/docs/core/tiltfile-v1alpha1.md b/docs/core/tiltfile-v1alpha1.md
@@ -81,6 +81,17 @@ TiltfileSpec defines the desired state of Tiltfile
 
     UIButtons that can trigger a restart.
 
+- **stopOn** (StopOnSpec)
+
+  Objects that can stop execution of this Tiltfile.
+
+  <a name="StopOnSpec"></a>
+  **
+
+  - **stopOn.uiButtons** ([]string), required
+
+    UIButtons that can trigger a stop.
+
 
 
 
diff --git a/docs/interface/ui-resource-v1alpha1.md b/docs/interface/ui-resource-v1alpha1.md
@@ -187,6 +187,10 @@ UIResourceStatus defines the observed state of UIResource
 
     The name of the ConfigMap
 
+  - **disableStatus.state** (string), required
+
+    Whether this is currently disabled (if known)
+
 - **endpointLinks** ([]UIResourceLink)
 
   Links attached to this resource.
diff --git a/docs/kubernetes/kubernetes-apply-v1alpha1.md b/docs/kubernetes/kubernetes-apply-v1alpha1.md
@@ -370,7 +370,7 @@ KubernetesApplyStatus defines the observed state of KubernetesApply
 
   - **disableStatus.disabled** (boolean), required
 
-    Whether this is currently disabled.
+    Whether this is currently disabled. Deprecated in favor of `State`.
 
   - **disableStatus.lastUpdateTime** (Time), required
 
@@ -383,6 +383,10 @@ KubernetesApplyStatus defines the observed state of KubernetesApply
 
     The reason this status was updated.
 
+  - **disableStatus.state** (string), required
+
+    Whether this is currently disabled (if known)
+
 - **error** (string)
 
   An error applying the YAML.
diff --git a/docs/kubernetes/pod-log-stream-v1alpha1.md b/docs/kubernetes/pod-log-stream-v1alpha1.md
@@ -129,6 +129,10 @@ PodLogStreamStatus defines the observed state of PodLogStream
 
     True when the logs are done stream and the container is terminated.
 
+- **error** (string)
+
+  Error message encountered while setting up the stream.
+
 
 
 
diff --git a/openapi-spec/swagger.json b/openapi-spec/swagger.json
@@ -2,7 +2,7 @@
   "swagger": "2.0",
   "info": {
     "title": "tilt",
-    "version": "0.23.5"
+    "version": "0.25.0"
   },
   "paths": {
     "/apis/": {
@@ -19967,6 +19967,7 @@
       "required": [
         "enabledCount",
         "disabledCount",
+        "state",
         "sources"
       ],
       "properties": {
@@ -19986,6 +19987,10 @@
           "items": {
             "$ref": "#/definitions/com.github.tilt-dev.tilt.pkg.apis.core.v1alpha1.DisableSource"
           }
+        },
+        "state": {
+          "description": "Whether this is currently disabled (if known)",
+          "type": "string"
         }
       }
     },
@@ -20004,11 +20009,12 @@
       "required": [
         "disabled",
         "lastUpdateTime",
-        "reason"
+        "reason",
+        "state"
       ],
       "properties": {
         "disabled": {
-          "description": "Whether this is currently disabled.",
+          "description": "Whether this is currently disabled. Deprecated in favor of `State`.",
           "type": "boolean"
         },
         "lastUpdateTime": {
@@ -20018,6 +20024,10 @@
         "reason": {
           "description": "The reason this status was updated.",
           "type": "string"
+        },
+        "state": {
+          "description": "Whether this is currently disabled (if known)",
+          "type": "string"
         }
       }
     },
@@ -21869,6 +21879,10 @@
           "items": {
             "$ref": "#/definitions/com.github.tilt-dev.tilt.pkg.apis.core.v1alpha1.ContainerLogStreamStatus"
           }
+        },
+        "error": {
+          "description": "Error message encountered while setting up the stream.",
+          "type": "string"
         }
       }
     },
@@ -22249,6 +22263,21 @@
         }
       }
     },
+    "com.github.tilt-dev.tilt.pkg.apis.core.v1alpha1.StopOnSpec": {
+      "type": "object",
+      "required": [
+        "uiButtons"
+      ],
+      "properties": {
+        "uiButtons": {
+          "description": "UIButtons that can trigger a stop.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
     "com.github.tilt-dev.tilt.pkg.apis.core.v1alpha1.TCPSocketAction": {
       "description": "TCPSocketAction describes an action based on opening a socket",
       "type": "object",
@@ -22299,13 +22328,17 @@
       }
     },
     "com.github.tilt-dev.tilt.pkg.apis.core.v1alpha1.TargetState": {
-      "description": "TargetState describes the current execution status for a target.\n\nEither EXACTLY one of Waiting, Active, or Terminated will be populated or NONE of them will be. In the event that all states are null, the target is currently inactive or disabled and should not be expected to execute.",
+      "description": "TargetState describes the current execution status for a target.\n\nEither EXACTLY one of Waiting, Active, Disabled, or Terminated will be populated or NONE of them will be. In the event that all states are null, the target is currently inactive or disabled and should not be expected to execute.",
       "type": "object",
       "properties": {
         "active": {
           "description": "Active being non-nil indicates that the target is currently executing.",
           "$ref": "#/definitions/com.github.tilt-dev.tilt.pkg.apis.core.v1alpha1.TargetStateActive"
         },
+        "disabled": {
+          "description": "Disabled being non-nil indicates that the target is disabled.",
+          "$ref": "#/definitions/com.github.tilt-dev.tilt.pkg.apis.core.v1alpha1.TargetStateDisabled"
+        },
         "terminated": {
           "description": "Terminated being non-nil indicates that the target finished execution either normally or due to failure.",
           "$ref": "#/definitions/com.github.tilt-dev.tilt.pkg.apis.core.v1alpha1.TargetStateTerminated"
@@ -22334,6 +22367,10 @@
         }
       }
     },
+    "com.github.tilt-dev.tilt.pkg.apis.core.v1alpha1.TargetStateDisabled": {
+      "description": "TargetStateDisabled is a target that has been disabled.",
+      "type": "object"
+    },
     "com.github.tilt-dev.tilt.pkg.apis.core.v1alpha1.TargetStateTerminated": {
       "description": "TargetStateTerminated is a target that finished running, either because it completed successfully or encountered an error.",
       "type": "object",
@@ -22482,6 +22519,10 @@
         "restartOn": {
           "description": "Objects that can trigger a re-execution of this Tiltfile.",
           "$ref": "#/definitions/com.github.tilt-dev.tilt.pkg.apis.core.v1alpha1.RestartOnSpec"
+        },
+        "stopOn": {
+          "description": "Objects that can stop execution of this Tiltfile.",
+          "$ref": "#/definitions/com.github.tilt-dev.tilt.pkg.apis.core.v1alpha1.StopOnSpec"
         }
       }
     },
