Skip to content

Commit

Permalink
Added support for showExtensions and $ref for Responses (Redocly#1406)
Browse files Browse the repository at this point in the history
* Corrected responses to support $ref

* Add showExtentions for Responses

* Add showExtentions support for Responses

* Update src/services/__tests__/models/Response.test.ts

Co-authored-by: Giles Wells <giles@mediagearhead.com>

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>
Co-authored-by: Giles Wells <giles@mediagearhead.com>
  • Loading branch information
3 people committed Dec 9, 2021
1 parent af13863 commit f82eb53
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 5 deletions.
5 changes: 3 additions & 2 deletions src/components/Responses/Response.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ export class ResponseView extends React.Component<{ response: ResponseModel }> {
};

render() {
const { headers, type, summary, description, code, expanded, content } = this.props.response;
const { extensions, headers, type, summary, description, code, expanded, content } = this.props.response;
const mimes =
content === undefined ? [] : content.mediaTypes.filter(mime => mime.schema !== undefined);

const empty = headers.length === 0 && mimes.length === 0 && !description;
const empty = (!extensions || Object.keys(extensions).length === 0) &&
headers.length === 0 && mimes.length === 0 && !description;

return (
<div>
Expand Down
4 changes: 3 additions & 1 deletion src/components/Responses/ResponseDetails.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,17 @@ import { DropdownOrLabel } from '../DropdownOrLabel/DropdownOrLabel';
import { MediaTypesSwitch } from '../MediaTypeSwitch/MediaTypesSwitch';
import { Schema } from '../Schema';

import { Extensions } from '../Fields/Extensions';
import { Markdown } from '../Markdown/Markdown';
import { ResponseHeaders } from './ResponseHeaders';

export class ResponseDetails extends React.PureComponent<{ response: ResponseModel }> {
render() {
const { description, headers, content } = this.props.response;
const { description, extensions, headers, content } = this.props.response;
return (
<>
{description && <Markdown source={description} />}
<Extensions extensions={extensions} />
<ResponseHeaders headers={headers} />
<MediaTypesSwitch content={content} renderDropdown={this.renderDropdown}>
{({ schema }) => {
Expand Down
7 changes: 7 additions & 0 deletions src/services/__tests__/models/Response.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,12 @@ describe('Models', () => {
const resp = new ResponseModel({ ...props, code: 'default', defaultAsError: true });
expect(resp.type).toEqual('error');
});

test('ensure extensions are shown if showExtensions is true', () => {
const options = new RedocNormalizedOptions({ showExtensions: true });
const resp = new ResponseModel(parser, 'default', true, { 'x-example': {a: 1} } as any, options);
expect(Object.keys(resp.extensions).length).toEqual(1);
expect(resp.extensions['x-example']).toEqual({a: 1});
});
});
});
10 changes: 9 additions & 1 deletion src/services/models/Response.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@ import { action, observable, makeObservable } from 'mobx';

import { OpenAPIResponse, Referenced } from '../../types';

import { getStatusCodeType } from '../../utils';
import {
getStatusCodeType,
extractExtensions
} from '../../utils';
import { OpenAPIParser } from '../OpenAPIParser';
import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
import { FieldModel } from './Field';
Expand All @@ -27,6 +30,7 @@ export class ResponseModel {
description: string;
type: string;
headers: FieldModel[] = [];
extensions: Record<string, any>;

constructor(props: ResponseProps) {
const { parser, code, defaultAsError, infoOrRef, options, isEvent } = props;
Expand Down Expand Up @@ -59,6 +63,10 @@ export class ResponseModel {
return new FieldModel(parser, { ...header, name }, '', options);
});
}

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

@action
Expand Down
2 changes: 1 addition & 1 deletion src/types/open-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ export interface OpenAPIRequestBody {
}

export interface OpenAPIResponses {
[code: string]: OpenAPIResponse;
[code: string]: Referenced<OpenAPIResponse>;
}

export interface OpenAPIResponse
Expand Down

0 comments on commit f82eb53

Please sign in to comment.