Skip to content

Commit b3c8c57

Browse files
committed
rearranged doc file
1 parent 4804fe7 commit b3c8c57

File tree

9 files changed

+15
-15
lines changed

9 files changed

+15
-15
lines changed

docs/overview/parsing-inputs/body.md renamed to docs/parsing-inputs/body.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,11 +121,11 @@ With just that Python type declaration, **Ellar** will:
121121

122122
The JSON Schemas of your models will be part of your OpenAPI generated schema, and will be shown in the interactive API docs:
123123

124-
![Openapi schema](../../img/body-schema-doc.png)
124+
![Openapi schema](../img/body-schema-doc.png)
125125

126126
... and they will be also used in the API docs inside each *path operation* that needs them:
127127

128-
![Openapi schema](../../img/body-schema-doc2.png)
128+
![Openapi schema](../img/body-schema-doc2.png)
129129

130130

131131
## Request Body + Path parameters
@@ -309,7 +309,7 @@ class ItemsController(ControllerBase):
309309
```
310310
And you will have this:
311311

312-
![Openapi schema](../../img/body-schema-doc3.png)
312+
![Openapi schema](../img/body-schema-doc3.png)
313313

314314
!!! info
315315
`Body` also has all the same extra validation and metadata parameters as `Query`,`Path` and others you will see later.

docs/overview/parsing-inputs/form-params.md renamed to docs/parsing-inputs/form-params.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ class ItemsController(ControllerBase):
6767
return item
6868
```
6969

70-
![Openapi schema](../../img/form-schema-doc.png)
70+
![Openapi schema](../img/form-schema-doc.png)
7171

7272
## Request form + path + query parameters
7373

File renamed without changes.

docs/overview/parsing-inputs/path-params.md renamed to docs/parsing-inputs/path-params.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ class ItemsController(ControllerBase):
189189

190190
### Documentation
191191
Now, when you open your browser at [http://localhost:8000/docs](http://localhost:8000/docs), you will see the automatic, interactive, API documentation.
192-
![events Swagger doc](../../img/event_docs_swagger.png)
192+
![events Swagger doc](../img/event_docs_swagger.png)
193193

194194
### Using Enum
195195

@@ -227,4 +227,4 @@ class ItemsController(ControllerBase):
227227
#### Check the docs
228228
Because the available values for the path parameter are predefined, the interactive docs can show them nicely:
229229

230-
![enum Swagger doc](../../img/enum_docs_swagger.png)
230+
![enum Swagger doc](../img/enum_docs_swagger.png)

docs/overview/parsing-inputs/query-params.md renamed to docs/parsing-inputs/query-params.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,4 +185,4 @@ class ItemsController(ControllerBase):
185185
return {"filters": filters.dict()}
186186
```
187187

188-
![Query Doc](../../img/query_filter_swagger.png)
188+
![Query Doc](../img/query_filter_swagger.png)

mkdocs.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,14 @@ nav:
4747
# - Functional Programming: overview/functional_route.md
4848
- Configuration: configurations.md
4949
- How-to Guides:
50-
- Input Parsing: overview/parsing-inputs/index.md
51-
- Path: overview/parsing-inputs/path-params.md
52-
- Query: overview/parsing-inputs/query-params.md
53-
- Header: overview/parsing-inputs/header-params.md
54-
- Cookie: overview/parsing-inputs/cookie-params.md
55-
- Body: overview/parsing-inputs/body.md
56-
- Form: overview/parsing-inputs/form-params.md
57-
- File: overview/parsing-inputs/file-params.md
50+
- Input Parsing: parsing-inputs/index.md
51+
- Path: parsing-inputs/path-params.md
52+
- Query: parsing-inputs/query-params.md
53+
- Header: parsing-inputs/header-params.md
54+
- Cookie: parsing-inputs/cookie-params.md
55+
- Body: parsing-inputs/body.md
56+
- Form: parsing-inputs/form-params.md
57+
- File: parsing-inputs/file-params.md
5858
# - Response: overview/responses.md
5959
- Templating:
6060
- html: templating/templating.md

0 commit comments

Comments
 (0)