chore: moving @alpha types to @public
Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
@@ -16,7 +16,7 @@
|
||||
|
||||
import { createApiRef } from '@backstage/core-plugin-api';
|
||||
|
||||
/** @alpha */
|
||||
/** @public */
|
||||
export type MetricKey =
|
||||
// alert status
|
||||
| 'alert_status'
|
||||
@@ -43,11 +43,11 @@ export type MetricKey =
|
||||
// duplicated lines
|
||||
| 'duplicated_lines_density';
|
||||
|
||||
/** @alpha */
|
||||
/** @public */
|
||||
export type SonarUrlProcessorFunc = (identifier: string) => string;
|
||||
|
||||
/**
|
||||
* @alpha
|
||||
* @public
|
||||
*
|
||||
* Define a type to make sure that all metrics are used
|
||||
*/
|
||||
@@ -55,7 +55,7 @@ export type Metrics = {
|
||||
[key in MetricKey]: string | undefined;
|
||||
};
|
||||
|
||||
/** @alpha */
|
||||
/** @public */
|
||||
export interface FindingSummary {
|
||||
lastAnalysis: string;
|
||||
metrics: Metrics;
|
||||
@@ -65,12 +65,12 @@ export interface FindingSummary {
|
||||
getSecurityHotspotsUrl: () => string;
|
||||
}
|
||||
|
||||
/** @alpha */
|
||||
/** @public */
|
||||
export const sonarQubeApiRef = createApiRef<SonarQubeApi>({
|
||||
id: 'plugin.sonarqube.service',
|
||||
});
|
||||
|
||||
/** @alpha */
|
||||
/** @public */
|
||||
export type SonarQubeApi = {
|
||||
getFindingSummary(options: {
|
||||
componentKey?: string;
|
||||
|
||||
@@ -25,7 +25,7 @@ export const SONARQUBE_PROJECT_INSTANCE_SEPARATOR = '/';
|
||||
*
|
||||
* If part or all info are not found, they will default to undefined
|
||||
*
|
||||
* @alpha
|
||||
* @public
|
||||
* @param entity - entity to find the sonarqube information from.
|
||||
* @returns a ProjectInfo properly populated.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user