Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-02-16 18:00:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix: support wildcard status codes

Browse Source 
fixes #531
This commit is contained in:
Roman Hotsiy 2018-06-18 15:56:30 +03:00
parent d38f2f2a5a
commit c0b0cd49b5
No known key found for this signature in database
GPG Key ID: 5CB7B3ACABA57CB0
2 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/services/models/Operation.ts
View File

@ -10,7 +10,9 @@ import { OpenAPIExternalDocumentation, OpenAPIServer } from '../../types';
import {
getOperationSummary,
getStatusCodeType,
isAbsolutePath,
isStatusCode,
JsonPointer,
mergeParams,
sortByRequired,
@ -99,10 +101,15 @@ export class OperationModel implements IMenuItem {
let hasSuccessResponses = false;
this.responses = Object.keys(operationSpec.responses || [])
.filter(code => {
if (parseInt(code, 10) >= 100 && parseInt(code, 10) <= 399) {
if (code === 'default') {
return true;
}
if (getStatusCodeType(code) === 'success') {
hasSuccessResponses = true;
}
return isNumeric(code) || code === 'default';
return isStatusCode(code);
}) // filter out other props (e.g. x-props)
.map(code => {
return new ResponseModel(

24
src/utils/openapi.ts
View File

@ -6,21 +6,35 @@ import {
OpenAPISchema,
Referenced,
} from '../types';
import { isNumeric } from './helpers';
export function getStatusCodeType(statusCode: string | number, defaultAsError = false): string {
function isWildcardStatusCode(statusCode: string | number): statusCode is string {
return typeof statusCode === 'string' && /\dxx/i.test(statusCode);
}
export function isStatusCode(statusCode: string) {
return statusCode === 'default' || isNumeric(statusCode) || isWildcardStatusCode(statusCode);
}
export function getStatusCodeType(statusCode: string, defaultAsError = false): string {
if (statusCode === 'default') {
return defaultAsError ? 'error' : 'success';
}
if (statusCode < 100 || statusCode > 599) {
let code = parseInt(statusCode, 10);
if (isWildcardStatusCode(statusCode)) {
code *= 100; // parseInt('2xx') parses to 2
}
if (code < 100 || code > 599) {
throw new Error('invalid HTTP code');
}
let res = 'success';
if (statusCode >= 300 && statusCode < 400) {
if (code >= 300 && code < 400) {
res = 'redirect';
} else if (statusCode >= 400) {
} else if (code >= 400) {
res = 'error';
} else if (statusCode < 200) {
} else if (code < 200) {
res = 'info';
}
return res;