21204: Merge branch '21204-stable-log-sort' from arvados-workbench2.git
[arvados.git] / doc / api / methods / keep_disks.html.textile.liquid
index 37c7b145eea71d93461051c06cbc9f8d97c4ec24..9a82a3e7ce7f7b4f67777986f63ce1bd9a10139d 100644 (file)
@@ -2,19 +2,30 @@
 layout: default
 navsection: api
 navmenu: API Methods
-title: "keep_disks (deprecated)"
+title: "keep_disks"
 
 ...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
 
-See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+
+{% include 'notebox_begin_warning' %}
+This is a legacy API.  This endpoint is deprecated, disabled by default in new installations, and slated to be removed entirely in a future major release of Arvados.  It is replaced by "keep services.":keep_services.html
+{% include 'notebox_end' %}
 
 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/keep_disks@
 
-Required arguments are displayed in %{background:#ccffcc}green%.
+Object type: @penuu@
+
+Example UUID: @zzzzz-penuu-0123456789abcde@
 
 h2. Resource
 
-Each KeepDisk has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
+Obsoleted by "keep_services":{{site.baseurl}}/api/methods/keep_services.html
+
+Each KeepDisk has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
 
 table(table table-bordered table-condensed).
 |_. Attribute|_. Type|_. Description|_. Example|
@@ -31,6 +42,11 @@ table(table table-bordered table-condensed).
 |keep_service_uuid|string|||
 
 h2. Methods
+
+See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
+
+Required arguments are displayed in %{background:#ccffcc}green%.
+
 h3. create
 
 Create a new KeepDisk.
@@ -65,13 +81,7 @@ h3. list
 
 List keep_disks.
 
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|limit|integer (default 100)|Maximum number of keep_disks to return.|query||
-|order|string|Order in which to return matching keep_disks.|query||
-|filters|array|Conditions for filtering keep_disks.|query||
+See "common resource list method.":{{site.baseurl}}/api/methods.html#index
 
 h3. ping