Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Commit 0a8a312

Browse files
spacetherspacether
authored
Java, adds schema docs (#299)
* Adds draft schema docs with partial info * Changes python to java types * Adds schema name to doc, adds ref link * Fixes schema readline link to ref schemas and listed file location * Works on schema doc types * Improves input type for array and map in schema docs * passes in forceNull so types match java * Turns on header for input map keys * New section removed, map output header added * Adds output type base class * reverts the segment templates * Uses whitespace control char to fix segment Object * Fixes input type template issues * Changes to fixed input typ template * Fixes input type whitespace * Updates output type template to eliminare endChar and fix whitespace * Removes endChar usages * Fixes output base class type info * Adds types of map key value inputs * Adds notes info for map key value inputs * Adds methods * Adds method info to map output type * Adds array model headers and input and output types * Adds list item type * Updates schema docs to look like javadoc * Adds nested class summary * Makes inner classes static * Adds extension info for classes * Adds and uses a reverse template helper in schema docs * Prints only schema in docs * Moves array template to separate part of schema docs * Moves map output class in docs * For ref schemas, adds extension info to docs * Adds links to ref schemas * Adds link to output type in validate method * Adds link for schema validate for list output types * Adds nested class links * Improves list output type docs * Adds output type links for of methods * Improves doc validate signatures for array and map output types * Makes schema classes static * Fixes formatting for map input keys * Uses isSimpleString in schema class writing * Uses isSimpleNull * isSimpleInteger isSimpleNumber * Uses isSimpleBoolean * Uses isSimpleArray * Uses isSimpleObject * Uses isSimpleAnyType * Adds line breaks before class extension line in schema docs * Corrects schema extension lines * Adds doc link for self ref * Adds ref schema extension to docs with links * Fixes links to component sschemas in readme * Adds keywordToValidator info * Adds field summary, breaks table * Adds list link in schema doc for properties * Adds link to map type * Fixes all list and map type property outputs * Uses forDocs in type * Updates format template * Fixes schema docs for keywordToValidator properties * Fixes indentation for keywordToValidator * Adds forDocs to items * Adds forDocs higher up * Fixes indentation in addProps if keywordToValidator * Adds docs links for items schemas * Adds addProps docs links * Adds links to schema properties * Removes field summary and method summary when schema classes extend primitive json schemas * Lists that the validate method is inherited from schemas.XJsonSchema * Removes pythn reference from java docs
1 parent bccd702 commit 0a8a312

680 files changed

Lines changed: 18114 additions & 2757 deletions

File tree

Some content is hidden

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

‎samples/client/petstore/java/.openapi-generator/FILES‎

Lines changed: 299 additions & 0 deletions
Large diffs are not rendered by default.

‎samples/client/petstore/java/README.md‎

Lines changed: 147 additions & 147 deletions
Large diffs are not rendered by default.

‎samples/client/petstore/java/docs/components/headers/int32jsoncontenttypeheader/content/applicationjson/Int32JsonContentTypeHeaderSchema.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Int32JsonContentTypeHeaderSchema
2+
org.openapijsonschematools.components.headers.int32jsoncontenttypeheader.content.applicationjson.Int32JsonContentTypeHeaderSchema.java
3+
public class Int32JsonContentTypeHeaderSchema
4+
5+
A class that contains necessary nested schema classes, and classes to store validated list and map payloads
6+
7+
## Nested Class Summary
8+
| Modifier and Type | Class and Description |
9+
| ----------------- | ---------------------- |
10+
| static class | [Int32JsonContentTypeHeaderSchema.Int32JsonContentTypeHeaderSchema1](#int32jsoncontenttypeheaderschema1)<br> schema class |
11+
12+
## Int32JsonContentTypeHeaderSchema1
13+
public static class Int32JsonContentTypeHeaderSchema1<br>
14+
extends Int32JsonSchema
15+
16+
A schema class that validates payloads

‎samples/client/petstore/java/docs/components/headers/numberheader/NumberHeaderSchema.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# NumberHeaderSchema
2+
org.openapijsonschematools.components.headers.numberheader.NumberHeaderSchema.java
3+
public class NumberHeaderSchema
4+
5+
A class that contains necessary nested schema classes, and classes to store validated list and map payloads
6+
7+
## Nested Class Summary
8+
| Modifier and Type | Class and Description |
9+
| ----------------- | ---------------------- |
10+
| static class | [NumberHeaderSchema.NumberHeaderSchema1](#numberheaderschema1)<br> schema class |
11+
12+
## NumberHeaderSchema1
13+
public static class NumberHeaderSchema1<br>
14+
extends DecimalJsonSchema
15+
16+
A schema class that validates payloads
17+
18+
| Methods Inherited from class org.openapijsonschematools.schemas.DecimalJsonSchema |
19+
| ------------------------------------------------------------------ |
20+
| validate |

‎samples/client/petstore/java/docs/components/headers/refcontentschemaheader/content/applicationjson/RefContentSchemaHeaderSchema.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# RefContentSchemaHeaderSchema
2+
org.openapijsonschematools.components.headers.refcontentschemaheader.content.applicationjson.RefContentSchemaHeaderSchema.java
3+
public class RefContentSchemaHeaderSchema
4+
5+
A class that contains necessary nested schema classes, and classes to store validated list and map payloads
6+
7+
## Nested Class Summary
8+
| Modifier and Type | Class and Description |
9+
| ----------------- | ---------------------- |
10+
| static class | [RefContentSchemaHeaderSchema.RefContentSchemaHeaderSchema1](#refcontentschemaheaderschema1)<br> schema class |
11+
12+
## RefContentSchemaHeaderSchema1
13+
public static class RefContentSchemaHeaderSchema1<br>
14+
extends [StringWithValidation.StringWithValidation1](../../../../../components/schemas/StringWithValidation.md#stringwithvalidation1)
15+
16+
A schema class that validates payloads

‎samples/client/petstore/java/docs/components/headers/refschemaheader/RefSchemaHeaderSchema.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# RefSchemaHeaderSchema
2+
org.openapijsonschematools.components.headers.refschemaheader.RefSchemaHeaderSchema.java
3+
public class RefSchemaHeaderSchema
4+
5+
A class that contains necessary nested schema classes, and classes to store validated list and map payloads
6+
7+
## Nested Class Summary
8+
| Modifier and Type | Class and Description |
9+
| ----------------- | ---------------------- |
10+
| static class | [RefSchemaHeaderSchema.RefSchemaHeaderSchema1](#refschemaheaderschema1)<br> schema class |
11+
12+
## RefSchemaHeaderSchema1
13+
public static class RefSchemaHeaderSchema1<br>
14+
extends [StringWithValidation.StringWithValidation1](../../../components/schemas/StringWithValidation.md#stringwithvalidation1)
15+
16+
A schema class that validates payloads

‎samples/client/petstore/java/docs/components/headers/stringheader/StringHeaderSchema.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# StringHeaderSchema
2+
org.openapijsonschematools.components.headers.stringheader.StringHeaderSchema.java
3+
public class StringHeaderSchema
4+
5+
A class that contains necessary nested schema classes, and classes to store validated list and map payloads
6+
7+
## Nested Class Summary
8+
| Modifier and Type | Class and Description |
9+
| ----------------- | ---------------------- |
10+
| static class | [StringHeaderSchema.StringHeaderSchema1](#stringheaderschema1)<br> schema class |
11+
12+
## StringHeaderSchema1
13+
public static class StringHeaderSchema1<br>
14+
extends StringJsonSchema
15+
16+
A schema class that validates payloads
17+
18+
| Methods Inherited from class org.openapijsonschematools.schemas.StringJsonSchema |
19+
| ------------------------------------------------------------------ |
20+
| validate |

‎samples/client/petstore/java/docs/components/parameters/componentrefschemastringwithvalidation/content/applicationjson/Schema.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Schema
2+
org.openapijsonschematools.components.parameters.componentrefschemastringwithvalidation.content.applicationjson.Schema.java
3+
public class Schema
4+
5+
A class that contains necessary nested schema classes, and classes to store validated list and map payloads
6+
7+
## Nested Class Summary
8+
| Modifier and Type | Class and Description |
9+
| ----------------- | ---------------------- |
10+
| static class | [Schema.Schema1](#schema1)<br> schema class |
11+
12+
## Schema1
13+
public static class Schema1<br>
14+
extends [StringWithValidation.StringWithValidation1](../../../../../components/schemas/StringWithValidation.md#stringwithvalidation1)
15+
16+
A schema class that validates payloads

‎samples/client/petstore/java/docs/components/parameters/pathusername/Schema.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Schema
2+
org.openapijsonschematools.components.parameters.pathusername.Schema.java
3+
public class Schema
4+
5+
A class that contains necessary nested schema classes, and classes to store validated list and map payloads
6+
7+
## Nested Class Summary
8+
| Modifier and Type | Class and Description |
9+
| ----------------- | ---------------------- |
10+
| static class | [Schema.Schema1](#schema1)<br> schema class |
11+
12+
## Schema1
13+
public static class Schema1<br>
14+
extends StringJsonSchema
15+
16+
A schema class that validates payloads
17+
18+
| Methods Inherited from class org.openapijsonschematools.schemas.StringJsonSchema |
19+
| ------------------------------------------------------------------ |
20+
| validate |

‎samples/client/petstore/java/docs/components/parameters/refschemastringwithvalidation/Schema.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Schema
2+
org.openapijsonschematools.components.parameters.refschemastringwithvalidation.Schema.java
3+
public class Schema
4+
5+
A class that contains necessary nested schema classes, and classes to store validated list and map payloads
6+
7+
## Nested Class Summary
8+
| Modifier and Type | Class and Description |
9+
| ----------------- | ---------------------- |
10+
| static class | [Schema.Schema1](#schema1)<br> schema class |
11+
12+
## Schema1
13+
public static class Schema1<br>
14+
extends [StringWithValidation.StringWithValidation1](../../../components/schemas/StringWithValidation.md#stringwithvalidation1)
15+
16+
A schema class that validates payloads

0 commit comments

Comments
 (0)