just some 🧹 api cleaning

Signed-off-by: Fredrik Adelöw <freben@gmail.com>

plugins/api-docs/src/components/ApiDefinitionCard/ApiTypeTitle.tsx

@@ -19,7 +19,11 @@ import React from 'react';
 import { apiDocsConfigRef } from '../../config';
 import { useApi } from '@backstage/core-plugin-api';
 
-export const ApiTypeTitle = ({ apiEntity }: { apiEntity: ApiEntity }) => {
+/**
+ * @public
+ */
+export const ApiTypeTitle = (props: { apiEntity: ApiEntity }) => {
+  const { apiEntity } = props;
   const config = useApi(apiDocsConfigRef);
   const definition = config.getApiDefinitionWidget(apiEntity);
   const type = definition ? definition.title : apiEntity.spec.type;

plugins/api-docs/src/components/ApisCards/ConsumedApisCard.tsx

@@ -32,11 +32,11 @@ import {
   WarningPanel,
 } from '@backstage/core-components';
 
-type Props = {
-  variant?: InfoCardVariants;
-};
-
-export const ConsumedApisCard = ({ variant = 'gridItem' }: Props) => {
+/**
+ * @public
+ */
+export const ConsumedApisCard = (props: { variant?: InfoCardVariants }) => {
+  const { variant = 'gridItem' } = props;
   const { entity } = useEntity();
   const { entities, loading, error } = useRelatedEntities(entity, {
     type: RELATION_CONSUMES_API,

plugins/api-docs/src/components/ApisCards/HasApisCard.tsx

@@ -33,10 +33,6 @@ import {
   WarningPanel,
 } from '@backstage/core-components';
 
-type Props = {
-  variant?: InfoCardVariants;
-};
-
 const columns: TableColumn<ApiEntity>[] = [
   EntityTable.columns.createEntityRefColumn({ defaultKind: 'API' }),
   EntityTable.columns.createOwnerColumn(),
@@ -45,7 +41,11 @@ const columns: TableColumn<ApiEntity>[] = [
   EntityTable.columns.createMetadataDescriptionColumn(),
 ];
 
-export const HasApisCard = ({ variant = 'gridItem' }: Props) => {
+/**
+ * @public
+ */
+export const HasApisCard = (props: { variant?: InfoCardVariants }) => {
+  const { variant = 'gridItem' } = props;
   const { entity } = useEntity();
   const { entities, loading, error } = useRelatedEntities(entity, {
     type: RELATION_HAS_PART,

plugins/api-docs/src/components/ApisCards/ProvidedApisCard.tsx

@@ -32,11 +32,11 @@ import {
   WarningPanel,
 } from '@backstage/core-components';
 
-type Props = {
-  variant?: InfoCardVariants;
-};
-
-export const ProvidedApisCard = ({ variant = 'gridItem' }: Props) => {
+/**
+ * @public
+ */
+export const ProvidedApisCard = (props: { variant?: InfoCardVariants }) => {
+  const { variant = 'gridItem' } = props;
   const { entity } = useEntity();
   const { entities, loading, error } = useRelatedEntities(entity, {
     type: RELATION_PROVIDES_API,

plugins/api-docs/src/components/ComponentsCards/ConsumingComponentsCard.tsx

@@ -34,11 +34,13 @@ import {
   WarningPanel,
 } from '@backstage/core-components';
 
-type Props = {
+/**
+ * @public
+ */
+export const ConsumingComponentsCard = (props: {
   variant?: InfoCardVariants;
-};
-
-export const ConsumingComponentsCard = ({ variant = 'gridItem' }: Props) => {
+}) => {
+  const { variant = 'gridItem' } = props;
   const { entity } = useEntity();
   const { entities, loading, error } = useRelatedEntities(entity, {
     type: RELATION_API_CONSUMED_BY,

plugins/api-docs/src/components/ComponentsCards/ProvidingComponentsCard.tsx

@@ -34,11 +34,10 @@ import {
   WarningPanel,
 } from '@backstage/core-components';
 
-type Props = {
+export const ProvidingComponentsCard = (props: {
   variant?: InfoCardVariants;
-};
-
-export const ProvidingComponentsCard = ({ variant = 'gridItem' }: Props) => {
+}) => {
+  const { variant = 'gridItem' } = props;
   const { entity } = useEntity();
   const { entities, loading, error } = useRelatedEntities(entity, {
     type: RELATION_API_PROVIDED_BY,

plugins/api-docs/src/plugin.ts

@@ -49,6 +49,7 @@ export const apiDocsPlugin = createPlugin({
   },
 });
 
+/** @public */
 export const ApiExplorerPage = apiDocsPlugin.provide(
   createRoutableExtension({
     name: 'ApiExplorerPage',
@@ -58,6 +59,7 @@ export const ApiExplorerPage = apiDocsPlugin.provide(
   }),
 );
 
+/** @public */
 export const EntityApiDefinitionCard = apiDocsPlugin.provide(
   createComponentExtension({
     name: 'EntityApiDefinitionCard',
@@ -68,6 +70,7 @@ export const EntityApiDefinitionCard = apiDocsPlugin.provide(
   }),
 );
 
+/** @public */
 export const EntityConsumedApisCard = apiDocsPlugin.provide(
   createComponentExtension({
     name: 'EntityConsumedApisCard',
@@ -78,6 +81,7 @@ export const EntityConsumedApisCard = apiDocsPlugin.provide(
   }),
 );
 
+/** @public */
 export const EntityConsumingComponentsCard = apiDocsPlugin.provide(
   createComponentExtension({
     name: 'EntityConsumingComponentsCard',
@@ -90,6 +94,7 @@ export const EntityConsumingComponentsCard = apiDocsPlugin.provide(
   }),
 );
 
+/** @public */
 export const EntityProvidedApisCard = apiDocsPlugin.provide(
   createComponentExtension({
     name: 'EntityProvidedApisCard',
@@ -100,6 +105,7 @@ export const EntityProvidedApisCard = apiDocsPlugin.provide(
   }),
 );
 
+/** @public */
 export const EntityProvidingComponentsCard = apiDocsPlugin.provide(
   createComponentExtension({
     name: 'EntityProvidingComponentsCard',
@@ -112,6 +118,7 @@ export const EntityProvidingComponentsCard = apiDocsPlugin.provide(
   }),
 );
 
+/** @public */
 export const EntityHasApisCard = apiDocsPlugin.provide(
   createComponentExtension({
     name: 'EntityHasApisCard',