Skip to content

Commit

Permalink
Correct the type names used in LoggingMiddleware example README (#467)
Browse files Browse the repository at this point in the history
### Motivation

Each of our examples includes a covering README. The README for the
logging
middleware example had some comments about the type names that were
inaccurate.

### Modifications

Fix the commentary in the logging middleware example README.

### Result

Fixed the commentary in the logging middleware example README.

### Test Plan

None.

---------

Co-authored-by: Honza Dvorsky <honza@apple.com>
  • Loading branch information
simonjbeaumont and czechboy0 committed Dec 11, 2023
1 parent fdecd12 commit c70be84
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions Examples/logging-middleware-swift-log-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,9 @@ that use `swift-log` to log requests and responses.
## Overview

This example extends the [hello-world-urlsession-client-example](../hello-world-urlsession-client-example)
with a new target, `LoggingMiddleware`, which is then used when creating
the `Client`.

The `LoggingMiddleware` provides two types:
- `LoggingClientMiddleware`, which implements the `OpenAPIRuntime.ClientMiddleware` protocol.
- `LoggingServerMiddleware`, which implements the `OpenAPIRuntime.ServerMiddleware` protocol.
with a new target, `LoggingMiddleware`, which can be used when creating
a `Client` or a `Server` because it conforms to both the `ClientMiddleware` and
`ServerMiddleware` protocols from the `OpenAPIRuntime` library.

Because request and response bodies support streaming and can be arbitrarily
large, the middleware is configured with a logging policy; one of:
Expand Down

0 comments on commit c70be84

Please sign in to comment.