@prefecthq/prefect-ui-library/src/models/api/SchemaResponse.ts

This library is the Vue and Typescript component library for [Prefect 2](https://github.com/PrefectHQ/prefect) and [Prefect Cloud 2](https://www.prefect.io/cloud/). _The components and utilities in this project are not meant to be used independently_.

import { SchemaReference, SchemaType, SchemaStringFormat, SchemaEnum } from '@/types/schemas'

export type BlockSchemaReferenceResponse = {
  block_schema_checksum: string,
  block_type_slug: string,
}

export type BlockSchemaReferencesResponse = Record<string, BlockSchemaReferenceResponse | undefined>

export type SchemaPropertiesResponse = Record<string, SchemaPropertyResponse | undefined>
export type SchemaDefinitionsResponse = Record<string, SchemaResponse | undefined>

export type SchemaPropertyResponse = {
  // prefect specific properties
  block_type_slug?: string,

  // open api properties
  $ref?: SchemaReference,
  anyOf?: SchemaResponse[],
  allOf?: SchemaResponse[],
  example?: string,
  alias?: string,
  default?: unknown,
  description?: string,
  enum?: SchemaEnum<unknown>,
  exclusiveMaximum?: number,
  exclusiveMinimum?: number,
  format?: SchemaStringFormat,
  items?: SchemaPropertyResponse,
  maximum?: number,
  maxItems?: number,
  maxLength?: number,
  minimum?: number,
  minItems?: number,
  minLength?: number,
  multipleOf?: number,
  pattern?: string,
  properties?: SchemaPropertiesResponse,
  required?: string[],
  title?: string,
  type?: SchemaType,
  uniqueItems?: boolean,
}

export type SchemaResponse = SchemaPropertyResponse & {
  // prefect specific properties
  block_schema_references?: BlockSchemaReferenceResponse,
  secret_fields?: string[],

  // open api properties
  definitions?: SchemaDefinitionsResponse,
}