import { OpenApiRefObject } from "../utils/cypher-to-openapi.util"; /** * Reference object for $ref schemas. */ export type RefObject = OpenApiRefObject; /** * Extended OpenAPI Schema Object for JSON:API schemas. * Includes all properties needed for complex OpenAPI schemas. */ export interface JsonApiSchemaObject { type?: string; format?: string; required?: string[]; properties?: Record; description?: string; example?: unknown; oneOf?: (JsonApiSchemaObject | RefObject)[]; allOf?: (JsonApiSchemaObject | RefObject)[]; minItems?: number; items?: JsonApiSchemaObject | RefObject; additionalProperties?: boolean; readOnly?: boolean; $ref?: string; } /** * JSON:API Resource Identifier schema. * Represents a reference to another resource: { type, id } */ export declare const JsonApiResourceIdentifierSchema: JsonApiSchemaObject; /** * JSON:API Relationship object schema. * Contains data (resource linkage) and optional links. */ export declare const JsonApiRelationshipSchema: JsonApiSchemaObject; /** * JSON:API Links object schema. */ export declare const JsonApiLinksSchema: JsonApiSchemaObject; /** * JSON:API Pagination Meta schema. */ export declare const JsonApiPaginationMetaSchema: JsonApiSchemaObject; /** * Creates a JSON:API single resource response schema. */ export declare function createSingleResourceResponseSchema(entitySchemaRef: string): JsonApiSchemaObject; /** * Creates a JSON:API collection response schema. */ export declare function createCollectionResponseSchema(entitySchemaRef: string): JsonApiSchemaObject; /** * Returns all base JSON:API schemas to register with Swagger. */ export declare function getBaseJsonApiSchemas(): Record; //# sourceMappingURL=jsonapi-base.schemas.d.ts.map