Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add catpkg.json.gz asset file to uploads, link in catpkg.json as 'repositoryGzipUrl' #8

Closed
amis92 opened this issue Apr 30, 2020 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@amis92
Copy link
Member

amis92 commented Apr 30, 2020

Schema: BSData/schemas#3

The catpkg.json should include links to both original and gzipped file (it's a lot of saved bandwidth, especially for a commonly pinged endpoint these files will become).

The .gz file should be an "optional" file, with the client app (BattleScribe) falling back to non-compressed json when gz is not available.

@amis92
Copy link
Member Author

amis92 commented Jun 1, 2020

Gzip provides savings of about 85% (see BSData/gallery#5)

@amis92 amis92 self-assigned this Jun 2, 2020
@amis92 amis92 added the enhancement New feature or request label Jun 2, 2020
@amis92 amis92 changed the title add gzipped catpkg.gz asset file to uploads Add catpkg.json.gz asset file to uploads, link in catpkg.json as 'repositoryGzipUrl' Jun 2, 2020
@amis92
Copy link
Member Author

amis92 commented Jun 2, 2020

Example:

{
    "$schema": "https://raw.githubusercontent.com/BSData/schemas/master/src/catpkg.schema.json",
    "name": "wh40k",
    "description": "Warhammer 40,000",
    "battleScribeVersion": "2.03",
    "version": "v1.4.21",
    "lastUpdated": "2020-05-30T13:27:29Z",
    "lastUpdateDescription": "It was as if millions of SM voices all cried out in terror...",
    "indexUrl": "https://github.com/BSData/wh40k/releases/latest/download/wh40k.latest.bsi",
    "repositoryUrl": "https://github.com/BSData/wh40k/releases/latest/download/wh40k.catpkg.json",
    "repositoryGzipUrl": "https://github.com/BSData/wh40k/releases/latest/download/wh40k.catpkg.json.gz",
}

@amis92
Copy link
Member Author

amis92 commented Jun 2, 2020

Schema: BSData/schemas#3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant