Skip to content

Commit d9b2df7

Browse files
Update 3.0.md
removed extraneous tt in table of contents, reverted external documentation to single object
1 parent fddb56a commit d9b2df7

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

versions/3.0.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ Additional utilities, such as testing tools, can also use the files.
4949
- [Media Type Object](#mediaTypeObject)
5050
- [Encoding Object](#encodingObject)
5151
- [Responses Object](#responsesObject)
52-
- [tt](#responseObject)
5352
- [Callback Object](#callbackObject)
5453
- [Example Object](#exampleObject)
5554
- [Link Object](#linkObject)
@@ -201,15 +200,15 @@ Field Name | Type | Description
201200
<a name="oasComponents"></a>components | [Components Object](#componentsObject) | An element to hold various schemas for the specification.
202201
<a name="oasSecurity"></a>security | [[Security Requirement Object](#securityRequirementObject)] | A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition.
203202
<a name="oasTags"></a>tags | [[Tag Object](#tagObject)] | A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the [Operation Object](#operationObject) must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.
204-
<a name="oasExternalDocs"></a>externalDocs | [[External Documentation Object](#externalDocumentationObject)] | Additional external documentation.
203+
<a name="oasExternalDocs"></a>externalDocs | [External Documentation Object(#externalDocumentationObject)] | Additional external documentation.
204+
205+
This object can be extended with [Specification Extensions](#specificationExtensions).
205206

206207
##### smartAPI Fields
207208
Field Name | Type | Description
208209
---|:---:|---
209210
<a name="oasExternalResources"></a>x-externalResources | [[External Resource Object](#externalResourceObject)] | A list of external resources pertinent to the API.
210211

211-
This object can be extended with [Specification Extensions](#specificationExtensions).
212-
213212
#### <a name="infoObject"></a>Info Object
214213

215214
The object provides metadata about the API.
@@ -1780,7 +1779,7 @@ Field Name | Type | Description
17801779
---|:---:|---
17811780
<a name="responseContent"></a>content | Map[`string`, [Media Type Object](#mediaTypeObject)] | A map containing descriptions of potential response payloads. The key is the media type and the value is used to describe it.The media type definitions should be in compliance with <a href="http://tools.ietf.org/html/rfc6838">RFC6838</a>.
17821781
<a name="responseProfile"></a>x-responseSchema| `URI` | Conformance to a particular schema/format.
1783-
<a name="responseDataType"></a>x-responseValueType | `array of 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.
1782+
<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.
17841783
<a name="x-JSONLDContext"></a>x-JSONLDContext | `URI` | JSON LD context.
17851784

17861785
##### Response Object Examples
@@ -1909,13 +1908,13 @@ description: object created
19091908
```yaml
19101909
responses:
19111910
- content:
1912-
- application/ld+json:
1913-
x-responseProfile: http://www.w3.org/ns/anno.jsonld
1911+
- 'application/ld+json':
1912+
x-responseProfile: 'http://www.w3.org/ns/anno.jsonld'
19141913
x-responseValueType:
19151914
- x-path: a.id
1916-
x-valueType: http://example.org/a.id
1915+
x-valueType: 'http://example.org/a.id'
19171916
- x-path: a.b.c.id
1918-
x-valueType: http://example.org/c.id
1917+
x-valueType: 'http://example.org/c.id'
19191918
```
19201919

19211920
#### <a name="callbackObject"></a>Callback Object

0 commit comments

Comments
 (0)