edoxen 0.1.2 → 0.3.0

data/schema/edoxen.yaml

@@ -1,57 +1,32 @@
-# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
 ---
 $schema: "http://json-schema.org/draft-07/schema#"
 $id: "https://github.com/metanorma/edoxen/schema/edoxen.yaml"
-title: "Edoxen Resolution Set Schema"
-description: "Schema for validating Edoxen resolution set YAML files"
+title: "Edoxen Resolution Collection Schema"
+description: |
+  Schema for validating Edoxen ResolutionCollection YAML files.
+
+  Mirrors the canonical LutaML information model in
+  https://github.com/metanorma/edoxen-model/tree/main/models .
+
+  The enum constants declared under `$defs` (ActionType,
+  ConsiderationType, ApprovalType, ApprovalDegree, ResolutionType,
+  ResolutionDateType, ResolutionRelationType, UrlKind) are the
+  authoritative wire values. `spec/edoxen/schema_enum_sync_spec.rb`
+  asserts each one is character-for-character identical to the
+  corresponding `Edoxen::Enums::*` frozen array.
+
+  Trade-off: json_schemer's `valid_values` is not populated when an
+  `enum` is reached via `$ref`, so the validator's enum-violation
+  message degrades to "value ... is not one of: (see schema)". This
+  is documented in `Edoxen::SchemaValidator#format_message`.
 type: object
+additionalProperties: false
 
 properties:
   metadata:
-    type: object
-    description: "Metadata about the resolution set"
-    properties:
-      title:
-        type: string
-        description: "Title of the resolution set"
-      identifier:
-        type: string
-        description: "Identifier for the resolution set (e.g., '2019-01')"
-      dates:
-        type: array
-        description: "Array of dates related to the set"
-        items:
-          $ref: "#/$defs/ComplexDate"
-      source:
-        type: string
-        description: "Source organization or secretariat"
-      venue:
-        type: string
-        description: "Meeting venue"
-      chair:
-        type: string
-        description: "Meeting chair"
-      attendees:
-        type: array
-        items:
-          type: string
-        description: "List of attendees"
-      apologies:
-        type: array
-        items:
-          type: string
-        description: "List of apologies"
-      urls:
-        type: array
-        items:
-          $ref: "#/$defs/Url"
-        description: "Array of URLs related to the resolution set"
-
-    additionalProperties: false
-
+    $ref: "#/$defs/ResolutionMetadata"
   resolutions:
     type: array
-    description: "Array of resolutions"
     items:
       $ref: "#/$defs/Resolution"
 
@@ -59,363 +34,349 @@ required:
   - resolutions
 
 $defs:
-  Resolution:
-    type: object
-    description: "A single resolution"
-    properties:
-      identifier:
-        oneOf:
-          - type: string
-          - type: integer
-        description: "Resolution identifier (e.g., '2019-01' or 1)"
-
-      title:
-        type: string
-        description: "Resolution title"
-
-      type:
-        type: string
-        enum:
-          - "resolution"
-          - "recommendation"
-          - "decision"
-          - "declaration"
-        description: "Type of resolution"
-
-      categories:
-        type: array
-        items:
-          type: string
-        description: "Resolution categories"
-
-      subject:
-        type: string
-        description: "Subject or scope of the resolution"
 
-      dates:
-        type: array
-        items:
-          $ref: "#/$defs/ComplexDate"
-        description: "Array of relevant dates with start/end structure"
+  # ====================================================================
+  # Identifiers and references.
+  # ====================================================================
 
-      message:
+  StructuredIdentifier:
+    type: object
+    description: "A resolution identifier (prefix + number). A Resolution may carry 1..* of these."
+    additionalProperties: false
+    required: [prefix, number]
+    properties:
+      prefix:
         type: string
-        description: "Resolution message"
-
-      considering:
+        description: "Authority prefix, e.g. 'ISO', 'OIML', 'CIML'."
+      number:
         type: string
-        description: "Considering clause"
-
-      considerations:
-        type: array
-        items:
-          $ref: "#/$defs/Consideration"
-        description: "Array of considerations leading to the resolution"
-
-      approvals:
-        type: array
-        items:
-          $ref: "#/$defs/Approval"
-        description: "Approval information"
-
-      actions:
-        type: array
-        items:
-          $ref: "#/$defs/Action"
-        description: "Actions taken in the resolution"
-
-      urls:
-        type: array
-        items:
-          $ref: "#/$defs/Url"
-        description: "Array of URLs related to the resolution"
-
-      meeting:
-        $ref: "#/$defs/MeetingIdentifier"
-        description: "Meeting information"
+        description: "Resolution number issued under that prefix."
 
-      relations:
-        type: array
-        items:
-          $ref: "#/$defs/ResolutionRelations"
-        description: "Relations to other resolutions"
-
-    additionalProperties: false
-    required:
-      - subject
-      - identifier
-      - actions
-
-  ComplexDate:
+  MeetingIdentifier:
     type: object
-    description: "Date with start and end"
+    description: "Identifies the meeting a Resolution belongs to."
+    additionalProperties: false
     properties:
-      start:
+      venue:
         type: string
-        format: date
-        description: "Start date or single date if no end date"
-      end:
+        description: "Meeting venue name (free text)."
+      date:
         type: string
         format: date
-        description: "End date (optional)"
-      kind:
-        type: string
-        enum:
-          - "enactment"
-          - "ballot"
-          - "effective"
-          - "decision"
-          - "meeting"
-        description: "Kind of date (e.g., enactment, ballot, effective)"
-    required:
-    - kind
-    additionalProperties: false
+        description: "Meeting date."
 
   Url:
     type: object
-    description: "URL with kind and reference"
+    description: "URL with a kind (access / report) and an optional format hint."
+    additionalProperties: false
+    required: [kind, ref]
     properties:
       kind:
-        type: string
-        enum:
-          - "access"
-          - "report"
-        description: "Kind of URL (e.g., access, report)"
+        $ref: "#/$defs/UrlKind"
       ref:
         type: string
-        description: "Reference URL"
       format:
         type: string
-        description: "Format of the URL (e.g., 'html', 'pdf')"
-    additionalProperties: false
 
-  Consideration:
+  ResolutionRelation:
     type: object
-    description: "A consideration leading to a resolution"
+    description: "Directed relation between two resolutions identified by their StructuredIdentifier."
+    additionalProperties: false
+    required: [source, destination, type]
     properties:
+      source:
+        $ref: "#/$defs/StructuredIdentifier"
+      destination:
+        $ref: "#/$defs/StructuredIdentifier"
       type:
-        type: string
-        enum:
-          - "acknowledging"
-          - "following"
-          - "basing"
-          - "considering"
-          - "identifying"
-          - "according"
-          - "noting"
-          - "recalling"
-          - "recognises"
-          - "recognising"
-          - "recognizing"
-        description: "Type of consideration"
+        $ref: "#/$defs/ResolutionRelationType"
 
-      dates:
-        type: array
-        items:
-          $ref: "#/$defs/ComplexDate"
+  # ====================================================================
+  # Date carriers.
+  # ====================================================================
 
-      message:
+  ResolutionDate:
+    type: object
+    description: "Date with semantic kind (adoption / drafted / discussed)."
+    additionalProperties: false
+    required: [date, type]
+    properties:
+      date:
         type: string
-        description: "Consideration text"
+        format: date
+        description: "The date itself."
+      type:
+        $ref: "#/$defs/ResolutionDateType"
 
-      subject:
-        type: string
-        description: "Subject of the consideration"
+  # ====================================================================
+  # Per-localization sub-structures. Each is owned by exactly one
+  # Language; the language_code discriminator lives on Localization.
+  # ====================================================================
 
-    required:
-    - type
-    - message
+  Action:
+    type: object
+    description: "A verb + one effective date + human-readable message."
     additionalProperties: false
+    required: [type, message, date_effective]
+    properties:
+      type:
+        $ref: "#/$defs/ActionType"
+      date_effective:
+        $ref: "#/$defs/ResolutionDate"
+      message:
+        type: string
 
   Approval:
     type: object
-    description: "Approval information for a resolution"
+    description: "Approval record: vote type, consensus degree, date, message."
+    additionalProperties: false
+    required: [type, degree, date]
     properties:
       type:
-        type: string
-        enum:
-          - "affirmative"
-          - "negative"
-        description: "Type of approval"
-
+        $ref: "#/$defs/ApprovalType"
       degree:
-        type: string
-        enum:
-          - "unanimous"
-          - "majority"
-          - "minority"
-        description: "Degree of approval"
-
+        $ref: "#/$defs/ApprovalDegree"
+      date:
+        $ref: "#/$defs/ResolutionDate"
       message:
         type: string
-        description: "Approval details"
-
-    additionalProperties: false
 
-  Action:
+  Consideration:
     type: object
-    description: "An action taken in a resolution"
-    required:
-      - type
-      - message
+    description: "The basis for a Resolution: a verb + one effective date + reasoning."
+    additionalProperties: false
+    required: [type, message, date_effective]
     properties:
       type:
