Automated deployment: Tue Sep 17 16:04:03 UTC 2024 1295161

aristanetworks · Sep 17, 2024 · b2fb4dd · b2fb4dd
1 parent 842eb9a
commit b2fb4dd
Show file tree

Hide file tree

Showing 55 changed files with 326 additions and 169 deletions.
diff --git a/404.html b/404.html
@@ -1,2 +1,2 @@
 <!doctype html><html lang=en class="js csstransforms3d"><head><meta charset=utf-8><meta name=description content><link rel="shortcut icon" href=https://aristanetworks.github.io/cloudvision-apis//images/favicon.ico type=image/x-icon><title>404 Page not found</title>
-<link href=/cloudvision-apis/css/nucleus.css?1726263488 rel=stylesheet><link href=/cloudvision-apis/css/fontawesome-all.min.css?1726263488 rel=stylesheet><link href=/cloudvision-apis/css/hybrid.css?1726263488 rel=stylesheet><link href=/cloudvision-apis/css/featherlight.min.css?1726263488 rel=stylesheet><link href=/cloudvision-apis/css/perfect-scrollbar.min.css?1726263488 rel=stylesheet><link href=/cloudvision-apis/css/theme.css?1726263488 rel=stylesheet><link href=/cloudvision-apis/css/hugo-theme.css?1726263488 rel=stylesheet><link href=/cloudvision-apis/css/theme-arista.css?1726263488 rel=stylesheet><style>:root #header+#content>#left>#rlblock_left{display:none!important}p,li,ul{text-align:center}ul{list-style-type:none}</style></head><body data-url=/><section id=body style=margin-left:0><div id=overlay></div><div id=chapter><div id=body-inner><h1>Error</h1><p></p><p>Woops. Looks like this page doesn't exist ¯\_(ツ)_/¯.</p><p></p><p><a href=/cloudvision-apis/>Go to homepage</a></p><p><img src=/images/gopher-404.jpg style=width:50% alt="Page not found!"></p></div></div></section></body></html>
+<link href=/cloudvision-apis/css/nucleus.css?1726589040 rel=stylesheet><link href=/cloudvision-apis/css/fontawesome-all.min.css?1726589040 rel=stylesheet><link href=/cloudvision-apis/css/hybrid.css?1726589040 rel=stylesheet><link href=/cloudvision-apis/css/featherlight.min.css?1726589040 rel=stylesheet><link href=/cloudvision-apis/css/perfect-scrollbar.min.css?1726589040 rel=stylesheet><link href=/cloudvision-apis/css/theme.css?1726589040 rel=stylesheet><link href=/cloudvision-apis/css/hugo-theme.css?1726589040 rel=stylesheet><link href=/cloudvision-apis/css/theme-arista.css?1726589040 rel=stylesheet><style>:root #header+#content>#left>#rlblock_left{display:none!important}p,li,ul{text-align:center}ul{list-style-type:none}</style></head><body data-url=/><section id=body style=margin-left:0><div id=overlay></div><div id=chapter><div id=body-inner><h1>Error</h1><p></p><p>Woops. Looks like this page doesn't exist ¯\_(ツ)_/¯.</p><p></p><p><a href=/cloudvision-apis/>Go to homepage</a></p><p><img src=/images/gopher-404.jpg style=width:50% alt="Page not found!"></p></div></div></section></body></html>
diff --git a/categories/index.html b/categories/index.html
diff --git a/clients/creating/index.html b/clients/creating/index.html
diff --git a/clients/existing/index.html b/clients/existing/index.html
diff --git a/clients/index.html b/clients/index.html
diff --git a/connecting/index.html b/connecting/index.html
diff --git a/examples/grpc/index.html b/examples/grpc/index.html
diff --git a/examples/index.html b/examples/index.html
diff --git a/examples/rest/bugexposure/index.html b/examples/rest/bugexposure/index.html
diff --git a/examples/rest/changecontrol/index.html b/examples/rest/changecontrol/index.html
diff --git a/examples/rest/dashboard/index.html b/examples/rest/dashboard/index.html
diff --git a/examples/rest/endpointlocation/index.html b/examples/rest/endpointlocation/index.html
diff --git a/examples/rest/events/index.html b/examples/rest/events/index.html
diff --git a/examples/rest/index.html b/examples/rest/index.html
diff --git a/examples/rest/inventory/index.html b/examples/rest/inventory/index.html
diff --git a/examples/rest/lifecycle/index.html b/examples/rest/lifecycle/index.html
diff --git a/examples/rest/studios-and-workspaces/index.html b/examples/rest/studios-and-workspaces/index.html
diff --git a/examples/rest/tag/index.html b/examples/rest/tag/index.html
diff --git a/index.html b/index.html
diff --git a/index.json b/index.json
diff --git a/index.xml b/index.xml
@@ -111,7 +111,21 @@ resource to fetch.&lt;/p>
 &lt;/span>&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>&lt;span style="color:#75715e">&lt;/span> google.protobuf.Timestamp time &lt;span style="color:#f92672">=&lt;/span> &lt;span style="color:#ae81ff">2&lt;/span>;&lt;span style="color:#960050;background-color:#1e0010">
 &lt;/span>&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>&lt;span style="color:#960050;background-color:#1e0010">&lt;/span>}&lt;span style="color:#960050;background-color:#1e0010">
 &lt;/span>&lt;/span>&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h4 id="response-type">Response Type&lt;/h4>
-&lt;p>The generated response for a model (&lt;code>ExampleConfig&lt;/code>, here) looks like so:&lt;/p></description></item><item><title>GetAll</title><link>https://aristanetworks.github.io/cloudvision-apis/rpcs/getall/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://aristanetworks.github.io/cloudvision-apis/rpcs/getall/</guid><description>&lt;p>&lt;code>GetAll&lt;/code> fetches (and optionally filters) all resource instances.&lt;/p>
+&lt;p>The generated response for a model (&lt;code>ExampleConfig&lt;/code>, here) looks like so:&lt;/p></description></item><item><title>GetSome</title><link>https://aristanetworks.github.io/cloudvision-apis/rpcs/getsome/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://aristanetworks.github.io/cloudvision-apis/rpcs/getsome/</guid><description>&lt;p>&lt;code>GetSome&lt;/code> returns multiple instances of a resource.&lt;/p>
+
+&lt;div class="notices note" >&lt;p>GetSome is supported on all keyed resources.&lt;br>
+However, in certain releases, this may have been missing. See Support section below for details.&lt;/p>
+&lt;/div>
+
+
+&lt;div class="notices note" >&lt;p>The &lt;code>Keys&lt;/code> field is required to be fully-specified because &lt;code>GetSome&lt;/code> needs to identify resources to fetch.&lt;/p>
+&lt;/div>
+
+&lt;h4 id="rpc-definition">RPC Definition&lt;/h4>
+&lt;p>The protobuf definition of &lt;code>GetSome&lt;/code> is defined as such (for &lt;code>ExampleConfig&lt;/code>):&lt;/p>
+&lt;div class="highlight">&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-protobuf" data-lang="protobuf">&lt;span style="display:flex;">&lt;span>&lt;span style="color:#66d9ef">rpc&lt;/span> GetSome (ExampleConfigSomeRequest) &lt;span style="color:#66d9ef">returns&lt;/span> (stream ExampleConfigSomeResponse);&lt;span style="color:#960050;background-color:#1e0010">
+&lt;/span>&lt;/span>&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h4 id="request-type">Request Type&lt;/h4>
+&lt;p>The generated request for a model (&lt;code>ExampleConfig&lt;/code>, here) looks like so:&lt;/p></description></item><item><title>GetAll</title><link>https://aristanetworks.github.io/cloudvision-apis/rpcs/getall/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://aristanetworks.github.io/cloudvision-apis/rpcs/getall/</guid><description>&lt;p>&lt;code>GetAll&lt;/code> fetches (and optionally filters) all resource instances.&lt;/p>
 &lt;p>For the filtering options available, see the &lt;a href="https://aristanetworks.github.io/cloudvision-apis/cloudvision-apis/rpcs/filtering">Filtering&lt;/a> section.
 These filtering options are the same for &lt;a href="https://aristanetworks.github.io/cloudvision-apis/cloudvision-apis/rpcs/subscribe">Subscribe&lt;/a>.&lt;/p>
 &lt;p>This RPC is effectively a full-table-scan so the time to complete depends on the amount of data
@@ -125,15 +139,26 @@ Once existing state has been sent to the client, any changes to resource entitie
 
 &lt;div class="notices note" >&lt;p>Any &lt;a href="https://aristanetworks.github.io/cloudvision-apis/cloudvision-apis/rpcs/filtering">filters&lt;/a> apply both to the initial state and updates.&lt;/p></description></item><item><title>Set</title><link>https://aristanetworks.github.io/cloudvision-apis/rpcs/set/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://aristanetworks.github.io/cloudvision-apis/rpcs/set/</guid><description>&lt;p>&lt;code>Set&lt;/code> updates a resource. Updates can be whole or partial (see: nullable fields) using only fields populated in the request.&lt;/p>
 
-&lt;div class="notices note" >&lt;p>The &lt;code>Key&lt;/code> field is required to be fully-specified because &lt;code>Set&lt;/code> needs to identify exactly-one
-resource to delete.&lt;/p>
+&lt;div class="notices note" >&lt;p>The &lt;code>Value&lt;/code> field is required to be fully-specified because &lt;code>Set&lt;/code> needs to identify exactly-one
+resource to update.&lt;/p>
 &lt;/div>
 
 
 &lt;div class="notices note" >&lt;p>The endpoint returns the time the &lt;code>Set&lt;/code> becomes effective internally and the service&amp;rsquo;s known-state of the resource.&lt;/p>
 &lt;/div>
 
-&lt;p>A &lt;code>*SetResponse&lt;/code> will contain an &amp;ldquo;echo&amp;rdquo; of the resource. This echo will be the original update-request at a minimum, and may include more data.This allows services to do fast, write-only, updates to internal storage. If the service needs to query existing state first then more data can be provided to the client. If you need a full model after a &lt;code>Set&lt;/code> operation, you can issue a &lt;code>GetOne&lt;/code> with the returned &lt;code>time&lt;/code>.&lt;/p></description></item><item><title>Delete</title><link>https://aristanetworks.github.io/cloudvision-apis/rpcs/delete/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://aristanetworks.github.io/cloudvision-apis/rpcs/delete/</guid><description>&lt;p>&lt;code>Delete&lt;/code> deletes a resource and returns the time the delete became effective.&lt;/p>
+&lt;p>A &lt;code>*SetResponse&lt;/code> will contain an &amp;ldquo;echo&amp;rdquo; of the resource. This echo will be the original update-request at a minimum, and may include more data.This allows services to do fast, write-only, updates to internal storage. If the service needs to query existing state first then more data can be provided to the client. If you need a full model after a &lt;code>Set&lt;/code> operation, you can issue a &lt;code>GetOne&lt;/code> with the returned &lt;code>time&lt;/code>.&lt;/p></description></item><item><title>SetSome</title><link>https://aristanetworks.github.io/cloudvision-apis/rpcs/setsome/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://aristanetworks.github.io/cloudvision-apis/rpcs/setsome/</guid><description>&lt;p>&lt;code>SetSome&lt;/code> updates multiple instances of a keyed resource. Updates can be whole or partial (see: nullable fields) using only fields populated in the request.&lt;/p>
+
+&lt;div class="notices note" >&lt;p>SetSome is supported on all keyed resources.&lt;br>
+However, in certain releases, this may have been missing. See Support section below for details.&lt;/p>
+&lt;/div>
+
+
+&lt;div class="notices note" >&lt;p>The &lt;code>Values&lt;/code> field is required to be fully-specified because &lt;code>SetSome&lt;/code> needs to identify
+resources to update.&lt;/p>
+&lt;/div>
+
+&lt;p>A &lt;code>*SetSomeResponse&lt;/code> will &amp;ldquo;echo&amp;rdquo; back the key of a resource that failed to set. It will also contain an error description on why the resource failed to set.&lt;/p></description></item><item><title>Delete</title><link>https://aristanetworks.github.io/cloudvision-apis/rpcs/delete/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://aristanetworks.github.io/cloudvision-apis/rpcs/delete/</guid><description>&lt;p>&lt;code>Delete&lt;/code> deletes a resource and returns the time the delete became effective.&lt;/p>
 
 &lt;div class="notices note" >&lt;p>The &lt;code>Key&lt;/code> field is required to be fully-specified because &lt;code>Delete&lt;/code> needs to identify exactly-one
 resource to delete.&lt;/p>
