|
317 | 317 | The gRPC cc.arduino.cli.commands.v1.CompileRequest.export_binaries changed type.
|
318 | 318 | </a>
|
319 | 319 |
|
| 320 | +</li> |
| 321 | + |
| 322 | + <li class="md-nav__item"> |
| 323 | + <a href="#some-grpc-responses-messages-now-uses-the-oneof-clause" class="md-nav__link"> |
| 324 | + Some gRPC responses messages now uses the oneof clause. |
| 325 | + </a> |
| 326 | + |
320 | 327 | </li>
|
321 | 328 |
|
322 | 329 | <li class="md-nav__item">
|
|
2599 | 2606 | The gRPC cc.arduino.cli.commands.v1.CompileRequest.export_binaries changed type.
|
2600 | 2607 | </a>
|
2601 | 2608 |
|
| 2609 | +</li> |
| 2610 | + |
| 2611 | + <li class="md-nav__item"> |
| 2612 | + <a href="#some-grpc-responses-messages-now-uses-the-oneof-clause" class="md-nav__link"> |
| 2613 | + Some gRPC responses messages now uses the oneof clause. |
| 2614 | + </a> |
| 2615 | + |
2602 | 2616 | </li>
|
2603 | 2617 |
|
2604 | 2618 | <li class="md-nav__item">
|
@@ -3957,6 +3971,48 @@ <h3 id="the-grpc-ccarduinoclicommandsv1compilerequestexport_binaries-changed-typ
|
3957 | 3971 | <p>Previously the field <code>export_binaries</code> was a <code>google.protobuf.BoolValue</code>. We used this type because it expresses this
|
3958 | 3972 | field's optional nature (that is, it could be <code>true</code>, <code>false</code>, and <code>null</code> if not set).</p>
|
3959 | 3973 | <p>Now the field is an <code>optional bool</code>, since the latest protobuf protocol changes now allows optional fields.</p>
|
| 3974 | +<h3 id="some-grpc-responses-messages-now-uses-the-oneof-clause">Some gRPC responses messages now uses the <code>oneof</code> clause.<a class="headerlink" href="#some-grpc-responses-messages-now-uses-the-oneof-clause" title="Permanent link">¶</a></h3> |
| 3975 | +<p>The following responses message:</p> |
| 3976 | +<ul> |
| 3977 | +<li><code>cc.arduino.cli.commands.v1.PlatformInstallResponse</code></li> |
| 3978 | +<li><code>cc.arduino.cli.commands.v1.PlatformDownloadResponse</code></li> |
| 3979 | +<li><code>cc.arduino.cli.commands.v1.PlatformUninstallResponse</code></li> |
| 3980 | +<li><code>cc.arduino.cli.commands.v1.PlatformUpgradeResponse</code></li> |
| 3981 | +<li><code>cc.arduino.cli.commands.v1.DebugResponse</code></li> |
| 3982 | +<li><code>cc.arduino.cli.commands.v1.LibraryDownloadResponse</code></li> |
| 3983 | +<li><code>cc.arduino.cli.commands.v1.LibraryInstallResponse</code></li> |
| 3984 | +<li><code>cc.arduino.cli.commands.v1.LibraryUpgradeResponse</code></li> |
| 3985 | +<li><code>cc.arduino.cli.commands.v1.LibraryUninstallResponse</code></li> |
| 3986 | +<li><code>cc.arduino.cli.commands.v1.LibraryUpgradeAllResponse</code></li> |
| 3987 | +<li><code>cc.arduino.cli.commands.v1.ZipLibraryInstallResponse</code></li> |
| 3988 | +<li><code>cc.arduino.cli.commands.v1.GitLibraryInstallResponse</code></li> |
| 3989 | +<li><code>cc.arduino.cli.commands.v1.MonitorResponse</code></li> |
| 3990 | +</ul> |
| 3991 | +<p>now use the <code>oneof</code> clause to make the stream nature of the message more explicit. Just to give an example, the |
| 3992 | +<code>PlatformInstallResponse</code> message has been changed from:</p> |
| 3993 | +<div class="highlight"><pre><span></span><code><span class="kd">message</span><span class="w"> </span><span class="nc">PlatformInstallResponse</span><span class="w"> </span><span class="p">{</span> |
| 3994 | +<span class="w"> </span><span class="c1">// Progress of the downloads of the platform and tool files.</span> |
| 3995 | +<span class="w"> </span><span class="n">DownloadProgress</span><span class="w"> </span><span class="na">progress</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| 3996 | +<span class="w"> </span><span class="c1">// Description of the current stage of the installation.</span> |
| 3997 | +<span class="w"> </span><span class="n">TaskProgress</span><span class="w"> </span><span class="na">task_progress</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| 3998 | +<span class="p">}</span> |
| 3999 | +</code></pre></div> |
| 4000 | +<p>to:</p> |
| 4001 | +<div class="highlight"><pre><span></span><code><span class="kd">message</span><span class="w"> </span><span class="nc">PlatformInstallResponse</span><span class="w"> </span><span class="p">{</span> |
| 4002 | +<span class="w"> </span><span class="kd">message</span><span class="w"> </span><span class="nc">Result</span><span class="w"> </span><span class="p">{</span> |
| 4003 | +<span class="w"> </span><span class="c1">// Empty message, reserved for future expansion.</span> |
| 4004 | +<span class="w"> </span><span class="p">}</span> |
| 4005 | +<span class="w"> </span><span class="k">oneof</span><span class="w"> </span><span class="kd">message</span><span class="w"> </span><span class="p">{</span> |
| 4006 | +<span class="w"> </span><span class="c1">// Progress of the downloads of the platform and tool files.</span> |
| 4007 | +<span class="w"> </span><span class="n">DownloadProgress</span><span class="w"> </span><span class="na">progress</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| 4008 | +<span class="w"> </span><span class="c1">// Description of the current stage of the installation.</span> |
| 4009 | +<span class="w"> </span><span class="n">TaskProgress</span><span class="w"> </span><span class="na">task_progress</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| 4010 | +<span class="w"> </span><span class="c1">// The installation result.</span> |
| 4011 | +<span class="w"> </span><span class="n">Result</span><span class="w"> </span><span class="na">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| 4012 | +<span class="w"> </span><span class="p">}</span> |
| 4013 | +<span class="p">}</span> |
| 4014 | +</code></pre></div> |
| 4015 | +<p>The other messages have been changed in a similar way.</p> |
3960 | 4016 | <h3 id="the-grpc-ccarduinoclicommandsv1updateindexresponse-and-updatelibrariesindexresponse-have-changed">The gRPC <code>cc.arduino.cli.commands.v1.UpdateIndexResponse</code> and <code>UpdateLibrariesIndexResponse</code> have changed.<a class="headerlink" href="#the-grpc-ccarduinoclicommandsv1updateindexresponse-and-updatelibrariesindexresponse-have-changed" title="Permanent link">¶</a></h3>
|
3961 | 4017 | <p>The responses coming from the update index commands:</p>
|
3962 | 4018 | <div class="highlight"><pre><span></span><code><span class="kd">message</span><span class="w"> </span><span class="nc">UpdateIndexResponse</span><span class="w"> </span><span class="p">{</span>
|
|
0 commit comments