$schema: https://json-schema.org/draft/2020-12/schema
$id: OrgSuccessionRelationship.yaml
type: object
properties:
  org:
    $ref: OrgRef.yaml
    description: The other organization.
  kind:
    type: object
    properties:
      value:
        $ref: OrgSuccessionKindOptions.yaml
        description: The selected value, from a predefined set of options
      customValue:
        type: string
        description: A custom value, used when the selected value is the `custom` option
      description:
        type: string
        description: A human-readable description of the value
    required:
      - value
    description: The relationship's subtype within the category its list names.
  startDate:
    $ref: isoDate.yaml
    description: 'When the relationship started, in ISO 8601 format: YYYY-MM-DD'
  endDate:
    $ref: isoDate.yaml
    description: 'When the relationship ended, in ISO 8601 format: YYYY-MM-DD'
  status:
    $ref: OrgRelationshipStatus.yaml
    description: Whether the relationship is in effect, as stated by the provider.
required:
  - org
examples:
  - org:
      id: 01912a8b-7c3d-7893-abcd-ef1234567893
      name: Riverside Reading East
    kind:
      value: split
    startDate: '2026-01-01'
description: A succession relationship.
