marshmallow-code / marshmallow-code/flask-smorest
Clarification on RapidDoc configuration
Open
Nobody has claimed this yet.
question
- Dominant language
- Python
- Stars
- 717
- Forks
- 77
- Avg merge
- 7h 49m
- Merged PRs (30d)
- 3
Description
I have two questions concerning RapidDoc configuration:
- Is it intended that inside the config object we need to pass boolean as string?
OPENAPI_RAPIDOC_CONFIG = {
"allow-spec-file-load" : "false", # it work
"allow-spec-url-load": False # it does not work
}
- Is there any way to use slots? I tried the following but it did not work
OPENAPI_RAPIDOC_CONFIG = {
"logo": '<img slot="nav-logo" src="http://localhost:5000/logo.svg" style="width:50px; height:50px"/>'
}
Thank you.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names OPENAPI_RAPIDOC_CONFIG and RapidDoc but no repository file or test entry point. Start by tracing how this configuration is passed to RapidDoc, then investigate boolean handling and slot support. Done means confirming the supported behavior and documenting the correct configuration or limitations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- flask, openapi, python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100