catalog.apps

Retrieve apps details for label catalog.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: catalog_apps_options

catalog_apps_options

Type: object

CatalogAppsArgs parameters.

No Additional Properties

cache

Cache

Type: boolean Default: true

Whether to use cached catalog data if available.

cache_only

Cache Only

Type: boolean Default: false

Whether to only return cached data without fetching updates.

retrieve_all_trains

Retrieve All Trains

Type: boolean Default: true

Whether to retrieve apps from all available trains.

trains

Trains

Type: array of string

Specific train names to retrieve apps from (empty array means all trains).

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Return value

Result

Type: object

Object mapping train names to their app information.

Additional Properties

Each additional property must conform to the following schema

CatalogTrainInfo

Type: object

Additional Properties

Each additional property must conform to the following schema

CatalogAppInfo

Type: object

app_readme Required

App Readme

HTML content of the app README.

Any of

• Option 1
• Option 2

Type: string

Must be at most 2147483647 characters long

Type: null

categories Required

Categories

Type: array of string

List of categories for the app.

No Additional Items

Each item of this array must be:

Type: string

description Required

Description

Type: string

Short description of the app.

healthy Required

Healthy

Type: boolean

Health status of the app.

healthy_error

Healthy Error

Default: null

Error if app is not healthy.

Any of

• Option 1
• Option 2

Type: string

Type: null

home Required

Home

Type: string

Homepage URL of the app.

location Required

Location

Type: string

Local path to the app's location.

latest_version Required

Latest Version

Latest available app version.

Any of

• Option 1
• Option 2

Type: string

Type: null

latest_app_version Required

Latest App Version

Latest available app version in repository.

Any of

• Option 1
• Option 2

Type: string

Type: null

latest_human_version Required

Latest Human Version

Human-readable version of the app.

Any of

• Option 1
• Option 2

Type: string

Type: null

last_update Required

Last Update

Timestamp of the last update in ISO format.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

name Required

Name

Type: string

Name of the app.

recommended Required

Recommended

Type: boolean

Indicates if the app is recommended.

title Required

Title

Type: string

Title of the app.

maintainers Required

Maintainers

Type: array of object

List of app maintainers.

No Additional Items

Each item of this array must be:

Maintainer

Type: object
No Additional Properties

name Required

Name

Type: string

Name of the app maintainer.

email Required

Email

Type: string

Email address of the app maintainer.

url Required

Url

Website URL of the app maintainer or null.

Any of

• Option 1
• Option 2

Type: string

Type: null

tags Required

Tags

Type: array of string

Tags associated with the app.

No Additional Items

Each item of this array must be:

Type: string

screenshots Required

Screenshots

Type: array of string

List of screenshot URLs.

No Additional Items

Each item of this array must be:

Type: string

sources Required

Sources

Type: array of string

List of source URLs.

No Additional Items

Each item of this array must be:

Type: string

icon_url

Icon Url

Default: null

URL of the app icon.

Any of

• Option 1
• Option 2

Type: string

Type: null

Additional Properties

Additional Properties of any type are allowed.

Type: object

Required roles: CATALOG_READ