Converted Objects to Maps #1115
Conversation
Renamed Encoding Property Object to Encoding Object.
|
Leaving links as maps allows them to be referenced ( |
|
|
|
Do we want to have a paragraph in one of the introducing sections about the Map[...] notation? |
|
#TDC @webron is asking if Callbacks and Links should be maps or arrays. #TDC: We'll merge this PR as-is (if LGTM'd from @darrelmiller and @earth2marsh) |
|
LGTM |
| <a name="operationResponses"></a>responses | [Responses Object](#responsesObject) | **Required.** The list of possible responses as they are returned from executing this operation. | ||
| <a name="operationCallbacks"></a>callbacks | [Callbacks Object](#callbacksObject) | The list of possible callbacks as they are returned from executing this operation. | ||
| <a name="operationCallbacks"></a>callbacks | Map[`string`, [Callback Object](#callbackObject) \| [Reference Object](#referenceObject)] | A map of possible out-of band callbacks related to the parent operation. Each value in the map is a [Callback Object](#callbackObject) that describes a request that may be initiated by the API provider and the expected responses. | ||
| The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation. |
There was a problem hiding this comment.
The key value here is a simple identifier, not a runtime expression. The runtime expression is for the keys inside the callback object.
versions/3.0.md
Outdated
| <a name="parameterExamples"></a>examples | Map[ `string`, [Example Object](#exampleObject) \| [Reference Object](#referenceObject)] | Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` object is mutually exclusive to the `example` object. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. | ||
|
|
||
| For more complex scenarios a [Content Object](#contentObject) can be used to define the media type and schema of the parameter. | ||
| For more complex scenarios the [`content`](#parameterContent) can be used to define the media type and schema of the parameter. |
There was a problem hiding this comment.
I think this should say "the content property can be used"
Resolved #975.
The following objects have been removed and converted to maps:
Map[{name}, Server Variable Object]
No extensions
Map[{property}, Encoding Property Object]
No extensions
Change Encoding Property Object to Encoding Object *
Map[string, Callback Object | Reference Object]
No extensions *
Map[string, Header Object | Reference Object]
No extensions
Map[string, Link Object | Reference Object]
No extensions
Map[string, Any | {expression}]
No extensions
Map[string, string]
No extensions *
Map[string, [string]]
No extensions
Map[{mediaType}, Media Type Object]
No extensions
A few points of consideration:
callbacksandlinksare both maps now, but we should consider converting them to arrays, and pulling the friendly name into their respective objects.Link Parameters Object, there's no example with a constant parameter value.