-        type: string
-        enum:
-          - "accepts"
-          - "acknowledges"
-          - "adoption"
-          - "adopts"
-          - "agrees"
-          - "allocates"
-          - "appoints"
-          - "appreciates"
-          - "appreciation"
-          - "approves"
-          - "asks"
-          - "assigns"
-          - "chairs"
-          - "communicating"
-          - "confirms"
-          - "considers"
-          - "consults"
-          - "creates"
-          - "decides"
-          - "defines"
-          - "delegates"
-          - "delivering"
-          - "directs"
-          - "disbands"
-          - "drafting"
-          - "elects"
-          - "empowers"
-          - "encourages"
-          - "endorses"
-          - "estabilishes"
-          - "establishes"
-          - "gathering"
-          - "identifies"
-          - "instructs"
-          - "investigates"
-          - "nominates"
-          - "notes"
-          - "notifies"
-          - "recognises"
-          - "recognizes"
-          - "reminds"
-          - "recommends"
-          - "registers"
-          - "regrets"
-          - "request"
-          - "replaces"
-          - "requests"
-          - "resolves"
-          - "restates"
-          - "scopes"
-          - "secures"
-          - "sends"
-          - "supports"
-          - "thanks"
-          - "welcomes"
-          - "withdraws"
-        description: "Type of action"
-
-      dates:
-        type: array
-        items:
-          $ref: "#/$defs/ComplexDate"
-        description: "Dates of the action"
-
+        $ref: "#/$defs/ConsiderationType"
+      date_effective:
+        $ref: "#/$defs/ResolutionDate"
       message:
         type: string
-        description: "Action text"
 
+  Localization:
+    type: object
+    description: |
+      A monolingual rendering of a Resolution. Mirrors the glossarist
+      LocalizedConcept pattern: language-agnostic fields live on the
+      parent Resolution; per-language content lives here.
+    additionalProperties: false
+    required: [language_code]
+    properties:
+      language_code:
+        type: string
+        pattern: "^[a-z]{3}$"
+        description: "ISO 639-3 three-letter language code (eng, fra, deu, spa, jpn, ...)."
+      script:
+        type: string
+        pattern: "^[A-Z][a-z]{3}$"
+        description: "ISO 15924 four-letter script code (Latn, Cyrl, Hant, Arab)."
+      title:
+        type: string
       subject:
         type: string
-        description: "Subject of the action"
-
-      degree:
+      message:
         type: string
-        description: "Degree of the action"
-        enum:
-          - "unanimous"
-          - "majority"
-          - "minority"
-
-    additionalProperties: false
-
-  MeetingIdentifier:
-    type: object
-    description: "Meeting identification information"
-    properties:
-      venue:
+      considering:
         type: string
-        description: "Meeting venue"
-
-      dates:
+      considerations:
         type: array
-        description: "Meeting dates"
         items:
-          $ref: "#/$defs/ComplexDate"
-
-      identifier:
-        type: string
-        description: "Meeting identifier"
-
-    additionalProperties: false
+          $ref: "#/$defs/Consideration"
+      approvals:
+        type: array
+        items:
+          $ref: "#/$defs/Approval"
+      actions:
+        type: array
+        items:
+          $ref: "#/$defs/Action"
 
-  ResolutionRelations:
+  SourceUrl:
     type: object
-    description: "Relation between resolutions"
+    description: "Per-language canonical source URL (e.g. one PDF per language)."
+    additionalProperties: false
+    required: [ref, format, language_code]
     properties:
-      type:
+      ref:
         type: string
-        enum:
-          - "supersedes"
-          - "amends"
-          - "references"
-          - "replaces"
-          - "updates"
-        description: "Type of relation"
-
-      target:
+        description: "The URL string."
+      format:
         type: string
-        description: "Target resolution identifier"
-
-      description:
+        description: "Document format, e.g. 'pdf', 'html'."
+      language_code:
         type: string
-        description: "Description of the relation"
+        pattern: "^[a-z]{3}$"
 
-    additionalProperties: false
+  # ====================================================================
+  # Top-level structures.
+  # ====================================================================
 
-  StructuredIdentifier:
+  Resolution:
     type: object
-    description: "Structured identifier with prefix and number"
+    description: |
+      A formal Resolution. Language-agnostic admin fields live here;
+      every translatable field is wrapped inside `localizations[]`
+      (one entry per available language; at least one is required).
+    additionalProperties: false
+    required: [identifier, localizations]
     properties:
-      prefix:
+      identifier:
+        type: array
+        minItems: 1
+        items:
+          $ref: "#/$defs/StructuredIdentifier"
+      type:
+        $ref: "#/$defs/ResolutionType"
+      doi:
         type: string
-        description: "Identifier prefix"
-
-      number:
-        oneOf:
-          - type: string
-          - type: integer
-        description: "Identifier number"
-
-    additionalProperties: false
+      urn:
+        type: string
+      agenda_item:
+        type: string
+      dates:
+        type: array
+        items:
+          $ref: "#/$defs/ResolutionDate"
+      categories:
+        type: array
+        items:
+          type: string
+      meeting:
+        $ref: "#/$defs/MeetingIdentifier"
+      relations:
+        type: array
+        items:
+          $ref: "#/$defs/ResolutionRelation"
+      urls:
+        type: array
+        items:
+          $ref: "#/$defs/Url"
+      localizations:
+        type: array
+        minItems: 1
+        items:
+          $ref: "#/$defs/Localization"
 
-  SubjectBody:
+  ResolutionMetadata:
     type: object
-    description: "Subject body information"
+    description: "Collection-level metadata (title, meeting date, source, source URLs, host venue)."
+    additionalProperties: false
     properties:
-      name:
+      title:
         type: string
-        description: "Name of the subject body"
-
-      address:
+        description: "Default title (no language). For multilingual, use `title_localized[]`."
+      title_localized:
+        type: array
+        items:
+          $ref: "#/$defs/Localization"
+        description: "Per-language title records (parallel pattern to Resolution#localizations)."
+      date:
         type: string
-        description: "Address of the subject body"
-
-    additionalProperties: false
-
-additionalProperties: false
+        format: date
+        description: "Meeting date."
+      source:
+        type: string
+        description: "Source organization / secretariat that issued the collection."
+      source_urls:
+        type: array
+        items:
+          $ref: "#/$defs/SourceUrl"
+        description: "Canonical URLs to the source PDFs in each available language."
+      city:
+        type: string
+        description: "IATA city code (3-letter, e.g. BER, CPT, PAR) of the host city."
+      country_code:
+        type: string
+        description: "ISO 3166-1 alpha-2 country code (2-letter, e.g. DE, FR, JP) of the host country."
+
+  # ====================================================================
+  # Enums. Each is referenced by its $ref name above. The schema
+  # <-> Ruby enum sync spec asserts each value-list matches the
+  # corresponding Edoxen::Enums::* frozen array.
+  # ====================================================================
+
+  ActionType:
+    type: string
+    description: "Edoxen::Enums::ACTION_TYPE — LUTAML action.lutaml (deduped)."
+    enum:
+      - adopts
+      - thanks
+      - approves
+      - decides
+      - declares
+      - asks
+      - invites
+      - resolves
+      - confirms
+      - welcomes
+      - recommends
+      - requests
+      - congratulates
+      - instructs
+      - urges
+      - appoints
+      - calls-upon
+      - encourages
+      - affirms
+      - elects
+      - authorizes
+      - charges
+      - states
+      - remarks
+      - judges
+      - sanctions
+      - abrogates
+      - empowers
+
+  ConsiderationType:
+    type: string
+    description: "Edoxen::Enums::CONSIDERATION_TYPE — LUTAML consideration.lutaml (deduped)."
+    enum:
+      - having
+      - noting
+      - recognizing
+      - acknowledging
+      - recalling
+      - reaffirming
+      - considering
+      - taking-into-account
+      - pursuant-to
+      - bearing-in-mind
+      - emphasizing
+      - concerned
+      - accepts
+      - observing
+      - referring
+      - acting
+      - empowers
+
+  ApprovalType:
+    type: string
+    description: "Edoxen::Enums::APPROVAL_TYPE — LUTAML approval_type.lutaml."
+    enum: [affirmative, negative]
+
+  ApprovalDegree:
+    type: string
+    description: "Edoxen::Enums::APPROVAL_DEGREE — LUTAML approval_degree.lutaml."
+    enum: [unanimous, majority, minority]
+
+  ResolutionType:
+    type: string
+    description: "Edoxen::Enums::RESOLUTION_TYPE — LUTAML resolution_type.lutaml."
+    enum: [resolution, recommendation, decision, declaration]
+
+  ResolutionDateType:
+    type: string
+    description: "Edoxen::Enums::RESOLUTION_DATE_TYPE — LUTAML resolution_date_type.lutaml."
+    enum: [adoption, drafted, discussed]
+
+  ResolutionRelationType:
+    type: string
+    description: "Edoxen::Enums::RESOLUTION_RELATION_TYPE — LUTAML resolution_relation_type.lutaml."
+    enum: [annexOf, hasAnnex, updates, refines, replaces, considers]
+
+  UrlKind:
+    type: string
+    description: "Edoxen::Enums::URL_KIND."
+    enum: [access, report]