release-2021-06-01 packages/core-plugin-api/src/apis/system/ApiRef.ts:27

Signed-off-by: Colton Padden <colton.padden@fastmail.com>

packages/core-plugin-api/src/apis/system/ApiRef.ts

@@ -23,10 +23,6 @@ import type { ApiRef } from './types';
  */
 export type ApiRefConfig = {
   id: string;
-  /**
-   * @deprecated Will be removed in the future
-   */
-  description?: string;
 };
 
 class ApiRefImpl<T> implements ApiRef<T> {
@@ -46,12 +42,6 @@ class ApiRefImpl<T> implements ApiRef<T> {
     return this.config.id;
   }
 
-  get description() {
-    // eslint-disable-next-line no-console
-    console.warn('Deprecated use of ApiRef.description');
-    return this.config.description;
-  }
-
   // Utility for getting type of an api, using `typeof apiRef.T`
   get T(): T {
     throw new Error(`tried to read ApiRef.T of ${this}`);

packages/integration-react/src/api/ScmIntegrationsApi.ts

@@ -45,5 +45,4 @@ export class ScmIntegrationsApi {
 export const scmIntegrationsApiRef: ApiRef<ScmIntegrationRegistry> =
   createApiRef({
     id: 'integration.scmintegrations',
-    description: 'All of the registered SCM integrations of your config',
   });

plugins/apache-airflow/src/api/ApacheAirflowApi.ts

@@ -19,7 +19,6 @@ import { Dag, InstanceStatus, InstanceVersion } from './types';
 
 export const apacheAirflowApiRef = createApiRef<ApacheAirflowApi>({
   id: 'plugin.apacheairflow.service',
-  description: 'Used by the Apache Airflow plugin to make requests',
 });
 
 export type ApacheAirflowApi = {

plugins/api-docs/src/config.ts

@@ -20,7 +20,6 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const apiDocsConfigRef = createApiRef<ApiDocsConfig>({
   id: 'plugin.api-docs.config',
-  description: 'Used to configure api-docs widgets',
 });
 
 export interface ApiDocsConfig {

plugins/azure-devops/src/api/AzureDevOpsApi.ts

@@ -27,8 +27,6 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const azureDevOpsApiRef = createApiRef<AzureDevOpsApi>({
   id: 'plugin.azure-devops.service',
-  description:
-    'Used by the Azure DevOps plugin to make requests to accompanying backend',
 });
 
 export interface AzureDevOpsApi {

plugins/badges/src/api/types.ts

@@ -19,7 +19,6 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const badgesApiRef = createApiRef<BadgesApi>({
   id: 'plugin.badges.client',
-  description: 'Used to make requests to the badges backend',
 });
 
 export type BadgeStyle =

plugins/bazaar/src/api.ts

@@ -24,7 +24,6 @@ import { BazaarProject } from './types';
 
 export const bazaarApiRef = createApiRef<BazaarApi>({
   id: 'bazaar',
-  description: 'Used to make requests towards the bazaar backend',
 });
 
 export interface BazaarApi {

plugins/bitrise/src/plugin.ts

@@ -26,8 +26,6 @@ import {
 
 export const bitriseApiRef = createApiRef<BitriseApi>({
   id: 'plugin.bitrise.service',
-  description:
-    'Used by the BitriseCI plugin to retrieve information about builds.',
 });
 
 export const bitrisePlugin = createPlugin({

plugins/catalog-import/src/api/CatalogImportApi.ts

@@ -20,7 +20,6 @@ import { PartialEntity } from '../types';
 
 export const catalogImportApiRef = createApiRef<CatalogImportApi>({
   id: 'plugin.catalog-import.service',
-  description: 'Used by the catalog import plugin to make requests',
 });
 
 // result of the analyze state

plugins/circleci/src/api/CircleCIApi.ts

@@ -33,7 +33,6 @@ export type { BuildWithSteps, BuildStepAction, BuildSummary };
 
 export const circleCIApiRef = createApiRef<CircleCIApi>({
   id: 'plugin.circleci.service',
-  description: 'Used by the CircleCI plugin to make requests',
 });
 
 const DEFAULT_PROXY_PATH = '/circleci/api';

plugins/cloudbuild/src/api/CloudbuildApi.ts

@@ -22,7 +22,6 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const cloudbuildApiRef = createApiRef<CloudbuildApi>({
   id: 'plugin.cloudbuild.service',
-  description: 'Used by the Cloudbuild plugin to make requests',
 });
 
 export type CloudbuildApi = {

plugins/code-coverage/src/api.ts

@@ -34,7 +34,6 @@ export type CodeCoverageApi = {
 
 export const codeCoverageApiRef = createApiRef<CodeCoverageApi>({
   id: 'plugin.code-coverage.service',
-  description: 'Used by the code coverage plugin to make requests',
 });
 
 export class CodeCoverageRestApi implements CodeCoverageApi {

plugins/cost-insights/src/api/CostInsightsApi.ts

@@ -148,5 +148,4 @@ export type CostInsightsApi = {
 
 export const costInsightsApiRef = createApiRef<CostInsightsApi>({
   id: 'plugin.costinsights.service',
-  description: 'Provides cost data and alerts for the cost-insights plugin',
 });

plugins/explore-react/src/tools/api.ts

@@ -18,7 +18,6 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const exploreToolsConfigRef = createApiRef<ExploreToolsConfig>({
   id: 'plugin.explore.toolsconfig',
-  description: 'Used to configure tools displayed in the explore plugin',
 });
 
 export type ExploreTool = {

plugins/firehydrant/src/api/index.ts

@@ -39,7 +39,6 @@ export interface FireHydrantAPI {
 
 export const fireHydrantApiRef = createApiRef<FireHydrantAPI>({
   id: 'plugin.firehydrant.service',
-  description: 'Used by FireHydrant plugin for requests',
 });
 
 export type Options = {

plugins/fossa/src/api/FossaApi.ts

@@ -26,7 +26,6 @@ export interface FindingSummary {
 
 export const fossaApiRef = createApiRef<FossaApi>({
   id: 'plugin.fossa.service',
-  description: 'Used by the Fossa plugin to make requests',
 });
 
 export type FossaApi = {

plugins/gcp-projects/src/api/GcpApi.ts

@@ -19,7 +19,6 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const gcpApiRef = createApiRef<GcpApi>({
   id: 'plugin.gcpprojects.service',
-  description: 'Used by the GCP Projects plugin to make requests',
 });
 
 export type GcpApi = {

plugins/git-release-manager/src/api/serviceApiRef.ts

@@ -20,5 +20,4 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const gitReleaseManagerApiRef = createApiRef<GitReleaseApi>({
   id: 'plugin.git-release-manager.service',
-  description: 'Used by the Git Release Manager plugin to make requests',
 });

plugins/github-actions/src/api/GithubActionsApi.ts

@@ -19,7 +19,6 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const githubActionsApiRef = createApiRef<GithubActionsApi>({
   id: 'plugin.githubactions.service',
-  description: 'Used by the GitHub Actions plugin to make requests',
 });
 
 export type GithubActionsApi = {

plugins/github-deployments/src/api/index.ts

@@ -91,7 +91,6 @@ export interface GithubDeploymentsApi {
 
 export const githubDeploymentsApiRef = createApiRef<GithubDeploymentsApi>({
   id: 'plugin.github-deployments.service',
-  description: 'Used by the GitHub Deployments plugin to make requests',
 });
 
 export type Options = {

plugins/gitops-profiles/src/api.ts

@@ -113,7 +113,6 @@ export type GitOpsApi = {
 
 export const gitOpsApiRef = createApiRef<GitOpsApi>({
   id: 'plugin.gitops.service',
-  description: 'Used by the GitOps profiles plugin to make requests',
 });
 
 export class GitOpsRestApi implements GitOpsApi {

plugins/ilert/src/api/client.ts

@@ -41,7 +41,6 @@ import {
 
 export const ilertApiRef = createApiRef<ILertApi>({
   id: 'plugin.ilert.service',
-  description: 'Used to make requests towards iLert API',
 });
 
 const DEFAULT_PROXY_PATH = '/ilert';

plugins/jenkins/src/api/JenkinsApi.ts

@@ -23,7 +23,6 @@ import { EntityName, EntityRef } from '@backstage/catalog-model';
 
 export const jenkinsApiRef = createApiRef<JenkinsApi>({
   id: 'plugin.jenkins.service2',
-  description: 'Used by the Jenkins plugin to make requests',
 });
 
 export interface Build {

plugins/kafka/src/api/types.ts

@@ -18,8 +18,6 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const kafkaApiRef = createApiRef<KafkaApi>({
   id: 'plugin.kafka.service',
-  description:
-    'Used by the Kafka plugin to make requests to accompanying backend',
 });
 
 export type ConsumerGroupOffsetsResponse = {

plugins/kubernetes/src/api/types.ts

@@ -22,8 +22,6 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const kubernetesApiRef = createApiRef<KubernetesApi>({
   id: 'plugin.kubernetes.service',
-  description:
-    'Used by the Kubernetes plugin to make requests to accompanying backend',
 });
 
 export interface KubernetesApi {

plugins/kubernetes/src/kubernetes-auth-provider/types.ts

@@ -26,8 +26,6 @@ export interface KubernetesAuthProvider {
 export const kubernetesAuthProvidersApiRef =
   createApiRef<KubernetesAuthProvidersApi>({
     id: 'plugin.kubernetes-auth-providers.service',
-    description:
-      'Used by the Kubernetes plugin to fetch KubernetesAuthProviders',
   });
 
 export interface KubernetesAuthProvidersApi {

plugins/lighthouse/src/api.ts

@@ -109,7 +109,6 @@ export type LighthouseApi = {
 
 export const lighthouseApiRef = createApiRef<LighthouseApi>({
   id: 'plugin.lighthouse.service',
-  description: 'Used by the Lighthouse plugin to make requests',
 });
 
 export class LighthouseRestApi implements LighthouseApi {

plugins/newrelic/src/api/index.ts

@@ -55,7 +55,6 @@ export type NewRelicApplications = {
 
 export const newRelicApiRef = createApiRef<NewRelicApi>({
   id: 'plugin.newrelic.service',
-  description: 'Used by the NewRelic plugin to make requests',
 });
 
 const DEFAULT_PROXY_PATH_BASE = '/newrelic';

plugins/pagerduty/src/api/client.ts

@@ -35,7 +35,6 @@ export class UnauthorizedError extends Error {}
 
 export const pagerDutyApiRef = createApiRef<PagerDutyApi>({
   id: 'plugin.pagerduty.api',
-  description: 'Used to fetch data from PagerDuty API',
 });
 
 export class PagerDutyClient implements PagerDutyApi {

plugins/rollbar/src/api/RollbarApi.ts

@@ -23,8 +23,6 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const rollbarApiRef = createApiRef<RollbarApi>({
   id: 'plugin.rollbar.service',
-  description:
-    'Used by the Rollbar plugin to make requests to accompanying backend',
 });
 
 export interface RollbarApi {

plugins/scaffolder/src/api.ts

@@ -30,7 +30,6 @@ import { ListActionsResponse, ScaffolderTask, Status } from './types';
 
 export const scaffolderApiRef = createApiRef<ScaffolderApi>({
   id: 'plugin.scaffolder.service',
-  description: 'Used to make requests towards the scaffolder backend',
 });
 
 type TemplateParameterSchema = {

plugins/search/src/apis.ts

@@ -25,7 +25,6 @@ import qs from 'qs';
 
 export const searchApiRef = createApiRef<SearchApi>({
   id: 'plugin.search.queryservice',
-  description: 'Used to make requests against the search API',
 });
 
 export interface SearchApi {

plugins/sentry/src/api/sentry-api.ts

@@ -19,7 +19,6 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const sentryApiRef = createApiRef<SentryApi>({
   id: 'plugin.sentry.service',
-  description: 'Used by the Sentry plugin to make requests',
 });
 
 export interface SentryApi {

plugins/shortcuts/src/api/ShortcutApi.ts

@@ -20,7 +20,6 @@ import { Observable } from '@backstage/types';
 
 export const shortcutsApiRef = createApiRef<ShortcutApi>({
   id: 'plugin.shortcuts.api',
-  description: 'API to handle shortcuts in a Backstage Sidebar',
 });
 
 export interface ShortcutApi {

plugins/sonarqube/src/api/SonarQubeApi.ts

@@ -35,7 +35,6 @@ export interface FindingSummary {
 
 export const sonarQubeApiRef = createApiRef<SonarQubeApi>({
   id: 'plugin.sonarqube.service',
-  description: 'Used by the SonarQube plugin to make requests',
 });
 
 export type SonarQubeApi = {

plugins/splunk-on-call/src/api/client.ts

@@ -41,7 +41,6 @@ export class UnauthorizedError extends Error {}
 
 export const splunkOnCallApiRef = createApiRef<SplunkOnCallApi>({
   id: 'plugin.splunk-on-call.api',
-  description: 'Used to fetch data from Splunk On-Call API',
 });
 
 export class SplunkOnCallClient implements SplunkOnCallApi {

plugins/tech-insights/src/api/TechInsightsApi.ts

@@ -22,7 +22,6 @@ import { EntityName } from '@backstage/catalog-model';
 
 export const techInsightsApiRef = createApiRef<TechInsightsApi>({
   id: 'plugin.techinsights.service',
-  description: 'Used by the tech insights plugin to make requests',
 });
 
 export interface TechInsightsApi {

plugins/tech-radar/src/api.ts

@@ -21,7 +21,6 @@ import { ApiRef, createApiRef } from '@backstage/core-plugin-api';
 export const techRadarApiRef: ApiRef<TechRadarApi> = createApiRef<TechRadarApi>(
   {
     id: 'plugin.techradar.service',
-    description: 'Used to populate data in the TechRadar plugin',
   },
 );
 

plugins/techdocs/src/api.ts

@@ -20,12 +20,10 @@ import { createApiRef } from '@backstage/core-plugin-api';
 
 export const techdocsStorageApiRef = createApiRef<TechDocsStorageApi>({
   id: 'plugin.techdocs.storageservice',
-  description: 'Used to make requests towards the techdocs storage',
 });
 
 export const techdocsApiRef = createApiRef<TechDocsApi>({
   id: 'plugin.techdocs.service',
-  description: 'Used to make requests towards techdocs API',
 });
 
 export type SyncResult = 'cached' | 'updated';

plugins/todo/src/api/types.ts

@@ -107,5 +107,4 @@ export interface TodoApi {
  */
 export const todoApiRef = createApiRef<TodoApi>({
   id: 'plugin.todo.api',
-  description: 'Lists TODOs',
 });

plugins/xcmetrics/src/api/types.ts

@@ -193,5 +193,4 @@ export interface XcmetricsApi {
 
 export const xcmetricsApiRef = createApiRef<XcmetricsApi>({
   id: 'plugin.xcmetrics.api',
-  description: 'Used by the XCMetrics plugin to make requests',
 });