Revert "fix: remove unused hide-hostname option"

This reverts commit 7031176330.
This commit is contained in:
Roman Hotsiy 2017-02-26 01:54:12 +02:00
parent 0323551ca1
commit fa9b634126
No known key found for this signature in database
GPG Key ID: 5CB7B3ACABA57CB0
4 changed files with 16 additions and 4 deletions

View File

@ -136,6 +136,7 @@ ReDoc makes use of the following [vendor extensions](http://swagger.io/specifica
* **function**: A getter function. Must return a number representing the offset (in pixels);
* `suppress-warnings` - if set, warnings are not rendered at the top of documentation (they still are logged to the console).
* `lazy-rendering` - if set, enables lazy rendering mode in ReDoc. This mode is useful for APIs with big number of operations (e.g. > 50). In this mode ReDoc shows initial screen ASAP and then renders the rest operations asynchronously while showing progress bar on the top. Check out the [demo](\\rebilly.github.io/ReDoc) for the example.
* `hide-hostname` - if set, the protocol and hostname is not shown in the method definition.
* `expand-responses` - specify which responses to expand by default by response codes. Values should be passed as comma-separated list without spaces e.g. `expand-responses="200,201"`. Special value `"all"` expands all responses by default. Be careful: this option can slow-down documentation rendering time.
## Advanced usage

View File

@ -11,6 +11,7 @@ import { getChildDebugElement } from '../../../tests/helpers';
import { EndpointLink } from './endpoint-link';
import { SpecManager } from '../../utils/spec-manager';
import { OptionsService } from '../../services/';
describe('Redoc components', () => {
beforeEach(() => {
@ -20,9 +21,11 @@ describe('Redoc components', () => {
let builder;
let component: EndpointLink;
let specMgr: SpecManager;
let opts: OptionsService;
beforeEach(async(inject([SpecManager], (_specMgr) => {
beforeEach(async(inject([SpecManager, OptionsService], (_specMgr, _opts) => {
specMgr = _specMgr;
opts = _opts;
})));
beforeEach(() => {
@ -44,7 +47,7 @@ describe('Redoc components', () => {
};
specMgr.init();
component = new EndpointLink(specMgr);
component = new EndpointLink(specMgr, opts);
});
it('should replace // with appropriate protocol', () => {

View File

@ -2,6 +2,7 @@
import { Component, ChangeDetectionStrategy, Input, OnInit, HostListener, HostBinding} from '@angular/core';
import { BaseComponent, SpecManager } from '../base';
import { trigger, state, animate, transition, style } from '@angular/core';
import { OptionsService } from '../../services/';
export interface ServerInfo {
description: string;
@ -38,7 +39,7 @@ export class EndpointLink implements OnInit {
this.expanded = !this.expanded;
}
constructor(public specMgr:SpecManager) {
constructor(public specMgr:SpecManager, public optionsService: OptionsService) {
this.expanded = false;
}
@ -60,7 +61,11 @@ export class EndpointLink implements OnInit {
}
getBaseUrl():string {
return this.specMgr.apiUrl;
if (this.optionsService.options.hideHostname) {
return '';
} else {
return this.specMgr.apiUrl;
}
}
ngOnInit() {

View File

@ -13,6 +13,7 @@ const OPTION_NAMES = new Set([
'disableLazySchemas',
'specUrl',
'suppressWarnings',
'hideHostname',
'lazyRendering',
'expandResponses'
]);
@ -22,6 +23,7 @@ interface Options {
disableLazySchemas?: boolean;
specUrl?: string;
suppressWarnings?: boolean;
hideHostname?: boolean;
lazyRendering?: boolean;
expandResponses?: Set<string> | 'all';
$scrollParent?: HTMLElement | Window;
@ -87,6 +89,7 @@ export class OptionsService {
if (isString(this._options.disableLazySchemas)) this._options.disableLazySchemas = true;
if (isString(this._options.suppressWarnings)) this._options.suppressWarnings = true;
if (isString(this._options.hideHostname)) this._options.hideHostname = true;
if (isString(this._options.lazyRendering)) this._options.lazyRendering = true;
if (isString(this._options.expandResponses)) {
let str = this._options.expandResponses as string;