Skip to content

Commit 459955e

Browse files
committed
Update project documentations
1 parent 046feed commit 459955e

File tree

368 files changed

+12027
-5969
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

368 files changed

+12027
-5969
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The next example represents an expanded version of the previous one, which bring
6767
```cpp
6868
%title: "Extended User Profile Dashboard API Response"
6969
%version: "2.0.0-extended"
70-
%import: com.relogiclabs.jschema.test.external.ExternalFunctions
70+
%import: com.relogiclabs.jschema.test.extension.GeneralExtension1
7171

7272
%pragma DateDataTypeFormat: "DD-MM-YYYY"
7373
%pragma TimeDataTypeFormat: "DD-MM-YYYY hh:mm:ss"

doc/content/articles/directives.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ In a schema, the version directive is used to provide a version label of the sch
2828
## Import Directive
2929
Import directive enables the addition or inclusion of a class, as defined by object-oriented programming, to a schema along with a set of methods that have specific signatures for performing custom validations. This feature extends the built-in validation capabilities of the schema. The example below illustrates how to utilize the import directive in Java language:
3030
```js
31-
%import: com.relogiclabs.jschema.test.external.ExternalFunctions
31+
%import: com.relogiclabs.jschema.test.extension.GeneralExtension1
3232
```
3333

3434
## Pragma Directive

doc/content/articles/functions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,9 @@ Validates whether the `target` string represents a valid email address. It follo
160160

161161
### URL & URI Address
162162
```stylus
163-
#string target - @url(#string scheme)
163+
#string target - @url(#string... schemes)
164164
```
165-
Validates whether the `target` string is a valid URL (Uniform Resource Locator) or URI (Uniform Resource Identifier) with a specific scheme provided by the `scheme` parameter. It follows the RFC 3986 URI Generic Syntax to determine the validity of the URL or URI. In addition to conforming to this standard, it recognizes all widely used URL and URI address formats, ensuring compatibility with a wide range of systems and user requirements.
165+
Validates whether the `target` string is a valid URL (Uniform Resource Locator) or URI (Uniform Resource Identifier) with a specific scheme that matches one of the schemes provided by the `schemes` parameter. It follows the RFC 3986 URI Generic Syntax to determine the validity of the URL or URI. In addition to conforming to this standard, it recognizes all widely used URL and URI address formats, ensuring compatibility with a wide range of systems and user requirements.
166166

167167
```stylus
168168
#string target - @url

doc/public/api/META-INF/MANIFEST.MF

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
Manifest-Version: 1.0
2-
Created-By: Maven Javadoc Plugin 3.6.3
2+
Created-By: Maven Javadoc Plugin 3.10.1
33
Build-Jdk-Spec: 17
44

doc/public/api/allclasses-index.html

+179-120
Large diffs are not rendered by default.

doc/public/api/allpackages-index.html

