]> Digital Transformation Department, Italian Government

Italy robipolli@gmail.com

General Internet-Draft This document defines two keywords to provide semantic information in OpenAPI Specification and JSON Schema documents, and support contract-first semantic schema design. About This Document Status information for this document may be found at . information can be found at . Source for this draft and an issue tracker can be found at .

Introduction API providers usually specify semantic information in text or out-of-band documents; at best, this information is described in prose into specific sections of interface definition documents (see ). This is because API providers do not always value machine-readable semantics, or because they have no knowledge of semantic technologies - that are perceived as unnecessarily complex. A full-semantic approach (e.g. writing RDF oriented APIs) has not become widespread because transferring and processing the semantics on every message significantly increases data transfer and computation requirements. Moreover the semantic landscape do not provide easy ways of defining / constraining the syntax of an object: tools like and restrictions are considered computationally intensive to process and complex to use from web and mobile developers. This document provides a simple mechanism to attach semantic information to REST APIs that rely on different dialects of , thus supporting a contract-first schema design. For example, the OpenAPI Specifications (see ) allow to describe REST APIs interactions and capabilities using a machine-readable format based on or . OAS 3.0 is based on JSON Schema draft-4 while OAS 3.1 relies on the latest JSON Schema draft.

Goals and Design Choices This document has the following goals:

• describe in a single specification document backed by (e.g. an OpenAPI document) both the syntax and semantics of JSON objects. This information can be either be provided editing the document by hand or via automated tools;
• easy for non-semantic experts and with reduced complexity;
• support for OAS 3.0 / JSON Schema Draft4;

while it is not intended to:

• integrate the syntax defined using ;
• infer semantic information where it is not provided;
• convert documents to RDF Schema (see ) or XML Schema.

Thus, the following design choices have been made:

• the semantic context of a JSON object will be described using and its keywords;
• property names are limited to characters that can be used in variable names (e.g. excluding : and .) to avoid interoperability issues with code-generation tools;
• privilege a deterministic behavior over automation and composability;
• interoperable with the mechanisms described in Section 6.1 of for conveying semantic context in REST APIs.

Prosaic semantics allows to define the structure of the exchanged data using specific keywords. Properties' semantics can be expressed in prose via the description keyword.

Example of JSON Schema model that provides semantic prose.

defines a way to interpret a JSON object as JSON-LD: the example schema instance (a JSON document conformant to a given schema) provided in the above "Person" schema can be integrated with semantic information adding the @type and @context properties.

Example of a schema instance transformed in a JSON-LD object.

This document shows how to integrate into a JSON Schema document information that can be used to add the @context and @type properties to the associated JSON Schema instances.

Notational Conventions The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here. These words may also appear in this document in lower case as plain English words, absent their normative meanings. The terms "content", "content negotiation", "resource", and "user agent" in this document are to be interpreted as in . The terms "fragment" and "fragment identifier" in this document are to be interpreted as in . The terms "node", "alias node", "anchor" and "named anchor" in this document are to be intepreded as in . The terms "schema" and "schema instance" in this document are to be intepreded as in draft-4 and higher. The terms "JSON object", "JSON document", "member", "member name" in this document are to be intepreded as in . The term "property" - when referred to a JSON document such as a schema instance - is a synonym of "member name", and the term "property value" is a synonym of "member value". The terms "@context", "@type", "@id", "@value" and "@language" are to be interpreted as JSON-LD keywords in , whereas the term "context" is to be interpreted as a JSON-LD Context defined in the same document. Since JSON-LD is a serialization format for RDF, the document can use JSON-LD and RDF interchangeably when it refers to the semantic interpretation of a resource. The JSON Schema keywords defined in are collectively named "semantic keywords".

JSON Schema keywords A schema (see ) MAY use the following JSON Schema keywords, collectively named "semantic keywords" to provide semantic information for all related schema instances.

x-jsonld-type:

This keyword conveys an RDF type (see ) for the JSON schema instances described by the associate schema. It is defined in .

x-jsonld-context:

This keyword conveys a JSON-LD context for the JSON schema instances described by the associate schema. It is defined in .

This specification MAY be used to:

• populate the @type property along the schema instance objects;
• compose an "instance context" to populate the @context property at the root of the schema instance.

The schema MUST be of type "object". This is because does not define a way to provide semantic information on JSON values that are not JSON objects. The schema MUST NOT describe a JSON-LD (e.g. of application/ld+json media type) or conflicts will arise, such as which is the correct @context or @type (see ). Both JSON Schema keywords defined in this document might contain URI references. Those references MUST NOT be dereferenced automatically, since there is no guarantee that they point to actual locations. Moreover they could reference unsecured resources (e.g. using the "http://" URI scheme ). provides various examples of integrating semantic information in schema instances.

The x-jsonld-type JSON Schema keyword The x-jsonld-type value provides information on the RDF type of the associate schema instances. It SHOULD NOT reference an RDF Datatype, because it is not intended to provide syntax information, but only semantic ones.

The x-jsonld-context JSON Schema keyword The x-jsonld-context value provides the information required to interpret the associate schema instances as JSON-LD according to the specification in Section 6.1 of JSON-LD-11. Its value MUST be a valid JSON-LD Context (see Section 9.15 of JSON-LD-11 ). When context composition (see ) is needed, the context SHOULD be provided in the form of a JSON object; in fact, if the x-jsonld-context is an URL string, to generate the instance context that URL needs to be dereferenced and processed.

Composing URL contexts requires dereferencing them.

Interpreting schema instances This section describes an OPTIONAL workflow to interpret a schema instance as JSON-LD.

1. ensure that the initial schema instance does not contain any @context or @type property. For further information see ;
2. add the @context property with the value of x-jsonld-context. This will be the initial "instance context": the only one that will be mangled;
3. add the @type property with the value of x-jsonld-type;
4. iterate on each instance property like the following:
   • identify the sub-schema associated to the property (e.g. resolving $refs) and check the presence of semantic keywords;
   • for the x-jsonld-type, add the @type property to the sub-instance;
   • for the x-jsonld-context, integrate its information in the instance context when they are not already present;
   • iterate this process in case of nested entries.

The specific algorithm for integrating the values of x-jsonld-context present in sub-schemas into the instance context (see ) is an implementation detail.

Interoperability Considerations See the interoperability considerations for the media types and specifications used, including , , , and . Annotating a schema with semantic keywords containing JSON-LD keywords (e.g. @context, @type and @language) may hinder its ability to be interpreted as a JSON-LD document (e.g. using the JSON-LD 1.1 context for the JSON Schema vocabulary); this can be mitigated extending that context and specifying that Linked Data keywords are JSON Literals. This is generally not a problem, since a generic document cannot be reliably interpreted as JSON-LD using a single context: this is because the same JSON member keys can have different meanings depending on their JSON Schema position (see the notes in the Interpreting JSON Schema as JSON-LD 1.1 section of ).

Syntax is out of scope This specification is not designed to restrict the syntax of a JSON value nor to support a conversion between JSON Schema and XMLSchema (see ).

Limited expressivity Not all RDF resources can be expressed as JSON documents annotated with @context and @type: this specification is limited by the possibilities of Section 6.1 of JSON-LD-11. On the other hand, since this approach delegates almost all the processing to of JSON-LD, as long as JSON-LD evolves it will cover further use cases.

Disjoint with JSON-LD This specification is not designed to pre-process or mangle JSON-LD documents (e.g. to add a missing @type to a JSON-LD document), but only to support schemas that do not describe JSON-LD documents. Applications exchanging JSON-LD documents need to explicitly populate @type and @context, and use a proper media type since Linked Data processing and interpretation requires further checks. If these applications describes messages using or , they needs to process them with a JSON-LD processor and declare all required properties in the schema - like in the example below.

Composability Limited composability can be achieved applying the process described in . Automatic composability is not an explicit goal of this specification because of its complexity. One of the issue is that the meaning of a JSON-LD keyword is affected by their position. For example, @type:

• in a node object, adds an rdf:type arc to the RDF graph (it also has a few other effects on processing, e.g. by enabling type-scoped contexts)
• in a value object, specifies the datatype of the produced literal
• in the context, and more precisely in a term definition, specifies type coercion. It only applies when the value of the term is a string.

These issues can be tackled in future versions of this specifications. Moreover, well-designed schemas do not usually have more than 3 or 4 nested levels. This means that, when needed, it is possible to assemble and optimize an instance context (see ) at design time and use it to valorize x-jsonld-context (see ). Once a context is assembled, the RDF data can be generated using the algorithms described in for example through a library.

Security Considerations See the interoperability considerations for the media types and specifications used, including , , , and .

Integrity and Authenticity Adding a semantic context to a JSON document alters its value and, in an implementation-dependent way, can lead to reordering of fields. This process can thus affect the processing of digitally signed content.

Conflicts If an OAS document includes the keywords defined in the provider explicitly states that the semantic of the schema instance:

• is defined at contract level;
• is the same for every message;
• and is not conveyed nor specific for each message.

In this case, processing the semantic conveyed in a message might have security implications. An application that relies on this specification might want to define separate processing streams for JSON documents and RDF graphs, even when RDF graphs are serialized as JSON-LD documents. For example, it might want to raise an error when an application/json resource contains unexpected properties impacting on the application logic like @type and @context.

IANA Considerations None

