Verse API

Check what's the latest version of your favorite open-source project

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.0.20.js"></script>
<script src="/docs/schema.js"></script>

gh

read

GET /gh/{owner}/{repo}/

Returns GitHub repository latest stable version

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`repo` required
`owner` required

# Load the schema document
$ coreapi get https://verse.pawelad.xyz/docs/

# Interact with the API endpoint
$ coreapi action gh read -p repo=... -p owner=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://verse.pawelad.xyz/docs/")

# Interact with the API endpoint
action = ["gh", "read"]
params = {
    "repo": ...,
    "owner": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["gh", "read"]
var params = {
    repo: ...,
    owner: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

major

GET /gh/{owner}/{repo}/major/

Returns GitHub repository latest stable version for each major release

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`repo` required
`owner` required

# Load the schema document
$ coreapi get https://verse.pawelad.xyz/docs/

# Interact with the API endpoint
$ coreapi action gh major -p repo=... -p owner=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://verse.pawelad.xyz/docs/")

# Interact with the API endpoint
action = ["gh", "major"]
params = {
    "repo": ...,
    "owner": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["gh", "major"]
var params = {
    repo: ...,
    owner: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

minor

GET /gh/{owner}/{repo}/minor/

Returns GitHub repository latest stable version for each minor release

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`repo` required
`owner` required

# Load the schema document
$ coreapi get https://verse.pawelad.xyz/docs/

# Interact with the API endpoint
$ coreapi action gh minor -p repo=... -p owner=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://verse.pawelad.xyz/docs/")

# Interact with the API endpoint
action = ["gh", "minor"]
params = {
    "repo": ...,
    "owner": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["gh", "minor"]
var params = {
    repo: ...,
    owner: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

projects

list

GET /projects/

Returns a list of all currently available projects with links to relevant API endpoints

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.

# Load the schema document
$ coreapi get https://verse.pawelad.xyz/docs/

# Interact with the API endpoint
$ coreapi action projects list -p page=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://verse.pawelad.xyz/docs/")

# Interact with the API endpoint
action = ["projects", "list"]
params = {
    "page": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "list"]
var params = {
    page: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

read

GET /projects/{project}/

Returns project latest stable version

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`project` required

# Load the schema document
$ coreapi get https://verse.pawelad.xyz/docs/

# Interact with the API endpoint
$ coreapi action projects read -p project=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://verse.pawelad.xyz/docs/")

# Interact with the API endpoint
action = ["projects", "read"]
params = {
    "project": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "read"]
var params = {
    project: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

major

GET /projects/{project}/major/

Returns project latest stable version for each major release

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`project` required

# Load the schema document
$ coreapi get https://verse.pawelad.xyz/docs/

# Interact with the API endpoint
$ coreapi action projects major -p project=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://verse.pawelad.xyz/docs/")

# Interact with the API endpoint
action = ["projects", "major"]
params = {
    "project": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "major"]
var params = {
    project: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

minor

GET /projects/{project}/minor/

Returns project latest stable version for each minor release

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`project` required

# Load the schema document
$ coreapi get https://verse.pawelad.xyz/docs/

# Interact with the API endpoint
$ coreapi action projects minor -p project=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://verse.pawelad.xyz/docs/")

# Interact with the API endpoint
action = ["projects", "minor"]
params = {
    "project": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "minor"]
var params = {
    project: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})