@@ -150,7 +175,18 @@ resource to delete.&lt;/p>
 &lt;/span>&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>&lt;span style="color:#75715e">&lt;/span> ExampleKey key &lt;span style="color:#f92672">=&lt;/span> &lt;span style="color:#ae81ff">1&lt;/span>;&lt;span style="color:#960050;background-color:#1e0010">
 &lt;/span>&lt;/span>&lt;/span>&lt;span style="display:flex;">&lt;span>&lt;span style="color:#960050;background-color:#1e0010">&lt;/span>};&lt;span style="color:#960050;background-color:#1e0010">
 &lt;/span>&lt;/span>&lt;/span>&lt;/code>&lt;/pre>&lt;/div>&lt;h4 id="response-type">Response Type&lt;/h4>
-&lt;p>The generated response for a model (&lt;code>ExampleConfig&lt;/code>, here) looks like so:&lt;/p></description></item><item><title>alert.v1</title><link>https://aristanetworks.github.io/cloudvision-apis/models/alert.v1/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://aristanetworks.github.io/cloudvision-apis/models/alert.v1/</guid><description>&lt;ul>
+&lt;p>The generated response for a model (&lt;code>ExampleConfig&lt;/code>, here) looks like so:&lt;/p></description></item><item><title>DeleteSome</title><link>https://aristanetworks.github.io/cloudvision-apis/rpcs/deletesome/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://aristanetworks.github.io/cloudvision-apis/rpcs/deletesome/</guid><description>&lt;p>&lt;code>DeleteSome&lt;/code> deletes a resource and streams back the resources that failed to be deleted and a description for the failure.&lt;/p>
+
+&lt;div class="notices note" >&lt;p>DeleteSome is supported on all keyed resources.&lt;br>
+However, in certain releases, this may have been missing. See Support section below for details.&lt;/p>
+&lt;/div>
+
+
+&lt;div class="notices note" >&lt;p>The &lt;code>Keys&lt;/code> field is required to be fully-specified because &lt;code>DeleteSome&lt;/code> needs to identify resources to delete.&lt;/p>
+&lt;/div>
+
+&lt;h4 id="rpc-definition">RPC Definition&lt;/h4>
+&lt;p>The protobuf definition of &lt;code>DeleteSome&lt;/code> is defined as such (for &lt;code>ExampleConfig&lt;/code>):&lt;/p></description></item><item><title>alert.v1</title><link>https://aristanetworks.github.io/cloudvision-apis/models/alert.v1/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://aristanetworks.github.io/cloudvision-apis/models/alert.v1/</guid><description>&lt;ul>
 &lt;li>
 &lt;p>&lt;a href="#arista/alert.v1/alert.proto">arista/alert.v1/alert.proto&lt;/a>&lt;/p>
 &lt;ul>