Skip to content
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.

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

Pass options as JSON to redoc-cli #797

Closed
lezhnev74 opened this issue Jan 28, 2019 · 8 comments
Closed

Pass options as JSON to redoc-cli #797

lezhnev74 opened this issue Jan 28, 2019 · 8 comments

Comments

@lezhnev74
Copy link

I am using redoc-cli to create a zero-dependency file for our API documentation portal.
I read that I can tweak the styles by customizing the file https://github.com/Rebilly/ReDoc/blob/master/src/theme.ts. I downloaded the file and changed it a bit.

How do I run redoc-cli and pass this updated file in? I just can't find the documentation about this.

Thanks a lot!

@jdillard
Copy link

jdillard commented May 7, 2019

I think pointing to a customized template has been documented in the recod-cli README now:

redoc-cli bundle [spec] -t custom.hbs

This can probably be closed.

edit: heh oops misread what was being customized. glad it got answered.

@RomanHotsiy
Copy link
Member

@lezhnev74 sorry for later reply.

You can use --options and pass a JSON string:

E.g. --options = '{"theme": {"colors": {"primary": {"main": "#ff0000" }}}}'

@lezhnev74
Copy link
Author

Thank you for the example!

@jdillard
Copy link

jdillard commented May 7, 2019

I'm not sure if it is user error, but that example isn't working for me in redoc-cli v0.8.3. Nothing changes if I do:

redoc-cli bundle [spec] --options = '{"theme": {"colors": {"primary": {"main": "#ff0000" }}}}'

Although, the options example in the README works:

redoc-cli bundle [spec] --options.theme.colors.primary.main=#ff0000

@bkhablenko
Copy link

I confirm that passing options as JSON doesn't seem to work.

redoc-cli serve --options='{"theme":{"colors":{"primary":{"main":"orange"}}}}' petstore.yaml

The command above generates an HTML page with the following line in its source code:

Redoc.init("spec.json", "{\"theme\":{\"colors\":{\"primary\":{\"main\":\"orange\"}}}}", container);

However, passing the color as a single option does work:

redoc-cli serve --options.theme.colors.primary.main=orange petstore.yaml

The resulting page has a slightly different line:

Redoc.init("spec.json", {"theme":{"colors":{"primary":{"main":"orange"}}}}, container);

So unless I'm doing something wrong, my guess is that there might be a bug in the CLI. Even though this issue was closed, could you please take a look? @RomanHotsiy

@RomanHotsiy RomanHotsiy reopened this Jun 20, 2019
@RomanHotsiy RomanHotsiy changed the title How to apply themes when executing redoc-cli? Pass options as JSON to redoc-cli Jun 20, 2019
@RomanHotsiy
Copy link
Member

Sorry, I confused this. There is no support for JSON string.
PR would be appreciated!

@adeelibr
Copy link

@RomanHotsiy how can you pass theme to docker command?

@knidarkness
Copy link
Contributor

Sorry, I confused this. There is no support for JSON string.
PR would be appreciated!

Here it is @RomanHotsiy : #1047

