From f65c4b3de3ae0f78bed68e53cfea33dc280f78f8 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Mon, 1 Aug 2016 08:15:52 +0300 Subject: [PATCH 1/8] add features to readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index e9e357a0..c6ea35c3 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,15 @@ ## [Live demo](http://rebilly.github.io/ReDoc/) +## Features +- Extremely easy deployment +- It’s free and open-source project under MIT license +- The widest OpenAPI features support (yes, it supports even discriminator) +- Neat documentation for nested objects +- Code samples support (via vendor extension) +- Responsive three-panel design with menu/scrolling synchronization +- Integrate API introduction into side menu - ReDoc takes advantage of markdown headings from OpenAPI description field. It pulls them into side menu and also supports deep linking. + ## Roadmap - [ ] docs pre-rendering (performance and SEO) - [ ] ability to simple customization From 9abd2691f78afd159c22fd843b413877935fe287 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Thu, 4 Aug 2016 19:14:50 +0300 Subject: [PATCH 2/8] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c6ea35c3..10e0430a 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ ReDoc makes use of the following [vendor extensions](http://swagger.io/specifica * [`x-traitTag`](docs/redoc-vendor-extensions.md#x-traitTag) - useful for handling out common things like Pagination, Rate-Limits, etc * [`x-code-samples`](docs/redoc-vendor-extensions.md#x-code-samples) - specify operation code samples -### Options +### `` tag attributes * `spec-url` - relative or absolute url to your spec file; * `scroll-y-offset` - If set, specifies a vertical scroll-offset. This is often useful when there are fixed positioned elements at the top of the page, such as navbars, headers etc; `scroll-y-offset` can be specified in various ways: @@ -114,7 +114,7 @@ Instead of adding `spec-url` attribute to the `` element you can initiali Redoc.init(specUrl, options) ``` -`options` is javascript object with camel-cased version of options names as the keys, e.g.: +`options` is javascript object with camel-cased version of `` tag attribute names as the keys, e.g.: ```js Redoc.init('http://petstore.swagger.io/v2/swagger.json', { scrollYOffset: 50 From 2364250e9666b36bc1f5201c676efe9917bc4c47 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Mon, 1 Aug 2016 09:31:53 +0300 Subject: [PATCH 3/8] Add GA to demo page --- demo/index.html | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/demo/index.html b/demo/index.html index 28fb0b47..bda7275f 100644 --- a/demo/index.html +++ b/demo/index.html @@ -26,5 +26,14 @@ + From 92f745d10f8a5a6b49e6233055145deffed3cb11 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Wed, 10 Aug 2016 14:44:24 +0300 Subject: [PATCH 4/8] Add Tuple support --- .../JsonSchema/json-schema-common.scss | 7 ++++- lib/components/JsonSchema/json-schema.html | 18 ++++++++++--- lib/components/JsonSchema/json-schema.scss | 26 +++++++++++++++++-- lib/services/schema-helper.service.ts | 22 +++++++++++++--- 4 files changed, 63 insertions(+), 10 deletions(-) diff --git a/lib/components/JsonSchema/json-schema-common.scss b/lib/components/JsonSchema/json-schema-common.scss index e6d24407..26b41559 100644 --- a/lib/components/JsonSchema/json-schema-common.scss +++ b/lib/components/JsonSchema/json-schema-common.scss @@ -77,6 +77,12 @@ $sub-schema-offset: ($bullet-size / 2) + $bullet-margin; font-weight: $base-font-weight; } +.param-type.tuple:before { + content: "Tuple"; + color: $black; + font-weight: $base-font-weight; +} + .param-type.with-hint { display: inline-block; margin-bottom: 0.4em; @@ -86,7 +92,6 @@ $sub-schema-offset: ($bullet-size / 2) + $bullet-margin; } .param-type-trivial { - margin: 10px 10px 0; display: inline-block; } diff --git a/lib/components/JsonSchema/json-schema.html b/lib/components/JsonSchema/json-schema.html index fb532383..fb188fee 100644 --- a/lib/components/JsonSchema/json-schema.html +++ b/lib/components/JsonSchema/json-schema.html @@ -21,7 +21,17 @@ {{enumItem.val | json}} - +
+ +
+