Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix Swagger docs: add /v0/submission prefix #395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulineribeyre merged 1 commit into from
Mar 28, 2023
Merged

Fix Swagger docs: add /v0/submission prefix #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ app.register_blueprint(blueprint)

### Sphinx

Auto-documentation is set up using
[Sphinx](http://www.sphinx-doc.org/en/stable/). To build it, run
Auto-documentation is set up using [Sphinx](http://www.sphinx-doc.org/en/stable/). To build it, run
```bash
cd docs
make html
Expand All @@ -48,6 +47,6 @@ which by default will output the `index.html` page to

[OpenAPI documentation available here.](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/uc-cdis/sheepdog/master/openapi/swagger.yml)

The YAML file comtaining the OpenAPI documentation is in the `openapi` folder;
The YAML file containing the OpenAPI documentation is in the `openapi` folder;
see the README in that folder for more details.

2 changes: 1 addition & 1 deletion build_openapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ def build_swag_doc():
spec["parameters"].extend(new_params)
spec.update(route["swagger"])

path = route["rule"] # OR? '/v0/submission' + route['rule']
path = f"/v0/submission{route['rule']}" # add blueprint prefix

# methods: GET, PUT, POST, DELETE
for method in route["options"].get("methods", []):
Expand Down
2 changes: 0 additions & 2 deletions openapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,5 +110,3 @@ new_route(
}
)
```

**Note that the current automation is temporary: the way sheepdog handles endpoint registration will be updated and documentation generation will be made easier.**
Loading