1686

pending completion

Build # 1686

Build Type

Pull #1329

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/Redocly/redoc/commit/<a class=hub.com/Redocly/redoc/commit/<a class="double-link" href="https://git"><a class=hub.com/Redocly/redoc/commit/<a class="double-link" href="https://git"><a class=hub.com/Redocly/redoc/commit/<a class="double-link" href="https://git"><a class=hub.com/Redocly/redoc/commit/d00aa3a6340e0509d69412a6f625f702a6d6a34f">d00aa3a63">&lt;a href=&quot;https://github.com/Redocly/redoc/commit/</a><a class="double-link" href="https://github.com/Redocly/redoc/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Redocly/redoc/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Redocly/redoc/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Redocly/redoc/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Redocly/redoc/commit/d00aa3a6340e0509d69412a6f625f702a6d6a34f">d00aa3a63</a><a href="https://github.com/Redocly/redoc/commit/d00aa3a6340e0509d69412a6f625f702a6d6a34f">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/Redocly/redoc/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/Redocly/redoc/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/Redocly/redoc/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/Redocly/redoc/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/Redocly/redoc/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/Redocly/redoc/commit/d00aa3a6340e0509d69412a6f625f702a6d6a34f&quot;&gt;d00aa3a63&lt;/a&gt;&lt;a href=&quot;https://github.com/Redocly/redoc/commit/d00aa3a6340e0509d69412a6f625f702a6d6a34f&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/Redocly/redoc/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/Redocly/redoc/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;htt... (continued)

Pull Request Pull Request #1329: Add theme support to additional elements

Run Details

1542 of 2260 branches covered (68.23%)

Branch coverage included in aggregate %.

24 of 24 new or added lines in 10 files covered. (100.0%)

3157 of 3894 relevant lines covered (81.07%)

123.26 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.0

/src/services/models/Operation.ts

import { action, observable } from 'mobx';

import { IMenuItem } from '../MenuStore';
import { GroupModel } from './Group.model';
import { SecurityRequirementModel } from './SecurityRequirement';

import { OpenAPIExternalDocumentation, OpenAPIServer, OpenAPIXCodeSample } from '../../types';

import {
  extractExtensions,
  getOperationSummary,
  getStatusCodeType,
  isStatusCode,
  memoize,
  mergeParams,
  normalizeServers,
  sortByField,
  sortByRequired,
} from '../../utils';
import { ContentItemModel, ExtendedOpenAPIOperation } from '../MenuBuilder';
import { OpenAPIParser } from '../OpenAPIParser';
import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
import { CallbackModel } from './Callback';
import { FieldModel } from './Field';
import { MediaContentModel } from './MediaContent';
import { RequestBodyModel } from './RequestBody';
import { ResponseModel } from './Response';

export interface XPayloadSample {
  lang: 'payload';
  label: string;
  requestBodyContent: MediaContentModel;
  source: string;
}

export function isPayloadSample(
  sample: XPayloadSample | OpenAPIXCodeSample,
): sample is XPayloadSample {
  return sample.lang === 'payload' && (sample as any).requestBodyContent;
}

let isCodeSamplesWarningPrinted = false;

/**
 * Operation model ready to be used by components
 */
export class OperationModel implements IMenuItem {
  //#region IMenuItem fields
  id: string;
  absoluteIdx?: number;
  name: string;
  description?: string;
  type = 'operation' as const;

  parent?: GroupModel;
  externalDocs?: OpenAPIExternalDocumentation;
  items: ContentItemModel[] = [];

  depth: number;

  @observable
  ready?: boolean = true;
  @observable
  active: boolean = false;
  @observable
  expanded: boolean = false;
  //#endregion

  pointer: string;
  operationId?: string;
  httpVerb: string;
  deprecated: boolean;
  path: string;
  servers: OpenAPIServer[];
  security: SecurityRequirementModel[];
  extensions: Record<string, any>;
  isCallback: boolean;

