Skip to content

Commit a49b9bb

Browse files
committed
[ksqlDB.RestApi.Client]: doc improvements
1 parent f717ff6 commit a49b9bb

File tree

3 files changed

+5
-7
lines changed

3 files changed

+5
-7
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ run in command line:
162162

163163
In [Blazor](https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor), the application logic and UI rendering occur on the server. The client's web browser receives updates and UI changes through a **SignalR** connection.
164164
This ensures smooth integration with the `ksqlDB.RestApi.Client` library, allowing the **Apache Kafka broker** and **ksqlDB** to remain hidden from direct exposure to clients.
165-
The **server-side Blazor** application communicates with ksqlDB using the `ksqlDB.RestApi.Client`.
165+
The **server-side Blazor** application communicates with `ksqlDB` using the `ksqlDB.RestApi.Client`.
166166
Whenever an event in `ksqlDB` occurs, the server-side Blazor app responds and signals the UI in the client's browser to update. This setup allows a smooth and continuous update flow, creating a real-time, reactive user interface.
167167

168168
- set `docker-compose.csproj` as startup project in [InsideOut.sln](https://github.com/tomasfabian/ksqlDB.RestApi.Client-DotNet/tree/main/Samples/InsideOut) for embedded Kafka connect integration and stream processing examples.
@@ -421,7 +421,7 @@ CREATE TABLE IF NOT EXISTS Accounts (
421421
) WITH ( KAFKA_TOPIC='Account', VALUE_FORMAT='Json', PARTITIONS='3', REPLICAS='3' );
422422
```
423423

424-
The Description property within the `Payment` type has been customized to override the resulting column name as "Desc".
424+
The `Description` property within the `Payment` type has been customized to override the resulting column name as "Desc".
425425
Additionally, the `Id` property within the `Account` table has been designated as the **primary key**, while the `Secret` property is disregarded during code generation.
426426

427427
### Aggregation functions

docs/modelbuilder.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ modelBuilder.AddConvention(decimalTypeConvention);
147147
### WithHeader
148148
**v5.1.0**
149149

150-
Properties of en entity can be marked as a [HEADER](https://docs.ksqldb.io/en/latest/reference/sql/data-definition/#headers) with the model builder's fluent API as demonstrated below:
150+
Properties of an entity can be marked as a [HEADER](https://docs.ksqldb.io/en/latest/reference/sql/data-definition/#headers) with the model builder's fluent API as demonstrated below:
151151

152152
```C#
153153
using ksqlDb.RestApi.Client.FluentAPI.Builders;
@@ -181,7 +181,7 @@ The `WithHeader` function within the fluent API takes precedence over the `Heade
181181
### WithHeaders
182182
**v5.1.0**
183183

184-
Properties of en entity can be marked as a [HEADERS](https://docs.ksqldb.io/en/latest/reference/sql/data-definition/#headers) with the model builder's fluent API as demonstrated below:
184+
Properties of an entity can be marked as a [HEADERS](https://docs.ksqldb.io/en/latest/reference/sql/data-definition/#headers) with the model builder's fluent API as demonstrated below:
185185

186186
```C#
187187
using ksqlDb.RestApi.Client.Metadata;
@@ -239,7 +239,7 @@ modelBuilder.Entity<Payment>()
239239
.HasColumnName("Desc");
240240

241241
var statement = new CreateInsert(modelBuilder)
242-
.Generate(movie, new InsertProperties { IdentifierEscaping = IdentifierEscaping.Keywords });
242+
.Generate(payment, new InsertProperties { IdentifierEscaping = IdentifierEscaping.Keywords });
243243
```
244244

245245
The KSQL snippet illustrates an example INSERT statement with the overridden column name, showing how it corresponds to the fluent API configuration:

docs/statements.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -747,7 +747,6 @@ var properties = new DropFromItemProperties
747747
IdentifierEscaping = IdentifierEscaping.Always
748748
};
749749

750-
//Act
751750
var response1 = await ksqlDbRestApiClient.DropTableAsync<TestTable>(properties);
752751
var response2 = await ksqlDbRestApiClient.DropStreamAsync<TestStream>(properties);
753752
```
@@ -1245,7 +1244,6 @@ Expression<Func<string>> valueExpression = () => INITCAP("One little mouse");
12451244

12461245
var insertValues = new InsertValues<Movie>(new Movie { Id = 5 });
12471246

1248-
//Act
12491247
insertValues.WithValue(c => c.Title, valueExpression);
12501248

12511249
Context.Add(insertValues);

0 commit comments

Comments
 (0)