Canister API documentation

Nov 25, 2024

Change #a0dec8ca

2.4.38

Breaking

Compare

7 structure changes including:

7 Modifications

Modified 7 Breaking

GET /jailbreak/package/multi

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - tags property Modified
      - Type went from array[string] to array[string] | null
    - repository property Modified
    - header, size, isCurrent, sha256, depiction, installedSize, isPruned, filename, repositorySlug, tintColor, sileoDepiction, uuid, icon properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - id, icon_url, package_id, native_depiction, installed_size, header_url, visible, sha256_hash, latest_version, package_size, package_filename, repository_id, quality properties Added

GET /jailbreak/package/search

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - tags property Modified
      - Type went from array[string] to array[string] | null
    - repository property Modified
    - header, size, isCurrent, sha256, depiction, installedSize, isPruned, filename, repositorySlug, tintColor, sileoDepiction, uuid, icon properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - id, icon_url, package_id, native_depiction, installed_size, header_url, visible, sha256_hash, latest_version, package_size, package_filename, repository_id, quality properties Added

GET /jailbreak/package/{packageId}

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - tags property Modified
      - Type went from array[string] to array[string] | null
    - repository property Modified
    - header, size, isCurrent, sha256, depiction, installedSize, isPruned, filename, repositorySlug, tintColor, sileoDepiction, uuid, icon properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - id, icon_url, package_id, native_depiction, installed_size, header_url, visible, sha256_hash, latest_version, package_size, package_filename, repository_id, quality properties Added

GET /jailbreak/repository/ranking

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - refs property Modified
    - isPruned, sileoEndpoint, aliases, origin, packageCount, originId properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - sileo_endpoint, origin_last_updated, visible, id, quality, package_count, origin_hostname, origin_release_path, origin_supports_payment_v2, date, bootstrap, isBootstrap, origin_release_hash, origin_packages_path, origin_has_release_gpg, origin_packages_hash, origin_supports_payment_v1, origin_has_in_release, origin_uses_https properties Added

GET /jailbreak/repository/search

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - refs property Modified
    - isPruned, sileoEndpoint, aliases, origin, packageCount, originId properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - sileo_endpoint, origin_last_updated, visible, id, quality, package_count, origin_hostname, origin_release_path, origin_supports_payment_v2, date, bootstrap, isBootstrap, origin_release_hash, origin_packages_path, origin_has_release_gpg, origin_packages_hash, origin_supports_payment_v1, origin_has_in_release, origin_uses_https properties Added

GET /jailbreak/repository/{repositorySlug}

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - refs property Modified
    - isPruned, sileoEndpoint, aliases, origin, packageCount, originId properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - sileo_endpoint, origin_last_updated, visible, id, quality, package_count, origin_hostname, origin_release_path, origin_supports_payment_v2, date, bootstrap, isBootstrap, origin_release_hash, origin_packages_path, origin_has_release_gpg, origin_packages_hash, origin_supports_payment_v1, origin_has_in_release, origin_uses_https properties Added

GET /jailbreak/repository/{repositorySlug}/packages

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - tags property Modified
      - Type went from array[string] to array[string] | null
    - repository property Modified
    - header, size, isCurrent, sha256, depiction, installedSize, isPruned, filename, repositorySlug, tintColor, sileoDepiction, uuid, icon properties Removed
      - Removing a resource is always breaking unless it was deprecated before
        Breaking
    - id, icon_url, package_id, native_depiction, installed_size, header_url, visible, sha256_hash, latest_version, package_size, package_filename, repository_id, quality properties Added

Jun 7, 2023

Change #0aa6d844

2.4.22

Compare

1 structure change including:

1 Modification

Modified 1

GET /

Response
200 response Modified
- data property Modified

Jun 7, 2023

Change #cdce7166

2.4.20

Breaking

Compare

2 structure changes including:

2 Modifications

Modified 2 Breaking

GET /

Response
200 response Modified
- connection, info, reference properties Removed
- status, date, data properties Added

GET /healthz

Response
200 response Modified
- healthy, typesense_healthy, postgres_healthy properties Removed
- status, date, data properties Added

Jan 20, 2023

Change #ec6972c3

2.4.3

Breaking

Compare

1 structure change including:

1 Modification

Modified 1 Breaking

GET /healthz

Response
200 response Modified
- status property Removed
- healthy, typesense_healthy, postgres_healthy properties Added

Jan 5, 2023

Change #65b32b49

2.3.1

Breaking

Compare

10 structure changes including:

10 Modifications

Modified 10 Breaking

GET /

Response
200 response Modified
- info, connection properties Modified
- references property Removed
- reference property Added

GET /healthz

Response
200 response Modified
- health property Removed
- status property Added

GET /jailbreak/package/multi

Response
200 response Modified
- data property Modified
404 response Modified
- error property Removed

GET /jailbreak/package/search

Response
200 response Modified
- data property Modified

GET /jailbreak/package/{packageId}

Response
200 response Modified
- data property Modified
404 response Modified
- error property Removed

GET /jailbreak/repository/ranking

Response
200 response Modified
- data property Modified

GET /jailbreak/repository/safety

Response
200 response Modified
- object-2 alternative Removed
Query
uri query parameter Removed

GET /jailbreak/repository/search

Response
200 response Modified
- data property Modified

GET /jailbreak/repository/{repositorySlug}

Response
200 response Modified
- data property Modified
404 response Modified
- error property Removed

GET /jailbreak/repository/{repositorySlug}/packages

Response
200 response Modified
- data property Modified
404 response Modified
- error property Removed

Dec 27, 2022

Change #d32f0751

2.2.4

Compare

2 structure changes including:

2 Modifications

Modified 2

GET /jailbreak/package/search

Response
200 response Modified
- data property Modified

GET /jailbreak/package/{packageId}

Response
200 response Modified
- data property Modified

Dec 23, 2022

Change #84ddd22e

2.2.0

Breaking

Compare

7 structure changes including:

7 Modifications

Modified 7

GET /jailbreak/package/multi

Response
200 response Modified
- data property Modified

GET /jailbreak/package/search

Response
200 response Modified
- data property Modified

GET /jailbreak/package/{packageId}

Response
200 response Modified
- data property Modified

GET /jailbreak/repository/ranking

Response
200 response Modified
- data property Modified

GET /jailbreak/repository/search

Response
200 response Modified
- data property Modified

GET /jailbreak/repository/{repositorySlug}

Response
200 response Modified
- data property Modified

GET /jailbreak/repository/{repositorySlug}/packages

Response
200 response Modified
- data property Modified

Sep 16, 2022

Change #bb148aea

2.1.14

Compare

1 structure change including:

1 Modification

Modified 1

GET /jailbreak/repository/{repositorySlug}/packages

Response
200 response Modified
- data property Modified

Sep 16, 2022

Change #e3159080

2.1.13

Compare

1 structure change including:

1 Addition

Added 1

GET /jailbreak/repository/{repositorySlug}/packages

Sep 11, 2022

Change #4dae7c2d

2.1.12

Compare

1 structure change including:

1 Modification

Modified 1

GET /jailbreak/repository/safety

Response
200 response Modified
- object-2 alternative Added

Sep 11, 2022

Change #dfcc1417

2.1.11

Compare

1 structure change including:

1 Addition

Added 1

GET /jailbreak/repository/safety

Sep 4, 2022

Change #655824a0

2.1.10

Compare

10 structure changes including:

10 Additions

Added 10

GET /

GET /healthz

GET /jailbreak/package/multi

GET /jailbreak/package/search

GET /jailbreak/package/{packageId}

GET /jailbreak/repository/ranking

GET /jailbreak/repository/search

GET /jailbreak/repository/{repositorySlug}

GET /openapi.json

GET /openapi.yaml

Sep 3, 2022

Change #e5ecac70

2.1.5

Breaking

Compare

6 structure changes including:

1 Addition

5 Modifications

Modified 5

GET /jailbreak/package/search

Response
200 response Modified
- data property Modified

GET /jailbreak/package/{packageId}

Response
200 response Modified
- data property Modified

GET /jailbreak/repository/ranking

Response
200 response Modified
- data property Modified

GET /jailbreak/repository/search

Response
200 response Modified
- data property Modified

GET /jailbreak/repository/{repositorySlug}

Response
200 response Modified
- data property Modified

Added 1

GET /jailbreak/package/multi

Aug 20, 2022

Change #0f5f1e16

2.1.0

Breaking

Compare

4 structure changes including:

2 Additions

2 Modifications

Modified 2 Breaking

GET /jailbreak/package/{packageId}

Response
200 response Modified
- refs property Removed
400, 404 responses Added

GET /jailbreak/repository/search

Response
200 response Modified
- data property Modified

Added 2

GET /jailbreak/repository/ranking

GET /jailbreak/repository/{repositorySlug}

Aug 20, 2022

Change #95a18fde

2.0.12-0

Breaking

Compare

3 structure changes including:

1 Addition

2 Modifications

Modified 2

GET /jailbreak/package/search

Response
200 response Modified
- data property Modified

GET /jailbreak/package/{packageId}

Response
200 response Modified
- data property Modified

Added 1

GET /jailbreak/repository/search

Aug 20, 2022

Change #27e983ca

2.0.9

Breaking

Compare

3 structure changes including:

1 Breaking change

2 Additions

1 Removal

Removed 1 Breaking

GET /jailbreak/search/packages

Added 2

GET /jailbreak/package/search

GET /jailbreak/package/{packageId}

Aug 13, 2022

Change #bbdd2f2a

2.0.8

Breaking

Compare

1 structure change including:

1 Modification

Modified 1

GET /jailbreak/search/packages

Response
200 response Modified
- data property Modified

Aug 12, 2022

Change #2eef099f

2.0.6

Compare

1 structure change including:

1 Modification

Modified 1

GET /jailbreak/search/packages

Response
200 response Modified
- data property Added
400 response Added

Aug 6, 2022

Change #f83a767c

v2.0.3 v2.0.2 v2.0.1

Compare

Do not miss any Canister API changes, ever again

Changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API documentation has been created