  constructor(
    private parser: OpenAPIParser,
    private operationSpec: ExtendedOpenAPIOperation,
    parent: GroupModel | undefined,
    private options: RedocNormalizedOptions,
    isCallback: boolean = false,
  ) {
    this.pointer = operationSpec.pointer;

    this.description = operationSpec.description;
    this.parent = parent;
    this.externalDocs = operationSpec.externalDocs;

    this.deprecated = !!operationSpec.deprecated;
    this.httpVerb = operationSpec.httpVerb;
    this.deprecated = !!operationSpec.deprecated;
    this.operationId = operationSpec.operationId;
    this.path = operationSpec.pathName;
    this.isCallback = isCallback;

    this.name = getOperationSummary(operationSpec);

    if (this.isCallback) {
      // NOTE: Callbacks by default should not inherit the specification's global `security` definition.
      // Can be defined individually per-callback in the specification. Defaults to none.
      this.security = (operationSpec.security || []).map(
        security => new SecurityRequirementModel(security, parser),
      );

      // TODO: update getting pathInfo for overriding servers on path level
      this.servers = normalizeServers('', operationSpec.servers || operationSpec.pathServers || []);
    } else {
      this.id =
        operationSpec.operationId !== undefined
          ? 'operation/' + operationSpec.operationId
          : parent !== undefined
          ? parent.id + this.pointer
          : this.pointer;

      this.security = (operationSpec.security || parser.spec.security || []).map(
        security => new SecurityRequirementModel(security, parser),
      );

      this.servers = normalizeServers(
        parser.specUrl,
        operationSpec.servers || operationSpec.pathServers || parser.spec.servers || [],
      );
    }

    if (options.showExtensions) {
      this.extensions = extractExtensions(operationSpec, options.showExtensions);
    }
  }

  /**
   * set operation as active (used by side menu)
   */
  @action
  activate() {
    this.active = true;
  }

  /**
   * set operation as inactive (used by side menu)
   */
  @action
  deactivate() {
    this.active = false;
  }

  /**
   * Toggle expansion in middle panel (for callbacks, which are operations)
   */
  @action
  toggle() {
    this.expanded = !this.expanded;
  }

  expand() {
    if (this.parent) {
      this.parent.expand();
    }
  }

  collapse() {
    /* do nothing */
  }

  @memoize
  get requestBody() {
    return (
      this.operationSpec.requestBody &&
      new RequestBodyModel(this.parser, this.operationSpec.requestBody, this.options)
    );
  }

  @memoize
  get codeSamples() {
    let samples: Array<OpenAPIXCodeSample | XPayloadSample> =
      this.operationSpec['x-codeSamples'] || this.operationSpec['x-code-samples'] || [];

    if (this.operationSpec['x-code-samples'] && !isCodeSamplesWarningPrinted) {
      isCodeSamplesWarningPrinted = true;
      console.warn('"x-code-samples" is deprecated. Use "x-codeSamples" instead');
    }

    const requestBodyContent = this.requestBody && this.requestBody.content;
    if (requestBodyContent && requestBodyContent.hasSample) {
      const insertInx = Math.min(samples.length, this.options.payloadSampleIdx);

      samples = [
        ...samples.slice(0, insertInx),
        {
          lang: 'payload',
          label: 'Payload',
          source: '',
          requestBodyContent,
        },
        ...samples.slice(insertInx),
      ];
    }

    return samples;
  }

  @memoize
  get parameters() {
    const _parameters = mergeParams(
      this.parser,
      this.operationSpec.pathParameters,
      this.operationSpec.parameters,
      // TODO: fix pointer
    ).map(paramOrRef => new FieldModel(this.parser, paramOrRef, this.pointer, this.options));

    if (this.options.sortPropsAlphabetically) {
      return sortByField(_parameters, 'name');
    }
    if (this.options.requiredPropsFirst) {
      return sortByRequired(_parameters);
    }

    return _parameters;
  }

  @memoize
  get responses() {
    let hasSuccessResponses = false;
    return Object.keys(this.operationSpec.responses || [])
      .filter(code => {
        if (code === 'default') {
          return true;
        }

        if (getStatusCodeType(code) === 'success') {
          hasSuccessResponses = true;
        }

        return isStatusCode(code);
      }) // filter out other props (e.g. x-props)
      .map(code => {
        return new ResponseModel(
          this.parser,
          code,
          hasSuccessResponses,
          this.operationSpec.responses[code],
          this.options,
        );
      });
  }

  @memoize
  get callbacks() {
    return Object.keys(this.operationSpec.callbacks || []).map(callbackEventName => {
      return new CallbackModel(
        this.parser,
        callbackEventName,
        this.operationSpec.callbacks![callbackEventName],
        this.pointer,
        this.options,
      );
    });
  }
}

