Categories
snaps_categories
Introduced in version 23
Summary: GET /v2/snaps/categories
List Categories
Returns a list of categories with selected fields and optional filtered by type.
Headers
Snap-Device-Authorization
: Required for access to restricted stores.Snap-Device-Store
: Store to search. Defaults to "ubuntu".
Query Parameters
type=string
: Filter by type, if not present all types are returned.fields=comma separated list
: See Supported Fields.
Supported Fields
If not present defaults to name
only.
name
type
title
summary
description
media
snaps_categories changelog
- Version 23: Added new Categories V2 API
Response JSON Schema
{ "additionalProperties": false, "properties": { "categories": { "items": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "media": { "additionalProperties": false, "properties": { "height": { "type": "number" }, "type": { "type": "string" }, "url": { "type": "string" }, "width": { "type": "number" } }, "required": [ "type", "url" ], "type": "object" }, "name": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "type": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }
charms_categories
Introduced in version 23
Summary: GET /v2/charms/categories
List Categories
Returns a list of categories with selected fields and optional filtered by type.
Headers
Snap-Device-Authorization
: Required for access to restricted stores.Snap-Device-Store
: Store to search. Defaults to "ubuntu".
Query Parameters
type=string
: Filter by type, if not present all types are returned.fields=comma separated list
: See Supported Fields.
Supported Fields
If not present defaults to name
only.
name
type
title
summary
description
media
charms_categories changelog
- Version 23: Added new Categories V2 API
Response JSON Schema
{ "additionalProperties": false, "properties": { "categories": { "items": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "media": { "additionalProperties": false, "properties": { "height": { "type": "number" }, "type": { "type": "string" }, "url": { "type": "string" }, "width": { "type": "number" } }, "required": [ "type", "url" ], "type": "object" }, "name": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "type": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }
snaps_category_by_name
Introduced in version 23
Summary: GET /v2/snaps/category/<name>
Get a Category by Name
Returns a category with selected fields.
Headers
Snap-Device-Authorization
: Required for access to restricted stores.Snap-Device-Store
: Store to search. Defaults to "ubuntu".
Query Parameters
fields=comma separated list
: See Supported Fields.
Supported Fields
If not present defaults to name
only.
name
type
title
summary
description
media
snaps_category_by_name changelog
- Version 23: Added new Categories V2 API
Response JSON Schema
{ "additionalProperties": false, "properties": { "category": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "media": { "additionalProperties": false, "properties": { "height": { "type": "number" }, "type": { "type": "string" }, "url": { "type": "string" }, "width": { "type": "number" } }, "required": [ "type", "url" ], "type": "object" }, "name": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "type": { "type": "string" } }, "type": "object" } }, "required": [ "category" ], "type": "object" }
charms_category_by_name
Introduced in version 23
Summary: GET /v2/charms/category/<name>
Get a Category by Name
Returns a category with selected fields.
Headers
Snap-Device-Authorization
: Required for access to restricted stores.Snap-Device-Store
: Store to search. Defaults to "ubuntu".
Query Parameters
fields=comma separated list
: See Supported Fields.
Supported Fields
If not present defaults to name
only.
name
type
title
summary
description
media
charms_category_by_name changelog
- Version 23: Added new Categories V2 API
Response JSON Schema
{ "additionalProperties": false, "properties": { "category": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "media": { "additionalProperties": false, "properties": { "height": { "type": "number" }, "type": { "type": "string" }, "url": { "type": "string" }, "width": { "type": "number" } }, "required": [ "type", "url" ], "type": "object" }, "name": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "type": { "type": "string" } }, "type": "object" } }, "required": [ "category" ], "type": "object" }