Giter Site home page Giter Site logo

Standard for VEX document discovery about spec HOT 1 OPEN

openvex avatar openvex commented on August 21, 2024 5
Standard for VEX document discovery

from spec.

Comments (1)

puerco avatar puerco commented on August 21, 2024

I love it @micahhausler.

Regarding the format, one of the goals we want with OpenVEX is that once you discover one document, the format itself can provide links to the rest of the relevant statements using its linked data capabilities.

One of the features we're thinking of adding to OpenVEX is support for references to link to other documents. One of the use cases this will unlock is to have "empty" OpenVEX documents - that is docs without any VEX statements - that only reference other documents. For example (this is just an idea no proposal exists yet for this):

{
  "@context": "https://openvex.dev/ns/v0.2.0",
  "@id": "https://openvex.dev/docs/example/vex-9fb3463de1b57",
  "links": [
      {"ref": "https://myurl.com/index.openvex.json"},
   ]
}

Using that schema, you can reference another document with relevant statements, but also you could point to an OpenVEX API endpoint or a continuously appended document (like an index) with links to known documents. For example:

{
  "@context": "https://openvex.dev/ns/v0.2.0",
  "@id": "https://myurl.com/index.openvex.json",
  "links": [
      {"ref": "https://myurl.com/document1.openvex.json"},
      {"ref": "https://myurl.com/document2.openvex.json"},
      {"ref": "https://myurl.com/document3.openvex.json"},
   ]
}

It would be awesome to fast forward this, the .well-known URL could respond with these documents.

from spec.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.