catalog.apps

Retrieve apps details for label catalog.

options.cache is a boolean which when set will try to get apps details for label catalog from cache if available.

options.cache_only is a boolean which when set will force usage of cache only for retrieving catalog information. If the content for the catalog in question is not cached, no content would be returned. If options.cache is unset, this attribute has no effect.

options.retrieve_all_trains is a boolean value which when set will retrieve information for all the trains present in the catalog ( it is set by default ).

options.trains is a list of train name(s) which will allow selective filtering to retrieve only information of desired trains in a catalog. If options.retrieve_all_trains is set, it has precedence over options.train.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: catalog_apps_options

catalog_apps_options

Type: object
No Additional Properties

cache

Cache

Type: boolean Default: true

cache_only

Cache Only

Type: boolean Default: false

retrieve_all_trains

Retrieve All Trains

Type: boolean Default: true

trains

Trains

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Return value

Result

Type: object

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

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

email Required

Email

Type: string

url Required

Url

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