You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPMENT.md
+7-3Lines changed: 7 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -54,12 +54,16 @@ By introducing new features this way we enable new features to be designed, docu
54
54
If the feature is successfully implemented and there is demonstrable value added by the feature, it will become a candidate for inclusion in a future release of the specification, at which point all tools will be expected to support the feature.
55
55
56
56
Draft feature extensions are identified by the `x-oas-draft-` prefix and can only be used where existing extensions are permitted.
57
-
This ensures no exising tooling will affected by the introduction of the draft feature.
57
+
This ensures no existing tooling will affected by the introduction of the draft feature.
58
58
If the feature is deemed appropriate for inclusion in the OAS, the `x-oas-draft-` prefix will be removed.
59
-
Tooling that supports draft features should plan for the future removal of the prefix and accomodate the transition period where descriptions exist with and without the prefix.
59
+
Tooling that supports draft features should plan for the future removal of the prefix.
60
+
When tooling adds support for a later version of OAS that includes the final implementation of the feature, it MUST not support the use of the draft prefix for that feature.
61
+
Draft features will only be promoted into minor or major releases of the specification and therefore will be transparent to OpenAPI description writers and tooling providers who choose not to use the feature while in its draft state.
60
62
61
-
Draft features will be documented as Github issues and labeled with the `draft-feature` label.
63
+
Draft features will be documented as GitHub issues and labeled with the `draft-feature` label.
62
64
If during the development of a draft feature, it is determined that the feature needs to change in a way that may break existing draft implementations, the extension name itself may be versioned with a version suffix. e.g. `-v2`
65
+
When a draft feature becomes part of a future update to the specification any version suffix will be removed.
66
+
Draft features that are deemed not appropriate for inclusion MUST be marked with the `abandoned` label.
63
67
64
68
Not all future new features will be introduced in this way.
65
69
Some new features impact the specification in ways that cannot be encapsulated in an extension.
0 commit comments