@kubb/agent 4.33.1 → 4.33.2

package/.output/server/node_modules/@redocly/config/lib/entities-catalog-entity-file-schema.js

@@ -0,0 +1,283 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.entityFileDefaultSchema = 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 entities_1 = require("./constants/entities");
+exports.userMetadataSchema = {
+    type: 'object',
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.UserEntityMetadata,
+    properties: {
+        email: {
+            type: 'string',
+            description: 'Email of the user',
+        },
+    },
+    required: ['email'],
+    additionalProperties: true,
+};
+exports.apiDescriptionMetadataSchema = {
+    type: 'object',
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiDescriptionEntityMetadata,
+    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',
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiOperationEntityMetadata,
+    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',
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.DataSchemaEntityMetadata,
+    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',
+        },
+        sdl: {
+            type: 'string',
+            description: 'SDL of the data structure',
+        },
+    },
+    required: ['specType'],
+    additionalProperties: true,
+};
+exports.defaultMetadataSchema = {
+    type: 'object',
+    properties: {},
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityMetadata,
+    additionalProperties: true,
+};
+exports.slackChannelFileSchema = {
+    type: 'object',
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntitySlackChannel,
+    properties: {
+        name: {
+            type: 'string',
+            minLength: 2,
+            maxLength: 150,
+        },
+        url: {
+            type: 'string',
+        },
+    },
+    required: ['name'],
+    additionalProperties: false,
+};
+exports.slackContactFileSchema = {
+    type: 'object',
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntitySlackContact,
+    properties: {
+        channels: {
+            type: 'array',
+            items: exports.slackChannelFileSchema,
+        },
+    },
+    required: ['channels'],
+    additionalProperties: false,
+};
+exports.entityContactFileSchema = {
+    type: 'object',
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityContact,
+    properties: {
+        slack: exports.slackContactFileSchema,
+    },
+    additionalProperties: false,
+};
+exports.entityLinkFileSchema = {
+    type: 'object',
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityLink,
+    properties: {
+        label: {
+            type: 'string',
+            minLength: 2,
+            maxLength: 150,
+        },
+        url: {
+            type: 'string',
+        },
+    },
+    required: ['label', 'url'],
+    additionalProperties: false,
+};
+exports.entityRelationFileSchema = {
+    type: 'object',
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityRelation,
+    properties: {
+        type: {
+            type: 'string',
+            enum: entities_1.ENTITY_RELATION_TYPES,
+        },
+        key: {
+            type: 'string',
+            minLength: 2,
+            maxLength: 100,
+        },
+        version: {
+            type: 'string',
+        },
+        revision: {
+            type: 'string',
+        },
+    },
+    required: ['type', 'key'],
+    additionalProperties: false,
+};
+// Base entity schema properties
+exports.entityBaseProperties = {
+    version: {
+        type: 'string',
+    },
+    key: {
+        type: 'string',
+        pattern: '^[a-z0-9]+(?:-[a-z0-9]+)*$',
+        minLength: 2,
+        maxLength: 150,
+    },
+    type: {
+        type: 'string',
+        enum: ['user', 'data-schema', 'api-operation', 'api-description', 'service', 'domain', 'team'],
+    },
+    title: {
+        type: 'string',
+        minLength: 2,
+        maxLength: 200,
+    },
+    summary: {
+        type: 'string',
+        minLength: 1,
+        maxLength: 500,
+    },
+    tags: {
+        type: 'array',
+        items: {
+            type: 'string',
+            minLength: 1,
+            maxLength: 50,
+        },
+    },
+    git: {
+        type: 'array',
+        items: {
+            type: 'string',
+        },
+    },
+    contact: exports.entityContactFileSchema,
+    links: {
+        type: 'array',
+        nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityLinkList,
+        items: exports.entityLinkFileSchema,
+    },
+    relations: {
+        type: 'array',
+        nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.EntityRelationList,
+        items: exports.entityRelationFileSchema,
+    },
+    metadata: exports.defaultMetadataSchema,
+};
+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,
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.UserEntity,
+        },
+        {
+            type: 'object',
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiOperationEntity,
+            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'api-operation' }, metadata: exports.apiOperationMetadataSchema }),
+            required: ['key', 'title', 'type', 'metadata'],
+            additionalProperties: false,
+        },
+        {
+            type: 'object',
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.DataSchemaEntity,
+            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'data-schema' }, metadata: exports.dataSchemaMetadataSchema }),
+            required: ['key', 'title', 'type', 'metadata'],
+            additionalProperties: false,
+        },
+        {
+            type: 'object',
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ApiDescriptionEntity,
+            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'api-description' }, metadata: exports.apiDescriptionMetadataSchema }),
+            required: ['key', 'title', 'type', 'metadata'],
+            additionalProperties: false,
+        },
+        {
+            type: 'object',
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.ServiceEntity,
+            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'service' } }),
+            required: ['key', 'title', 'type'],
+            additionalProperties: false,
+        },
+        {
+            type: 'object',
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.DomainEntity,
+            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'domain' } }),
+            required: ['key', 'title', 'type'],
+            additionalProperties: false,
+        },
+        {
+            type: 'object',
+            nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.TeamEntity,
+            properties: Object.assign(Object.assign({}, exports.entityBaseProperties), { type: { const: 'team' } }),
+            required: ['key', 'title', 'type'],
+            additionalProperties: false,
+        },
+    ],
+};
+exports.entityFileDefaultSchema = {
+    type: 'object',
+    nodeTypeName: entities_1.ENTITY_NODE_TYPE_NAMES.Entity,
+    properties: Object.assign({}, exports.entityBaseProperties),
+    required: ['key', 'title', 'type'],
+    additionalProperties: false,
+};
+//# sourceMappingURL=entities-catalog-entity-file-schema.js.map