marshmallow-code / marshmallow-code/flask-smorest

How to add Rapidoc logo?

Open
#355 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
717
Forks
77
Avg merge
7h 49m
Merged PRs (30d)
3

Description

Is there a way, via `API_SPEC_OPTIONS`, `OPENAPI_RAPIDOC_CONFIG`, or some other app config constant, to set the logo for use in rapidoc? Specifically I'm looking for something like the `Change Logo` example from https://rapidocweb.com/examples.html.

From what I understand, it doesn't seem like there is without a change to `flask_smorest/spec/tempaltes/rapidoc.html` to add the `` tag section as shown in the above example.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect API_SPEC_OPTIONS and OPENAPI_RAPIDOC_CONFIG, then read flask_smorest/spec/templates/rapidoc.html to see how configuration reaches the RapiDoc template. Compare the available options with the Rapidoc “Change Logo” example linked in the issue. Done means establishing whether logo configuration can be supported and identifying the template/configuration changes required.

Written by the indexing model from the issue text.

Assessment

Tech stack
flask, python
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.