Retrieving Information

Welcome to my shop! The name's Open Shop Channel.

If a client is written to support multiple repositories, it would be ideal if it could quickly receive general information about a given repository before connecting to it. This endpoint serves that purpose.

Get Repository Information

GET /information

Returns general repository information such as its name, the number of apps it provides, and the available categories.

200: OK Success!

Example response:

{
    "name": "Homebrew Apps",
    "provider": "Open Shop Channel",
    "description": "Open Shop Channel's homebrew apps repository.",
    "git_url": "https://github.com/OpenShopChannel/Apps.git",
    "available_apps_count": 242,
    "available_categories": [
        {
            "name": "demos",
            "display_name": "Demos",
            "singular": "demo",
            "plural": "demos"
        },
        {
            "name": "emulators",
            "display_name": "Emulators",
            "singular": "emulator",
            "plural": "emulators"
        },
        {
            "name": "games",
            "display_name": "Games",
            "singular": "game",
            "plural": "games"
        },
        {
            "name": "media",
            "display_name": "Media",
            "singular": "media application",
            "plural": "media applications"
        },
        {
            "name": "utilities",
            "display_name": "Utilities",
            "singular": "utility",
            "plural": "utilities"
        }
    ],
    "available_platforms": [
        {
            "name": "wii",
            "display_name": "Wii"
        },
        {
            "name": "vwii",
            "display_name": "vWii"
        },
        {
            "name": "wii_mini",
            "display_name": "Wii Mini"
        }
    ]
}

On the root level of the JSON response, the following fields are available:

Field	Description	Type
available_apps_count	Number of available applications. This number refers to successfuly indexed applications, and not the total amount of installed manifests.	Integer
available_categories	A list of application categories defined by this repository.	List of Categories
available_platforms	A list of platforms this repository serves apps for.	List of Platforms
description	The description of the repository, as defined in the repository.json file in repository root.	String
git_url	The source repository of the Repository Manager instance.	String
name	The display name of the repository, as defined in the repository.json file in repository root.	String
provider	The provider of the repository, as defined in the repository.json file in repository root.	String

Category

Field	Description	Type
name	The internal name for the category, this is also the name to be used in manifests.	String
display_name	Human readable name of the category.	String
singular	Singular representation of the name.	String
plural	Plural representation of the name.	String

Platforms

Field	Description	Type
name	The internal name for the platform, this is also the name to be used in manifests.	String
display_name	Human readable name of the platform.	String