v1

latestOpenAPI 3.1.02026-07-261690320.7 KB

Get changelog summary

Get changelog summary for package

get/changelog-summary

Query parameters

package_namestring required

Package name

from_versionstring required

The version of the package used as a starting point for the changelog summary

to_versionstring required

The version of the package used as an ending point for the changelog summary

language'JS' | 'PY' | 'GO' | '.NET' | 'Java' | 'Scala' | 'Kotlin' required

The programming language of the package

Response

Information about the changelog summary is returned

is_generatingboolean

A boolean indicating if the changelog summary is still generating or not. When it is still generating try the api again at a later time

Example response

{
  "summary": {
    "package_name": "jsonpath-plus",
    "from_version": "5.1.0",
    "to_version": "10.2.0",
    "source_url": "https://github.com/JSONPath-Plus/JSONPath/blob/main/CHANGES.md",
    "failed_at": -1,
    "failure_error_message": "",
    "update_status": "breaking",
    "changes_by_version": {
      "6.0.0": [
        "Create as true ESM module",
        "Utilize `.cjs` extension for UMD and CJS builds",
        "Utilize `.js` extension instead of `.mjs` for now default ESM builds"
      ],
      "7.0.0": [
        "Bump `engines` to 12"
      ],
      "8.0.0": [
        "Bump Node `engines` to 14"
      ],
      "9.0.0": [
        "Removes `preventEval` property. Prefer `eval: false` instead",
        "Changed behavior of `eval` property. In the browser, `eval`/`Function` won't be used by default to evaluate expressions"
      ],
      "10.0.0": [
        "Require Node 18+",
        "Use safe vm by default in Node"
      ]
    }
  },
  "is_generating": false
}