Skip to content

Commit a2962b3

Browse files
refactored the json-ld + schema parts
1 parent c97dcae commit a2962b3

File tree

1 file changed

+27
-13
lines changed

1 file changed

+27
-13
lines changed

versions/3.0.0.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1780,9 +1780,9 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
17801780
Field Name | Type | Description
17811781
---|:---:|---
17821782
<a name="responseContent"></a>content | Map[`string`, [Media Type Object](#mediaTypeObject)] | **SHOULD** Use media type definitions listed at <a href="https://www.iana.org/assignments/media-types/media-types.xhtml">RFC6838</a>.
1783-
<a name="responseProfile"></a>x-responseSchema| `URI` | Conformance to a particular schema/format.
1784-
<a name="responseDataType"></a>x-responseValueType | [`responseValueType object`] | To specify the types of objects in the response. The responseValueType object consists of a required `x-valueType` that should provide URI values to the type of object, and an optional `x-path` to specify to ___location in the response for that valueType.
1785-
<a name="x-JSONLDContext"></a>x-JSONLDContext | `URI` | JSON LD context.
1783+
<a name="responseSchema"></a> | `URI` | Specify the json schema using a Reference Object, or use "x-uri" as an additional property in the schema field to point to an external ___location for an XML, RDF, etc schema.
1784+
<a name="responseDataType"></a>x-responseValueType | [`responseValueType`] \| [Reference Object](#referenceObject)] | Specify the types of objects and relations in the response using either a reference to the JSON-LD context file or to a [Response Value Type](responseValueType).
1785+
17861786

17871787
##### Response Object Examples
17881788

@@ -1906,19 +1906,33 @@ Response with no return value:
19061906
```yaml
19071907
description: object created
19081908
```
1909-
##### Response Object smartAPI Examples
1909+
1910+
1911+
1912+
1913+
1914+
#### <a name="responseValueType"></a>Response Value Type [smartAPI extension]
1915+
1916+
that should provide URI values to the type of object, and an optional `x-path` to specify to ___location in the response for that valueType.
1917+
1918+
1919+
##### smartAPI Fields
1920+
1921+
Field Name | Type | Description
1922+
---|:---:|---
1923+
<a name="responseValueTypeObjectPath"></a>x-path | `string` | The path using dot notation to the element of interest. e.g. friend.name to follow the path from root object to the name attribute to the name field
1924+
<a name="responseValueTypeObjectValue"></a>x-valueType | `string` | The value type for the field. e.g.
1925+
1926+
##### Response Value Type Object smartAPI Example
1927+
19101928
```yaml
1911-
responses:
1912-
- content:
1913-
- 'application/ld+json':
1914-
x-responseProfile: 'http://www.w3.org/ns/anno.jsonld'
1915-
x-responseValueType:
1916-
- x-path: a.id
1917-
x-valueType: 'http://example.org/a.id'
1918-
- x-path: a.b.c.id
1919-
x-valueType: 'http://example.org/c.id'
1929+
- x-path: ncbigene.id
1930+
x-valueType: http://identifiers.org/ncbigene:12345
1931+
19201932
```
19211933

1934+
1935+
19221936
#### <a name="callbackObject"></a>Callback Object
19231937

19241938
A map of possible out-of band callbacks related to the parent operation.

0 commit comments

Comments
 (0)