diff --git a/.changeset/empty-mugs-bow.md b/.changeset/empty-mugs-bow.md new file mode 100644 index 0000000000..d9d63e7f89 --- /dev/null +++ b/.changeset/empty-mugs-bow.md @@ -0,0 +1,5 @@ +--- +'@backstage/core-plugin-api': patch +--- + +The authentication APIs are no longer `@alpha`. Since the `@backstage/core-plugin-api` has no `/alpha` entrypoint, the only effect of marking the APIs as `@alpha` was to hide them in documentation. They are still expected to be widely used and there will be a migration path if they are changed in the future. diff --git a/packages/core-plugin-api/api-report.md b/packages/core-plugin-api/api-report.md index 89361419ba..8289e863e0 100644 --- a/packages/core-plugin-api/api-report.md +++ b/packages/core-plugin-api/api-report.md @@ -172,7 +172,7 @@ export type AppThemeApi = { // @public export const appThemeApiRef: ApiRef; -// @alpha +// @public export const atlassianAuthApiRef: ApiRef< OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi >; @@ -230,7 +230,7 @@ export type BackstageUserIdentity = { ownershipEntityRefs: string[]; }; -// @alpha +// @public export const bitbucketAuthApiRef: ApiRef< OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi >; @@ -462,17 +462,17 @@ export function getComponentData( type: string, ): T | undefined; -// @alpha +// @public export const githubAuthApiRef: ApiRef< OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi >; -// @alpha +// @public export const gitlabAuthApiRef: ApiRef< OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi >; -// @alpha +// @public export const googleAuthApiRef: ApiRef< OAuthApi & OpenIdConnectApi & @@ -517,7 +517,7 @@ export type MergeParams< P2 extends AnyParams, > = (P1[keyof P1] extends never ? {} : P1) & (P2 extends undefined ? {} : P2); -// @alpha +// @public export const microsoftAuthApiRef: ApiRef< OAuthApi & OpenIdConnectApi & @@ -559,7 +559,7 @@ export type OAuthRequesterOptions = { // @public export type OAuthScope = string | string[]; -// @alpha +// @public export const oktaAuthApiRef: ApiRef< OAuthApi & OpenIdConnectApi & @@ -568,7 +568,7 @@ export const oktaAuthApiRef: ApiRef< SessionApi >; -// @alpha +// @public export const oneloginAuthApiRef: ApiRef< OAuthApi & OpenIdConnectApi & diff --git a/packages/core-plugin-api/src/apis/definitions/auth.ts b/packages/core-plugin-api/src/apis/definitions/auth.ts index 497ce8233b..163ae74806 100644 --- a/packages/core-plugin-api/src/apis/definitions/auth.ts +++ b/packages/core-plugin-api/src/apis/definitions/auth.ts @@ -295,8 +295,7 @@ export type SessionApi = { /** * Provides authentication towards Google APIs and identities. * - * @alpha This API is **EXPERIMENTAL** and might change in the future. - * + * @public * @remarks * * See {@link https://developers.google.com/identity/protocols/googlescopes} for a full list of supported scopes. @@ -317,8 +316,7 @@ export const googleAuthApiRef: ApiRef< /** * Provides authentication towards GitHub APIs. * - * @alpha This API is **EXPERIMENTAL** and might change in the future. - * + * @public * @remarks * * See {@link https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/} @@ -333,8 +331,7 @@ export const githubAuthApiRef: ApiRef< /** * Provides authentication towards Okta APIs. * - * @alpha This API is **EXPERIMENTAL** and might change in the future. - * + * @public * @remarks * * See {@link https://developer.okta.com/docs/guides/implement-oauth-for-okta/scopes/} @@ -353,8 +350,7 @@ export const oktaAuthApiRef: ApiRef< /** * Provides authentication towards GitLab APIs. * - * @alpha This API is **EXPERIMENTAL** and might change in the future. - * + * @public * @remarks * * See {@link https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#limiting-scopes-of-a-personal-access-token} @@ -369,8 +365,7 @@ export const gitlabAuthApiRef: ApiRef< /** * Provides authentication towards Microsoft APIs and identities. * - * @alpha This API is **EXPERIMENTAL** and might change in the future. - * + * @public * @remarks * * For more info and a full list of supported scopes, see: @@ -390,7 +385,7 @@ export const microsoftAuthApiRef: ApiRef< /** * Provides authentication towards OneLogin APIs. * - * @alpha This API is **EXPERIMENTAL** and might change in the future. + * @public */ export const oneloginAuthApiRef: ApiRef< OAuthApi & @@ -405,7 +400,7 @@ export const oneloginAuthApiRef: ApiRef< /** * Provides authentication towards Bitbucket APIs. * - * @alpha This API is **EXPERIMENTAL** and might change in the future. + * @public * @remarks * * See {@link https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud/} @@ -420,7 +415,7 @@ export const bitbucketAuthApiRef: ApiRef< /** * Provides authentication towards Atlassian APIs. * - * @alpha This API is **EXPERIMENTAL** and might change in the future. + * @public * @remarks * * See {@link https://developer.atlassian.com/cloud/jira/platform/scopes-for-connect-and-oauth-2-3LO-apps/}