@redocly/openapi-core 1.0.2 → 1.2.0

package/src/types/portal-config-schema.ts

@@ -0,0 +1,343 @@
+import {
+  ApigeeDevOnboardingIntegrationAuthType,
+  AuthProviderType,
+  DEFAULT_TEAM_CLAIM_NAME,
+} from '../config';
+
+const oidcIssuerMetadataSchema = {
+  type: 'object',
+  properties: {
+    end_session_endpoint: { type: 'string' },
+    token_endpoint: { type: 'string' },
+    authorization_endpoint: { type: 'string' },
+    jwks_uri: { type: 'string' },
+  },
+  required: ['token_endpoint', 'authorization_endpoint'],
+  additionalProperties: true,
+} as const;
+
+const oidcProviderConfigSchema = {
+  type: 'object',
+  properties: {
+    type: { type: 'string', const: AuthProviderType.OIDC },
+    title: { type: 'string' },
+    configurationUrl: { type: 'string', minLength: 1 },
+    configuration: oidcIssuerMetadataSchema,
+    clientId: { type: 'string', minLength: 1 },
+    clientSecret: { type: 'string', minLength: 1 },
+    teamsClaimName: { type: 'string' },
+    teamsClaimMap: { type: 'object', additionalProperties: { type: 'string' } },
+    defaultTeams: { type: 'array', items: { type: 'string' } },
+    scopes: { type: 'array', items: { type: 'string' } },
+    tokenExpirationTime: { type: 'number' },
+    authorizationRequestCustomParams: { type: 'object', additionalProperties: { type: 'string' } },
+    tokenRequestCustomParams: { type: 'object', additionalProperties: { type: 'string' } },
+    audience: { type: 'array', items: { type: 'string' } },
+  },
+  required: ['type', 'clientId', 'clientSecret'],
+  oneOf: [{ required: ['configurationUrl'] }, { required: ['configuration'] }],
+  additionalProperties: false,
+} as const;
+
+const saml2ProviderConfigSchema = {
+  type: 'object',
+  properties: {
+    type: { type: 'string', const: AuthProviderType.SAML2 },
+    title: { type: 'string' },
+    issuerId: { type: 'string' },
+    entityId: { type: 'string' },
+    ssoUrl: { type: 'string' },
+    x509PublicCert: { type: 'string' },
+    teamsAttributeName: { type: 'string', default: DEFAULT_TEAM_CLAIM_NAME },
+    teamsAttributeMap: { type: 'object', additionalProperties: { type: 'string' } },
+    defaultTeams: { type: 'array', items: { type: 'string' } },
+  },
+  additionalProperties: false,
+  required: ['type', 'issuerId', 'ssoUrl', 'x509PublicCert'],
+} as const;
+
+const basicAuthProviderConfigSchema = {
+  type: 'object',
+  properties: {
+    type: { type: 'string', const: AuthProviderType.BASIC },
+    title: { type: 'string' },
+    credentials: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          username: { type: 'string' },
+          password: { type: 'string' },
+          passwordHash: { type: 'string' },
+          teams: { type: 'array', items: { type: 'string' } },
+        },
+        required: ['username'],
+        additionalProperties: false,
+      },
+    },
+  },
+  required: ['type', 'credentials'],
+  additionalProperties: false,
+} as const;
+
+const authProviderConfigSchema = {
+  oneOf: [oidcProviderConfigSchema, saml2ProviderConfigSchema, basicAuthProviderConfigSchema],
+  discriminator: { propertyName: 'type' },
+} as const;
+
+export const ssoConfigSchema = {
+  type: 'object',
+  additionalProperties: authProviderConfigSchema,
+} as const;
+
+const redirectConfigSchema = {
+  type: 'object',
+  properties: {
+    to: { type: 'string' },
+    type: { type: 'number', default: 301 },
+  },
+  required: ['to'],
+  additionalProperties: false,
+} as const;
+
+export const apiConfigSchema = {
+  type: 'object',
+  properties: {
+    root: { type: 'string' },
+    rbac: { type: 'object', additionalProperties: true },
+    theme: {
+      type: 'object',
+      properties: {
+        openapi: { type: 'object', additionalProperties: true },
+      },
+      additionalProperties: false,
+    },
+    title: { type: 'string' },
+    metadata: { type: 'object', additionalProperties: true },
+  },
+  additionalProperties: true,
+  required: ['root'],
+} as const;
+
+const metadataConfigSchema = {
+  type: 'object',
+  additionalProperties: true,
+} as const;
+
+const seoConfigSchema = {
+  type: 'object',
+  properties: {
+    title: { type: 'string' },
+    description: { type: 'string' },
+    siteUrl: { type: 'string' },
+    image: { type: 'string' },
+    keywords: { type: 'array', items: { type: 'string' } },
+    lang: { type: 'string' },
+    jsonLd: { type: 'object' },
+    meta: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          name: { type: 'string' },
+          content: { type: 'string' },
+        },
+        required: ['name', 'content'],
+        additionalProperties: false,
+      },
+    },
+  },
+  additionalProperties: false,
+} as const;
+
+const rbacScopeItemsSchema = { type: 'object', additionalProperties: { type: 'string' } } as const;
+
+const rbacConfigSchema = {
+  type: 'object',
+  properties: {
+    defaults: rbacScopeItemsSchema,
+  },
+  additionalProperties: rbacScopeItemsSchema,
+} as const;
+
+const graviteeAdapterConfigSchema = {
+  type: 'object',
+  properties: {
+    type: { type: 'string', const: 'GRAVITEE' },
+    apiBaseUrl: { type: 'string' },
+    env: { type: 'string' },
+    allowApiProductsOutsideCatalog: { type: 'boolean', default: false },
+    stage: { type: 'string', default: 'non-production' },
+
+    auth: { type: 'object', properties: { static: { type: 'string' } } },
+  },
+  additionalProperties: false,
+  required: ['type', 'apiBaseUrl'],
+} as const;
+
+const apigeeAdapterAuthOauth2Schema = {
+  type: 'object',
+  properties: {
+    type: { type: 'string', const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2 },
+    tokenEndpoint: { type: 'string' },
+    clientId: { type: 'string' },
+    clientSecret: { type: 'string' },
+  },
+  additionalProperties: false,
+  required: ['type', 'tokenEndpoint', 'clientId', 'clientSecret'],
+} as const;
+
+const apigeeAdapterAuthServiceAccountSchema = {
+  type: 'object',
+  properties: {
+    type: { type: 'string', const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT },
+    serviceAccountEmail: { type: 'string' },
+    serviceAccountPrivateKey: { type: 'string' },
+  },
+  additionalProperties: false,
+  required: ['type', 'serviceAccountEmail', 'serviceAccountPrivateKey'],
+} as const;
+
+const apigeeXAdapterConfigSchema = {
+  type: 'object',
+  properties: {
+    type: { type: 'string', const: 'APIGEE_X' },
+    apiUrl: { type: 'string' },
+    stage: { type: 'string', default: 'non-production' },
+    organizationName: { type: 'string' },
+    ignoreApiProducts: { type: 'array', items: { type: 'string' } },
+    allowApiProductsOutsideCatalog: { type: 'boolean', default: false },
+    auth: {
+      type: 'object',
+      oneOf: [apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema],
+      discriminator: { propertyName: 'type' },
+    },
+  },
+  additionalProperties: false,
+  required: ['type', 'organizationName', 'auth'],
+} as const;
+
+const apigeeEdgeAdapterConfigSchema = {
+  ...apigeeXAdapterConfigSchema,
+  properties: {
+    ...apigeeXAdapterConfigSchema.properties,
+    type: { type: 'string', const: 'APIGEE_EDGE' },
+  },
+} as const;
+
+const devOnboardingAdapterConfigSchema = {
+  type: 'object',
+  oneOf: [apigeeXAdapterConfigSchema, apigeeEdgeAdapterConfigSchema, graviteeAdapterConfigSchema],
+  discriminator: { propertyName: 'type' },
+} as const;
+
+const devOnboardingConfigSchema = {
+  type: 'object',
+  required: ['adapters'],
+  additionalProperties: false,
+  properties: {
+    adapters: {
+      type: 'array',
+      items: devOnboardingAdapterConfigSchema,
+    },
+  },
+} as const;
+
+const responseHeaderSchema = {
+  type: 'object',
+  properties: {
+    name: { type: 'string' },
+    value: { type: 'string' },
+  },
+  additionalProperties: false,
+  required: ['name', 'value'],
+} as const;
+
+export const redoclyConfigSchema = {
+  type: 'object',
+  properties: {
+    licenseKey: { type: 'string' },
+    theme: { type: 'object', default: {} }, // ThemeConfig
+    redirects: { type: 'object', additionalProperties: redirectConfigSchema, default: {} },
+    seo: seoConfigSchema,
+    rbac: rbacConfigSchema,
+    responseHeaders: {
+      type: 'object',
+      additionalProperties: {
+        type: 'array',
+        items: responseHeaderSchema,
+      },
+    },
+    mockServer: {
+      type: 'object',
+      properties: {
+        off: { type: 'boolean', default: false },
+        position: { type: 'string', enum: ['first', 'last', 'replace', 'off'], default: 'first' },
+        strictExamples: { type: 'boolean', default: false },
+        errorIfForcedExampleNotFound: { type: 'boolean', default: false },
+        description: { type: 'string' },
+      },
+    },
+    apis: {
+      type: 'object',
+      additionalProperties: apiConfigSchema,
+    },
+    sso: ssoConfigSchema,
+    developerOnboarding: devOnboardingConfigSchema,
+    i18n: {
+      type: 'object',
+      properties: {
+        defaultLocale: {
+          type: 'string',
+        },
+        locales: {
+          type: 'array',
+          items: {
+            type: 'object',
+            properties: {
+              code: {
+                type: 'string',
+              },
+              name: {
+                type: 'string',
+              },
+            },
+            required: ['code'],
+          },
+        },
+      },
+      additionalProperties: false,
+      required: ['defaultLocale', 'locales'],
+    },
+    metadata: metadataConfigSchema,
+  },
+  default: {},
+  additionalProperties: true,
+} as const;
+
+export const environmentSchema = {
+  oneOf: [
+    { ...redoclyConfigSchema, additionalProperties: false },
+    {
+      type: 'object',
+      properties: {
+        $ref: { type: 'string' },
+      },
+      required: ['$ref'],
+      additionalProperties: false,
+    },
+  ],
+} as const;
+
+export const rootRedoclyConfigSchema = {
+  ...redoclyConfigSchema,
+  properties: {
+    ...redoclyConfigSchema.properties,
+    env: {
+      type: 'object',
+      additionalProperties: environmentSchema,
+    },
+  },
+  default: {},
+  required: ['redirects'],
+} as const;

