Skip to content

Commit 5315213

Browse files
scordioscordio
committed
Improve README
Signed-off-by: Stefano Cordio <stefano.cordio@gmail.com>
1 parent ac67f55 commit 5315213

1 file changed

Lines changed: 14 additions & 20 deletions

File tree

‎spring-batch-notion/README.md‎

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Spring Batch Notion](https://github.com/spring-projects/spring-batch-extensions/actions/workflows/spring-batch-notion.yml/badge.svg?branch=main)](https://github.com/spring-projects/spring-batch-extensions/actions/workflows/spring-batch-notion.yml?query=branch%3Amain)
44

5-
This project provides a [Spring Batch][] extension module that adds support for [Notion][].
5+
This project provides a [Spring Batch](https://github.com/spring-projects/spring-batch) extension module that adds support for [Notion](https://notion.so/).
66

77
## Compatibility
88

@@ -30,7 +30,7 @@ implementation("org.springframework.batch.extensions:spring-batch-notion:${sprin
3030

3131
## NotionDatabaseItemReader
3232

33-
The `NotionDatabaseItemReader` is a restartable `ItemReader` that reads entries from a [Notion Database] via a paging technique.
33+
`NotionDatabaseItemReader` is a restartable `ItemReader` that reads entries from a [Notion Database](https://www.notion.so/help/category/databases) via a paging technique.
3434

3535
A minimal configuration of the item reader is as follows:
3636

@@ -45,20 +45,20 @@ NotionDatabaseItemReader<Item> itemReader() {
4545

4646
The following constructor parameters should be provided:
4747

48-
| Property | Description |
49-
|------------------|---------------------------------------------------------------------------------------------------------------------------|
50-
| `token` | The Notion integration token. |
51-
| `databaseId` | UUID of the database to read from. |
52-
| `propertyMapper` | The `PropertyMapper` responsible for mapping properties of a Notion item into a Java object. |
48+
| Parameter | Description |
49+
|------------------|-----------------------------------------------------------------------------------------------------------------|
50+
| `token` | The Notion integration token. |
51+
| `databaseId` | UUID of the database to read from. |
52+
| `propertyMapper` | The [`PropertyMapper`](#propertymapper) responsible for mapping properties of a Notion item into a Java object. |
5353

5454
and the following configuration options are available:
5555

56-
| Property | Required | Default | Description |
57-
|------------|----------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------|
58-
| `baseUrl` | no | `https://api.notion.com/v1` | Base URL of the Notion API. A custom value can be provided for testing purposes (e.g., the URL of a [WireMock][] server). |
59-
| `filter` | no | `null` | `Filter` condition to limit the returned items. |
60-
| `pageSize` | no | `100` | Number of items to be read with each page. Must be greater than zero and less than or equal to 100. |
61-
| `sorts` | no | `[]` | `Sort` conditions to order the returned items. Each condition is applied following the declaration order. |
56+
| Property | Default | Description |
57+
|------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
58+
| `baseUrl` | `https://api.notion.com/v1` | Base URL of the Notion API. A custom value can be provided for testing purposes (e.g., the URL of a [WireMock](https://wiremock.org/) server). |
59+
| `filter` | `null` | `Filter` condition to limit the returned items. |
60+
| `pageSize` | `100` | Number of items to be read with each page. Must be greater than zero and less than or equal to 100. |
61+
| `sorts` | `[]` | `Sort` conditions to order the returned items. Each condition is applied following the declaration order. |
6262

6363
In addition to the Notion-specific configuration, all the configuration options of the Spring Batch
6464
[`AbstractPaginatedDataItemReader`](https://docs.spring.io/spring-batch/docs/current/api/org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html)
@@ -92,10 +92,4 @@ Currently not provided but will be added in the future.
9292

9393
## License
9494

95-
The Spring Batch Notion is released under version 2.0 of the [Apache License][].
96-
97-
[Apache License]: https://www.apache.org/licenses/LICENSE-2.0
98-
[Notion]: https://notion.so/
99-
[Notion Database]: https://www.notion.so/help/category/databases
100-
[Spring Batch]: https://github.com/spring-projects/spring-batch
101-
[WireMock]: https://wiremock.org/
95+
The Spring Batch Notion is released under version 2.0 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0).

0 commit comments

Comments
 (0)