Version API documentation version v1

http://server:port/versions/

Introduction

This document describes the REST API to query deployed versions of API in a web application.

This can be used to query the available versions of APIs in order to adapt your clients to the existing versions. By default, all ActivePivot sandbox applications deploy this API so clients can detect available versions.

Note: the root URL provided here will depend of the deployment of your application. For this documentation, we used the URL as provided in ActivePivot sandbox.

/rest

/rest get

get

Get all deployed APIs and their versions

Response

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "version": {
      "type": "number",
      "description": "Structural version of the response object. The following structure is valid for version 1."
    },
    "apis": {
      "type": "object",
      "description": "Mapping of API name to their deployed versions",
      "patternProperties": {
          "^.+$": { "$ref": "#/definitions/apiVersions" }
      }
    }
  },
  "definitions": {
    "apiVersions": {
      "type": "object",
      "description": "List of deployed versions for a given API",
      "required": [ "versions" ],
      "properties": {
        "versions": {
          "type": "array",
          "minItems": 1,
          "items": { "$ref": "#/definitions/apiVersion" },
          "uniqueItems": true
        }
      }
    },
    "apiVersion": {
      "type": "object",
      "description": "Description of a given version for a specific API",
      "required": [ "id" ],
      "properties": {
        "id": {
          "type": "number",
          "description": "Version id of a deployed API"
        }
      }
    }
  }
}

Example: