paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #28805 from backstage/freben/inheritdoc

Browse Source 
🧹  inherit the right docs
This commit is contained in:
Ben Lambert
2025-02-12 09:51:21 +01:00
committed by GitHub
parent 8dee48768c eb80a1ad5a
commit c8d8d93a58
13 changed files with 38 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/fair-wolves-smash.md
+12
View File
@@ -0,0 +1,12 @@
---
'@backstage/plugin-catalog-backend-module-backstage-openapi': patch
'@backstage/plugin-catalog-backend-module-bitbucket-server': patch
'@backstage/plugin-catalog-backend-module-bitbucket-cloud': patch
'@backstage/plugin-catalog-backend-module-msgraph': patch
'@backstage/plugin-catalog-backend-module-github': patch
'@backstage/plugin-catalog-backend-module-azure': patch
'@backstage/plugin-catalog-backend-module-ldap': patch
'@backstage/plugin-catalog-backend-module-aws': patch
---
Minor doc string update
contrib/catalog/ImmediateEntityProvider.ts
+2 -2
View File
@@ -61,12 +61,12 @@ export class ImmediateEntityProvider implements EntityProvider {
this.entityValidator = entitySchemaValidator();
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
getProviderName() {
return `ImmediateEntityProvider`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection) {
this.connection = connection;
}
contrib/catalog/LoadTestingEntityProvider.ts
+3 -3
View File
@@ -6,7 +6,7 @@ import {
import {
EntityProvider,
EntityProviderConnection,
} from '@backstage/plugin-catalog-backend';
} from '@backstage/plugin-catalog-node';
import { Logger } from 'winston';
/**
@@ -41,12 +41,12 @@ import { Logger } from 'winston';
export class LoadTestingEntityProvider implements EntityProvider {
constructor(private readonly options: LoadTestingEntityProviderOptions) {}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
getProviderName() {
return `LoadTestingEntityProvider`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection) {
const delayStartup = this.options.delayStartup ?? 10_000;
const logger = this.options.logger.child({
plugins/catalog-backend-module-aws/src/providers/AwsS3EntityProvider.ts
+2 -2
View File
@@ -146,12 +146,12 @@ export class AwsS3EntityProvider implements EntityProvider {
};
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
getProviderName(): string {
return `awsS3-provider:${this.config.id}`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection): Promise<void> {
this.connection = connection;
const { accountId, region, bucketName } = this.config;
plugins/catalog-backend-module-azure/src/providers/AzureDevOpsEntityProvider.ts
+2 -2
View File
@@ -138,12 +138,12 @@ export class AzureDevOpsEntityProvider implements EntityProvider {
};
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
getProviderName(): string {
return `AzureDevOpsEntityProvider:${this.config.id}`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection): Promise<void> {
this.connection = connection;
await this.scheduleFn();
plugins/catalog-backend-module-backstage-openapi/src/InternalOpenApiDocumentationProvider.ts
+2 -2
View File
@@ -194,12 +194,12 @@ export class InternalOpenApiDocumentationProvider implements EntityProvider {
taskRunner,
);
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
getProviderName() {
return `InternalOpenApiDocumentationProvider`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection) {
this.connection = connection;
return await this.scheduleFn();
plugins/catalog-backend-module-bitbucket-cloud/src/providers/BitbucketCloudEntityProvider.ts
+3 -3
View File
@@ -169,17 +169,17 @@ export class BitbucketCloudEntityProvider implements EntityProvider {
};
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
getProviderName(): string {
return `bitbucketCloud-provider:${this.config.id}`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getTaskId} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getTaskId} */
getTaskId(): string {
return `${this.getProviderName()}:refresh`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection): Promise<void> {
this.connection = connection;
await this.scheduleFn();
plugins/catalog-backend-module-bitbucket-server/src/providers/BitbucketServerEntityProvider.ts
+2 -2
View File
@@ -145,12 +145,12 @@ export class BitbucketServerEntityProvider implements EntityProvider {
};
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
getProviderName(): string {
return `bitbucketServer-provider:${this.config.id}`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection): Promise<void> {
this.connection = connection;
await this.scheduleFn();
plugins/catalog-backend-module-github/src/providers/GithubEntityProvider.ts
+2 -2
View File
@@ -158,12 +158,12 @@ export class GithubEntityProvider implements EntityProvider, EventSubscriber {
SingleInstanceGithubCredentialsProvider.create(integration.config);
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
getProviderName(): string {
return `github-provider:${this.config.id}`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection): Promise<void> {
this.connection = connection;
await this.events?.subscribe({
plugins/catalog-backend-module-github/src/providers/GithubMultiOrgEntityProvider.ts
+2 -2
View File
@@ -232,12 +232,12 @@ export class GithubMultiOrgEntityProvider implements EntityProvider {
},
) {}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
getProviderName() {
return `GithubMultiOrgEntityProvider:${this.options.id}`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection) {
this.connection = connection;
await this.options.events?.subscribe({
plugins/catalog-backend-module-github/src/providers/GithubOrgEntityProvider.ts
+2 -2
View File
@@ -191,12 +191,12 @@ export class GithubOrgEntityProvider implements EntityProvider {
SingleInstanceGithubCredentialsProvider.create(this.options.gitHubConfig);
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
getProviderName() {
return `GithubOrgEntityProvider:${this.options.id}`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection) {
this.connection = connection;
await this.options.events?.subscribe({
plugins/catalog-backend-module-ldap/src/processors/LdapOrgEntityProvider.ts
+2 -2
View File
@@ -257,12 +257,12 @@ export class LdapOrgEntityProvider implements EntityProvider {
},
) {}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
getProviderName() {
return `LdapOrgEntityProvider:${this.options.id}`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection) {
this.connection = connection;
await this.scheduleFn?.();
plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgEntityProvider.ts
+2 -2
View File
@@ -301,12 +301,12 @@ export class MicrosoftGraphOrgEntityProvider implements EntityProvider {
},
) {}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
getProviderName() {
return `MicrosoftGraphOrgEntityProvider:${this.options.id}`;
}
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
/** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
async connect(connection: EntityProviderConnection) {
this.connection = connection;
await this.scheduleFn?.();