Skip to content

Commit f076006

Browse files
moved maturity to server object
1 parent 8838951 commit f076006

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

schemas/smartapi_schema.json

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -105,14 +105,6 @@
105105
"x-implementationLanguage": {
106106
"type": "string",
107107
"description": "API Implementation Language"
108-
},
109-
"x-maturity": {
110-
"type": "string",
111-
"enum": [
112-
"development",
113-
"production"
114-
],
115-
"description": "Maturity of the API. Values to use: development, production."
116108
}
117109
}
118110
},
@@ -214,6 +206,15 @@
214206
"x-___location": {
215207
"type": "string",
216208
"description": "Location, city and country of the server hosting the API."
209+
},
210+
"x-maturity": {
211+
"type": "string",
212+
"enum": [
213+
"development",
214+
"staging",
215+
"production"
216+
],
217+
"description": "Maturity of the API. Values to use: development, staging, production."
217218
}
218219
}
219220
},

versions/3.0.0.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -225,10 +225,9 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
225225
##### smartAPI Fields
226226
Field Name | Type | Description
227227
---|:---:|---
228-
<a name="infoDescription"></a>description | `string` | **SHOULD** See <a href="https://github.com/smartapi/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#fixed-fields-1">above</a>.
229-
<a name="infoTermsOfService"></a>termsOfService | `URL` | **REQUIRED** See <a href="https://github.com/smartapi/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#fixed-fields-1">above</a>.
228+
<a name="infoDescription"></a>description | `string` | **SHOULD** See <a href="#fixed-fields-1">above</a>.
229+
<a name="infoTermsOfService"></a>termsOfService | `URL` | **REQUIRED** See <a href="#fixed-fields-1">above</a>.
230230
<a name="infoVersion"></a>version | `string` | **REQUIRED** 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.
231-
<a name="infoMaturity"></a>x-maturity | `enum` | Maturity of the API. Values to use: development, production.
232231
<a name="infoAccessRestriction"></a>x-accessRestriction | `enum` | Indicate whether there are restrictions to using the API. Values to use: none, limited, fee.
233232
<a name="infoImplementationLanguage"></a>x-implementationLanguage | `string` | Language the API was written in.
234233

@@ -354,11 +353,12 @@ Field Name | Type | Description
354353
<a name="serverDescription"></a>description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation.
355354
<a name="serverVariables"></a>variables | Map[`string`, [Server Variable Object](#serverVariableObject)] | A map between a variable name and its value. The value is used for substitution in the server's URL template.
356355

357-
##### smartAPi Fields
356+
##### smartAPI Fields
358357

359358
Field Name | Type | Description
360359
---|:---:|---
361360
<a name="serverLocation"></a>x-___location | `string` | Location, city and country of the server hosting the API.
361+
<a name="serverMaturity"></a>x-maturity | `enum` | Maturity of the API. Values to use: development, staging, production.
362362

363363
This object MAY be extended with [Specification Extensions](#specificationExtensions).
364364

@@ -879,7 +879,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
879879

880880
Field Name | Type | Description
881881
---|:---:|---
882-
<a name="operationSummary"></a>summary | `string` | **REQUIRED** See <a href="https://github.com/smartapi/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#operation-object">above.</a>
882+
<a name="operationSummary"></a>summary | `string` | **REQUIRED** See <a href="#operation-object">above.</a>
883883
<a name="operationAccessRestriction"></a>x-accessRestriction | `enum` | Access restrictions to invoke the operation. values: none, limited, fee.
884884

885885
##### Operation Object Example

0 commit comments

Comments
 (0)