package/src/types/redocly-yaml.ts

@@ -1,15 +1,7 @@
-import {
-  devOnboardingConfigSchema,
-  i18nConfigSchema,
-  mockServerConfigSchema,
-  rbacConfigSchema,
-  redirectConfigSchema,
-  responseHeaderSchema,
-  seoConfigSchema,
-  ssoConfigSchema,
-  themeConfigSchema,
-} from './config-external-schemas';
+import { rootRedoclyConfigSchema, apiConfigSchema } from './portal-config-schema';
+import { themeConfigSchema } from './theme-config';
 import { NodeType, listOf } from '.';
+import { Oas3_1Types } from './oas3_1';
 import { omitObjectProps, pickObjectProps, isCustomRuleId } from '../utils';
 
 const builtInRulesList = [
@@ -67,7 +59,10 @@ const builtInRulesList = [
   'required-string-property-missing-min-length',
   'spec-strict-refs',
   'component-name-unique',
+  'channels-kebab-case',
+  'no-channel-trailing-slash',
 ];
+
 const nodeTypesList = [
   'any',
   'Root',
@@ -128,6 +123,7 @@ const nodeTypesList = [
   'XCodeSampleList',
   'WebhooksMap',
   'SpecExtension',
+  'Message',
 ];
 
 const ConfigStyleguide: NodeType = {
@@ -165,12 +161,13 @@ const RootConfigStyleguide: NodeType = {
 
 const ConfigRoot: NodeType = {
   properties: {
-    organization: { type: 'string' },
-    apis: 'ConfigApis',
+    ...rootRedoclyConfigSchema.properties,
     ...RootConfigStyleguide.properties,
+    apis: 'ConfigApis',
     theme: 'ConfigRootTheme',
     'features.openapi': 'ConfigReferenceDocs', // deprecated
     'features.mockServer': 'ConfigMockServer', // deprecated
+    organization: { type: 'string' },
     region: { enum: ['us', 'eu'] },
     telemetry: { enum: ['on', 'off'] },
     resolve: {
@@ -185,15 +182,6 @@ const ConfigRoot: NodeType = {
         type: 'string',
       },
     },
-    redirects: { type: 'object', additionalProperties: redirectConfigSchema },
-    licenseKey: { type: 'string' },
-    seo: seoConfigSchema,
-    rbac: rbacConfigSchema,
-    responseHeaders: responseHeaderSchema,
-    mockServer: mockServerConfigSchema,
-    sso: ssoConfigSchema,
-    developerOnboarding: devOnboardingConfigSchema,
-    i18n: i18nConfigSchema,
   },
 };
 
@@ -204,6 +192,7 @@ const ConfigApis: NodeType = {
 
 const ConfigApisProperties: NodeType = {
   properties: {
+    ...apiConfigSchema.properties,
     root: { type: 'string' },
     labels: {
       type: 'array',
@@ -223,9 +212,6 @@ const ConfigApisProperties: NodeType = {
         type: 'string',
       },
     },
-    title: { type: 'string' },
-    rbac: { type: 'object' },
-    metadata: { type: 'object' },
   },
   required: ['root'],
 };
@@ -263,6 +249,8 @@ const Rules: NodeType = {
       } else {
         return 'ObjectRule';
       }
+    } else if (key === 'metadata-schema' || key === 'custom-fields-schema') {
+      return 'Schema';
     }
     // Otherwise is considered as invalid
     return;
@@ -572,7 +560,7 @@ const TryItButton: NodeType = {
   },
 };
 
-const Components: NodeType = {
+const ConfigThemeComponents: NodeType = {
   properties: {
     buttons: 'ButtonsConfig',
     httpBadges: 'HttpBadgesConfig',
@@ -619,7 +607,7 @@ const SchemaColorsConfig: NodeType = {
   },
 };
 
-const Schema: NodeType = {
+const ConfigThemeSchema: NodeType = {
   properties: {
     breakFieldNames: { type: 'boolean' },
     caretColor: { type: 'string' },
@@ -759,7 +747,7 @@ const CodeBlock: NodeType = {
   },
 };
 
-const Logo: NodeType = {
+const ConfigThemeLogo: NodeType = {
   properties: {
     gutter: { type: 'string' },
     maxHeight: { type: 'string' },
@@ -815,13 +803,13 @@ const ConfigTheme: NodeType = {
     breakpoints: 'Breakpoints',
     codeBlock: 'CodeBlock',
     colors: 'ThemeColors',
-    components: 'Components',
+    components: 'ConfigThemeComponents',
     layout: 'Layout',
-    logo: 'Logo',
+    logo: 'ConfigThemeLogo',
     fab: 'Fab',
     overrides: 'Overrides',
     rightPanel: 'RightPanel',
-    schema: 'Schema',
+    schema: 'ConfigThemeSchema',
     shape: 'Shape',
     sidebar: 'Sidebar',
     spacing: 'ThemeSpacing',
@@ -973,6 +961,7 @@ const ConfigMockServer: NodeType = {
 };
 
 export const ConfigTypes: Record<string, NodeType> = {
+  ...Oas3_1Types,
   Assert,
   ConfigRoot,
   ConfigApis,
@@ -1018,7 +1007,7 @@ export const ConfigTypes: Record<string, NodeType> = {
   LinksConfig,
   TokenProps,
   CodeBlock,
-  Logo,
+  ConfigThemeLogo,
   Fab,
   ButtonOverrides,
   Overrides,
@@ -1029,9 +1018,9 @@ export const ConfigTypes: Record<string, NodeType> = {
   ThemeSpacing,
   GenerateCodeSamples,
   GroupItemsConfig,
-  Components,
+  ConfigThemeComponents,
   Layout,
-  Schema,
+  ConfigThemeSchema,
   Sidebar,
   Heading,
   Typography,