jmendiara added a commit to jmendiara/ReDoc that referenced this issue Feb 28, 2020
* feat(cli): added support for JSON string value for --options CLI argument (Redocly#1047)

closes Redocly#797

* docs: expandDefaultServerVariables

* fix: do not crash on empty scopes

fixes Redocly#1044

* fix: auth section appears twice

fixes Redocly#818

* fix: left menu item before group is not highligted

fixes Redocly#1033

* fix: clicking on group title breaks first tag

fixes Redocly#1034

* fix: false-positive recursive detection with allOf at the same level

* fix: remove excessive whitespace between md sections on small screens

fixes Redocly#874

* chore: Release 2.0.0-rc.15 🔖

* chore(cli): redoc-cli v0.9.0

* chore(cli): update yarn.lock

* chore(cli): [email protected]

* fix: fix scrollYOffset when SSR

* chore: Release 2.0.0-rc.16 🔖

* chore(cli): [email protected]

* docs: fix typo (Redocly#1062)

* feat: added support for file paths as --options cli argument (Redocly#1049)

* fix: types over-pluralization (Redocly#1057)

fixes Redocly#1053

* docs: improve options documentation (Redocly#1071)

* Sort by name
* Document `hideSingleRequestSampleTab`
* End option description with `.`

* fix: no quotes for default values in header fields. (Redocly#1059)

* fix: changed several components style font-family to monospace (Redocly#1063)

fixes Redocly#909

* fix: active menu item scroll into view

* chore: Release 2.0.0-rc.17 🔖

* fix: improve mime-type dropdown font

* fix: add oneOf buttons vertical space when wrapped to new line

* hore: Release 2.0.0-rc.18 🔖

* fix: wrap json examples in code tag (Redocly#1064)

* feat: display `multipleOf` constrains (Redocly#1065)

* docs: fix link to x-nullable docs from README (Redocly#1135)

* fix: change the title of "Security Scheme Type" to match "HTTP Authorization Scheme" (Redocly#1126)

* docs: fixed example slack api url (Redocly#1077)

* doc: fix some typos (Redocly#1117)

* feat(cli): Fallback on the spec's title before falling back on… (Redocly#1073)

* fix: do not URI-encode parameter values for better readability

fixes Redocly#1138

* chore: upgrade deps

* feat: enable menuToggle by default

* chore: remove react-hot-loader from deps

fixes Redocly#1133

* fix: support discriminator mapping 1-n

fixes Redocly#1111

* fix: remove hardcoded fontFamily for oneOf labels

fixes Redocly#1120

* fix: h2 padding on mobile

fixes Redocly#1118

* fix: python comment stripped in headings

fixes Redocly#1116

* feat: new option hideSchemaTitles

* fix: remove implicit discriminator mapping when explicit is present

* chore: refactor request samples

* feat: new option payloadSampleIdx

* fix: search-box use theme

* fix: fix sortByRequired (stabilise sort) (Redocly#1136)

fixes Redocly#1104
fixes Redocly#1121
fixes Redocly#1061

* chore: Release 2.0.0-rc.19 🔖

* chore: update npm token for travis deploy

* chore(cli): [email protected]

* fix: fix missing parameters

fixes Redocly#1142

* chore: Release 2.0.0-rc.20 🔖

* chore(cli): [email protected]

* fix: use mobile menu background color value from theme (Redocly#1144)

* chore(cli): Lint and prettify cli/index.ts (Redocly#1074)

* fix: fix duplicated content in tags when using md headings

fixes Redocly#1150, fixes Redocly#1152

* fix: empty servers behaviour per OAS spec

fixes Redocly#1151

* chore: fix travis export vars

* tests: fix tests for empty servers

* chore: Release 2.0.0-rc.21 🔖

* chore(cli): upgrade handlebars in yarn.lock

* chore(cli): update redoc

* chore(cli): [email protected]

* feat: add HTTP syntax highlighting (Redocly#1157)

* fix: do not process oneOf if inherited from parent with discriminator

* chore: minor perf optimizations

* chore: Release 2.0.0-rc.22 🔖

* fix: fix broken sticky sidebar in Chrome 80

fixes Redocly#1167

* chore: Release 2.0.0-rc.23 🔖

* chore(cli): [email protected]

Co-authored-by: Sergey Dubovyk <[email protected]>
Co-authored-by: Roman Hotsiy <[email protected]>
Co-authored-by: Anastasiya Mashoshyna <[email protected]>
Co-authored-by: Michael Huynh <[email protected]>
Co-authored-by: Alex <[email protected]>
Co-authored-by: russellrobinson <[email protected]>
Co-authored-by: Andrew Zhukevych <[email protected]>
Co-authored-by: Andrii Tykhan <[email protected]>
Co-authored-by: Dimitar Nanov <[email protected]>
Co-authored-by: bwjohnson-ss <[email protected]>
Co-authored-by: torbenw <[email protected]>
Co-authored-by: Chris Faulkner <[email protected]>
Co-authored-by: Zakary Kamal Ismail <[email protected]>
Co-authored-by: Nan Yan <[email protected]>
Co-authored-by: Anna Stasiuk <[email protected]>
Co-authored-by: Kryštof Korb <[email protected]>
jmendiara added a commit to jmendiara/ReDoc that referenced this issue Feb 28, 2020
* feat(cli): added support for JSON string value for --options CLI argument (Redocly#1047)

closes Redocly#797

* docs: expandDefaultServerVariables

* fix: do not crash on empty scopes

fixes Redocly#1044

* fix: auth section appears twice

fixes Redocly#818

* fix: left menu item before group is not highligted

fixes Redocly#1033

* fix: clicking on group title breaks first tag

fixes Redocly#1034

* fix: false-positive recursive detection with allOf at the same level

* fix: remove excessive whitespace between md sections on small screens

fixes Redocly#874

* chore: Release 2.0.0-rc.15 🔖

* chore(cli): redoc-cli v0.9.0

* chore(cli): update yarn.lock

* chore(cli): [email protected]

* fix: fix scrollYOffset when SSR

* chore: Release 2.0.0-rc.16 🔖

* chore(cli): [email protected]

* docs: fix typo (Redocly#1062)

* feat: added support for file paths as --options cli argument (Redocly#1049)

* fix: types over-pluralization (Redocly#1057)

fixes Redocly#1053

* docs: improve options documentation (Redocly#1071)

* Sort by name
* Document `hideSingleRequestSampleTab`
* End option description with `.`

* fix: no quotes for default values in header fields. (Redocly#1059)

* fix: changed several components style font-family to monospace (Redocly#1063)

fixes Redocly#909

* fix: active menu item scroll into view

* chore: Release 2.0.0-rc.17 🔖

* fix: improve mime-type dropdown font

* fix: add oneOf buttons vertical space when wrapped to new line

* hore: Release 2.0.0-rc.18 🔖

* fix: wrap json examples in code tag (Redocly#1064)

* feat: display `multipleOf` constrains (Redocly#1065)

* docs: fix link to x-nullable docs from README (Redocly#1135)

* fix: change the title of "Security Scheme Type" to match "HTTP Authorization Scheme" (Redocly#1126)

* docs: fixed example slack api url (Redocly#1077)

* doc: fix some typos (Redocly#1117)

* feat(cli): Fallback on the spec's title before falling back on… (Redocly#1073)

* fix: do not URI-encode parameter values for better readability

fixes Redocly#1138

* chore: upgrade deps

* feat: enable menuToggle by default

* chore: remove react-hot-loader from deps

fixes Redocly#1133

* fix: support discriminator mapping 1-n

fixes Redocly#1111

* fix: remove hardcoded fontFamily for oneOf labels

fixes Redocly#1120

* fix: h2 padding on mobile

fixes Redocly#1118

* fix: python comment stripped in headings

fixes Redocly#1116

* feat: new option hideSchemaTitles

* fix: remove implicit discriminator mapping when explicit is present

* chore: refactor request samples

* feat: new option payloadSampleIdx

* fix: search-box use theme

* fix: fix sortByRequired (stabilise sort) (Redocly#1136)

fixes Redocly#1104
fixes Redocly#1121
fixes Redocly#1061

* chore: Release 2.0.0-rc.19 🔖

* chore: update npm token for travis deploy

* chore(cli): [email protected]

* fix: fix missing parameters

fixes Redocly#1142

* chore: Release 2.0.0-rc.20 🔖

* chore(cli): [email protected]

* fix: use mobile menu background color value from theme (Redocly#1144)

* chore(cli): Lint and prettify cli/index.ts (Redocly#1074)

* fix: fix duplicated content in tags when using md headings

fixes Redocly#1150, fixes Redocly#1152

* fix: empty servers behaviour per OAS spec

fixes Redocly#1151

* chore: fix travis export vars

* tests: fix tests for empty servers

* chore: Release 2.0.0-rc.21 🔖

* chore(cli): upgrade handlebars in yarn.lock

* chore(cli): update redoc

* chore(cli): [email protected]

* feat: add HTTP syntax highlighting (Redocly#1157)

* fix: do not process oneOf if inherited from parent with discriminator

* chore: minor perf optimizations

* chore: Release 2.0.0-rc.22 🔖

* fix: fix broken sticky sidebar in Chrome 80

fixes Redocly#1167

* chore: Release 2.0.0-rc.23 🔖

* chore(cli): [email protected]

Co-authored-by: Sergey Dubovyk <[email protected]>
Co-authored-by: Roman Hotsiy <[email protected]>
Co-authored-by: Anastasiya Mashoshyna <[email protected]>
Co-authored-by: Michael Huynh <[email protected]>
Co-authored-by: Alex <[email protected]>
Co-authored-by: russellrobinson <[email protected]>
Co-authored-by: Andrew Zhukevych <[email protected]>
Co-authored-by: Andrii Tykhan <[email protected]>
Co-authored-by: Dimitar Nanov <[email protected]>
Co-authored-by: bwjohnson-ss <[email protected]>
Co-authored-by: torbenw <[email protected]>
Co-authored-by: Chris Faulkner <[email protected]>
Co-authored-by: Zakary Kamal Ismail <[email protected]>
Co-authored-by: Nan Yan <[email protected]>
Co-authored-by: Anna Stasiuk <[email protected]>
Co-authored-by: Kryštof Korb <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants