Skip to content
Snippets Groups Projects
Commit 636e65e2 authored by Sabine Schröder's avatar Sabine Schröder
Browse files

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
......@@ -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
......
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment