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

Merge pull request #29665 from GabDug/typos

Browse Source 
chore(typos): fix various code typos
This commit is contained in:
Fredrik Adelöw
2025-04-28 16:50:18 +02:00
committed by GitHub
parent 43852f5caa 72d019d663
commit 28aa309325
83 changed files with 217 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/api-docs/README-alpha.md
+16 -16
View File
@@ -77,12 +77,12 @@ To link that a component provides or consumes an API, see the [`providesApis`](h
# Shows a table of components that provides a particular api
- entity-card:api-docs/providing-components:
config:
# Presenting the card ony for entites of kind api
# Presenting the card only for entities of kind api
filter: kind:api
# Shows a table of components that consumes a particular api
- entity-card:api-docs/consuming-components:
config:
# Presenting the card ony for entites of kind api
# Presenting the card only for entities of kind api
filter: kind:api
# Enabling some contents
# The contents will be displayed in the same order it appears in this setting list
@@ -285,7 +285,7 @@ export default createFrontendModule({
pluginId: 'api-docs',
extensions: [
createPageExtension({
// Ommitting name since we are overriding a plugin index page
// Omitting name since we are overriding a plugin index page
// It's up to you whether to use the original default path or not, but links that are hardcoded to the default path won't work if you change it
defaultPath: '/api-docs',
// Associating the page with a different route ref may result in the sidebar item or external plugin route pointing to an unreachable page
@@ -370,7 +370,7 @@ export default createFrontendModule({
createEntityCardExtension({
// Name is necessary so the system knows that this extension will override the default 'has-apis' entity card extension provided by the 'api-docs' plugin
name: 'has-apis',
// Returing a custom card component
// Returning a custom card component
loader: () =>
import('./components').then(m => <m.MyCustomHasApisEntityCard />),
}),
@@ -443,7 +443,7 @@ export default createFrontendModule({
createEntityCardExtension({
// Name is necessary so the system knows that this extension will override the default 'definition' entity card extension provided by the 'api-docs' plugin
name: 'definition',
// Returing a custom card component
// Returning a custom card component
loader: () =>
import('./components').then(m => <m.MyCustomApiDefinitionEntityCard />),
}),
@@ -516,7 +516,7 @@ export default createFrontendModule({
createEntityCardExtension({
// Name is necessary so the system knows that this extension will override the default 'provided-apis' entity card extension provided by the 'api-docs' plugin
name: 'provided-apis',
// Returing a custom card component
// Returning a custom card component
loader: () =>
import('./components').then(m => <m.MyCustomProvidedApisEntityCard />),
}),
@@ -589,7 +589,7 @@ export default createFrontendModule({
createEntityCardExtension({
// Name is necessary so the system knows that this extension will override the default 'consumed-apis' entity card extension provided by the 'api-docs' plugin
name: 'consumed-apis',
// Returing a custom card component
// Returning a custom card component
loader: () =>
import('./components').then(m => <m.MyCustomConsumedApisEntityCard />),
}),
@@ -662,7 +662,7 @@ export default createFrontendModule({
createEntityCardExtension({
// Name is necessary so the system knows that this extension will override the default 'providing-components' entity card extension provided by the 'api-docs' plugin
name: 'providing-components',
// Returing a custom card component
// Returning a custom card component
loader: () =>
import('./components').then(m => (
<m.MyCustomProvidingComponentsEntityCard />
@@ -737,7 +737,7 @@ export default createFrontendModule({
createEntityCardExtension({
// Name is necessary so the system knows that this extension will override the default 'consuming-components' entity card extension provided by the 'api-docs' plugin
name: 'consuming-components',
// Returing a custom card component
// Returning a custom card component
loader: () =>
import('./components').then(m => (
<m.MyCustomConsumingComponentsEntityCard />
@@ -906,7 +906,7 @@ export default createFrontendModule({
createEntityContentExtension({
// Name is necessary so the system knows that this extension will override the default 'apis' entity content extension provided by the 'api-docs' plugin
name: 'apis',
// Returing a custom content component
// Returning a custom content component
loader: () =>
import('./components').then(m => <m.MyCustomApisEntityContent />),
}),
@@ -935,7 +935,7 @@ This is an example with a made-up renderer for SQL schemas:
```tsx
import {
createFrontendModule,
createApiExtenion,
createApiExtension,
createApiFactory,
} from '@backstage/frontend-plugin-api';
import { ApiEntity } from '@backstage/catalog-model';
@@ -949,7 +949,7 @@ import { SqlRenderer } from '...';
export default createFrontendModule({
pluginId: 'api-docs',
extensions: [
createApiExtenion({
createApiExtension({
factory: createApiFactory({
api: apiDocsConfigRef,
deps: {},
@@ -989,7 +989,7 @@ Override the config api to configure a [`requestInterceptor` for Swagger UI](htt
```tsx
import {
createFrontendModule,
createApiExtenion,
createApiExtension,
createApiFactory,
} from '@backstage/frontend-plugin-api';
import {
@@ -1002,7 +1002,7 @@ import { ApiEntity } from '@backstage/catalog-model';
export default createFrontendModule({
pluginId: 'api-docs',
extensions: [
createApiExtenion({
createApiExtension({
factory: createApiFactory({
api: apiDocsConfigRef,
deps: {},
@@ -1051,7 +1051,7 @@ If you want to limit the HTTP methods available for the `Try It Out` feature of
```tsx
import {
createFrontendModule,
createApiExtenion,
createApiExtension,
createApiFactory,
} from '@backstage/frontend-plugin-api';
import {
@@ -1064,7 +1064,7 @@ import { ApiEntity } from '@backstage/catalog-model';
export default createFrontendModule({
pluginId: 'api-docs',
extensions: [
createApiExtenion({
createApiExtension({
factory: createApiFactory({
api: apiDocsConfigRef,
deps: {},
plugins/api-docs/src/alpha.tsx
+6 -6
View File
@@ -74,7 +74,7 @@ const apiDocsConfigApi = ApiBlueprint.make({
const apiDocsExplorerPage = PageBlueprint.makeWithOverrides({
config: {
schema: {
// Ommiting columns and actions for now as their types are too complex to map to zod
// Omitting columns and actions for now as their types are too complex to map to zod
initiallySelectedFilter: z =>
z.enum(['owned', 'starred', 'all']).optional(),
},
@@ -98,7 +98,7 @@ const apiDocsExplorerPage = PageBlueprint.makeWithOverrides({
const apiDocsHasApisEntityCard = EntityCardBlueprint.make({
name: 'has-apis',
params: {
// Ommiting configSchema for now
// Omitting configSchema for now
// We are skipping variants and columns are too complex to map to zod
// See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252
filter: entity => {
@@ -132,7 +132,7 @@ const apiDocsDefinitionEntityCard = EntityCardBlueprint.make({
const apiDocsConsumedApisEntityCard = EntityCardBlueprint.make({
name: 'consumed-apis',
params: {
// Ommiting configSchema for now
// Omitting configSchema for now
// We are skipping variants and columns are too complex to map to zod
// See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252
filter: 'kind:component',
@@ -146,7 +146,7 @@ const apiDocsConsumedApisEntityCard = EntityCardBlueprint.make({
const apiDocsProvidedApisEntityCard = EntityCardBlueprint.make({
name: 'provided-apis',
params: {
// Ommiting configSchema for now
// Omitting configSchema for now
// We are skipping variants and columns are too complex to map to zod
// See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252
filter: 'kind:component',
@@ -160,7 +160,7 @@ const apiDocsProvidedApisEntityCard = EntityCardBlueprint.make({
const apiDocsConsumingComponentsEntityCard = EntityCardBlueprint.make({
name: 'consuming-components',
params: {
// Ommiting configSchema for now
// Omitting configSchema for now
// We are skipping variants
// See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252
filter: 'kind:api',
@@ -174,7 +174,7 @@ const apiDocsConsumingComponentsEntityCard = EntityCardBlueprint.make({
const apiDocsProvidingComponentsEntityCard = EntityCardBlueprint.make({
name: 'providing-components',
params: {
// Ommiting configSchema for now
// Omitting configSchema for now
// We are skipping variants
// See: https://github.com/backstage/backstage/pull/22619#discussion_r1477333252
filter: 'kind:api',