================ V2 API Reference ================ This is the documentation for version 33 of Snapcraft Dashboard v2 API. .. toctree:: :maxdepth: 2 :titlesonly: :glob: * Changelog --------- Version 32: * `api-tokens-revoke `_: New API endpoint for revoking Developer Tokens. Version 31: * `api-store-info `_: Added extra field to store info dict: "brand-id". * `api-store-invites `_: Added extra field to store info dict: "brand-id". * `api-store-settings `_: Added extra field to store info dict: "brand-id". * `api-store-snaps `_: Added extra field to store info dict: "brand-id". * `api-store-users `_: Added extra field to store info dict: "brand-id". * `api-tokens-list `_: New API endpoint for Developer Tokens listing. Version 30: * `api-tokens-exchange `_: New API endpoint for Developer Tokens exchange. Version 29: * `api-store-metrics-models `_: Added extra field to store metrics: "device-ids". Version 28: * `api-store-info `_: Added extra field to store info dict: parent. * `api-store-invites `_: Added extra field to store info dict: parent. * `api-store-settings `_: Added extra field to store info dict: parent. * `api-store-snaps `_: Added extra field to store info dict: parent. * `api-store-users `_: Added extra field to store info dict: parent. Version 27: * `api-tokens-whoami `_: New API endpoints for obtaining user information. Version 26: * `api-tokens-request-macaroon `_: New API endpoints for Developer Tokens management. Version 25: * `api-store-snaps `_: Add searching of snaps for inclusion in brand store using query params: q and allowed-for-inclusion Version 24: * `api-store-snaps `_: Remove fields from store snaps endpoint: user id, user email Version 23: * `api-store-snaps `_: Add searching of snaps to store snaps endpoint using query param: q Version 22: * `api-store-snaps `_: Added extra field to store snaps GET response: latest-release Version 21: * `api-store-snaps `_: Added extra field to store snaps response: users (publisher and collaborators). Version 20: * `api-store-users `_: Add GET support to store users endpoint. Version 19: * `api-store-invites `_: Update store invites endpoint to allow modifications to existing invites. Version 18: * `api-store-settings `_: New API endpoint to edit store settings. Version 17: * `api-store-info `_: Added extra fields to store info dict: private, manual-review-policy * `api-store-invites `_: Added extra fields to store info dict: private, manual-review-policy * `api-store-snaps `_: Added extra fields to store info dict: private, manual-review-policy * `api-store-users `_: Added extra fields to store info dict: private, manual-review-policy Version 16: * `api-validation-sets `_: New API endpoints for Validation Sets management. * `api-validation-sets-build-assertion `_: New API endpoints for Validation Sets management. Version 15: * `api-store-metrics-models `_: New API endpoint to fetch store metrics. Version 14: * `api-snap-channel-map `_: Added ``current-percentage`` to the ``progressive`` dict. * `api-snap-releases `_: Added ``current-percentage`` to the ``progressive`` dict. Version 13: * `api-snap-channel-map `_: Added ``status`` to the tracks metadata dict. * `api-snap-releases `_: Added ``status`` to the tracks metadata dict. Version 12: * `api-snap-channel-map `_: Added ``title`` and ``publisher`` to the snap metadata dict. * `api-snap-releases `_: Added ``title`` and ``publisher`` to the snap metadata dict. Version 11: * `api-snap-channel-map `_: Removed the field ``key`` in the ``progressive`` dictionary. * `api-snap-releases `_: Removed the field ``key`` in the ``progressive`` dictionary. Version 9: * `api-snap-releases `_: Added two new top-level fields to the response: ``tracks``, listing the most relevant tracks for this snap, with proper metadata and ordering; and ``channels``, listing the most relevant channels, including the channel breakdown with ``track``, ``risk`` and ``branch`` and their ``fallback`` channel. Branches are only included in the ``channels`` list if there is a release available in that branch. Version 8: * `api-snap-releases `_: Added two new fields to the ``releases`` dictionaries: ``channel``, providing the channel name for the release; and ``expiration-date`` that, if not null, indicates when the release will expire, in ISO 8601 format. Version 7: * `api-store-invites `_: New API endpoint to create store invites. Version 6: * `api-snap-releases `_: Added new field ``snap`` to the response including metadata from the snap itself. Version 5: * `api-store-info `_: Added extra field to store info dict: invites. Version 4: * `api-snap-releases `_: Added new field ``progressive`` for each release item, providing details about whether that release is a progressive release or not. Version 3: * `api-store-info `_: Added extra field to store info dict: snap-name-prefixes. * `api-store-snaps `_: Added extra field to store info dict: snap-name-prefixes. * `api-store-users `_: Added extra field to store info dict: snap-name-prefixes. Version 2: * `api-store-info `_: Added extra fields to store info dict: allowed-inclusion-source-stores and allowed-inclusion-target-stores. * `api-store-snaps `_: Added extra fields to store info dict: allowed-inclusion-source-stores and allowed-inclusion-target-stores. * `api-store-users `_: Added extra fields to store info dict: allowed-inclusion-source-stores and allowed-inclusion-target-stores.