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 new version of podping schema #26

Closed
agates opened this issue Dec 31, 2021 · 0 comments
Closed

Add new version of podping schema #26

agates opened this issue Dec 31, 2021 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@agates
Copy link
Collaborator

agates commented Dec 31, 2021

The current on-chains custom_json schema has some extra information we wont need with the change in #25.

Current schema:

{
    "version": "0.3",
    "num_urls": "<# of iris in 'urls'>",
    "reason": "reason code",
    "urls": ["list", "of", "iris"],
}

New proposed schema:

{
    "version": "1.0",
    "medium": "<ex: podcast>",
    "reason": "<ex: update>",
    "iris": ["list", "of", "iris"],
}

With num_urls being removed as redundant (any programming language has a way to get the length of a list, and the list will never been too large to worry about optimization of parsing for other, perhaps statistical, purposes).

medium is being added even though it also exists in the operation_id, just like reason, to allow for maximum portability and filtering even though it adds to payload size by a small amount.

urls is being changed to iris to match the language that already exists elsewhere in the application: This indicates that 1) the given RSS feeds do not have to be locators (perhaps supporting IPFS CIDs or magnet links, for example) and 2) the character set is "internationalized," supporting any UTF-8 character. Note that this has been assumed by podping-hivewriter since the initial release, this is merely a naming change we are doing now ahead of time.

@agates agates added the enhancement New feature or request label Dec 31, 2021
@agates agates added this to the 1.1 milestone Dec 31, 2021
@agates agates self-assigned this Dec 31, 2021
@agates agates closed this as completed in d198bb1 Jan 18, 2022
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