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
So that the request description could be rendered in the request section and the response description in the response section. Currently they cannot be separated, as both are part of the operation description field in API Blueprint.
The text was updated successfully, but these errors were encountered:
It is possible to separate the request and response body descriptions by placing each in the description of the Request and Response sections of the API Blueprint, respectively.
I suggest the following:
Have StaticDocumentation._generateOperationDescriptor()'s return object have a requests key with an array value. An element of the array describes one possible request under the current operation, and contains the pertinent data in StaticDocumentation._generateOperationDescriptor().requestSchemaElements.
StaticDocumentation._generateOperationDescriptor().responses is an array and contains a response element corresponding to status code 200 or 201. Have this response element contain the pertinent data in StaticDocumentation._generateOperationDescriptor().responseSchemaElements.
Move StaticDocumentation._generateOperationDescriptor().parameters into the element(s) of the new StaticDocumentation._generateOperationDescriptor().requests array.
Modify carbond/lib/docgen/templates/api-blueprint/body.hbs to render accordingly.
So that the request description could be rendered in the request section and the response description in the response section. Currently they cannot be separated, as both are part of the operation
description
field in API Blueprint.The text was updated successfully, but these errors were encountered: