@redocly/config 0.32.0 → 0.34.0

package/lib/entities-catalog-entity-file-schema.js

@@ -0,0 +1,273 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.entityFileSchema = exports.entityBaseProperties = exports.entityRelationFileSchema = exports.entityLinkFileSchema = exports.entityContactFileSchema = exports.slackContactFileSchema = exports.slackChannelFileSchema = exports.defaultMetadataSchema = exports.dataSchemaMetadataSchema = exports.apiOperationMetadataSchema = exports.apiDescriptionMetadataSchema = exports.userMetadataSchema = void 0;
+const constants_1 = require("./constants");
+exports.userMetadataSchema = {
+    type: 'object',
+    properties: {
+        email: {
+            type: 'string',
+            description: 'Email of the user',
+        },
+    },
+    required: ['email'],
+    additionalProperties: true,
+};
+exports.apiDescriptionMetadataSchema = {
+    type: 'object',
+    properties: {
+        specType: {
+            type: 'string',
+            enum: ['jsonschema', 'openapi', 'asyncapi', 'avro', 'zod', 'graphql', 'protobuf', 'arazzo'],
+            description: 'Type of the API description',
+        },
+        descriptionFile: {
+            type: 'string',
+            description: 'Path to the file containing the API description',
+        },
+    },
+    required: ['specType', 'descriptionFile'],
+    additionalProperties: true,
+};
+exports.apiOperationMetadataSchema = {
+    type: 'object',
+    properties: {
+        method: {
+            type: 'string',
+            enum: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'MUTATION', 'QUERY', 'SUBSCRIBE', 'PUBLISH'],
+            description: 'HTTP method of the API operation',
+        },
+        path: {
+            type: 'string',
+            description: 'Path of the API operation',
+        },
+        payload: {
+            type: 'array',
+            items: {
+                type: 'string',
+                description: 'Related dataSchema name',
+            },
+        },
+        responses: {
+            type: 'array',
+            items: {
+                type: 'string',
+                description: 'Related dataSchema name',
+            },
+        },
+    },
+    required: ['method', 'path'],
+    additionalProperties: true,
+};
+exports.dataSchemaMetadataSchema = {
+    type: 'object',
+    properties: {
+        specType: {
+            type: 'string',
+            enum: ['jsonschema', 'openapi', 'asyncapi', 'avro', 'zod', 'graphql', 'protobuf', 'arazzo'],
+            description: 'Specification type of the data schema',
+        },
+        schema: {
+            type: 'string',
+            description: 'Inline schema of the data structure',
+        },
+    },
+    required: ['specType', 'schema'],
+    additionalProperties: true,
+};
+exports.defaultMetadataSchema = {
+    type: 'object',
+    additionalProperties: true,
+};
+exports.slackChannelFileSchema = {
+    type: 'object',
+    properties: {
+        name: {
+            type: 'string',
+            minLength: 2,
+            maxLength: 150,
+        },
+    },
+    required: ['name'],
+    additionalProperties: false,
+};
+exports.slackContactFileSchema = {
+    type: 'object',
+    properties: {
+        channels: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    name: {
+                        type: 'string',
+                        minLength: 2,
+                        maxLength: 150,
+                    },
+                },
+                required: ['name'],
+                additionalProperties: false,
+            },
+        },
+    },
+    required: ['channels'],
+    additionalProperties: false,
+};
+exports.entityContactFileSchema = {
+    type: 'object',
+    properties: {
+        slack: {
+            type: 'object',
+            properties: {
+                channels: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            name: {
+                                type: 'string',
+                                minLength: 2,
+                                maxLength: 150,
+                            },
+                            url: {
+                                type: 'string',
+                            },
+                        },
+                        required: ['name'],
+                        additionalProperties: false,
+                    },
+                },
+            },
+            required: ['channels'],
+            additionalProperties: false,
+        },
+    },
+    additionalProperties: false,
+};
+exports.entityLinkFileSchema = {
+    type: 'object',
+    properties: {
+        label: {
+            type: 'string',
+            minLength: 2,
+            maxLength: 150,
+        },
+        url: {
+            type: 'string',
+        },
+    },
+    required: ['label', 'url'],
+    additionalProperties: false,
+};
+exports.entityRelationFileSchema = {
+    type: 'object',
+    properties: {
+        type: {
+            type: 'string',
+            enum: constants_1.ENTITY_RELATION_TYPES,
+        },
+        key: {
+            type: 'string',
+            minLength: 2,
+            maxLength: 100,
+        },
+    },
+    required: ['type', 'key'],
+    additionalProperties: false,
+};
+// Base entity schema properties
+exports.entityBaseProperties = {
+    key: {
+        type: 'string',
+        pattern: '^[a-z0-9]+(?:-[a-z0-9]+)*$',
+        minLength: 2,
+        maxLength: 150,
+    },
+    title: {
+        type: 'string',
+        minLength: 2,
+        maxLength: 200,
+    },
+    summary: {
+        type: ['string', 'null'],
+        minLength: 1,
+        maxLength: 500,
+    },
+    tags: {
+        type: ['array', 'null'],
+        items: {
+            type: 'string',
+            minLength: 1,
+            maxLength: 50,
+        },
+    },
+    git: {
+        type: ['array', 'null'],
+        items: {
+            type: 'string',
+        },
+    },
+    contact: {
+        anyOf: [{ type: 'null' }, exports.entityContactFileSchema],
+    },
+    links: {
+        anyOf: [
+            { type: 'null' },
+            {
+                type: 'array',
+                items: exports.entityLinkFileSchema,
+            },
+        ],
+    },
+    relations: {
+        anyOf: [
+            { type: 'null' },
+            {
+                type: 'array',
+                items: exports.entityRelationFileSchema,
+            },
+        ],
+    },
+};
+exports.entityFileSchema = {
+    type: 'object',
+    discriminator: {
+        propertyName: 'type',
+    },
+    oneOf: [
+        {
+            type: 'object',
+            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'user' }, metadata: exports.userMetadataSchema }),
+            required: ['key', 'title', 'type', 'metadata'],
+            additionalProperties: false,
+        },
+        {
+            type: 'object',
+            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'api-operation' }, metadata: exports.apiOperationMetadataSchema }),
+            required: ['key', 'title', 'type', 'metadata'],
+            additionalProperties: false,
+        },
+        {
+            type: 'object',
+            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'data-schema' }, metadata: exports.dataSchemaMetadataSchema }),
+            required: ['key', 'title', 'type', 'metadata'],
+            additionalProperties: false,
+        },
+        {
+            type: 'object',
+            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'api-description' }, metadata: exports.apiDescriptionMetadataSchema }),
+            required: ['key', 'title', 'type', 'metadata'],
+            additionalProperties: false,
+        },
+        {
+            type: 'object',
+            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { enum: ['service', 'domain', 'team'] }, metadata: {
+                    type: ['object', 'null'],
+                    additionalProperties: true,
+                } }),
+            required: ['key', 'title', 'type'],
+            additionalProperties: false,
+        },
+    ],
+};
+//# sourceMappingURL=entities-catalog-entity-file-schema.js.map

package/lib/ex-theme-config-schemas.d.ts

@@ -1114,7 +1114,7 @@ export declare const markdownConfigSchema: {
             readonly items: {
                 readonly type: "string";
             };
-            readonly default: readonly ["_partials"];
+            readonly default: readonly ["**/_partials/**"];
         };
         readonly lastUpdatedBlock: {
             readonly type: "object";
@@ -2970,6 +2970,9 @@ export declare const openapiConfigSchema: {
         readonly excludeFromSearch: {
             readonly type: "boolean";
         };
+        readonly showSchemaCatalogLinks: {
+            readonly type: "boolean";
+        };
     };
     readonly type: "object";
     readonly additionalProperties: false;

package/lib/ex-theme-config-schemas.js

@@ -303,7 +303,7 @@ exports.markdownConfigSchema = {
         partialsFolders: {
             type: 'array',
             items: { type: 'string' },
-            default: ['_partials'],
+            default: ['**/_partials/**'],
         },
         lastUpdatedBlock: {
             type: 'object',

package/lib/graphql-config-schema.d.ts

@@ -435,6 +435,16 @@ export declare const graphqlConfigSchema: {
             };
             readonly additionalProperties: false;
         };
+        readonly layout: {
+            readonly type: "string";
+            readonly enum: readonly ["stacked", "three-panel"];
+        };
+        readonly showBuiltInScalars: {
+            readonly type: "boolean";
+        };
+        readonly showBuiltInDirectives: {
+            readonly type: "boolean";
+        };
     };
     readonly additionalProperties: false;
 };

package/lib/graphql-config-schema.js

@@ -113,6 +113,13 @@ exports.graphqlConfigSchema = {
             additionalProperties: true,
         },
         feedback: feedback_config_schema_1.feedbackConfigSchema,
+        layout: { type: 'string', enum: ['stacked', 'three-panel'] },
+        showBuiltInScalars: {
+            type: 'boolean',
+        },
+        showBuiltInDirectives: {
+            type: 'boolean',
+        },
     },
     additionalProperties: false,
 };

package/lib/index.d.ts

@@ -2,4 +2,5 @@ export { productThemeOverrideSchema, productConfigOverrideSchema } from './produ
 export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema';
 export { redocConfigSchema } from './redoc-config-schema';
 export * from './types';
-export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, } from './constants';
+export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, ENTITY_RELATION_TYPES, } from './constants';
+export * from './entities-catalog-entity-file-schema';

package/lib/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.LayoutVariant = exports.DEFAULT_TEAM_CLAIM_NAME = exports.AuthProviderType = exports.ApigeeDevOnboardingIntegrationAuthType = exports.redocConfigSchema = exports.rootRedoclyConfigSchema = exports.rbacConfigSchema = exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = void 0;
+exports.ENTITY_RELATION_TYPES = exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.LayoutVariant = exports.DEFAULT_TEAM_CLAIM_NAME = exports.AuthProviderType = exports.ApigeeDevOnboardingIntegrationAuthType = exports.redocConfigSchema = exports.rootRedoclyConfigSchema = exports.rbacConfigSchema = exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = void 0;
 var product_override_schema_1 = require("./product-override-schema");
 Object.defineProperty(exports, "productThemeOverrideSchema", { enumerable: true, get: function () { return product_override_schema_1.productThemeOverrideSchema; } });
 Object.defineProperty(exports, "productConfigOverrideSchema", { enumerable: true, get: function () { return product_override_schema_1.productConfigOverrideSchema; } });
@@ -31,4 +31,6 @@ Object.defineProperty(exports, "DEFAULT_TEAM_CLAIM_NAME", { enumerable: true, ge
 Object.defineProperty(exports, "LayoutVariant", { enumerable: true, get: function () { return constants_1.LayoutVariant; } });
 Object.defineProperty(exports, "REDOCLY_TEAMS_RBAC", { enumerable: true, get: function () { return constants_1.REDOCLY_TEAMS_RBAC; } });
 Object.defineProperty(exports, "REDOCLY_ROUTE_RBAC", { enumerable: true, get: function () { return constants_1.REDOCLY_ROUTE_RBAC; } });
+Object.defineProperty(exports, "ENTITY_RELATION_TYPES", { enumerable: true, get: function () { return constants_1.ENTITY_RELATION_TYPES; } });
+__exportStar(require("./entities-catalog-entity-file-schema"), exports);
 //# sourceMappingURL=index.js.map

package/lib/product-override-schema.d.ts

@@ -2429,6 +2429,9 @@ export declare const productThemeOverrideSchema: {
                 readonly excludeFromSearch: {
                     readonly type: "boolean";
                 };
+                readonly showSchemaCatalogLinks: {
+                    readonly type: "boolean";
+                };
             };
             readonly type: "object";
             readonly additionalProperties: false;
@@ -4676,6 +4679,9 @@ export declare const productConfigOverrideSchema: {
                             readonly excludeFromSearch: {
                                 readonly type: "boolean";
                             };
+                            readonly showSchemaCatalogLinks: {
+                                readonly type: "boolean";
+                            };
                         };
                         readonly type: "object";
                         readonly additionalProperties: false;
@@ -5117,6 +5123,16 @@ export declare const productConfigOverrideSchema: {
                                 };
                                 readonly additionalProperties: false;
                             };
+                            readonly layout: {
+                                readonly type: "string";
+                                readonly enum: readonly ["stacked", "three-panel"];
+                            };
+                            readonly showBuiltInScalars: {
+                                readonly type: "boolean";
+                            };
+                            readonly showBuiltInDirectives: {
+                                readonly type: "boolean";
+                            };
                         };
                         readonly additionalProperties: false;
                     };
