Upgrade Guidance

Get Upgrade Guidance

post

Get or generate version upgrade guidance.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

package_namestringRequired

package_ecosystemstring · enumRequired

An enumeration of supported package ecosystems.

An ecosystem is defined as a repository of packages such as PyPi or Maven Central. This is distinct from a package manager (e.g. yarn, conda), which is a tool that can interact with one or more ecosystems.

Possible values:

from_versionsstring[]Required

to_versionstringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/upgrade-guidance/

HTTPcURLJavaScriptPython

POST /api/upgrade-guidance/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "package_name": "text",
  "package_ecosystem": "default",
  "from_versions": [
    "text"
  ],
  "to_version": "text"
}

{
  "id": 1,
  "guidance": "text",
  "generated_at": "2025-12-14T05:45:19.698Z"
}

Invalidate Upgrade Guidance

post

Get or generate version upgrade guidance.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

package_namestringRequired

package_ecosystemstring · enumRequired

An enumeration of supported package ecosystems.

An ecosystem is defined as a repository of packages such as PyPi or Maven Central. This is distinct from a package manager (e.g. yarn, conda), which is a tool that can interact with one or more ecosystems.

Possible values:

from_versionsstring[]Required

to_versionstringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/upgrade-guidance/invalidate

HTTPcURLJavaScriptPython

POST /api/upgrade-guidance/invalidate HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "package_name": "text",
  "package_ecosystem": "default",
  "from_versions": [
    "text"
  ],
  "to_version": "text"
}

{
  "ok": true,
  "message": "text"
}