Skip to content

Commit 837930f

Browse files
committed
Use scope provided for the api
1 parent f1d1853 commit 837930f

File tree

2 files changed

+9
-22
lines changed

2 files changed

+9
-22
lines changed

README.md

+8-21
Original file line numberDiff line numberDiff line change
@@ -7,34 +7,20 @@ An annotation processor converting JSON schemas to java records.
77

88
# Quick start
99

10-
1. Import the BOM:
11-
```xml
12-
<dependencyManagement>
13-
<dependencies>
14-
<!-- ... -->
15-
<dependency>
16-
<groupId>com.cosium.json_schema_to_java_record</groupId>
17-
<artifactId>json-schema-to-java-record-bom</artifactId>
18-
<version>${json-schema-to-java-record.version}</version>
19-
<scope>import</scope>
20-
<type>pom</type>
21-
</dependency>
22-
<!-- ... -->
23-
</dependencies>
24-
</dependencyManagement>
25-
```
26-
2. Import the API:
10+
1. Import the API:
2711
```xml
2812
<dependencies>
2913
<!-- ... -->
3014
<dependency>
3115
<groupId>com.cosium.json_schema_to_java_record</groupId>
3216
<artifactId>json-schema-to-java-record-api</artifactId>
17+
<version>${json-schema-to-java-record.version}</version>
18+
<scope>provided</scope>
3319
</dependency>
3420
<!-- ... -->
3521
</dependencies>
3622
```
37-
3. Import the annotation processor:
23+
2. Import the annotation processor:
3824
```xml
3925
<plugin>
4026
<groupId>org.apache.maven.plugins</groupId>
@@ -44,17 +30,18 @@ An annotation processor converting JSON schemas to java records.
4430
<path>
4531
<groupId>com.cosium.json_schema_to_java_record</groupId>
4632
<artifactId>json-schema-to-java-record</artifactId>
33+
<version>${json-schema-to-java-record.version}</version>
4734
</path>
4835
</annotationProcessorPaths>
4936
</configuration>
5037
</plugin>
5138
```
52-
4. Add your JSON schema files to the class path:
39+
3. Add your JSON schema files to the class path:
5340
```
5441
src/main/resources/com/aqme
5542
└── foo.schema.json
5643
```
57-
5. Annotate a `package-info.java` file like this:
44+
4. Annotate a `package-info.java` file like this:
5845
```java
5946
@GenerateRecordsFromJsonSchemas(
6047
schemaRootFileLocations =
@@ -69,4 +56,4 @@ An annotation processor converting JSON schemas to java records.
6956
import com.cosium.json_schema_to_java_record_api.JsonSchemaConfiguration;
7057
import com.cosium.json_schema_to_java_record_api.JsonSchemaFileLocation;
7158
```
72-
6. Compile to generate the java files
59+
5. Compile to generate the java files

tests/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<groupId>${project.groupId}</groupId>
1717
<artifactId>json-schema-to-java-record-api</artifactId>
1818
<version>${project.version}</version>
19-
<scope>test</scope>
19+
<scope>provided</scope>
2020
</dependency>
2121
<dependency>
2222
<groupId>com.fasterxml.jackson.core</groupId>

0 commit comments

Comments
 (0)