-
{isCallback ? 'Callback responses' : 'Responses'}
+
{isCallback ? l('callbackResponses') : l('responses')}
{responses.map(response => {
return
;
})}
diff --git a/src/components/Schema/ArraySchema.tsx b/src/components/Schema/ArraySchema.tsx
index 48e7dc41..eab37595 100644
--- a/src/components/Schema/ArraySchema.tsx
+++ b/src/components/Schema/ArraySchema.tsx
@@ -4,7 +4,8 @@ import { Schema, SchemaProps } from './Schema';
import { ArrayClosingLabel, ArrayOpenningLabel } from '../../common-elements';
import styled from '../../styled-components';
-import {humanizeConstraints} from "../../utils";
+import { humanizeConstraints } from '../../utils';
+import { TypeName } from '../../common-elements/fields';
const PaddedSchema = styled.div`
padding-left: ${({ theme }) => theme.spacing.unit * 2}px;
@@ -13,12 +14,20 @@ const PaddedSchema = styled.div`
export class ArraySchema extends React.PureComponent
{
render() {
const itemsSchema = this.props.schema.items!;
+ const schema = this.props.schema;
+
const itemConstraintSchema = (
min: number | undefined = undefined,
max: number | undefined = undefined,
) => ({ type: 'array', minItems: min, maxItems: max });
- const minMaxItems = humanizeConstraints(itemConstraintSchema(itemsSchema.schema.minItems, itemsSchema.schema.maxItems));
+ const minMaxItems = humanizeConstraints(itemConstraintSchema(itemsSchema?.schema?.minItems, itemsSchema?.schema?.maxItems));
+
+ if (schema.displayType && !itemsSchema && !minMaxItems.length) {
+ return (
+ {schema.displayType}
+
);
+ }
return (
diff --git a/src/components/Schema/Schema.tsx b/src/components/Schema/Schema.tsx
index 8948e2b4..392a0f23 100644
--- a/src/components/Schema/Schema.tsx
+++ b/src/components/Schema/Schema.tsx
@@ -63,20 +63,15 @@ export class Schema extends React.Component
> {
return ;
}
- if (type && Array.isArray(type)) {
+ const types = Array.isArray(type) ? type : [type];
+ if (types.includes('object')) {
+ if (schema.fields?.length) {
+ return ;
+ }
+ } else if (types.includes('array')) {
return ;
}
- switch (type) {
- case 'object':
- if (schema.fields?.length) {
- return ;
- }
- break;
- case 'array':
- return ;
- }
-
// TODO: maybe adjust FieldDetails to accept schema
const field = ({
schema,
diff --git a/src/components/SecurityRequirement/SecurityRequirement.tsx b/src/components/SecurityRequirement/SecurityRequirement.tsx
index 3a52ad81..91bf9f43 100644
--- a/src/components/SecurityRequirement/SecurityRequirement.tsx
+++ b/src/components/SecurityRequirement/SecurityRequirement.tsx
@@ -8,8 +8,8 @@ import { SecurityRequirementModel } from '../../services/models/SecurityRequirem
import { linksCss } from '../Markdown/styled.elements';
const ScopeName = styled.code`
- font-size: ${props => props.theme.typography.code.fontSize};
- font-family: ${props => props.theme.typography.code.fontFamily};
+ font-size: ${(props) => props.theme.typography.code.fontSize};
+ font-family: ${(props) => props.theme.typography.code.fontFamily};
border: 1px solid ${({ theme }) => theme.colors.border.dark};
margin: 0 3px;
padding: 0.2em;
@@ -67,18 +67,22 @@ export class SecurityRequirement extends React.PureComponent
- {security.schemes.map(scheme => {
- return (
-
- {scheme.id}
- {scheme.scopes.length > 0 && ' ('}
- {scheme.scopes.map(scope => (
- {scope}
- ))}
- {scheme.scopes.length > 0 && ') '}
-
- );
- })}
+ {security.schemes.length ? (
+ security.schemes.map((scheme) => {
+ return (
+
+ {scheme.id}
+ {scheme.scopes.length > 0 && ' ('}
+ {scheme.scopes.map((scope) => (
+ {scope}
+ ))}
+ {scheme.scopes.length > 0 && ') '}
+
+ );
+ })
+ ) : (
+ None
+ )}
);
}
@@ -89,7 +93,7 @@ const AuthHeaderColumn = styled.div`
`;
const SecuritiesColumn = styled.div`
- width: ${props => props.theme.schema.defaultDetailsWidth};
+ width: ${(props) => props.theme.schema.defaultDetailsWidth};
${media.lessThan('small')`
margin-top: 10px;
`}
diff --git a/src/components/StoreBuilder.ts b/src/components/StoreBuilder.ts
index 1981e2e6..527d3700 100644
--- a/src/components/StoreBuilder.ts
+++ b/src/components/StoreBuilder.ts
@@ -58,6 +58,12 @@ export function StoreBuilder(props: StoreBuilderProps) {
}
}, [resolvedSpec, specUrl, options]);
+ React.useEffect(() => {
+ if (store && onLoaded) {
+ onLoaded();
+ }
+ }, [store, onLoaded])
+
return children({
loading: !store,
store,
diff --git a/src/components/__tests__/SecurityRequirement.test.tsx b/src/components/__tests__/SecurityRequirement.test.tsx
new file mode 100644
index 00000000..723c0505
--- /dev/null
+++ b/src/components/__tests__/SecurityRequirement.test.tsx
@@ -0,0 +1,27 @@
+import * as React from 'react';
+import { shallow } from 'enzyme';
+
+import { OpenAPIParser } from '../../services';
+import { SecurityRequirementModel } from '../../services/models/SecurityRequirement';
+import { SecurityRequirement } from '../SecurityRequirement/SecurityRequirement';
+import { RedocNormalizedOptions } from '../../services/RedocNormalizedOptions';
+
+const options = new RedocNormalizedOptions({});
+describe('Components', () => {
+ describe('SecurityRequirement', () => {
+ describe('SecurityRequirement', () => {
+ it('should render \'None\' when empty object in security open api', () => {
+ const parser = new OpenAPIParser({ openapi: '3.0', info: { title: 'test', version: '0' }, paths: {} },
+ undefined,
+ options,
+ );
+ const securityRequirement = new SecurityRequirementModel({}, parser);
+ const securityElement = shallow(
+
+ ).getElement();
+ expect(securityElement.props.children.type.target).toEqual('span');
+ expect(securityElement.props.children.props.children).toEqual('None');
+ });
+ });
+ });
+});
diff --git a/src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap b/src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap
index f293088f..fe5617ed 100644
--- a/src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap
+++ b/src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap
@@ -20,6 +20,8 @@ exports[`Components SchemaView discriminator should correctly render discriminat
"activeOneOf": 0,
"const": "",
"constraints": Array [],
+ "contentEncoding": undefined,
+ "contentMediaType": undefined,
"default": undefined,
"deprecated": false,
"description": "",
@@ -71,6 +73,8 @@ exports[`Components SchemaView discriminator should correctly render discriminat
"activeOneOf": 0,
"const": "",
"constraints": Array [],
+ "contentEncoding": undefined,
+ "contentMediaType": undefined,
"default": undefined,
"deprecated": false,
"description": "",
diff --git a/src/services/Labels.ts b/src/services/Labels.ts
index 8e89bc2f..71b83e58 100644
--- a/src/services/Labels.ts
+++ b/src/services/Labels.ts
@@ -10,6 +10,12 @@ export interface LabelsConfig {
arrayOf: string;
webhook: string;
const: string;
+ download: string;
+ downloadSpecification: string;
+ responses: string;
+ callbackResponses: string;
+ requestSamples: string;
+ responseSamples: string;
}
export type LabelsConfigRaw = Partial;
@@ -26,6 +32,12 @@ const labels: LabelsConfig = {
arrayOf: 'Array of ',
webhook: 'Event',
const: 'Value',
+ download: 'Download',
+ downloadSpecification: 'Download OpenAPI specification',
+ responses: 'Responses',
+ callbackResponses: 'Callback responses',
+ requestSamples: 'Request samples',
+ responseSamples: 'Response samples',
};
export function setRedocLabels(_labels?: LabelsConfigRaw) {
diff --git a/src/services/RedocNormalizedOptions.ts b/src/services/RedocNormalizedOptions.ts
index 1cd3d38d..be1df279 100644
--- a/src/services/RedocNormalizedOptions.ts
+++ b/src/services/RedocNormalizedOptions.ts
@@ -45,12 +45,12 @@ export interface RedocRawOptions {
generatedPayloadSamplesMaxDepth?: number;
}
-function argValueToBoolean(val?: string | boolean, defaultValue?: boolean): boolean {
+export function argValueToBoolean(val?: string | boolean, defaultValue?: boolean): boolean {
if (val === undefined) {
return defaultValue || false;
}
if (typeof val === 'string') {
- return val === 'false' ? false : true;
+ return val !== 'false';
}
return val;
}
diff --git a/src/services/__tests__/models/RequestBody.test.ts b/src/services/__tests__/models/RequestBody.test.ts
new file mode 100644
index 00000000..554a1222
--- /dev/null
+++ b/src/services/__tests__/models/RequestBody.test.ts
@@ -0,0 +1,27 @@
+import { RequestBodyModel } from '../../models/RequestBody';
+import { OpenAPIParser } from '../../OpenAPIParser';
+import { RedocNormalizedOptions } from '../../RedocNormalizedOptions';
+
+const opts = new RedocNormalizedOptions({});
+describe('Models', () => {
+ describe('RequestBodyModel', () => {
+ let parser, props;
+
+ beforeEach(() => {
+ parser = new OpenAPIParser({ openapi: '3.0.0' } as any, undefined, opts);
+ props = {
+ parser,
+ infoOrRef: {},
+ options: opts,
+ isEvent: false,
+ };
+ });
+
+ test('should work with default props', () => {
+ const consoleError = jest.spyOn(global.console, 'error');
+ const req = new RequestBodyModel(props);
+ expect(consoleError).not.toHaveBeenCalled();
+ expect(req).toEqual({ description: '', required: false });
+ });
+ });
+});
diff --git a/src/services/__tests__/models/Response.test.ts b/src/services/__tests__/models/Response.test.ts
index 3fb220f2..ae3c1fd1 100644
--- a/src/services/__tests__/models/Response.test.ts
+++ b/src/services/__tests__/models/Response.test.ts
@@ -5,30 +5,38 @@ import { RedocNormalizedOptions } from '../../RedocNormalizedOptions';
const opts = new RedocNormalizedOptions({});
describe('Models', () => {
describe('ResponseModel', () => {
- let parser;
+ let parser, props;
beforeEach(() => {
parser = new OpenAPIParser({ openapi: '3.0.0' } as any, undefined, opts);
+ props = {
+ parser,
+ defaultAsError: false,
+ infoOrRef: {},
+ options: opts,
+ isEvent: false,
+ code: 'default',
+ };
});
test('should calculate response type based on code', () => {
- let resp = new ResponseModel(parser, '200', false, {}, opts);
+ let resp = new ResponseModel({...props, code: '200' });
expect(resp.type).toEqual('success');
- resp = new ResponseModel(parser, '120', false, {}, opts);
+ resp = new ResponseModel({...props, code: '120' });
expect(resp.type).toEqual('info');
- resp = new ResponseModel(parser, '301', false, {}, opts);
+ resp = new ResponseModel({...props, code: '301' });
expect(resp.type).toEqual('redirect');
- resp = new ResponseModel(parser, '400', false, {}, opts);
+ resp = new ResponseModel({...props, code: '400' });
expect(resp.type).toEqual('error');
});
test('default should be successful by default', () => {
- const resp = new ResponseModel(parser, 'default', false, {}, opts);
+ const resp = new ResponseModel({...props, code: 'default' });
expect(resp.type).toEqual('success');
});
test('default should be error if defaultAsError is true', () => {
- const resp = new ResponseModel(parser, 'default', true, {}, opts);
+ const resp = new ResponseModel({...props, code: 'default', defaultAsError: true });
expect(resp.type).toEqual('error');
});
});
diff --git a/src/services/models/MediaType.ts b/src/services/models/MediaType.ts
index d84159c2..9e41d89a 100644
--- a/src/services/models/MediaType.ts
+++ b/src/services/models/MediaType.ts
@@ -53,8 +53,8 @@ export class MediaTypeModel {
generateExample(parser: OpenAPIParser, info: OpenAPIMediaType) {
const samplerOptions = {
skipReadOnly: this.isRequestType,
- skipNonRequired: this.isRequestType && this.onlyRequiredInSamples,
skipWriteOnly: !this.isRequestType,
+ skipNonRequired: this.isRequestType && this.onlyRequiredInSamples,
maxSampleDepth: this.generatedPayloadSamplesMaxDepth,
};
if (this.schema && this.schema.oneOf) {
diff --git a/src/services/models/Operation.ts b/src/services/models/Operation.ts
index d00461a1..5b1b5aca 100644
--- a/src/services/models/Operation.ts
+++ b/src/services/models/Operation.ts
@@ -76,6 +76,7 @@ export class OperationModel implements IMenuItem {
extensions: Record;
isCallback: boolean;
isWebhook: boolean;
+ isEvent: boolean;
constructor(
private parser: OpenAPIParser,
@@ -98,7 +99,8 @@ export class OperationModel implements IMenuItem {
this.operationId = operationSpec.operationId;
this.path = operationSpec.pathName;
this.isCallback = isCallback;
- this.isWebhook = !!operationSpec.isWebhook;
+ this.isWebhook = operationSpec.isWebhook;
+ this.isEvent = this.isCallback || this.isWebhook;
this.name = getOperationSummary(operationSpec);
@@ -171,8 +173,12 @@ export class OperationModel implements IMenuItem {
@memoize
get requestBody() {
return (
- this.operationSpec.requestBody &&
- new RequestBodyModel(this.parser, this.operationSpec.requestBody, this.options)
+ this.operationSpec.requestBody && new RequestBodyModel({
+ parser: this.parser,
+ infoOrRef: this.operationSpec.requestBody,
+ options: this.options,
+ isEvent: this.isEvent,
+ })
);
}
@@ -240,13 +246,14 @@ export class OperationModel implements IMenuItem {
return isStatusCode(code);
}) // filter out other props (e.g. x-props)
.map((code) => {
- return new ResponseModel(
- this.parser,
+ return new ResponseModel({
+ parser: this.parser,
code,
- hasSuccessResponses,
- this.operationSpec.responses[code],
- this.options,
- );
+ defaultAsError: hasSuccessResponses,
+ infoOrRef: this.operationSpec.responses[code],
+ options: this.options,
+ isEvent: this.isEvent,
+ });
});
}
diff --git a/src/services/models/RequestBody.ts b/src/services/models/RequestBody.ts
index f3b45959..3ca3dc21 100644
--- a/src/services/models/RequestBody.ts
+++ b/src/services/models/RequestBody.ts
@@ -4,22 +4,27 @@ import { OpenAPIParser } from '../OpenAPIParser';
import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
import { MediaContentModel } from './MediaContent';
+type RequestBodyProps = {
+ parser: OpenAPIParser;
+ infoOrRef: Referenced;
+ options: RedocNormalizedOptions;
+ isEvent: boolean;
+}
+
export class RequestBodyModel {
description: string;
required: boolean;
content?: MediaContentModel;
- constructor(
- parser: OpenAPIParser,
- infoOrRef: Referenced,
- options: RedocNormalizedOptions,
- ) {
+ constructor(props: RequestBodyProps) {
+ const { parser, infoOrRef, options, isEvent } = props;
+ const isRequest = isEvent ? false : true;
const info = parser.deref(infoOrRef);
this.description = info.description || '';
this.required = !!info.required;
parser.exitRef(infoOrRef);
if (info.content !== undefined) {
- this.content = new MediaContentModel(parser, info.content, true, options);
+ this.content = new MediaContentModel(parser, info.content, isRequest, options);
}
}
}
diff --git a/src/services/models/Response.ts b/src/services/models/Response.ts
index f50ee0f1..d3ed554a 100644
--- a/src/services/models/Response.ts
+++ b/src/services/models/Response.ts
@@ -8,6 +8,15 @@ import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
import { FieldModel } from './Field';
import { MediaContentModel } from './MediaContent';
+type ResponseProps = {
+ parser: OpenAPIParser,
+ code: string,
+ defaultAsError: boolean,
+ infoOrRef: Referenced,
+ options: RedocNormalizedOptions,
+ isEvent: boolean,
+}
+
export class ResponseModel {
@observable
expanded: boolean = false;
@@ -19,13 +28,9 @@ export class ResponseModel {
type: string;
headers: FieldModel[] = [];
- constructor(
- parser: OpenAPIParser,
- code: string,
- defaultAsError: boolean,
- infoOrRef: Referenced,
- options: RedocNormalizedOptions,
- ) {
+ constructor(props: ResponseProps) {
+ const { parser, code, defaultAsError, infoOrRef, options, isEvent } = props;
+ const isRequest = isEvent ? true : false;
makeObservable(this);
this.expanded = options.expandResponses === 'all' || options.expandResponses[code];
@@ -34,7 +39,7 @@ export class ResponseModel {
parser.exitRef(infoOrRef);
this.code = code;
if (info.content !== undefined) {
- this.content = new MediaContentModel(parser, info.content, false, options);
+ this.content = new MediaContentModel(parser, info.content, isRequest, options);
}
if (info['x-summary'] !== undefined) {
diff --git a/src/services/models/Schema.ts b/src/services/models/Schema.ts
index adb2de19..d79d738b 100644
--- a/src/services/models/Schema.ts
+++ b/src/services/models/Schema.ts
@@ -61,6 +61,8 @@ export class SchemaModel {
schema: MergedOpenAPISchema;
extensions?: Record;
const: any;
+ contentEncoding?: string;
+ contentMediaType?: string;
/**
* @param isChild if schema discriminator Child
@@ -98,6 +100,10 @@ export class SchemaModel {
this.activeOneOf = idx;
}
+ hasType(type: string) {
+ return this.type === type || (Array.isArray(this.type) && this.type.includes(type));
+ }
+
init(parser: OpenAPIParser, isChild: boolean) {
const schema = this.schema;
this.isCircular = schema['x-circular-ref'];
@@ -120,10 +126,14 @@ export class SchemaModel {
this.readOnly = !!schema.readOnly;
this.writeOnly = !!schema.writeOnly;
this.const = schema.const || '';
+ this.contentEncoding = schema.contentEncoding;
+ this.contentMediaType = schema.contentMediaType;
- if (!!schema.nullable) {
- if (Array.isArray(this.type) && !this.type.includes('null')) {
+ if (!!schema.nullable || schema['x-nullable']) {
+ if (Array.isArray(this.type) && !this.type.some((value) => value === null || value === 'null')) {
this.type = [...this.type, 'null'];
+ } else if (!Array.isArray(this.type) && (this.type !== null || this.type !== 'null')) {
+ this.type = [this.type, 'null'];
}
}
@@ -164,9 +174,9 @@ export class SchemaModel {
return;
}
- if (this.type === 'object') {
+ if (this.hasType('object')) {
this.fields = buildFields(parser, schema, this.pointer, this.options);
- } else if ((this.type === 'array' || Array.isArray(this.type)) && schema.items) {
+ } else if (this.hasType('array') && schema.items) {
this.items = new SchemaModel(parser, schema.items, this.pointer + '/items', this.options);
this.displayType = pluralizeType(this.items.displayType);
this.displayFormat = this.items.format;
diff --git a/src/types/open-api.ts b/src/types/open-api.ts
index d55e44b1..03898457 100644
--- a/src/types/open-api.ts
+++ b/src/types/open-api.ts
@@ -147,6 +147,8 @@ export interface OpenAPISchema {
enum?: any[];
example?: any;
const?: string;
+ contentEncoding?: string;
+ contentMediaType?: string;
}
export interface OpenAPIDiscriminator {
diff --git a/src/utils/__tests__/__snapshots__/loadAndBundleSpec.test.ts.snap b/src/utils/__tests__/__snapshots__/loadAndBundleSpec.test.ts.snap
index 1aa507f9..7807e39e 100644
--- a/src/utils/__tests__/__snapshots__/loadAndBundleSpec.test.ts.snap
+++ b/src/utils/__tests__/__snapshots__/loadAndBundleSpec.test.ts.snap
@@ -2187,6 +2187,12 @@ Object {
"id": Object {
"$ref": "#/components/schemas/Id",
},
+ "image": Object {
+ "contentEncoding": "base64",
+ "contentMediaType": "image/png",
+ "description": "User image",
+ "type": "string",
+ },
"lastName": Object {
"description": "User last name",
"example": "Smith",
diff --git a/src/utils/highlight.ts b/src/utils/highlight.ts
index d86ee374..036b9129 100644
--- a/src/utils/highlight.ts
+++ b/src/utils/highlight.ts
@@ -19,6 +19,7 @@ import 'prismjs/components/prism-ruby.js';
import 'prismjs/components/prism-scala.js';
import 'prismjs/components/prism-sql.js';
import 'prismjs/components/prism-swift.js';
+import 'prismjs/components/prism-yaml.js';
const DEFAULT_LANG = 'clike';
diff --git a/src/utils/openapi.ts b/src/utils/openapi.ts
index c31e3cd2..ad267722 100644
--- a/src/utils/openapi.ts
+++ b/src/utils/openapi.ts
@@ -83,6 +83,8 @@ const schemaKeywordTypes = {
maxLength: 'string',
minLength: 'string',
pattern: 'string',
+ contentEncoding: 'string',
+ contentMediaType: 'string',
items: 'array',
maxItems: 'array',