schemas/changes/v1/schema_changes.yaml at main · expresslang/schemas · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
$schema: http://json-schema.org/draft-04/schema#
title: EXPRESS Schema Changes
description: Records modifications to EXPRESS schema structure across versions
type: object
required:
  - schema
  - versions
additionalProperties: false
properties:
  schema:
    type: string
    description: Name of the EXPRESS schema
  versions:
    type: array
    description: Array of version changes
    items:
      $ref: '#/definitions/version_change'
definitions:
  version_change:
    type: object
    description: Changes made to the schema in a specific version
    required:
      - version
    additionalProperties: false
    properties:
      version:
        type: integer
        description: Version number for this change version
      description:
        type: string
        description: >-
          Multi-line string describing the changes made in this version.
          Provides comprehensive overview of what changed and why.
      additions:
        type: array
        description: Array of addition changes representing added elements
        items:
          $ref: '#/definitions/addition_change'
      modifications:
        type: array
        description: Array of modification changes representing modifications
        items:
          $ref: '#/definitions/modification_change'
      deletions:
        type: array
        description: Array of deletion changes representing removed elements
        items:
          $ref: '#/definitions/deletion_change'
  item_change:
    type: object
    description: Represents a specific schema element change
    required:
      - type
      - name
    properties:
      type:
        type: string
        description: Type of the EXPRESS construct
        enum:
          - ENTITY
          - TYPE
          - FUNCTION
          - RULE
          - PROCEDURE
          - CONSTANT
          - REFERENCE_FROM
          - USE_FROM
          - SUBTYPE_CONSTRAINT
      name:
        type: string
        description: Name of the EXPRESS construct
      description:
        type: array
        description: >-
          Array of strings describing the change. Each string represents
          a description for a single change in the named target.
        items:
          type: string
      interfaced_items:
        type: array
        description: >-
          For USE_FROM or REFERENCE_FROM, list of specific items referenced
          or used. Not needed when in deletions.
        items:
          type: string
  modification_change:
    description: Represents a modification to the schema
    $ref: '#/definitions/item_change'
  addition_change:
    description: Represents an addition to the schema
    allOf:
      - $ref: '#/definitions/item_change'
      - properties:
          moved_from:
            type: object
            description: >-
              If the addition was due to a move from another schema, provides
              the resource and module where it was moved from.
            required:
              - schema
            properties:
              schema:
                type: string
                description: Name of the schema where the item was moved from
              version:
                type: integer
                description: Version number in the source schema
  deletion_change:
    description: Represents a deletion from the schema
    allOf:
      - $ref: '#/definitions/item_change'
      - properties:
          moved_to:
            type: object
            description: >-
              If the deletion was due to a move to another schema, provides
              the resource and module where it was moved to.
            required:
              - schema
            properties:
              schema:
                type: string
                description: Name of the schema where the item was moved to
              version:
                type: integer
                description: Version number in the target schema