API Summary

The displayed UI components are variants and are for demo purposes only. The normal instances of this UI component can be found in regular documentation.

This componenent is a display themed with a custom color palette. It contains clickable links that redirect to SwaggerHub and other articles on the DOCS site.

Details

Criteria	Component Meets Criteria
Has hover styles	Yes
Has light and dark mode	Yes
Has brand theming	No

Component Props

Prop Name	Type	Description
title	string	The title appearing in the component header
description	string	The text appearing before endpoint and item sections
endpoints	object	An array of objects, where each object contains an array of endpoints and a category name
articles	object	An array of entries, where each entry gets a redirect URL

Example Code

import SummaryAPI from '@site/src/elements/SummaryAPI';

<SummaryAPI
	title={'Vehicles'}
	description={
		'This interface allows users to access data collected from connected vehicles.'
	}
	endpoints={[
			{
				category: 'Endpoints',
				items: [
					{
						url: '/',
						method: 'get',
						title: 'List of Vehicles',
					},
					{
						url: '/',
						method: 'put',
						title: 'Vehicle Details',
					},
				],
			}
		]}
	articles={[
		{
			url: '/',
			title: 'How to see Vehicles',
		},
		{
			url: '/',
			title: 'Using Old Data',
		},
	]}
/>

Overview​

Details​

Component Props​

Example Code​

Overview

Details

Component Props

Example Code