overlane api versions | Overlane Docs

The API version is a date sent in the Overlane-Version header; leave it off for the current version. An old version keeps working at least 12 months after the next one ships.

Usage

overlane api versions [--service URL]

Flags

Flag	Type	Required	Default	Description
`--service`	string	no		The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)

Examples

overlane api versions
overlane api versions --json

Behavior

Effect: read (changes nothing).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: no. Accepts --force: no.
Machine-readable description: overlane schema api versions.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "type": "object",
  "properties": {
    "current": {
      "type": "string"
    },
    "versions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "version": {
            "type": "string"
          },
          "releasedAt": {
            "type": "string"
          },
          "supportedUntil": {
            "type": [
              "string",
              "null"
            ]
          },
          "breaking": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "summary": {
            "type": "string"
          }
        },
        "required": [
          "version",
          "releasedAt",
          "supportedUntil",
          "breaking",
          "summary"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "current",
    "versions"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.