|
1 | 1 | Object | Field | Recommendation | Datatype | Description
|
2 | 2 | ---|:---:|:---:|:---:|---
|
3 | 3 | OpenAPI Object|x-externalResources||External Resource Object|A list of external resources pertinent to the API.
|
4 |
| -Info Object|description|SHOULD| string |See <a href="https://github.com/WebsmartAPI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#fixed-fields-1">above</a>. |
5 |
| -Info Object|termsOfService|REQUIRED| URL |See <a href="https://github.com/WebsmartAPI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#fixed-fields-1">above</a>. |
| 4 | +Info Object|description|SHOULD| string |See <a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.mdfixed-fields-1">above</a>. |
| 5 | +Info Object|termsOfService|REQUIRED| URL |See <a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.mdfixed-fields-1">above</a>. |
6 | 6 | Info Object|version|REQUIRED| string |The version of the API definition. Specify API version using <a href="http://semver.org/spec/v2.0.0.html">Semantic Versioning<a/>. The major.minor portion of the semver (for example 3.0) shall designate the feature set. Typically, .patch versions address errors in the API metadata, not the feature set.
|
7 | 7 | Info Object|x-maturity|| enum |Maturity of the API. Values to use: development, production.
|
8 | 8 | Info Object|x-accessRestriction|| enum |Indicate whether there are restrictions to using the API. Values to use: none, limited, fee.
|
9 | 9 | Info Object|x-implementationLanguage|| string |Language the API was written in.
|
10 | 10 | Contact Object|x-role|REQUIRED| enum |Indicate the role of the contact. Values can be: `responsible organization`,`responsible developer`,`contributor`,`support`.
|
11 | 11 | Contact Object|x-id|SHOULD| string |Provide a unique identifier for the contact.
|
12 |
| -Operation Object|summary|REQUIRED| string |See <a href="https://github.com/WebsmartAPI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#operation-object">above.</a> |
| 12 | +Operation Object|summary|REQUIRED| string |See <a href="https://github.com/SmartAPI/smartAPI-Specification/blob/OpenAPI.next/versions/3.0.0.mdoperation-object">above.</a> |
13 | 13 | Operation Object|x-accessRestriction|| enum |Access restrictions to invoke the operation. values: none, limited, fee.
|
14 | 14 | External Resource Object [smartAPI extension]|x-url|REQUIRED| string |. The URL for the target documentation. Value MUST be in the format of a URL.
|
15 | 15 | External Resource Object [smartAPI extension]|x-type|REQUIRED| enum |values: `api documentation`, `website`,`developer forum`,`mailing list`,`social media`,`publication` </a>
|
|
0 commit comments