@@ -6923,6 +6939,9 @@ export declare const productConfigOverrideSchema: {
                                     readonly excludeFromSearch: {
                                         readonly type: "boolean";
                                     };
+                                    readonly showSchemaCatalogLinks: {
+                                        readonly type: "boolean";
+                                    };
                                 };
                                 readonly type: "object";
                                 readonly additionalProperties: false;
@@ -7364,6 +7383,16 @@ export declare const productConfigOverrideSchema: {
                                         };
                                         readonly additionalProperties: false;
                                     };
+                                    readonly layout: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["stacked", "three-panel"];
+                                    };
+                                    readonly showBuiltInScalars: {
+                                        readonly type: "boolean";
+                                    };
+                                    readonly showBuiltInDirectives: {
+                                        readonly type: "boolean";
+                                    };
                                 };
                                 readonly additionalProperties: false;
                             };
@@ -9815,6 +9844,9 @@ export declare const productConfigOverrideSchema: {
                         readonly excludeFromSearch: {
                             readonly type: "boolean";
                         };
+                        readonly showSchemaCatalogLinks: {
+                            readonly type: "boolean";
+                        };
                     };
                     readonly type: "object";
                     readonly additionalProperties: false;
@@ -12520,6 +12552,9 @@ export declare const productConfigOverrideSchema: {
                 readonly excludeFromSearch: {
                     readonly type: "boolean";
                 };
+                readonly showSchemaCatalogLinks: {
+                    readonly type: "boolean";
+                };
             };
             readonly type: "object";
             readonly additionalProperties: false;

package/lib/redoc-config-schema.d.ts

@@ -443,6 +443,9 @@ export declare const redocConfigSchema: {
         readonly excludeFromSearch: {
             readonly type: "boolean";
         };
+        readonly showSchemaCatalogLinks: {
+            readonly type: "boolean";
+        };
     };
     readonly additionalProperties: false;
 };

package/lib/redoc-config-schema.js

@@ -113,6 +113,7 @@ exports.redocConfigSchema = {
         },
         hidePropertiesPrefix: { type: 'boolean' },
         excludeFromSearch: { type: 'boolean' },
+        showSchemaCatalogLinks: { type: 'boolean' },
     },
     additionalProperties: false,
 };

package/lib/reunite-config-schema.d.ts

@@ -28,7 +28,7 @@ export declare const reuniteConfigSchema: {
                 readonly properties: {
                     readonly path: {
                         readonly type: "string";
-                        readonly pattern: "^(?!\\.\\./)(/[a-zA-Z0-9_\\-\\./]+|./[a-zA-Z0-9_\\-\\./]+|[a-zA-Z0-9_\\-\\./]+)$";
+                        readonly pattern: "^(?!\\/|\\.\\./)";
                     };
                     readonly agent: {
                         readonly type: "string";

package/lib/reunite-config-schema.js

@@ -71,7 +71,7 @@ exports.reuniteConfigSchema = {
                 properties: {
                     path: {
                         type: 'string',
-                        pattern: '^(?!\\.\\./)(/[a-zA-Z0-9_\\-\\./]+|./[a-zA-Z0-9_\\-\\./]+|[a-zA-Z0-9_\\-\\./]+)$',
+                        pattern: '^(?!\\/|\\.\\./)',
                     },
                     agent: {
                         type: 'string',