* fix(docs): typos which were reflacted from vale linter's command * feat: Implement Vale linter (#2031) Initialize .vale.ini file Add 'lint:docs' script to package.json, to lint all md files except the ones which are located in node_modules Generate 'vocab.txt' by using command 'yarn run lint:docs' | grep -o ''[a-z A-Z]*'' | grep -o '[a-z A-Z]*' | sort | uniq > .github/styles/vocab.txt Add steps to github workflow 'master' to check docs quality * chore: Separate workflow for quality checking * chore: Added 'shx' dev dependency to support grep command in cross platform * feat: Add script to operate same quality check process on different platform * ignore: remove lint:docs from lint-stages which was added for experiment purpose * fix: check-all-files on push event & check-changed-files on pull_request event * chore(CI): triggle workflow only when there is any updates in .md file(s) on pull request * fix: use spawnSync to solve 'The command line is too long.' error * fix: github workflow syntax * fix: prettier error * chore: add vale command directly to lint-staged * chore: use shebang for easy access * fix: windows script issue & remove shebang * chore: Add shebang flag * chore: better error message related to vale * chore: mention vale linter in documentation * fix: spelling errors & add keywords to vocab.txt
Backstage Core Utility APIs
The following is a list of all Utility APIs defined by @backstage/core. They
are available to use by plugins and components, and can be accessed using the
useApi hook, also provided by @backstage/core. For more information, see
https://github.com/spotify/backstage/blob/master/docs/api/utility-apis.md.
alert
Used to report alerts and forward them to the app
Implemented type: AlertApi
ApiRef: alertApiRef
appTheme
API Used to configure the app theme, and enumerate options
Implemented type: AppThemeApi
ApiRef: appThemeApiRef
auth0Auth
Provides authentication towards Auth0 APIs
Implemented types: OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: auth0AuthApiRef
config
Used to access runtime configuration
Implemented type: Config
ApiRef: configApiRef
discovery
Provides service discovery of backend plugins
Implemented type: DiscoveryApi
ApiRef: discoveryApiRef
error
Used to report errors and forward them to the app
Implemented type: ErrorApi
ApiRef: errorApiRef
featureFlags
Used to toggle functionality in features across Backstage
Implemented type: FeatureFlagsApi
ApiRef: featureFlagsApiRef
githubAuth
Provides authentication towards GitHub APIs
Implemented types: OAuthApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: githubAuthApiRef
gitlabAuth
Provides authentication towards GitLab APIs
Implemented types: OAuthApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: gitlabAuthApiRef
googleAuth
Provides authentication towards Google APIs and identities
Implemented types: OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: googleAuthApiRef
identity
Provides access to the identity of the signed in user
Implemented type: IdentityApi
ApiRef: identityApiRef
microsoftAuth
Provides authentication towards Microsoft APIs and identities
Implemented types: OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: microsoftAuthApiRef
oauth2
Example of how to use oauth2 custom provider
Implemented types: OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: oauth2ApiRef
oauthRequest
An API for implementing unified OAuth flows in Backstage
Implemented type: OAuthRequestApi
ApiRef: oauthRequestApiRef
oktaAuth
Provides authentication towards Okta APIs
Implemented types: OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi
ApiRef: oktaAuthApiRef
storage
Provides the ability to store data which is unique to the user
Implemented type: StorageApi
ApiRef: storageApiRef