1	import { action, observable } from 'mobx';	8✔
2
3	import { IMenuItem } from '../MenuStore';
4	import { GroupModel } from './Group.model';
5	import { SecurityRequirementModel } from './SecurityRequirement';	8✔
6
7	import { OpenAPIExternalDocumentation, OpenAPIServer, OpenAPIXCodeSample } from '../../types';
8
9	import {	8✔
10	extractExtensions,
11	getOperationSummary,
12	getStatusCodeType,
13	isStatusCode,
14	memoize,
15	mergeParams,
16	normalizeServers,
17	sortByField,
18	sortByRequired,
19	} from '../../utils';
20	import { ContentItemModel, ExtendedOpenAPIOperation } from '../MenuBuilder';
21	import { OpenAPIParser } from '../OpenAPIParser';
22	import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
23	import { CallbackModel } from './Callback';	8✔
24	import { FieldModel } from './Field';	8✔
25	import { MediaContentModel } from './MediaContent';
26	import { RequestBodyModel } from './RequestBody';	8✔
27	import { ResponseModel } from './Response';	8✔
28
29	export interface XPayloadSample {
30	lang: 'payload';
31	label: string;
32	requestBodyContent: MediaContentModel;
33	source: string;
34	}
35
36	export function isPayloadSample(	8✔
37	sample: XPayloadSample \| OpenAPIXCodeSample,
38	): sample is XPayloadSample {
39	return sample.lang === 'payload' && (sample as any).requestBodyContent;	24✔
40	}
41
42	let isCodeSamplesWarningPrinted = false;	8✔
43
44	/**
45	* Operation model ready to be used by components
46	*/
47	export class OperationModel implements IMenuItem {	8✔
48	//#region IMenuItem fields
49	id: string;
50	absoluteIdx?: number;
51	name: string;
52	description?: string;
53	type = 'operation' as const;	52✔
54
55	parent?: GroupModel;
56	externalDocs?: OpenAPIExternalDocumentation;
57	items: ContentItemModel[] = [];	52✔
58
59	depth: number;
60
61	@observable
62	ready?: boolean = true;	52✔
63	@observable
64	active: boolean = false;	52✔
65	@observable
66	expanded: boolean = false;	52✔
67	//#endregion
68
69	pointer: string;
70	operationId?: string;
71	httpVerb: string;
72	deprecated: boolean;
73	path: string;
74	servers: OpenAPIServer[];
75	security: SecurityRequirementModel[];
76	extensions: Record<string, any>;
77	isCallback: boolean;
78
79	constructor(
80	private parser: OpenAPIParser,	52✔
81	private operationSpec: ExtendedOpenAPIOperation,	52✔
82	parent: GroupModel \| undefined,
83	private options: RedocNormalizedOptions,	52✔
84	isCallback: boolean = false,	94✔
85	) {
86	this.pointer = operationSpec.pointer;	52✔
87
88	this.description = operationSpec.description;	52✔
89	this.parent = parent;	52✔
90	this.externalDocs = operationSpec.externalDocs;	52✔
91
92	this.deprecated = !!operationSpec.deprecated;	52✔
93	this.httpVerb = operationSpec.httpVerb;	52✔
94	this.deprecated = !!operationSpec.deprecated;	52✔
95	this.operationId = operationSpec.operationId;	52✔
96	this.path = operationSpec.pathName;	52✔
97	this.isCallback = isCallback;	52✔
98
99	this.name = getOperationSummary(operationSpec);	52✔
100
101	if (this.isCallback) {	52✔
102	// NOTE: Callbacks by default should not inherit the specification's global `security` definition.
103	// Can be defined individually per-callback in the specification. Defaults to none.
104	this.security = (operationSpec.security \|\| []).map(	10✔
105	security => new SecurityRequirementModel(security, parser),	×
106	);
107
108	// TODO: update getting pathInfo for overriding servers on path level
109	this.servers = normalizeServers('', operationSpec.servers \|\| operationSpec.pathServers \|\| []);	10✔
110	} else {
111	this.id =	42✔
112	operationSpec.operationId !== undefined
113	? 'operation/' + operationSpec.operationId	42✔
114	: parent !== undefined
115	? parent.id + this.pointer	2!
116	: this.pointer;
117
118	this.security = (operationSpec.security \|\| parser.spec.security \|\| []).map(	42✔
119	security => new SecurityRequirementModel(security, parser),	18✔
120	);
121
122	this.servers = normalizeServers(	42✔
123	parser.specUrl,
124	operationSpec.servers \|\| operationSpec.pathServers \|\| parser.spec.servers \|\| [],	126!
125	);
126	}
127
128	if (options.showExtensions) {	52!
129	this.extensions = extractExtensions(operationSpec, options.showExtensions);	×
130	}
131	}
132
133	/**
134	* set operation as active (used by side menu)
135	*/
136	@action
137	activate() {	16✔
138	this.active = true;	×
139	}
140
141	/**
142	* set operation as inactive (used by side menu)
143	*/
144	@action
145	deactivate() {	16✔
146	this.active = false;	×
147	}
148
149	/**
150	* Toggle expansion in middle panel (for callbacks, which are operations)
151	*/
152	@action
153	toggle() {	16✔
154	this.expanded = !this.expanded;	×
155	}
156
157	expand() {	8✔
158	if (this.parent) {	×
159	this.parent.expand();	×
160	}
161	}
162
163	collapse() {	8✔
164	/* do nothing */
165	}
166
167	@memoize
168	get requestBody() {	16✔
169	return (	44✔
170	this.operationSpec.requestBody &&	66✔
171	new RequestBodyModel(this.parser, this.operationSpec.requestBody, this.options)
172	);
173	}
174
175	@memoize
176	get codeSamples() {	16✔
177	let samples: Array<OpenAPIXCodeSample \| XPayloadSample> =
178	this.operationSpec['x-codeSamples'] \|\| this.operationSpec['x-code-samples'] \|\| [];	44✔
179
180	if (this.operationSpec['x-code-samples'] && !isCodeSamplesWarningPrinted) {	44!
181	isCodeSamplesWarningPrinted = true;	×
182	console.warn('"x-code-samples" is deprecated. Use "x-codeSamples" instead');	×
183	}
184
185	const requestBodyContent = this.requestBody && this.requestBody.content;	44✔
186	if (requestBodyContent && requestBodyContent.hasSample) {	44✔
187	const insertInx = Math.min(samples.length, this.options.payloadSampleIdx);	18✔
188
189	samples = [	18✔
190	...samples.slice(0, insertInx),
191	{
192	lang: 'payload',
193	label: 'Payload',
194	source: '',
195	requestBodyContent,
196	},
197	...samples.slice(insertInx),
198	];
199	}
200
201	return samples;	44✔
202	}
203
204	@memoize	42✔
205	get parameters() {	16✔
206	const _parameters = mergeParams(	42✔
207	this.parser,
208	this.operationSpec.pathParameters,
209	this.operationSpec.parameters,
210	// TODO: fix pointer
211	).map(paramOrRef => new FieldModel(this.parser, paramOrRef, this.pointer, this.options));	36✔
212
213	if (this.options.sortPropsAlphabetically) {	42!
214	return sortByField(_parameters, 'name');	×
215	}
216	if (this.options.requiredPropsFirst) {	42!
217	return sortByRequired(_parameters);	×
218	}
219
220	return _parameters;	42✔
221	}
222
223	@memoize	42✔
224	get responses() {	16✔
225	let hasSuccessResponses = false;	42✔
226	return Object.keys(this.operationSpec.responses \|\| [])	42!
227	.filter(code => {
228	if (code === 'default') {	72✔
229	return true;	8✔
230	}
231
232	if (getStatusCodeType(code) === 'success') {	64✔
233	hasSuccessResponses = true;	20✔
234	}
235
236	return isStatusCode(code);	64✔
237	}) // filter out other props (e.g. x-props)
238	.map(code => {
239	return new ResponseModel(	72✔
240	this.parser,
241	code,
242	hasSuccessResponses,
243	this.operationSpec.responses[code],
244	this.options,
245	);
246	});
247	}
248
249	@memoize	42✔
250	get callbacks() {	16✔
251	return Object.keys(this.operationSpec.callbacks \|\| []).map(callbackEventName => {	42✔
252	return new CallbackModel(	6✔
253	this.parser,
254	callbackEventName,
255	this.operationSpec.callbacks![callbackEventName],
256	this.pointer,
257	this.options,
258	);
259	});
260	}
261	}	8✔

Redocly / redoc / 1686

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous