oasis-xrd

Extensible Resource Descriptor https://gitlab.com/dpwiz/oasis-xrd

Latest on Hackage:1.0

This package is not currently in any snapshots. If you're interested in using it, we recommend adding it to Stackage Nightly. Doing so will make builds more reliable, and allow stackage.org to host generated Haddocks.

BSD3 licensed by Alexander Bondarenko
Maintained by aenor.realm@gmail.com

oasis-xrd

Types and rendering of XRD and web-host metadata.

Part of the Fediverse suite of protocols.

XML

XML output of tests/example/Main.hs on example from Section B:

<XRD xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
    <Expires>
        1970-01-01T00:00:00Z
    </Expires>
    <Subject>
        http://example.com/gpburdell
    </Subject>
    <Property type="http://spec.example.net/type/person" xsi:nil="True"/>
    <Link href="http://services.example.com/auth" rel="http://spec.example.net/auth/1.0"/>
    <Link
      href="http://photos.example.com/gpburdell.jpg"
      rel="http://spec.example.net/photo/1.0"
      type="image/jpeg">
        <Title xml:lang="en">
            User Photo
        </Title>
        <Title xml:lang="de">
            Benutzerfoto
        </Title>
        <Property type="http://spec.example.net/created/1.0">
            1970-01-01
        </Property>
    </Link>
</XRD>

JSON (JRD)

JSON output of tests/example-json/Main.hs on example from RFC 6415:

{
    "subject": "http://blog.example.com/article/id/314",
    "expires": "1970-01-01T00:00:00Z",
    "aliases": [
        "http://blog.example.com/cool_new_thing",
        "http://blog.example.com/steve/article/7"
    ],
    "links": [
        {
            "titles": {
                "default": "About the Author",
                "en-us": "Author Information"
            },
            "href": "http://blog.example.com/author/steve",
            "type": "text/html",
            "rel": "author",
            "properties": {
                "http://example.com/role": "editor"
            }
        },
        {
            "titles": {
                "default": "The other author"
            },
            "href": "http://example.com/author/john",
            "rel": "author"
        },
        {
            "template": "http://example.com/copyright?id={uri}",
            "rel": "author"
        }
    ],
    "properties": {
        "http://blgx.example.net/ns/ext": null,
        "http://blgx.example.net/ns/version": "1.3"
    }
}

Changes

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Compatible Versioning.

[Unreleased]

1.0 - 2018-04-07

Added

  • Initial release with XRD and JRD encoders

comments powered byDisqus