Transtats APIs

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

# Install the Python client library
$ pip install coreapi

coverage

read

GET /api/coverage/{coverage_rule}

Translation coverage of multiple packages for a product release in selected languages.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`coverage_rule` required

# Load the schema document
$ coreapi get https://transtats.stg.fedoraproject.org/api-docs/

# Interact with the API endpoint
$ coreapi action coverage read -p coverage_rule=...

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 = ["coverage", "read"]
var params = {
    coverage_rule: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://transtats.stg.fedoraproject.org/api-docs/")

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

job

log > list

GET /api/job/{job_id}/log

Fetch details about a YML job ran successfully in Transtats.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`job_id` required

# Load the schema document
$ coreapi get https://transtats.stg.fedoraproject.org/api-docs/

# Interact with the API endpoint
$ coreapi action job log list -p job_id=...

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 = ["job", "log > list"]
var params = {
    job_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://transtats.stg.fedoraproject.org/api-docs/")

# Interact with the API endpoint
action = ["job", "log > list"]
params = {
    "job_id": ...,
}
result = client.action(schema, action, params=params)

run > create

POST /api/job/run

API to run YML Jobs. Requires authentication token.

# Load the schema document
$ coreapi get https://transtats.stg.fedoraproject.org/api-docs/

# Interact with the API endpoint
$ coreapi action job run create

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 = ["job", "run > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://transtats.stg.fedoraproject.org/api-docs/")

# Interact with the API endpoint
action = ["job", "run > create"]
result = client.action(schema, action)

package

read

GET /api/package/{package_name}

Translation status of a package at various places.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`package_name` required

# Load the schema document
$ coreapi get https://transtats.stg.fedoraproject.org/api-docs/

# Interact with the API endpoint
$ coreapi action package read -p package_name=...

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 = ["package", "read"]
var params = {
    package_name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://transtats.stg.fedoraproject.org/api-docs/")

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

create > create

POST /api/package/create

API to add new package. Requires authentication token.

# Load the schema document
$ coreapi get https://transtats.stg.fedoraproject.org/api-docs/

# Interact with the API endpoint
$ coreapi action package create create

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 = ["package", "create > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://transtats.stg.fedoraproject.org/api-docs/")

# Interact with the API endpoint
action = ["package", "create > create"]
result = client.action(schema, action)

exist > list

GET /api/package/{package_name}/exist

Determine, if the package exist in Transtats or not.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`package_name` required

# Load the schema document
$ coreapi get https://transtats.stg.fedoraproject.org/api-docs/

# Interact with the API endpoint
$ coreapi action package exist list -p package_name=...

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 = ["package", "exist > list"]
var params = {
    package_name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://transtats.stg.fedoraproject.org/api-docs/")

# Interact with the API endpoint
action = ["package", "exist > list"]
params = {
    "package_name": ...,
}
result = client.action(schema, action, params=params)

health > list

GET /api/package/{package_name}/health

Get package health

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`package_name` required

# Load the schema document
$ coreapi get https://transtats.stg.fedoraproject.org/api-docs/

# Interact with the API endpoint
$ coreapi action package health list -p package_name=...

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 = ["package", "health > list"]
var params = {
    package_name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://transtats.stg.fedoraproject.org/api-docs/")

# Interact with the API endpoint
action = ["package", "health > list"]
params = {
    "package_name": ...,
}
result = client.action(schema, action, params=params)

ping

list

GET /api/ping

Ping Transtats Server.

# Load the schema document
$ coreapi get https://transtats.stg.fedoraproject.org/api-docs/

# Interact with the API endpoint
$ coreapi action ping list

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 = ["ping", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://transtats.stg.fedoraproject.org/api-docs/")

# Interact with the API endpoint
action = ["ping", "list"]
result = client.action(schema, action)

release

read

GET /api/release/{release_stream}

Translation status of a product release for linked packages.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`release_stream` required

# Load the schema document
$ coreapi get https://transtats.stg.fedoraproject.org/api-docs/

# Interact with the API endpoint
$ coreapi action release read -p release_stream=...

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 = ["release", "read"]
var params = {
    release_stream: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://transtats.stg.fedoraproject.org/api-docs/")

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

detail > list

GET /api/release/{release_stream}/detail

Detailed (language-wise) translation status of a product release.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`release_stream` required

# Load the schema document
$ coreapi get https://transtats.stg.fedoraproject.org/api-docs/

# Interact with the API endpoint
$ coreapi action release detail list -p release_stream=...

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 = ["release", "detail > list"]
var params = {
    release_stream: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://transtats.stg.fedoraproject.org/api-docs/")

# Interact with the API endpoint
action = ["release", "detail > list"]
params = {
    "release_stream": ...,
}
result = client.action(schema, action, params=params)

locale > read

GET /api/release/{release_stream}/locale/{locale}

Translation status of a product release in a particular language.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`release_stream` required
`locale` required

# Load the schema document
$ coreapi get https://transtats.stg.fedoraproject.org/api-docs/

# Interact with the API endpoint
$ coreapi action release locale read -p release_stream=... -p locale=...

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 = ["release", "locale > read"]
var params = {
    release_stream: ...,
    locale: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://transtats.stg.fedoraproject.org/api-docs/")

# Interact with the API endpoint
action = ["release", "locale > read"]
params = {
    "release_stream": ...,
    "locale": ...,
}
result = client.action(schema, action, params=params)