---
seo:
    title: "FinSpec Change Log"
    description: "The optional FinSpec changes block records the version history of a specification."
llm_context: "Reference for the FinSpec changes key - the optional version history block carrying lastVersion plus issue dates, live dates and summaries for each release."
category: "reference"
related:
    - "/finspec/reference"
    - "/finspec/guides/upgrade_guide"
---

## Document Change Log

`changes` is an optional block that provides a version history for the specification.

```json
"changes": {
  "lastVersion": "2.1",
  "history": [
    {
      "version": "2.1",
      "issueDate": "2024-06-01",
      "liveDate": "2024-07-01",
      "summary": "<p>Added TimeInForce=GTD support to NewOrderSingle.</p>"
    },
    {
      "version": "2.0",
      "issueDate": "2023-12-01",
      "summary": "<p>Initial release of v2 specification.</p>"
    }
  ]
}
```

```jsonSchema protocol=finspec version=5.2 def=changes
{
    "type": "object",
    "description": "An array of historical changes made to the document.",
    "required": [
        "lastVersion",
        "history"
    ],
    "additionalProperties": false,
    "patternProperties": {
        "^x-": {
            "description": "Any property starting with x- is valid.",
            "additionalProperties": true,
            "additionalItems": true,
            "$refName": "vendorExtension",
            "$refResolved": true
        }
    },
    "properties": {
        "lastVersion": {
            "type": "string",
            "description": "The current (latest) version of the document."
        },
        "history": {
            "type": "array",
            "description": "Historical changes made to the document.",
            "items": {
                "type": "object",
                "required": [
                    "version",
                    "issueDate",
                    "summary"
                ],
                "description": "A single historical change entry.",
                "additionalProperties": false,
                "patternProperties": {
                    "^x-": {
                        "description": "Any property starting with x- is valid.",
                        "additionalProperties": true,
                        "additionalItems": true,
                        "$refName": "vendorExtension",
                        "$refResolved": true
                    }
                },
                "properties": {
                    "version": {
                        "type": "string",
                        "description": "The version number of the change. Typically follows semantic versioning, but may be non-standard for legacy documents."
                    },
                    "issueDate": {
                        "type": "string",
                        "format": "date",
                        "description": "The date when the version was issued.",
                        "pattern": "^(19|20)\\d{2}-(0\\d|1[012])-([0-2]\\d|3[01])$"
                    },
                    "summary": {
                        "description": "A brief summary of the change.",
                        "type": "string"
                    },
                    "liveDate": {
                        "type": "string",
                        "format": "date",
                        "description": "The date when the version entered into production.",
                        "pattern": "^(19|20)\\d{2}-(0\\d|1[012])-([0-2]\\d|3[01])$"
                    },
                    "deprecatedDate": {
                        "type": "string",
                        "format": "date",
                        "description": "The date when the version was deprecated.",
                        "pattern": "^(19|20)\\d{2}-(0\\d|1[012])-([0-2]\\d|3[01])$"
                    },
                    "description": {
                        "description": "A detailed description of the change.",
                        "type": "string"
                    }
                },
                "$refName": "change",
                "$refResolved": true
            },
            "uniqueItems": true
        }
    }
}
```

`lastVersion` should match the `version` of the most recent entry in `history`.

A full list of attributes available in each change entry is shown below:

```jsonSchema protocol=finspec version=5.2 def=change
{
    "type": "object",
    "required": [
        "version",
        "issueDate",
        "summary"
    ],
    "description": "A single historical change entry.",
    "additionalProperties": false,
    "patternProperties": {
        "^x-": {
            "description": "Any property starting with x- is valid.",
            "additionalProperties": true,
            "additionalItems": true,
            "$refName": "vendorExtension",
            "$refResolved": true
        }
    },
    "properties": {
        "version": {
            "type": "string",
            "description": "The version number of the change. Typically follows semantic versioning, but may be non-standard for legacy documents."
        },
        "issueDate": {
            "type": "string",
            "format": "date",
            "description": "The date when the version was issued.",
            "pattern": "^(19|20)\\d{2}-(0\\d|1[012])-([0-2]\\d|3[01])$"
        },
        "summary": {
            "description": "A brief summary of the change.",
            "type": "string"
        },
        "liveDate": {
            "type": "string",
            "format": "date",
            "description": "The date when the version entered into production.",
            "pattern": "^(19|20)\\d{2}-(0\\d|1[012])-([0-2]\\d|3[01])$"
        },
        "deprecatedDate": {
            "type": "string",
            "format": "date",
            "description": "The date when the version was deprecated.",
            "pattern": "^(19|20)\\d{2}-(0\\d|1[012])-([0-2]\\d|3[01])$"
        },
        "description": {
            "description": "A detailed description of the change.",
            "type": "string"
        }
    }
}
```
