1978

pending completion

Build # 1978

Build Type

Pull #1533

travis-ci-com

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/4740445342b0947cf96c067ab81c2384d57049fe">474044534">&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/4740445342b0947cf96c067ab81c2384d57049fe">474044534</a><a href="https://github.com/Redocly/redoc/commit/4740445342b0947cf96c067ab81c2384d57049fe">&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/4740445342b0947cf96c067ab81c2384d57049fe&quot;&gt;474044534&lt;/a&gt;&lt;a href=&quot;https://github.com/Redocly/redoc/commit/4740445342b0947cf96c067ab81c2384d57049fe&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 #1533: disableDefaultSample option

Run Details

1611 of 2381 branches covered (67.66%)

Branch coverage included in aggregate %.

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

3245 of 4029 relevant lines covered (80.54%)

128.66 hits per line

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

72.86

/src/services/models/MediaType.ts

import * as Sampler from 'openapi-sampler';

import { OpenAPIMediaType } from '../../types';
import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
import { SchemaModel } from './Schema';

import { isJsonLike, mapValues } from '../../utils';
import { OpenAPIParser } from '../OpenAPIParser';
import { ExampleModel } from './Example';

export class MediaTypeModel {
  examples?: { [name: string]: ExampleModel };
  schema?: SchemaModel;
  name: string;
  isRequestType: boolean;
  onlyRequiredInSamples: boolean;

  /**
   * @param isRequestType needed to know if skipe RO/RW fields in objects
   */
  constructor(
    parser: OpenAPIParser,
    name: string,
    isRequestType: boolean,
    info: OpenAPIMediaType,
    options: RedocNormalizedOptions,
  ) {
    this.name = name;
    this.isRequestType = isRequestType;
    this.schema = info.schema && new SchemaModel(parser, info.schema, '', options);
    this.onlyRequiredInSamples = options.onlyRequiredInSamples;
    if (info.examples !== undefined) {
      this.examples = mapValues(
        info.examples,
        example => new ExampleModel(parser, example, name, info.encoding),
      );
    } else if (info.example !== undefined) {
      this.examples = {
        default: new ExampleModel(
          parser,
          { value: parser.shalowDeref(info.example) },
          name,
          info.encoding,
        ),
      };
    } else if (isJsonLike(name)) {
      this.generateExample(parser, info, options.disableDefaultSample);
    }
  }

  generateExample(parser: OpenAPIParser, info: OpenAPIMediaType, disableDefaultSample: boolean) {
    const samplerOptions = {
      skipReadOnly: this.isRequestType,
      skipNonRequired: this.isRequestType && this.onlyRequiredInSamples,
      skipWriteOnly: !this.isRequestType,
      maxSampleDepth: 10,
    };
    if (this.schema && this.schema.oneOf) {
      this.examples = {};
      for (const subSchema of this.schema.oneOf) {
        const sample = Sampler.sample(subSchema.rawSchema, samplerOptions, parser.spec);

        if (this.schema.discriminatorProp && typeof sample === 'object' && sample) {
          sample[this.schema.discriminatorProp] = subSchema.title;
        }

        this.examples[subSchema.title] = new ExampleModel(
          parser,
          {
            value: sample,
          },
          this.name,
          info.encoding,
        );
      }
    } else if (this.schema) {
      const sampledData = Sampler.sample(info.schema, samplerOptions, parser.spec);

      if (disableDefaultSample && info.schema) {
        const properties = parser.deref(info.schema)?.properties  || {};
        Object.keys(properties).map((propName) => {
          const property = properties[propName];
          if (!property.example && sampledData[propName] !== undefined) {
            delete sampledData[propName];
          }
        });
      }

      this.examples = {
        default: new ExampleModel(
          parser,
          { value: sampledData },
          this.name,
          info.encoding,
        ),
      };
    }
  }
}

1	import * as Sampler from 'openapi-sampler';	9✔
2
3	import { OpenAPIMediaType } from '../../types';
4	import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
5	import { SchemaModel } from './Schema';	9✔
6
7	import { isJsonLike, mapValues } from '../../utils';	9✔
8	import { OpenAPIParser } from '../OpenAPIParser';
9	import { ExampleModel } from './Example';	9✔
10
11	export class MediaTypeModel {	9✔
12	examples?: { [name: string]: ExampleModel };
13	schema?: SchemaModel;
14	name: string;
15	isRequestType: boolean;
16	onlyRequiredInSamples: boolean;
17
18	/**
19	* @param isRequestType needed to know if skipe RO/RW fields in objects
20	*/
21	constructor(
22	parser: OpenAPIParser,
23	name: string,
24	isRequestType: boolean,
25	info: OpenAPIMediaType,
26	options: RedocNormalizedOptions,
27	) {
28	this.name = name;	72✔
29	this.isRequestType = isRequestType;	72✔
30	this.schema = info.schema && new SchemaModel(parser, info.schema, '', options);	72✔
31	this.onlyRequiredInSamples = options.onlyRequiredInSamples;	72✔
32	if (info.examples !== undefined) {	72✔
33	this.examples = mapValues(	8✔
34	info.examples,
35	example => new ExampleModel(parser, example, name, info.encoding),	8✔
36	);
37	} else if (info.example !== undefined) {	64✔
38	this.examples = {	4✔
39	default: new ExampleModel(
40	parser,
41	{ value: parser.shalowDeref(info.example) },
42	name,
43	info.encoding,
44	),
45	};
46	} else if (isJsonLike(name)) {	60✔
47	this.generateExample(parser, info, options.disableDefaultSample);	40✔
48	}
49	}
50
51	generateExample(parser: OpenAPIParser, info: OpenAPIMediaType, disableDefaultSample: boolean) {	9✔
52	const samplerOptions = {	40✔
53	skipReadOnly: this.isRequestType,
54	skipNonRequired: this.isRequestType && this.onlyRequiredInSamples,	60✔
55	skipWriteOnly: !this.isRequestType,
56	maxSampleDepth: 10,
57	};
58	if (this.schema && this.schema.oneOf) {	40✔
59	this.examples = {};	10✔
60	for (const subSchema of this.schema.oneOf) {	30✔
61	const sample = Sampler.sample(subSchema.rawSchema, samplerOptions, parser.spec);	30✔
62
63	if (this.schema.discriminatorProp && typeof sample === 'object' && sample) {	30!
64	sample[this.schema.discriminatorProp] = subSchema.title;	30✔
65	}
66
67	this.examples[subSchema.title] = new ExampleModel(	30✔
68	parser,
69	{
70	value: sample,
71	},
72	this.name,
73	info.encoding,
74	);
75	}
76	} else if (this.schema) {	30!
77	const sampledData = Sampler.sample(info.schema, samplerOptions, parser.spec);	30✔
78
79	if (disableDefaultSample && info.schema) {	30!
80	const properties = parser.deref(info.schema)?.properties \|\| {};	×
81	Object.keys(properties).map((propName) => {	×
82	const property = properties[propName];	×
83	if (!property.example && sampledData[propName] !== undefined) {	×
84	delete sampledData[propName];	×
85	}
86	});
87	}
88
89	this.examples = {	30✔
90	default: new ExampleModel(
91	parser,
92	{ value: sampledData },
93	this.name,
94	info.encoding,
95	),
96	};
97	}
98	}
99	}	9✔

Redocly / redoc / 1978

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