Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
TOAR-II FastAPI
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
esde
toar-data
TOAR-II FastAPI
Commits
636e65e2
Commit
636e65e2
authored
4 years ago
by
Sabine Schröder
Browse files
Options
Downloads
Patches
Plain Diff
do not show patch APIs in user documentation
parent
851b0503
No related branches found
No related tags found
No related merge requests found
Pipeline
#57725
passed
4 years ago
Stage: deploy
Stage: pages
Changes
2
Pipelines
1
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
CI/prepare_openapi_json.py
+2
-2
2 additions, 2 deletions
CI/prepare_openapi_json.py
docs/toardb_fastapi.md
+0
-95
0 additions, 95 deletions
docs/toardb_fastapi.md
with
2 additions
and
97 deletions
CI/prepare_openapi_json.py
+
2
−
2
View file @
636e65e2
...
...
@@ -6,11 +6,11 @@ if len(sys.argv) == 2:
with
open
(
sys
.
argv
[
1
])
as
f
:
fastapi
=
json
.
load
(
f
)
# do not show "post" commands in user documentation
# do not show "post"
or "patch"
commands in user documentation
paths
=
deepcopy
(
fastapi
[
'
paths
'
])
for
path
in
fastapi
[
'
paths
'
].
keys
():
for
key
in
fastapi
[
'
paths
'
][
path
].
keys
():
if
(
key
==
'
post
'
):
if
(
key
==
'
post
'
or
key
==
'
patch
'
):
paths
[
path
].
pop
(
key
)
# do not show "create" objects in user documentation
...
...
This diff is collapsed.
Click to expand it.
docs/toardb_fastapi.md
+
0
−
95
View file @
636e65e2
...
...
@@ -983,25 +983,6 @@ Get Stationmeta
| 200 | Successful Response |
| 422 | Validation Error |
#### PATCH
##### Summary:
Patch Stationmeta Core
##### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ---- |
| station_code | path | | Yes | string |
| description | query | | Yes | string |
##### Responses
| Code | Description |
| ---- | ----------- |
| 200 | Successful Response |
| 422 | Validation Error |
### /stationmeta_changelog/{station_id}
#### GET
...
...
@@ -1024,25 +1005,6 @@ Get Stationmeta Changelog
### /stationmeta/delete_field/{station_code}
#### PATCH
##### Summary:
Patch Stationmeta Core
##### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ---- |
| station_code | path | | Yes | string |
| field | query | | Yes | string |
##### Responses
| Code | Description |
| ---- | ----------- |
| 200 | Successful Response |
| 422 | Validation Error |
### /timeseries/
#### GET
...
...
@@ -1084,25 +1046,6 @@ Get Timeseries
| 200 | Successful Response |
| 422 | Validation Error |
#### PATCH
##### Summary:
Patch Timeseries
##### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ---- |
| timeseries_id | path | | Yes | integer |
| description | query | | Yes | string |
##### Responses
| Code | Description |
| ---- | ----------- |
| 200 | Successful Response |
| 422 | Validation Error |
### /timeseries/unique/
#### GET
...
...
@@ -1148,25 +1091,6 @@ Get Timeseries Changelog
### /timeseries/delete_field/{timeseries_id}
#### PATCH
##### Summary:
Patch Timeseries
##### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ---- |
| timeseries_id | path | | Yes | integer |
| field | query | | Yes | string |
##### Responses
| Code | Description |
| ---- | ----------- |
| 200 | Successful Response |
| 422 | Validation Error |
### /data/
#### GET
...
...
@@ -1188,25 +1112,6 @@ Get All Data
| 200 | Successful Response |
| 422 | Validation Error |
#### PATCH
##### Summary:
Patch Data
##### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ---- |
| description | query | | Yes | string |
| version | query | | Yes | string |
##### Responses
| Code | Description |
| ---- | ----------- |
| 200 | Successful Response |
| 422 | Validation Error |
### /data/{timeseries_id}
#### GET
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment