OpenAPI block - How to get a heading to display in the page contents instead of the endpoint #791
-
So in the GitBook documentation for the OpenAPI block, as well as in one of the example docs from other companies, there is a heading and a description above the block: And in the page contents, the heading displays along with the endpoint type: I added a heading followed by an OpenAPI block: But the page contents show both the heading and the full endpoint path: I don't see any configuration options to specify the heading or description. Is the heading in the example coming from the API itself? |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments
-
One very easy thing you could do to make it easier to see how this works is to update the doc to include the entry in the original specification as well as the resulting OpenAPI block. That way we could see how items map from one to the other. |
Beta Was this translation helpful? Give feedback.
-
I was able to figure this out - turned out the edit view does not display the OpenAPI block headings correctly in the table of contents - it just uses the paths. The preview view does show the headings instead of the paths. And the headings are coming from the summary value in the spec. |
Beta Was this translation helpful? Give feedback.
I was able to figure this out - turned out the edit view does not display the OpenAPI block headings correctly in the table of contents - it just uses the paths. The preview view does show the headings instead of the paths.
And the headings are coming from the summary value in the spec.