Skip to content

Commit 12aec2f

Browse files
Update src/Docker.DotNet/Endpoints/ISwarmOperations.cs
Co-authored-by: Andre Hofmeister <9199345+HofmeisterAn@users.noreply.github.com>
1 parent bb3212d commit 12aec2f

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

src/Docker.DotNet/Endpoints/ISwarmOperations.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -156,13 +156,14 @@ public interface ISwarmOperations
156156
Task RemoveServiceAsync(string id, CancellationToken cancellationToken = default(CancellationToken));
157157

158158
/// <summary>
159-
/// Get service logs.
160-
///
161-
/// Get {stdout} and {stderr} logs from all service tasks.
162-
/// Note: This endpoint works only for services with the {json-file} or {journald} logging driver.
159+
/// Gets <c>stdout</c> and <c>stderr</c> logs from services.
163160
/// </summary>
161+
/// <param name="id">The ID or name of the service.</param>
162+
/// <param name="parameters">Specifics of how to perform the operation.</param>
163+
/// <param name="cancellationToken">When triggered, the operation will stop at the next available time, if possible.</param>
164+
/// <returns>A <see cref="Task"/> that will complete once all log lines have been read.</returns>
164165
/// <remarks>
165-
/// docker service logs
166+
/// This method is only suited for services with the <c>json-file</c> or <c>journald</c> logging driver.
166167
///
167168
/// HTTP GET /services/(id)/logs
168169
///
@@ -172,7 +173,6 @@ public interface ISwarmOperations
172173
/// 500 - Server error.
173174
/// 503 - Node is not part of a swarm.
174175
/// </remarks>
175-
/// <param name="id">ID or name of the service.</param>
176176
Task<Stream> GetServiceLogsAsync(string id, ServiceLogsParameters parameters, CancellationToken cancellationToken = default(CancellationToken));
177177

178178
/// <summary>

0 commit comments

Comments
 (0)