+9-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>All Packages (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>All Packages (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="package index">
1010
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
1111
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -61,7 +61,11 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
6161
<div class="col-last odd-row-color">&nbsp;</div>
6262
<div class="col-first even-row-color"><a href="com/relogiclabs/jschema/exception/package-summary.html">com.relogiclabs.jschema.exception</a></div>
6363
<div class="col-last even-row-color">&nbsp;</div>
64-
<div class="col-first odd-row-color"><a href="com/relogiclabs/jschema/function/package-summary.html">com.relogiclabs.jschema.function</a></div>
64+
<div class="col-first odd-row-color"><a href="com/relogiclabs/jschema/extension/package-summary.html">com.relogiclabs.jschema.extension</a></div>
65+
<div class="col-last odd-row-color">&nbsp;</div>
66+
<div class="col-first even-row-color"><a href="com/relogiclabs/jschema/function/package-summary.html">com.relogiclabs.jschema.function</a></div>
67+
<div class="col-last even-row-color">&nbsp;</div>
68+
<div class="col-first odd-row-color"><a href="com/relogiclabs/jschema/library/package-summary.html">com.relogiclabs.jschema.library</a></div>
6569
<div class="col-last odd-row-color">&nbsp;</div>
6670
<div class="col-first even-row-color"><a href="com/relogiclabs/jschema/message/package-summary.html">com.relogiclabs.jschema.message</a></div>
6771
<div class="col-last even-row-color">&nbsp;</div>

doc/public/api/com/relogiclabs/jschema/JsonAssert.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>JsonAssert (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>JsonAssert (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="declaration: package: com.relogiclabs.jschema, class: JsonAssert">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/jschema/JsonSchema.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>JsonSchema (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>JsonSchema (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="declaration: package: com.relogiclabs.jschema, class: JsonSchema">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/jschema/class-use/JsonAssert.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>Uses of Class com.relogiclabs.jschema.JsonAssert (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>Uses of Class com.relogiclabs.jschema.JsonAssert (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="use: package: com.relogiclabs.jschema, class: JsonAssert">
1010
<meta name="generator" content="javadoc/ClassUseWriter">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/jschema/class-use/JsonSchema.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>Uses of Class com.relogiclabs.jschema.JsonSchema (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>Uses of Class com.relogiclabs.jschema.JsonSchema (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="use: package: com.relogiclabs.jschema, class: JsonSchema">
1010
<meta name="generator" content="javadoc/ClassUseWriter">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/jschema/collection/IndexMap.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>IndexMap (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>IndexMap (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="declaration: package: com.relogiclabs.jschema.collection, interface: IndexMap">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/jschema/collection/Keyable.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>Keyable (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>Keyable (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="declaration: package: com.relogiclabs.jschema.collection, interface: Keyable">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/jschema/collection/class-use/IndexMap.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>Uses of Interface com.relogiclabs.jschema.collection.IndexMap (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>Uses of Interface com.relogiclabs.jschema.collection.IndexMap (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="use: package: com.relogiclabs.jschema.collection, interface: IndexMap">
1010
<meta name="generator" content="javadoc/ClassUseWriter">
1111
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/jschema/collection/class-use/Keyable.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>Uses of Interface com.relogiclabs.jschema.collection.Keyable (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>Uses of Interface com.relogiclabs.jschema.collection.Keyable (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="use: package: com.relogiclabs.jschema.collection, interface: Keyable">
1010
<meta name="generator" content="javadoc/ClassUseWriter">
1111
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/jschema/collection/package-summary.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>com.relogiclabs.jschema.collection (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>com.relogiclabs.jschema.collection (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="declaration: package: com.relogiclabs.jschema.collection">
1010
<meta name="generator" content="javadoc/PackageWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/jschema/collection/package-tree.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>com.relogiclabs.jschema.collection Class Hierarchy (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>com.relogiclabs.jschema.collection Class Hierarchy (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="tree: package: com.relogiclabs.jschema.collection">
1010
<meta name="generator" content="javadoc/PackageTreeWriter">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/jschema/collection/package-use.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>Uses of Package com.relogiclabs.jschema.collection (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>Uses of Package com.relogiclabs.jschema.collection (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="use: package: com.relogiclabs.jschema.collection">
1010
<meta name="generator" content="javadoc/PackageUseWriter">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/jschema/exception/AliasNotFoundException.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!DOCTYPE HTML>
2-
<html lang="en">
2+
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Fri Aug 30 22:43:58 EDT 2024 -->
5-
<title>AliasNotFoundException (JSchema 2.2.0 API)</title>
4+
<!-- Generated by javadoc (17) on Thu Oct 24 05:11:34 EDT 2024 -->
5+
<title>AliasNotFoundException (JSchema 2.3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2024-08-30">
8+
<meta name="dc.created" content="2024-10-24">
99
<meta name="description" content="declaration: package: com.relogiclabs.jschema.exception, class: AliasNotFoundException">
1010
<meta name="generator" content="javadoc/ClassWriterImpl">
1111
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

0 commit comments

Comments
 (0)