Skip to content

Commit c586a23

Browse files
zhossain-infozhossain-info
committed
Update README and pom files
1 parent b588cc8 commit c586a23

File tree

2 files changed

+111
-5
lines changed

2 files changed

+111
-5
lines changed

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Let's explore an example of our schema for a typical JSON API response containin
3737
}
3838
}
3939
```
40-
In the above example, two types of constraint or rule descriptors are used: constraint functions (also known as validation functions, such as `@range(1, 10000)`) and constraint data types (also known as validation data types, such as `#integer`). All constraint functions begin with the `@` symbol, while all constraint data types start with `#`. C-style comments are also permitted in the schema. Please note that `address` can be `null` (eg. an optional input for users) and if it is `null` then no constraints of `address` are applicable. The following JSON is one of the examples which can successfully validate against the above schema. To start your journey with the JSON validation library, please consult the documentation available [here](https://relogiclabs.github.io/JsonSchema-DotNet/articles/intro.html).
40+
In the above example, two types of constraint or rule descriptors are used: constraint functions (also known as validation functions, such as `@range(1, 10000)`) and constraint data types (also known as validation data types, such as `#integer`). All constraint functions begin with the `@` symbol, while all constraint data types start with `#`. C-style comments are also permitted in the schema. Please note that `address` can be `null` (eg. an optional input for users) and if it is `null` then no constraints of `address` are applicable. The following JSON is one of the examples which can successfully validate against the above schema. To start your journey with the JSON validation library, please consult the documentation available [here](https://relogiclabs.github.io/JsonSchema-Java/articles/intro).
4141
```json
4242
{
4343
"user": {
@@ -63,7 +63,7 @@ In the above example, two types of constraint or rule descriptors are used: cons
6363
}
6464
```
6565
## Extended Example
66-
The next example represents an expanded version of the previous one, which brings more complexity. To effectively construct such schemas with multiple layers of nested structures, it's beneficial to have a fundamental understanding of this schema format. While the syntax may seem difficult at first, it becomes straightforward once you have a basic understanding of it. For more detailed information, reference documentation is available [here](https://relogiclabs.github.io/JsonSchema-DotNet/articles/intro.html).
66+
The next example represents an expanded version of the previous one, which brings more complexity. To effectively construct such schemas with multiple layers of nested structures, it's beneficial to have a fundamental understanding of this schema format. While the syntax may seem difficult at first, it becomes straightforward once you have a basic understanding of it. For more detailed information, reference documentation is available [here](https://relogiclabs.github.io/JsonSchema-Java/articles/intro).
6767
```cpp
6868
%title: "Extended User Profile Dashboard API Response"
6969
%version: 2.0.0
@@ -220,4 +220,4 @@ The subsequent JSON sample is an illustrative example that successfully validate
220220
}
221221
}
222222
```
223-
For more information about the schema syntax format and library functionalities, please refer to the reference documentation [here](https://relogiclabs.github.io/JsonSchema-DotNet/api/index.html).
223+
For more information about the schema syntax format and library functionalities, please refer to the reference documentation [here](https://relogiclabs.github.io/JsonSchema-Java/api/index.html).

‎pom.xml

Lines changed: 108 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,21 @@
66

77
<groupId>com.relogiclabs.json</groupId>
88
<artifactId>relogiclabs-json-schema</artifactId>
9-
<version>1.3.0</version>
9+
<version>1.4.0</version>
1010
<name>New Json Schema</name>
1111
<description>A simplified, concise, intuitive, and extensible Json Schema</description>
1212
<url>https://www.relogiclabs.com/p/json-schema.html</url>
1313
<organization>
1414
<name>Relogic Labs</name>
1515
<url>https://www.relogiclabs.com</url>
1616
</organization>
17+
<developers>
18+
<developer>
19+
<name>Relogic Labs</name>
20+
<email>[email protected]</email>
21+
<url>https://www.relogiclabs.com</url>
22+
</developer>
23+
</developers>
1724
<licenses>
1825
<license>
1926
<name>GNU Affero General Public License</name>
@@ -31,6 +38,7 @@
3138
<maven.compiler.source>17</maven.compiler.source>
3239
<maven.compiler.target>17</maven.compiler.target>
3340
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
41+
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
3442
</properties>
3543

3644
<dependencies>
@@ -57,4 +65,102 @@
5765
<scope>test</scope>
5866
</dependency>
5967
</dependencies>
60-
</project>
68+
69+
<distributionManagement>
70+
<snapshotRepository>
71+
<id>ossrh</id>
72+
<url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
73+
</snapshotRepository>
74+
<repository>
75+
<id>ossrh</id>
76+
<url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
77+
</repository>
78+
</distributionManagement>
79+
80+
<profiles>
81+
<profile>
82+
<id>release</id>
83+
<build>
84+
<plugins>
85+
<plugin>
86+
<groupId>org.projectlombok</groupId>
87+
<artifactId>lombok-maven-plugin</artifactId>
88+
<version>1.18.20.0</version>
89+
<executions>
90+
<execution>
91+
<phase>generate-sources</phase>
92+
<goals>
93+
<goal>delombok</goal>
94+
</goals>
95+
</execution>
96+
</executions>
97+
<configuration>
98+
<addOutputDirectory>false</addOutputDirectory>
99+
<sourceDirectory>src/main/java</sourceDirectory>
100+
</configuration>
101+
</plugin>
102+
<plugin>
103+
<groupId>org.apache.maven.plugins</groupId>
104+
<artifactId>maven-source-plugin</artifactId>
105+
<version>3.3.0</version>
106+
<executions>
107+
<execution>
108+
<id>attach-sources</id>
109+
<goals>
110+
<goal>jar</goal>
111+
</goals>
112+
</execution>
113+
</executions>
114+
</plugin>
115+
<plugin>
116+
<groupId>org.apache.maven.plugins</groupId>
117+
<artifactId>maven-javadoc-plugin</artifactId>
118+
<version>3.6.0</version>
119+
<configuration>
120+
<sourcepath>target/generated-sources/delombok</sourcepath>
121+
<show>public</show>
122+
<excludePackageNames>com.relogiclabs.json.schema.internal.*</excludePackageNames>
123+
</configuration>
124+
<executions>
125+
<execution>
126+
<id>attach-javadocs</id>
127+
<goals>
128+
<goal>jar</goal>
129+
</goals>
130+
</execution>
131+
</executions>
132+
</plugin>
133+
<plugin>
134+
<groupId>org.apache.maven.plugins</groupId>
135+
<artifactId>maven-gpg-plugin</artifactId>
136+
<version>3.1.0</version>
137+
<executions>
138+
<execution>
139+
<id>sign-artifacts</id>
140+
<phase>verify</phase>
141+
<goals>
142+
<goal>sign</goal>
143+
</goals>
144+
<configuration>
145+
<keyname>${gpg.keyname}</keyname>
146+
<passphraseServerId>${gpg.keyname}</passphraseServerId>
147+
</configuration>
148+
</execution>
149+
</executions>
150+
</plugin>
151+
<plugin>
152+
<groupId>org.sonatype.plugins</groupId>
153+
<artifactId>nexus-staging-maven-plugin</artifactId>
154+
<version>1.6.13</version>
155+
<extensions>true</extensions>
156+
<configuration>
157+
<serverId>ossrh</serverId>
158+
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
159+
<autoReleaseAfterClose>true</autoReleaseAfterClose>
160+
</configuration>
161+
</plugin>
162+
</plugins>
163+
</build>
164+
</profile>
165+
</profiles>
166+
</project>

0 commit comments

Comments
 (0)