GithubHelp home page GithubHelp logo

Comments (4)

benfrancis avatar benfrancis commented on July 19, 2024

Note: System for defining object values of properties which are more complex than a simple type like “integer”, e.g. an acceleration vector. Perhaps using JSON Schema syntax.

Note: Decide whether a “required” property is needed for properties or whether the use of a JSON Schema to validate a Thing Description is enough.

from api.

coderbyheart avatar coderbyheart commented on July 19, 2024

OpenAPI has this figured out very well: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schema-object-examples

from api.

benfrancis avatar benfrancis commented on July 19, 2024

There's lots of ongoing discussion about this at the W3C. In this specification we are currently re-using types from JSON Schema (as I believe OpenAPI does), but not the same syntax. Also in addition to a type definition, properties may have a human readable description and a URL.

One problem with the syntax used by JSON Schema and OpenAPI is the potential confusion between "properties" and "properties" of "properties".

But yes, OpenAPI is a useful source of inspiration.

from api.

benfrancis avatar benfrancis commented on July 19, 2024

Fixed.

from api.

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.