@@ -176,14 +176,19 @@ public interface ISwarmOperations
176176 Task < Stream > GetServiceLogsAsync ( string id , ServiceLogsParameters parameters , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
177177
178178 /// <summary>
179- /// Gets the <code>stdout</code> and <code>stderr</code> logs from all service tasks.
180- /// This endpoint works only for services with the <code>json-file</code> or <code>journald</code> logging driver.
181- /// </summary>
182- /// <param name="id">ID or name of the service.</param>
183- /// <param name="tty">If the service was created with a TTY or not. If <see langword="false" />, the returned stream is multiplexed.</param>
184- /// <param name="parameters">The parameters used to retrieve the logs.</param>
185- /// <param name="cancellationToken">A token used to cancel this operation.</param>
186- /// <returns>A stream with the retrieved logs. If the service wasn't created with a TTY, this stream is multiplexed.</returns>
179+ /// Gets <c>stdout</c> and <c>stderr</c> logs from services.
180+ /// </summary>
181+ /// <param name="id">The ID or name of the service.</param>
182+ /// <param name="tty">Indicates whether the service was created with a TTY. If <see langword="false"/>, the returned stream is multiplexed.</param>
183+ /// <param name="parameters">Specifics of how to perform the operation.</param>
184+ /// <param name="cancellationToken">When triggered, the operation will stop at the next available time, if possible.</param>
185+ /// <returns>
186+ /// A <see cref="Task{TResult}"/> that resolves to a <see cref="MultiplexedStream"/>, which provides the log information.
187+ /// If the service wasn't created with a TTY, this stream is multiplexed.
188+ /// </returns>
189+ /// <remarks>
190+ /// This method is only suited for services with the <c>json-file</c> or <c>journald</c> logging driver.
191+ /// </remarks>
187192 Task < MultiplexedStream > GetServiceLogsAsync ( string id , bool tty , ServiceLogsParameters parameters , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
188193
189194 #endregion Services
0 commit comments