n8n-nodes-semble v2.1.0

n8n-nodes-semble / services/FieldDiscoveryService / FieldMetadata

Interface: FieldMetadata¶

Defined in: services/FieldDiscoveryService.ts:185

Comprehensive metadata interface for GraphQL fields

Contains detailed information about individual GraphQL fields including type information, validation rules, permission constraints, and usage context. This is the primary data structure for field-level introspection results.

Example¶

const fieldMetadata: FieldMetadata = {
  name: 'firstName',
  type: 'String!',
  description: 'The patient\'s first name',
  required: true,
  deprecated: false,
  permissions: {
    read: true,
    write: true,
    restricted: false
  },
  validation: {
    minLength: 1,
    maxLength: 50,
    pattern: '^[A-Za-z]+$'
  }
};

FieldMetadata

Since¶

2.0.0

Properties¶

name¶

name: string

Defined in: services/FieldDiscoveryService.ts:187

The field name as it appears in the GraphQL schema

type¶

type: string

Defined in: services/FieldDiscoveryService.ts:189

The GraphQL type specification (e.g., 'String!', '[Patient]')

description?¶

optional description: string

Defined in: services/FieldDiscoveryService.ts:191

Human-readable description from schema documentation

isRequired¶

isRequired: boolean

Defined in: services/FieldDiscoveryService.ts:192

isDeprecated¶

isDeprecated: boolean

Defined in: services/FieldDiscoveryService.ts:193

deprecationReason?¶

optional deprecationReason: string

Defined in: services/FieldDiscoveryService.ts:194

defaultValue?¶

optional defaultValue: any

Defined in: services/FieldDiscoveryService.ts:195

permissions?¶

optional permissions: string[]

Defined in: services/FieldDiscoveryService.ts:196

validationRules?¶

optional validationRules: Record\<string, any>

Defined in: services/FieldDiscoveryService.ts:197

examples?¶

optional examples: any[]

Defined in: services/FieldDiscoveryService.ts:198