Replace links #847
Replace links #847
Conversation
fmvilas
force-pushed
the
feature/fix-components-object-links
branch
3 times, most recently
from
dc50092 to
881e53d
Compare
|
Thanks for this. I'm afraid this doesn't follow the standard naming convention we use so I can't merge it yet. Object field anchors contain the object name only (without However, looking at the current documentation it looks like that table is broken more than that, because it doesn't even contain the field names and the header is wrong. |
| <a name="securityDefinitionsObject"></a> | [Security Definitions Object](#securityDefinitionsObject) | Security definitions to reuse across the specification. | ||
| <a name="linksDefinitionObject"></a> | [Link Definitions Object](#linksDefinitionsObject) | Link definitions to reuse across the specification. | ||
| <a name="callbacksDefinitionObject"></a> | [Callback Definitions Object](#callbacksDefinitionsObject) | Callback definitions to reuse across the specification. | ||
| <a name="componentsObject-definitionsObject"></a> | [Definitions Object](#definitionsObject) | A hash containing payload definitions for the specification. |
There was a problem hiding this comment.
There was a problem hiding this comment.
<a name="componentsDefinitionsObject"></a>definitions | [Definitions Object](#definitionsObject) | A hash containing payload definitions for the specification.
in this case (notice the anchor and the added field name).
The first header of the table, Field Pattern should be Field Name.
There was a problem hiding this comment.
Got it. Will fix today. Thanks!
fmvilas
force-pushed
the
feature/fix-components-object-links
branch
from
881e53d to
8b5afbc
Compare
|
@webron Please review the field names as it's something I don't know. |
| <a name="componentsDefinitionsObject"></a>definitions | [Definitions Object](#definitionsObject) | A hash containing payload definitions for the specification. | ||
| <a name="componentsResponsesDefinitionsObject"></a>responsesDefinitions | [Responses Definitions Object](#responsesDefinitionsObject) | Reusable responses objects. | ||
| <a name="componentsParametersDefinitionsObject"></a>parametersDefinitions | [Parameters Definitions Object](#parametersDefinitionsObject) | An object to hold parameters to be reused across operations. Parameter definitions can be referenced to the ones defined here. | ||
| <a name="componentsRequestBodyDefinitionsObject"></a>requestBodyDefinitions | [Request Body Definitions Object](#requestBodyObject) | An object to hold request body definitions to be reused across operations. Request Body definitions can be referenced to the ones defined here. |
There was a problem hiding this comment.
#requestBodyObject → #requestBodyDefinitionsObject?
Ah, that one is still missing.
| <a name="componentsResponsesDefinitionsObject"></a>responsesDefinitions | [Responses Definitions Object](#responsesDefinitionsObject) | Reusable responses objects. | ||
| <a name="componentsParametersDefinitionsObject"></a>parametersDefinitions | [Parameters Definitions Object](#parametersDefinitionsObject) | An object to hold parameters to be reused across operations. Parameter definitions can be referenced to the ones defined here. | ||
| <a name="componentsRequestBodyDefinitionsObject"></a>requestBodyDefinitions | [Request Body Definitions Object](#requestBodyObject) | An object to hold request body definitions to be reused across operations. Request Body definitions can be referenced to the ones defined here. | ||
| <a name="componentsResponseHeadersDefinitionsObject"></a>responseHeadersDefinitions | [Response Headers Definitions Object](#responseObject) | Response headers to reuse across the specification. |
There was a problem hiding this comment.
The correct link target here, #responseHeadersDefinitionsObject, is also still missing.
| <a name="componentsResponseHeadersDefinitionsObject"></a>responseHeadersDefinitions | [Response Headers Definitions Object](#responseObject) | Response headers to reuse across the specification. | ||
| <a name="componentsSecurityDefinitionsObject"></a>securityDefinitions | [Security Definitions Object](#securityDefinitionsObject) | Security definitions to reuse across the specification. | ||
| <a name="componentsLinksDefinitionObject"></a>linkDefinitions | [Link Definitions Object](#linkObject) | Link definitions to reuse across the specification. | ||
| <a name="componentsCallbacksDefinitionObject"></a>callbackDefinitions | [Callback Definitions Object](#callbackObject) | Callback definitions to reuse across the specification. |
There was a problem hiding this comment.
Both #callbackDefinitionsObject and #linkDefinitionsObject are still missing. Or are they the same as the callback Object and links object linked here? Then the name of the links here should be changed, too.
|
As just mentioned in my review, some of the "* definitions objects" included in the components object are not yet described in the specification. They should certainly be added near the existing similar ones. I don't have the overview about the currently open issues – if there is not yet an issue to track this, please create one. (Possible a sub issue of #589?) |
|
Thanks for the PR. That section was overhauled eventually, so no longer needed. |
|
Cool, thanks for the good job you're doing here guys. I'm sorry I don't have enough time to contribute more often to OpenAPI. |
Hi all,
Just saw the links in the Component Object table were broken and here is a PR to fix it. Hope it helps.