Document the deprecation of include_terminated

hashicorp · May 24, 2024 · ceb3cf2 · ceb3cf2
1 parent 1aa8c2e
commit ceb3cf2
Show file tree

Hide file tree

Showing 3 changed files with 114 additions and 100 deletions.
diff --git a/internal/gen/controller.swagger.json b/internal/gen/controller.swagger.json
@@ -4221,7 +4221,7 @@
           },
           {
             "name": "include_terminated",
-            "description": "Experimental. By default only non-terminated (i.e. pending, active, canceling) are returned.\nSet this option to include terminated sessions as well.",
+            "description": "Deprecated. Should be removed in 0.18.0 since pagination removes the need\nfor the optimization that this provided.\nBy default only non-terminated (i.e. pending, active, canceling) are returned.\nSet this option to include terminated sessions as well.  If not set paginated\nresponses may not include terminated sessions either in the response or in\nthe removed_ids.",
             "in": "query",
             "required": false,
             "type": "boolean"