References Normative References n.d. n.d. JavaScript Object Notation (JSON) is a lightweight, text-based, language-independent data interchange format. It was derived from the ECMAScript Programming Language Standard. JSON defines a small set of formatting rules for the portable representation of structured data. This document removes inconsistencies with other specifications of JSON, repairs specification errors, and offers experience-based interoperability guidance. The Hypertext Transfer Protocol (HTTP) is a stateless application-level protocol for distributed, collaborative, hypertext information systems. This document describes the overall architecture of HTTP, establishes common terminology, and defines aspects of the protocol that are shared by all versions. In this definition are core protocol elements, extensibility mechanisms, and the "http" and "https" Uniform Resource Identifier (URI) schemes. This document updates RFC 3864 and obsoletes RFCs 2818, 7231, 7232, 7233, 7235, 7538, 7615, 7694, and portions of 7230. A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [STANDARDS-TRACK] n.d. n.d. n.d. In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. Informative References Fachhochschule Dortmund Universität Bremen TZI JSONPath defines a string syntax for selecting and extracting JSON (RFC 8259) values from a JSON value. JSON Pointer defines a string syntax for identifying a specific value within a JavaScript Object Notation (JSON) document. n.d. n.d. n.d. n.d.

Examples

Schema with semantic information The following example shows a Person JSON Schema with semantic information provided by the x-jsonld-type and x-jsonld-context.

A JSON Schema data model with semantic context and type.

The example object is assembled as a JSON-LD object as follows. The above JSON-LD can be represented as text/turtle as follows. @prefix schema: _:b0 rdf:type schema:Person ; schema:country "FRA" ; schema:familyName "Doe" ; schema:givenName "John" . ]]>

Schema with semantic and vocabulary information The following example shows a "Person" schema with semantic information provided by the x-jsonld-type and x-jsonld-context.

A JSON Schema data model with semantic context and type.

The resulting RDF graph is

An RDF graph with semantic context and type. . @prefix country: . schema:familyName "Doe" ; schema:givenName "John" ; schema:addressCountry country:FRA . ]]>

Cyclic schema The following schema contains a cyclic reference. The example schema instance contained in the above schema results in the following JSON-LD document. Applying the workflow described in just recursively copying the x-jsonld-context, the instance context could have been more complex.

An instance context containing redundant information

Composite instance context In the following schema document, the "Citizen" schema references the "BirthPlace" schema.

A schema with object contexts.

The example schema instance contained in the above schema results in the following JSON-LD document. The instance context contains information from both "Citizen" and "BirthPlace" semantic keywords.

A @context that includes information from different schemas.

That can be serialized as text/turtle as

The above entry in text/turtle . @prefix eu: . @prefix itl: . rdf:type eu:Person ; eu:birthplace _:b0 ; eu:familyName "Polli" ; eu:givenName "Roberto" . _:b0 rdf:type itl:Feature ; itl:hasCountry . itl:hasProvince . ]]>

Acknowledgements Thanks to Giorgia Lodi, Matteo Fortini and Saverio Pulizzi for being the initial contributors of this work. In addition to the people above, this document owes a lot to the extensive discussion inside and outside the workgroup. The following contributors have helped improve this specification by opening pull requests, reporting bugs, asking smart questions, drafting or reviewing text, and evaluating open issues: Pierre-Antoine Champin, and Vladimir Alexiev.

FAQ

Q: Why this document?

There's currently no standard way to provide machine-readable semantic information in / to be used at contract time.

Q: Does this document support the exchange of JSON-LD resources?

This document is focused on annotating schemas that are used at contract/design time, so that application can exchange compact JSON object without dereferencing nor interpreting external resources at runtime. While you can use the provided semantic information to generate JSON-LD objects, it is not the primary goal of this specification: context information are not expected to be dereferenced at runtime (see security considerations in JSON-LD) and the semantics of exchanged messages is expected to be constrained inside the application.

Q: Why don't use existing keywords like externalDocs ?

We already tried, but this was actually squatting a keyword designed for human readable documents.

Q: Why using x- keywords?

OpenAPI 3.0 considers invalid unregistered keywords that don't start with x-, and we want a solution that is valid for all OAS versions >= 3.0.

Q: Why not using a full-semantic approach?

This approach allows API providers to attach metadata to their specification without modifying their actual services nor their implementation, since custom keywords are ignored by OpenAPI toolings like Gateways and code generators.

Q: Why not defining a mechanism to attach semantic information to

non-object schemas (e.g. JSON Strings) like other implementations?

This is actually problematic. Look at this example that reuses the TaxCode schema and semantic in different properties.

Q: Why don't use SHACL or OWL restrictions instead of JSON Schema?

Web and mobile developers consider JSON Schema is easier to use than SHACL. Moreover, OWL restrictions are about semantics, and are not designed to restrict the syntax.

Q: Why don't design for composability first?

JSON-LD is a complex specification. ~~~ yaml TaxCode: type: string $linkedData: "@id": "https://w3id.org/italia/onto/CPV/taxCode" "term": "taxCode" Contract: ... properties: employer_tax_code: # Beware! TaxCode.$linkedData.term == 'taxCode' $ref: "#/components/schemas/TaxCode" employee_tax_code: # Here we are reusing not only the schema, # but even the same term. $ref: "#/components/schemas/TaxCode" ~~~ For this reason, composability is limited to the object level.

Change Log TBD