@redocly/openapi-core 1.0.0-beta.62 → 1.0.0-beta.66

package/src/rules/oas3/index.ts

@@ -1,4 +1,5 @@
 import { Oas3RuleSet } from '../../oas-types';
+import { Oas3Decorator } from '../../visitors';
 import { OasSpec } from '../common/spec';
 import { Operation2xxResponse } from '../common/operation-2xx-response';
 import { OperationIdUnique } from '../common/operation-operationId-unique';
@@ -37,8 +38,14 @@ import { OperationOperationId } from '../common/operation-operationId';
 import { OperationSummary } from '../common/operation-summary';
 import { NoAmbiguousPaths } from '../common/no-ambiguous-paths';
 import { NoEmptyEnumServers } from './no-servers-empty-enum';
-
-import { Oas3Decorator } from '../../visitors';
+import { NoHttpVerbsInPaths } from '../common/no-http-verbs-in-paths';
+import { RequestMimeType } from './request-mime-type';
+import { ResponseMimeType } from './response-mime-type';
+import { PathSegmentPlural } from '../common/path-segment-plural';
+import { OperationDescriptionOverride } from '../common/operation-description-override';
+import { TagDescriptionOverride } from '../common/tag-description-override';
+import { InfoDescriptionOverride } from '../common/info-description-override';
+import { PathExcludesPatterns } from '../common/path-excludes-patterns';
 
 export const rules = {
   spec: OasSpec,
@@ -78,11 +85,19 @@ export const rules = {
   'no-identical-paths': NoIdenticalPaths,
   'no-ambiguous-paths': NoAmbiguousPaths,
   'no-undefined-server-variable': NoUndefinedServerVariable,
-  'no-servers-empty-enum': NoEmptyEnumServers
+  'no-servers-empty-enum': NoEmptyEnumServers,
+  'no-http-verbs-in-paths': NoHttpVerbsInPaths,
+  'path-excludes-patterns': PathExcludesPatterns,
+  'request-mime-type': RequestMimeType,
+  'response-mime-type': ResponseMimeType,
+  'path-segment-plural': PathSegmentPlural,
 } as Oas3RuleSet;
 
 export const preprocessors = {};
 
 export const decorators = {
   'registry-dependencies': RegistryDependencies as Oas3Decorator,
+  'operation-description-override': OperationDescriptionOverride as Oas3Decorator,
+  'tag-description-override': TagDescriptionOverride as Oas3Decorator,
+  'info-description-override': InfoDescriptionOverride as Oas3Decorator,
 };

package/src/rules/oas3/request-mime-type.ts

@@ -0,0 +1,31 @@
+import { Oas3Rule } from '../../visitors';
+import { UserContext } from '../../walk';
+import { Oas3RequestBody, Oas3Response } from '../../typings/openapi';
+import { validateMimeTypeOAS3 } from '../../utils';
+
+export const RequestMimeType: Oas3Rule = ({ allowedValues }) => {
+  return {
+    PathMap: {
+      RequestBody: {
+        leave(requestBody: Oas3RequestBody, ctx: UserContext) {
+          validateMimeTypeOAS3({ type: 'consumes', value: requestBody }, ctx, allowedValues);
+        },
+      },
+      Callback: {
+        RequestBody() {},
+        Response: {
+          leave(response: Oas3Response, ctx: UserContext) {
+            validateMimeTypeOAS3({ type: 'consumes', value: response }, ctx, allowedValues);
+          },
+        },
+      },
+    },
+    WebhooksMap: {
+      Response: {
+        leave(response: Oas3Response, ctx: UserContext) {
+          validateMimeTypeOAS3({ type: 'consumes', value: response }, ctx, allowedValues);
+        },
+      },
+    },
+  };
+};

package/src/rules/oas3/response-mime-type.ts

@@ -0,0 +1,31 @@
+import { Oas3Rule } from '../../visitors';
+import { UserContext } from '../../walk';
+import { Oas3RequestBody, Oas3Response } from '../../typings/openapi';
+import { validateMimeTypeOAS3 } from '../../utils';
+
+export const ResponseMimeType: Oas3Rule = ({ allowedValues }) => {
+  return {
+    PathMap: {
+      Response: {
+        leave(response: Oas3Response, ctx: UserContext) {
+          validateMimeTypeOAS3({ type: 'produces', value: response }, ctx, allowedValues);
+        },
+      },
+      Callback: {
+        Response() {},
+        RequestBody: {
+          leave(requestBody: Oas3RequestBody, ctx: UserContext) {
+            validateMimeTypeOAS3({ type: 'produces', value: requestBody }, ctx, allowedValues);
+          },
+        },
+      },
+    },
+    WebhooksMap: {
+      RequestBody: {
+        leave(requestBody: Oas3RequestBody, ctx: UserContext) {
+          validateMimeTypeOAS3({ type: 'produces', value: requestBody }, ctx, allowedValues);
+        },
+      },
+    },
+  };
+};

package/src/rules/utils.ts

@@ -79,4 +79,4 @@ export function getSuggest(given: string, variants: string[]): string[] {
 
   // if (bestMatch.distance <= 4) return bestMatch.string;
   return distances.map((d) => d.variant);
-}
+}

package/src/types/oas3_1.ts

@@ -97,6 +97,13 @@ const Operation: NodeType = {
 
 const Schema: NodeType = {
   properties: {
+    $id: { type: 'string' },
+    id: { type: 'string' },
+    $schema: { type: 'string' },
+    definitions: 'NamedSchemas',
+    $defs: 'NamedSchemas',
+    $vocabulary: { type: 'string' },
+
     externalDocs: 'ExternalDocs',
     discriminator: 'Discriminator',
     myArbitraryKeyword: { type: 'boolean' },

package/src/types/redocly-yaml.ts

@@ -1,11 +1,12 @@
 import { NodeType, listOf } from '.';
+import { omitObjectProps, pickObjectProps } from '../utils';
 
 const ConfigRoot: NodeType = {
   properties: {
     apiDefinitions: {
       type: 'object',
       properties: {},
-      additionalProperties: { properties: { type: 'string' } }
+      additionalProperties: { properties: { type: 'string' } },
     },
     lint: 'ConfigLint',
     referenceDocs: 'ConfigReferenceDocs',
@@ -91,25 +92,398 @@ const ConfigSidebarLinks: NodeType = {
   },
 };
 
+const CommonThemeColors: NodeType = {
+  properties: {
+    main: { type: 'string' },
+    light: { type: 'string' },
+    dark: { type: 'string' },
+    contrastText: { type: 'string' },
+  },
+};
+
+const CommonColorProps: NodeType = {
+  properties: {
+    backgroundColor: { type: 'string' },
+    borderColor: { type: 'string' },
+    color: { type: 'string' },
+    tabTextColor: { type: 'string' },
+  },
+};
+
+const BorderThemeColors: NodeType = {
+  properties: pickObjectProps(CommonThemeColors.properties, ['light', 'dark']),
+};
+
+const HttpColors: NodeType = {
+  properties: {
+    basic: { type: 'string' },
+    delete: { type: 'string' },
+    get: { type: 'string' },
+    head: { type: 'string' },
+    link: { type: 'string' },
+    options: { type: 'string' },
+    patch: { type: 'string' },
+    post: { type: 'string' },
+    put: { type: 'string' },
+  },
+};
+
+const ResponseColors: NodeType = {
+  properties: {
+    errors: 'CommonColorProps',
+    info: 'CommonColorProps',
+    redirect: 'CommonColorProps',
+    success: 'CommonColorProps',
+  },
+};
+
+const SecondaryColors: NodeType = {
+  properties: omitObjectProps(CommonThemeColors.properties, ['dark']),
+};
+
+const TextThemeColors: NodeType = {
+  properties: {
+    primary: { type: 'string' },
+    secondary: { type: 'string' },
+    light: { type: 'string' },
+  },
+};
+
+const ThemeColors: NodeType = {
+  properties: {
+    accent: 'CommonThemeColors',
+    border: 'BorderThemeColors',
+    error: 'CommonThemeColors',
+    http: 'HttpColors',
+    primary: 'CommonThemeColors',
+    responses: 'ResponseColors',
+    secondary: 'SecondaryColors',
+    success: 'CommonThemeColors',
+    text: 'TextThemeColors',
+    tonalOffset: { type: 'number' },
+    warning: 'CommonThemeColors',
+  },
+};
+
+const SizeProps: NodeType = {
+  properties: {
+    fontSize: { type: 'string' },
+    padding: { type: 'string' },
+    minWidth: { type: 'string' },
+  },
+};
+
+const Sizes: NodeType = {
+  properties: {
+    small: 'SizeProps',
+    medium: 'SizeProps',
+    large: 'SizeProps',
+    xlarge: 'SizeProps',
+  },
+};
+
+const FontConfig: NodeType = {
+  properties: {
+    fontFamily: { type: 'string' },
+    fontSize: { type: 'string' },
+    fontWeight: { type: 'string' },
+    lineHeight: { type: 'string' },
+  },
+};
+
+const ButtonsConfig: NodeType = {
+  properties: {
+    ...omitObjectProps(FontConfig.properties, ['fontSize', 'lineHeight']),
+    borderRadius: { type: 'string' },
+    hoverStyle: { type: 'string' },
+    boxShadow: { type: 'string' },
+    hoverBoxShadow: { type: 'string' },
+    sizes: 'Sizes',
+  },
+};
+
+const BadgeFontConfig: NodeType = {
+  properties: pickObjectProps(FontConfig.properties, ['fontSize', 'lineHeight']),
+};
+
+const BadgeSizes: NodeType = {
+  properties: {
+    medium: 'BadgeFontConfig',
+    small: 'BadgeFontConfig',
+  },
+};
+
+const HttpBadgesConfig: NodeType = {
+  properties: {
+    ...omitObjectProps(FontConfig.properties, ['fontSize', 'lineHeight']),
+    borderRadius: { type: 'string' },
+    color: { type: 'string' },
+    sizes: 'BadgeSizes',
+  },
+};
+
+const LabelControls: NodeType = {
+  properties: {
+    top: { type: 'string' },
+  },
+};
+
+const Panels: NodeType = {
+  properties: {
+    borderRadius: { type: 'string' },
+  },
+};
+
+const TryItButton: NodeType = {
+  properties: {
+    fullWidth: { type: 'boolean' },
+  },
+};
+
+const Components: NodeType = {
+  properties: {
+    buttons: 'ButtonsConfig',
+    httpBadges: 'HttpBadgesConfig',
+    layoutControls: 'LabelControls',
+    panels: 'Panels',
+    tryItButton: 'TryItButton',
+    tryItSendButton: 'TryItButton',
+  },
+};
+
+const Breakpoints: NodeType = {
+  properties: {
+    small: { type: 'string' },
+    medium: { type: 'string' },
+    large: { type: 'string' },
+  },
+};
+
+const StackedConfig: NodeType = {
+  properties: {
+    maxWidth: 'Breakpoints',
+  },
+};
+
+const ThreePanelConfig: NodeType = {
+  properties: {
+    maxWidth: 'Breakpoints',
+  },
+};
+
+const Layout: NodeType = {
+  properties: {
+    showDarkRightPanel: { type: 'boolean' },
+    stacked: 'StackedConfig',
+    'three-panel': 'ThreePanelConfig',
+  },
+};
+
+const SchemaColorsConfig: NodeType = {
+  properties: {
+    backgroundColor: { type: 'string' },
+    border: { type: 'string' },
+  },
+};
+
+const Schema: NodeType = {
+  properties: {
+    breakFieldNames: { type: 'boolean' },
+    caretColor: { type: 'string' },
+    caretSize: { type: 'string' },
+    constraints: 'SchemaColorsConfig',
+    defaultDetailsWidth: { type: 'string' },
+    examples: 'SchemaColorsConfig',
+    labelsTextSize: { type: 'string' },
+    linesColor: { type: 'string' },
+    nestedBackground: { type: 'string' },
+    nestingSpacing: { type: 'string' },
+    requireLabelColor: { type: 'string' },
+    typeNameColor: { type: 'string' },
+    typeTitleColor: { type: 'string' },
+  },
+};
+
+const GroupItemsConfig: NodeType = {
+  properties: {
+    subItemsColor: { type: 'string' },
+    textTransform: { type: 'string' },
+    fontWeight: { type: 'string' },
+  },
+};
+
+const Level1Items: NodeType = {
+  properties: pickObjectProps(GroupItemsConfig.properties, ['textTransform']),
+};
+
+const SpacingConfig: NodeType = {
+  properties: {
+    unit: { type: 'number' },
+    paddingHorizontal: { type: 'string' },
+    paddingVertical: { type: 'string' },
+    offsetTop: { type: 'string' },
+    offsetLeft: { type: 'string' },
+    offsetNesting: { type: 'string' },
+  },
+};
+
+const Sidebar: NodeType = {
+  properties: {
+    ...omitObjectProps(FontConfig.properties, ['fontWeight', 'lineHeight']),
+    activeBgColor: { type: 'string' },
+    activeTextColor: { type: 'string' },
+    backgroundColor: { type: 'string' },
+    borderRadius: { type: 'string' },
+    breakPath: { type: 'boolean' },
+    caretColor: { type: 'string' },
+    caretSize: { type: 'string' },
+    groupItems: 'GroupItemsConfig',
+    level1items: 'Level1Items',
+    rightLineColor: { type: 'string' },
+    separatorLabelColor: { type: 'string' },
+    showAtBreakpoint: { type: 'string' },
+    spacing: 'SpacingConfig',
+    textColor: { type: 'string' },
+    width: { type: 'string' },
+  },
+};
+
+const Heading: NodeType = {
+  properties: {
+    ...FontConfig.properties,
+    color: { type: 'string' },
+    transform: { type: 'string' },
+  },
+};
+
+const CodeConfig: NodeType = {
+  properties: {
+    ...FontConfig.properties,
+    backgroundColor: { type: 'string' },
+    color: { type: 'string' },
+    wordBreak: { type: 'string' },
+    wrap: { type: 'boolean' },
+  },
+};
+
+const HeadingsConfig: NodeType = {
+  properties: omitObjectProps(FontConfig.properties, ['fontSize']),
+};
+
+const LinksConfig: NodeType = {
+  properties: {
+    color: { type: 'string' },
+    hover: { type: 'string' },
+    textDecoration: { type: 'string' },
+    visited: { type: 'string' },
+  },
+};
+
+const Typography: NodeType = {
+  properties: {
+    code: 'CodeConfig',
+    fieldName: 'FontConfig',
+    ...pickObjectProps(FontConfig.properties, ['fontSize', 'fontFamily']),
+    fontWeightBold: { type: 'string' },
+    fontWeightLight: { type: 'string' },
+    fontWeightRegular: { type: 'string' },
+    heading1: 'Heading',
+    heading2: 'Heading',
+    heading3: 'Heading',
+    headings: 'HeadingsConfig',
+    lineHeight: { type: 'string' },
+    links: 'LinksConfig',
+    optimizeSpeed: { type: 'boolean' },
+    rightPanelHeading: 'Heading',
+    smoothing: { type: 'string' },
+  },
+};
+
+const TokenProps: NodeType = {
+  properties: {
+    color: { type: 'string' },
+    ...omitObjectProps(FontConfig.properties, ['fontWeight']),
+  },
+};
+
+const CodeBlock: NodeType = {
+  properties: {
+    backgroundColor: { type: 'string' },
+    borderRadius: { type: 'string' },
+    tokens: 'TokenProps',
+  },
+};
+
+const Logo: NodeType = {
+  properties: {
+    gutter: { type: 'string' },
+    maxHeight: { type: 'string' },
+    maxWidth: { type: 'string' },
+  },
+};
+
+const ButtonOverrides: NodeType = {
+  properties: {
+    custom: { type: 'string' },
+  },
+};
+
+const Overrides: NodeType = {
+  properties: {
+    DownloadButton: 'ButtonOverrides',
+    NextSectionButton: 'ButtonOverrides',
+  },
+};
+
+const RightPanel: NodeType = {
+  properties: {
+    backgroundColor: { type: 'string' },
+    panelBackgroundColor: { type: 'string' },
+    panelControlsBackgroundColor: { type: 'string' },
+    showAtBreakpoint: { type: 'string' },
+    textColor: { type: 'string' },
+    width: { type: 'string' },
+  },
+};
+
+const Shape: NodeType = {
+  properties: { borderRadius: { type: 'string' } },
+};
+
+const ThemeSpacing: NodeType = {
+  properties: {
+    sectionHorizontal: { type: 'number' },
+    sectionVertical: { type: 'number' },
+    unit: { type: 'number' },
+  },
+};
+
 const ConfigTheme: NodeType = {
   properties: {
-    breakpoints: { type: 'object', additionalProperties: { type: 'string' } },
-    codeBlock: { type: 'object', additionalProperties: { type: 'string' } },
-    colors: { type: 'object', additionalProperties: { type: 'string' } },
-    components: { type: 'object', additionalProperties: { type: 'string' } },
-    layout: { type: 'object', additionalProperties: { type: 'string' } },
-    logo: { type: 'object', additionalProperties: { type: 'string' } },
-    overrides: { type: 'object', additionalProperties: { type: 'string' } },
-    rightPanel: { type: 'object', additionalProperties: { type: 'string' } },
-    schema: { type: 'object', additionalProperties: { type: 'string' } },
-    shape: { type: 'object', additionalProperties: { type: 'string' } },
-    sidebar: { type: 'object', additionalProperties: { type: 'string' } },
-    spacing: { type: 'object', additionalProperties: { type: 'string' } },
-    typography: { type: 'object', additionalProperties: { type: 'string' } },
+    breakpoints: 'Breakpoints',
+    codeBlock: 'CodeBlock',
+    colors: 'ThemeColors',
+    components: 'Components',
+    layout: 'Layout',
+    logo: 'Logo',
+    overrides: 'Overrides',
+    rightPanel: 'RightPanel',
+    schema: 'Schema',
+    shape: 'Shape',
+    sidebar: 'Sidebar',
+    spacing: 'ThemeSpacing',
+    typography: 'Typography',
     links: { properties: { color: { type: 'string' } } },
     codeSample: { properties: { backgroundColor: { type: 'string' } } },
   },
-}
+};
+
+const GenerateCodeSamples: NodeType = {
+  properties: {
+    skipOptionalParameters: { type: 'boolean' },
+    languages: listOf('ConfigLanguage'),
+  },
+};
 
 const ConfigReferenceDocs: NodeType = {
   properties: {
@@ -124,12 +498,7 @@ const ConfigReferenceDocs: NodeType = {
     expandDefaultServerVariables: { type: 'boolean' },
     expandResponses: { type: 'string' },
     expandSingleSchemaField: { type: 'boolean' },
-    generateCodeSamples: {
-      properties: {
-        skipOptionalParameters: { type: 'boolean' },
-        languages: listOf('ConfigLanguage'),
-      },
-    },
+    generateCodeSamples: 'GenerateCodeSamples',
     generatedPayloadSamplesMaxDepth: { type: 'number' },
     hideDownloadButton: { type: 'boolean' },
     hideHostname: { type: 'boolean' },
@@ -143,7 +512,7 @@ const ConfigReferenceDocs: NodeType = {
     htmlTemplate: { type: 'string' },
     jsonSampleExpandLevel: { type: 'string' },
     labels: 'ConfigLabels',
-    layout: { type: 'object' },
+    layout: { type: 'string' },
     maxDisplayedEnumValues: { type: 'number' },
     menuToggle: { type: 'boolean' },
     nativeScrollbars: { type: 'boolean' },
@@ -192,4 +561,47 @@ export const ConfigTypes: Record<string, NodeType> = {
   ConfigLabels,
   ConfigSidebarLinks,
   ConfigTheme,
+  ThemeColors,
+  CommonThemeColors,
+  BorderThemeColors,
+  HttpColors,
+  ResponseColors,
+  SecondaryColors,
+  TextThemeColors,
+  Sizes,
+  ButtonsConfig,
+  CommonColorProps,
+  BadgeFontConfig,
+  BadgeSizes,
+  HttpBadgesConfig,
+  LabelControls,
+  Panels,
+  TryItButton,
+  Breakpoints,
+  StackedConfig,
+  ThreePanelConfig,
+  SchemaColorsConfig,
+  SizeProps,
+  Level1Items,
+  SpacingConfig,
+  FontConfig,
+  CodeConfig,
+  HeadingsConfig,
+  LinksConfig,
+  TokenProps,
+  CodeBlock,
+  Logo,
+  ButtonOverrides,
+  Overrides,
+  RightPanel,
+  Shape,
+  ThemeSpacing,
+  GenerateCodeSamples,
+  GroupItemsConfig,
+  Components,
+  Layout,
+  Schema,
+  Sidebar,
+  Heading,
+  Typography,
 };

package/src/typings/swagger.ts

@@ -1,5 +1,4 @@
 import { Referenced } from './openapi';
-//@ts-ignore
 import { Schema } from 'js-yaml';
 
 export interface Oas2Definition {