Skip to content

Commit d252652

Browse files
fixed responseValueTypeObject
1 parent 4f62ad3 commit d252652

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

versions/3.0.0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1782,7 +1782,7 @@ Field Name | Type | Description
17821782
---|:---:|---
17831783
<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>.
17841784
<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.
1785-
<a name="responseDataType"></a>x-responseValueType | [Response Value Type Object](#responseValueTypeObject) \| [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 Object](responseValueTypeObject).
1785+
<a name="responseDataType"></a>x-responseValueType | [Response Value Type Object](#responseValueTypeObject) \| [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 Object](#responseValueTypeObject).
17861786

17871787

17881788
##### Response Object Examples
@@ -1922,13 +1922,13 @@ description: object created
19221922
Field Name | Type | Description
19231923
---|:---:|---
19241924
<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
1925-
<a name="responseValueTypeObjectValue"></a>x-valueType | `string` | The value type for the field. e.g.
1925+
<a name="responseValueTypeObjectValue"></a>x-valueType | `string` | The value type for the field. e.g. http://identifiers.org/ncbigene indicates that the field type is from the NCBI Gene database
19261926

19271927
##### Response Value Type Object smartAPI Example
19281928

19291929
```yaml
19301930
- x-path: ncbigene.id
1931-
x-valueType: http://identifiers.org/ncbigene:12345
1931+
x-valueType: http://identifiers.org/ncbigene
19321932
19331933
```
19341934

versions/smartapi-list.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Object | Field | Recommendation | Datatype | Description
2222
<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#parameterObject">Parameter Object</a>|<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#parameterValueType">x-valueType</a>|SHOULD| [uri] |A list of URIs to define the types of accepted value types. These should be selected from a registry of value types such as identifiers.org. This attribute is different from
2323
<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#parameterObject">Parameter Object</a>|<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#parameterExampleValue"></a>|examples| |Use the Schema object to define examples.
2424
<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseObject">Response Object</a>|<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseContent">content</a>|SHOULD| Map[string, [Media Type Object](#mediaTypeObject)] |Use media type definitions listed at <a href="https://www.iana.org/assignments/media-types/media-types.xhtml">RFC6838</a>.
25-
<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseObject">Response Object</a>|<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseProfile">x-responseSchema</a>|| URI |Conformance to a particular schema/format.
26-
<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseObject">Response Object</a>|<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseDataType">x-responseValueType</a>|| [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.
27-
<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseObject">Response Object</a>|<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#x-JSONLDContext">x-JSONLDContext</a>|| URI |JSON LD context.
25+
<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseObject">Response Object</a>|<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#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.
26+
<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseObject">Response Object</a>|<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseDataType">x-responseValueType</a>|| [Response Value Type Object](#responseValueTypeObject) \|[Reference Object](#referenceObject)]
27+
<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseValueTypeObject">Response Value Type Object [smartAPI extension]</a>|<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseValueTypeObjectPath">x-path</a>|| 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
28+
<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseValueTypeObject">Response Value Type Object [smartAPI extension]</a>|<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#responseValueTypeObjectValue">x-valueType</a>|| string |The value type for the field. e.g. http://identifiers.org/ncbigene indicates that the field type is from the NCBI Gene database
2829
<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#tagObject">Tag Object</a>|<a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#tagName">x-id</a>|| URI |The name of the tag. Recommend that you use URI to specify the concept.

0 commit comments

Comments
 (0)