Skip to content

Commit 7ca1d43

Browse files
authored
Update 3.0.md
external resource object added
1 parent 415d61b commit 7ca1d43

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

versions/3.0.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Additional utilities, such as testing tools, can also use the files.
4343
- [Path Item Object](#pathItemObject)
4444
- [Operation Object](#operationObject)
4545
- [External Documentation Object](#externalDocumentationObject)
46+
- [External Resource Object](#externalDocumentationObject)
4647
- [Parameter Object](#parameterObject)
4748
- [Request Body Object](#requestBodyObject)
4849
- [Media Type Object](#mediaTypeObject)
@@ -201,6 +202,7 @@ Field Name | Type | Description
201202
<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.
202203
<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.
203204
<a name="oasExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation.
205+
<a name="oasExternalResources"></a>externalResources | [External Resource Object](#externalResourceObject) | Additional external resources.
204206

205207
This object can be extended with [Specification Extensions](#specificationExtensions).
206208

@@ -1006,14 +1008,6 @@ Field Name | Type | Description
10061008

10071009
This object can be extended with [Specification Extensions](#specificationExtensions).
10081010

1009-
##### smartAPI Fields
1010-
1011-
Field Name | Type | Description
1012-
---|:---:|---
1013-
<a name="externalDocType"></a>x-type | `enum` | **REQUIRED** values: `api documentation`, `website`,`developer forum`,`mailing list`,`social media`,`publication` </a>
1014-
1015-
1016-
10171011

10181012
##### External Documentation Object Example
10191013

@@ -1028,12 +1022,30 @@ Field Name | Type | Description
10281022
- description: Find more info here
10291023
url: https://example.com
10301024
type: website
1031-
- x-type: api documentation
1032-
url: http://example.org/api/docs
1033-
- x-type: publication
1034-
url: https://doi.org/10.1093/nar/gks1114
1035-
- x-type: social media
1036-
url: http://twitter.com/mypetstore
1025+
```
1026+
1027+
#### <a name="externalResourceObject"></a>External Resource Object
1028+
1029+
Allows referencing external resources for extended documentation.
1030+
1031+
##### smartAPI Fields
1032+
1033+
Field Name | Type | Description
1034+
---|:---:|---
1035+
<a name="externalResourceUrl"></a>x-url | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL.
1036+
<a name="externalResourceType"></a>x-type | `enum` | **REQUIRED** values: `api documentation`, `website`,`developer forum`,`mailing list`,`social media`,`publication` </a>
1037+
<a name="externalResourceDescription"></a>x-description | `string` | A short description of the target documentation. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
1038+
1039+
##### External Resource Object Example
1040+
1041+
```yaml
1042+
- x-url: http://example.org/api/docs
1043+
x-type: api documentation
1044+
- x-url: https://doi.org/10.1093/nar/gks1114
1045+
x-type: publication
1046+
x-description: "BioGPS and MyGene.info: organizing online, gene-centric information"
1047+
- x-url: http://twitter.com/mygeneinfo
1048+
x-type: social media
10371049
```
10381050

10391051
#### <a name="parameterObject"></a>Parameter Object

0 commit comments

Comments
 (0)