X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/a7f378b2267ddc1b44a8661d6723264fe959d98e..9feeea1226399a9fc28acc53eafc45d884f7db65:/doc/api/methods/nodes.html.textile.liquid diff --git a/doc/api/methods/nodes.html.textile.liquid b/doc/api/methods/nodes.html.textile.liquid index f02d50c660..7aa5896ea5 100644 --- a/doc/api/methods/nodes.html.textile.liquid +++ b/doc/api/methods/nodes.html.textile.liquid @@ -6,7 +6,9 @@ title: "nodes" ... +See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html +API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/nodes@ Required arguments are displayed in %{background:#ccffcc}green%. @@ -19,7 +21,7 @@ Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -|node|object||query|| +{background:#ccffcc}.|node|object||query|| h2. delete @@ -31,16 +33,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path|| -h2. destroy - -destroy nodes - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| - h2. get Gets a Node's metadata by UUID. @@ -51,17 +43,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path|| -h2. index - -index nodes - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List nodes. @@ -72,9 +53,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of nodes to return.|query|| |order|string|Order in which to return matching nodes.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching nodes.|query|| -|where|object|Conditions for filtering nodes.|query|| +|filters|array|Conditions for filtering nodes.|query|| h2. ping @@ -87,16 +66,6 @@ table(table table-bordered table-condensed). {background:#ccffcc}.|ping_secret|string||query|| {background:#ccffcc}.|uuid|string||path|| -h2. show - -show nodes - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| - h2. update Update attributes of an existing Node. @@ -107,3 +76,5 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path|| |node|object||query|| + +To remove a node's job assignment, update the node object's @job_uuid@ to null.