search

arc-archive / api-navigation

⛔️ DEPRECATED This component is being deprecated. Use `@api-components/amf-components` instead.
0 stars 1 forks source link

No endpoints overview #26

Closed carowright closed 3 years ago

carowright commented 3 years ago

New property added: noOverview. When set it will not render overview as a separated element for each endpoint. Overview will still be available when clicking on the endpoint path label.

twoplustwoone commented 3 years ago

I believe the use case we need this for is for users who have a low endpoint-to-method ratio. We had complaints that there were too many "Overview" items when endpoints only had one method. The idea was to be able to remove the overview items and transfer the behavior of opening the endpoint documentation when clicking on the endpoint item.

I also think the behavior of expanding the endpoint item was going to be limited to just the arrow in the item. But I'm not sure if this was intended to be changed for all cases, or only when disabling the Overview items