Metadata

snap_metadata

Introduced in version 1

Summary: POST /api/v1/snaps/metadata

No documentation yet.

Request JSON Schema

{
    "properties": {
        "fields": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "include_default_fields": {
            "type": "boolean"
        },
        "snaps": {
            "items": {
                "properties": {
                    "architecture": {
                        "type": "string"
                    },
                    "channel": {
                        "type": "string"
                    },
                    "ignore_validation": {
                        "type": "boolean"
                    },
                    "revision": {
                        "type": "number"
                    },
                    "series": {
                        "type": "string"
                    },
                    "snap_id": {
                        "type": "string"
                    }
                },
                "required": [
                    "snap_id",
                    "channel"
                ],
                "type": "object"
            },
            "type": "array"
        }
    },
    "required": [
        "snaps"
    ],
    "type": "object"
}

legacy_metadata (DEPRECATED)

Deprecated: Deprecated from version 1

Summary: POST /api/v1/metadata

No documentation yet.

Request JSON Schema

{
    "properties": {
        "fields": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "include_default_fields": {
            "type": "boolean"
        },
        "snaps": {
            "items": {
                "properties": {
                    "architecture": {
                        "type": "string"
                    },
                    "channel": {
                        "type": "string"
                    },
                    "ignore_validation": {
                        "type": "boolean"
                    },
                    "revision": {
                        "type": "number"
                    },
                    "series": {
                        "type": "string"
                    },
                    "snap_id": {
                        "type": "string"
                    }
                },
                "required": [
                    "snap_id",
                    "channel"
                ],
                "type": "object"
            },
            "type": "array"
        }
    },
    "required": [
        "snaps"
    ],
    "type": "object"
}

click_metadata (DEPRECATED)

Deprecated: Deprecated from version 1

Summary: POST /api/v1/click-metadata

Legacy 'click-metadata' (refresh) implementation.

Returns a list of snap representation exact-matching the POSTed names.

Response is wrapped into the usual CPI '_embedded["clickindex:package"]' structure.

Request JSON Schema

{
    "properties": {
        "name": {
            "items": {
                "type": "string"
            },
            "type": "array"
        }
    },
    "required": [
        "name"
    ],
    "type": "object"
}