-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: provide schemas useful for frontend development (#94)
- Loading branch information
1 parent
2111f72
commit 01cad8b
Showing
11 changed files
with
121 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# List of unused schemas. These are not used in API definitions but useful for frontend development. | ||
PaperWithoutAutofield: | ||
$ref: ./entity/paper/PaperWithoutAutofield.yaml | ||
PaperWithoutAutofieldError: | ||
$ref: ./entity/paper/PaperWithoutAutofieldError.yaml | ||
GraphContentWithoutAutofield: | ||
$ref: ./entity/graph/GraphContentWithoutAutofield.yaml | ||
GraphContentWithoutAutofieldError: | ||
$ref: ./entity/graph/GraphContentWithoutAutofieldError.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,5 +14,4 @@ properties: | |
This is the introduction of the paper. | ||
required: | ||
- id | ||
- name | ||
- paragraph |
12 changes: 12 additions & 0 deletions
12
docs/openapi/schemas/entity/graph/GraphContentWithoutAutofield.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
type: object | ||
description: Graph object with only content fields without auto-generated fields | ||
properties: | ||
paragraph: | ||
type: string | ||
maxLength: 40000 | ||
description: Graph paragraph | ||
example: | | ||
## Introduction | ||
This is the introduction of the paper. | ||
required: | ||
- paragraph |
7 changes: 7 additions & 0 deletions
7
docs/openapi/schemas/entity/graph/GraphContentWithoutAutofieldError.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
type: object | ||
description: Error Message for GraphContentWithoutAutofield object | ||
properties: | ||
paragraph: | ||
type: string | ||
description: Error message for graph paragraph | ||
example: graph paragraph must be less than or equal to 40000 bytes |
15 changes: 15 additions & 0 deletions
15
docs/openapi/schemas/entity/paper/PaperWithoutAutofield.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
type: object | ||
description: Paper object without auto-generated fields | ||
properties: | ||
content: | ||
type: string | ||
maxLength: 40000 | ||
description: Paper content | ||
example: | | ||
## Introduction | ||
This is the introduction of the paper. | ||
## What is note apps? | ||
Note apps is a web application that allows users to create, read, update, and delete notes. | ||
required: | ||
- content |
7 changes: 7 additions & 0 deletions
7
docs/openapi/schemas/entity/paper/PaperWithoutAutofieldError.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
type: object | ||
description: Error Message for PaperWithoutAutofield object | ||
properties: | ||
content: | ||
type: string | ||
description: Error message for paper content | ||
example: paper content must be less than or equal to 40000 bytes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
/* | ||
* Web API of kNODEledge | ||
* | ||
* App to Create Graphically-Summarized Notes in Three Steps | ||
* | ||
* API version: 0.1.0 | ||
* Generated by: OpenAPI Generator (https://openapi-generator.tech) | ||
*/ | ||
|
||
package model | ||
|
||
// GraphContentWithoutAutofield - Graph object with only content fields without auto-generated fields | ||
type GraphContentWithoutAutofield struct { | ||
|
||
// Graph paragraph | ||
Paragraph string `json:"paragraph"` | ||
} |
17 changes: 17 additions & 0 deletions
17
internal/model/model_graph_content_without_autofield_error.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
/* | ||
* Web API of kNODEledge | ||
* | ||
* App to Create Graphically-Summarized Notes in Three Steps | ||
* | ||
* API version: 0.1.0 | ||
* Generated by: OpenAPI Generator (https://openapi-generator.tech) | ||
*/ | ||
|
||
package model | ||
|
||
// GraphContentWithoutAutofieldError - Error Message for GraphContentWithoutAutofield object | ||
type GraphContentWithoutAutofieldError struct { | ||
|
||
// Error message for graph paragraph | ||
Paragraph string `json:"paragraph,omitempty"` | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
/* | ||
* Web API of kNODEledge | ||
* | ||
* App to Create Graphically-Summarized Notes in Three Steps | ||
* | ||
* API version: 0.1.0 | ||
* Generated by: OpenAPI Generator (https://openapi-generator.tech) | ||
*/ | ||
|
||
package model | ||
|
||
// PaperWithoutAutofield - Paper object without auto-generated fields | ||
type PaperWithoutAutofield struct { | ||
|
||
// Paper content | ||
Content string `json:"content"` | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
/* | ||
* Web API of kNODEledge | ||
* | ||
* App to Create Graphically-Summarized Notes in Three Steps | ||
* | ||
* API version: 0.1.0 | ||
* Generated by: OpenAPI Generator (https://openapi-generator.tech) | ||
*/ | ||
|
||
package model | ||
|
||
// PaperWithoutAutofieldError - Error Message for PaperWithoutAutofield object | ||
type PaperWithoutAutofieldError struct { | ||
|
||
// Error message for paper content | ||
Content string `json:"content,omitempty"` | ||
} |