包详细信息

@backstage/plugin-catalog-common

backstage362.7kApache-2.01.1.4

Common functionalities for the catalog plugin

backstage

自述文件

headline

Backstage

English | 한국어 | 中文版 | Français

License CNCF Status Discord Code style Codecov OpenSSF Best Practices OpenSSF Scorecard

What is Backstage?

Backstage is an open source framework for building developer portals. Powered by a centralized software catalog, Backstage restores order to your microservices and infrastructure and enables your product teams to ship high-quality code quickly without compromising autonomy.

Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end.

software-catalog

Out of the box, Backstage includes:

  • Backstage Software Catalog for managing all your software such as microservices, libraries, data pipelines, websites, and ML models
  • Backstage Software Templates for quickly spinning up new projects and standardizing your tooling with your organization’s best practices
  • Backstage TechDocs for making it easy to create, maintain, find, and use technical documentation, using a "docs like code" approach
  • Plus, a growing ecosystem of open source plugins that further expand Backstage’s customizability and functionality

Backstage was created by Spotify but is now hosted by the Cloud Native Computing Foundation (CNCF) as an Incubation level project. For more information, see the announcement.

Project roadmap

For information about the detailed project roadmap including delivered milestones, see the Roadmap.

Getting Started

To start using Backstage, see the Getting Started documentation.

Documentation

The documentation of Backstage includes:

Community

To engage with our community, you can use the following resources:

Governance

See the GOVERNANCE.md document in the backstage/community repository.

License

Copyright 2020-2025 © The Backstage Authors. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page: https://www.linuxfoundation.org/trademark-usage

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

Security

Please report sensitive security issues using Spotify's bug-bounty program rather than GitHub.

For further details, see our complete security release process.

更新日志

@backstage/plugin-catalog-common

1.1.4

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.7.4
    • @backstage/plugin-permission-common@0.9.0
    • @backstage/plugin-search-common@1.2.18

1.1.4-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.9.0-next.0
    • @backstage/catalog-model@1.7.3
    • @backstage/plugin-search-common@1.2.18-next.0

1.1.3

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.7.3
    • @backstage/plugin-permission-common@0.8.4
    • @backstage/plugin-search-common@1.2.17

1.1.3-next.0

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.7.3-next.0
    • @backstage/plugin-permission-common@0.8.4-next.0
    • @backstage/plugin-search-common@1.2.17-next.0

1.1.2

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.7.2
    • @backstage/plugin-permission-common@0.8.3
    • @backstage/plugin-search-common@1.2.16

1.1.2-next.0

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.7.2-next.0
    • @backstage/plugin-permission-common@0.8.3-next.0
    • @backstage/plugin-search-common@1.2.16-next.0

1.1.1

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.8.2
    • @backstage/catalog-model@1.7.1
    • @backstage/plugin-search-common@1.2.15

1.1.0

Minor Changes

  • bd35cdb: The analyze-location endpoint is now protected by the catalog.location.analyze permission. The validate-entity endpoint is now protected by the catalog.entity.validate permission.

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.7.0
    • @backstage/plugin-permission-common@0.8.1
    • @backstage/plugin-search-common@1.2.14

1.0.26

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.8.1
    • @backstage/plugin-search-common@1.2.14
    • @backstage/catalog-model@1.6.0

1.0.26-next.2

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.6.0-next.0
    • @backstage/plugin-permission-common@0.8.1-next.1
    • @backstage/plugin-search-common@1.2.14-next.1

1.0.26-next.1

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.8.1-next.1
    • @backstage/plugin-search-common@1.2.14-next.1
    • @backstage/catalog-model@1.5.0

1.0.26-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.8.1-next.0
    • @backstage/plugin-search-common@1.2.14-next.0
    • @backstage/catalog-model@1.5.0

1.0.25

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.8.0
    • @backstage/plugin-search-common@1.2.13
    • @backstage/catalog-model@1.5.0

1.0.24

Patch Changes

  • d44a20a: Added additional plugin metadata to package.json.
  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.14
    • @backstage/plugin-search-common@1.2.12
    • @backstage/catalog-model@1.5.0

1.0.24-next.0

Patch Changes

  • d44a20a: Added additional plugin metadata to package.json.
  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.14-next.0
    • @backstage/plugin-search-common@1.2.12-next.0
    • @backstage/catalog-model@1.5.0

1.0.23

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.5.0

1.0.23-next.0

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.5.0-next.0
    • @backstage/plugin-permission-common@0.7.13
    • @backstage/plugin-search-common@1.2.11

1.0.22

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.13
    • @backstage/plugin-search-common@1.2.11
    • @backstage/catalog-model@1.4.5

1.0.22-next.1

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.13-next.1
    • @backstage/catalog-model@1.4.5-next.0
    • @backstage/plugin-search-common@1.2.11-next.1

1.0.22-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.13-next.0
    • @backstage/plugin-search-common@1.2.11-next.0
    • @backstage/catalog-model@1.4.5-next.0

1.0.21

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.4.4
    • @backstage/plugin-permission-common@0.7.12
    • @backstage/plugin-search-common@1.2.10

1.0.21-next.0

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.4.4-next.0
    • @backstage/plugin-permission-common@0.7.12
    • @backstage/plugin-search-common@1.2.10

1.0.20

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.12
    • @backstage/catalog-model@1.4.3
    • @backstage/plugin-search-common@1.2.10

1.0.19

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.11
    • @backstage/catalog-model@1.4.3
    • @backstage/plugin-search-common@1.2.9

1.0.18

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.10
    • @backstage/catalog-model@1.4.3
    • @backstage/plugin-search-common@1.2.8

1.0.17

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.4.3
    • @backstage/plugin-permission-common@0.7.9
    • @backstage/plugin-search-common@1.2.7

1.0.17-next.0

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.4.3-next.0
    • @backstage/plugin-permission-common@0.7.9-next.0
    • @backstage/plugin-search-common@1.2.7-next.0

1.0.16

Patch Changes

  • 406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
  • Updated dependencies
    • @backstage/catalog-model@1.4.2
    • @backstage/plugin-permission-common@0.7.8
    • @backstage/plugin-search-common@1.2.6

1.0.16-next.2

Patch Changes

  • 406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
  • Updated dependencies
    • @backstage/catalog-model@1.4.2-next.2
    • @backstage/plugin-permission-common@0.7.8-next.2
    • @backstage/plugin-search-common@1.2.6-next.2

1.0.16-next.1

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.4.2-next.1
    • @backstage/plugin-permission-common@0.7.8-next.1
    • @backstage/plugin-search-common@1.2.6-next.1

1.0.16-next.0

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.4.2-next.0
    • @backstage/plugin-permission-common@0.7.8-next.0
    • @backstage/plugin-search-common@1.2.6-next.0

1.0.15

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.4.1
    • @backstage/plugin-permission-common@0.7.7
    • @backstage/plugin-search-common@1.2.5

1.0.15-next.0

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.4.1-next.0
    • @backstage/plugin-permission-common@0.7.7-next.0
    • @backstage/plugin-search-common@1.2.5-next.0

1.0.14

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.4.0
    • @backstage/plugin-permission-common@0.7.6
    • @backstage/plugin-search-common@1.2.4

1.0.14-next.1

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.4.0-next.1
    • @backstage/plugin-permission-common@0.7.6-next.0
    • @backstage/plugin-search-common@1.2.4-next.0

1.0.14-next.0

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.4.0-next.0
    • @backstage/plugin-permission-common@0.7.6-next.0
    • @backstage/plugin-search-common@1.2.4-next.0

1.0.13

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.5
    • @backstage/catalog-model@1.3.0
    • @backstage/plugin-search-common@1.2.3

1.0.13-next.1

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.3.0-next.0
    • @backstage/plugin-permission-common@0.7.5-next.0
    • @backstage/plugin-search-common@1.2.3-next.0

1.0.13-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.5-next.0
    • @backstage/catalog-model@1.2.1
    • @backstage/plugin-search-common@1.2.3-next.0

1.0.12

Patch Changes

  • 928a12a9b3e: Internal refactor of /alpha exports.
  • Updated dependencies
    • @backstage/catalog-model@1.2.1
    • @backstage/plugin-permission-common@0.7.4
    • @backstage/plugin-search-common@1.2.2

1.0.12-next.1

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.4-next.0
    • @backstage/catalog-model@1.2.1-next.1
    • @backstage/plugin-search-common@1.2.2-next.0

1.0.12-next.0

Patch Changes

  • 928a12a9b3: Internal refactor of /alpha exports.
  • Updated dependencies
    • @backstage/catalog-model@1.2.1-next.0
    • @backstage/plugin-permission-common@0.7.3
    • @backstage/plugin-search-common@1.2.1

1.0.11

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.2.0
    • @backstage/plugin-permission-common@0.7.3
    • @backstage/plugin-search-common@1.2.1

1.0.11-next.1

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.2.0-next.1
    • @backstage/plugin-permission-common@0.7.3
    • @backstage/plugin-search-common@1.2.1

1.0.11-next.0

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.1.6-next.0

1.0.10

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.1.5
    • @backstage/plugin-permission-common@0.7.3
    • @backstage/plugin-search-common@1.2.1

1.0.10-next.1

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.1.5-next.1
    • @backstage/plugin-permission-common@0.7.3-next.0
    • @backstage/plugin-search-common@1.2.1-next.0

1.0.10-next.0

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.1.5-next.0
    • @backstage/plugin-permission-common@0.7.2
    • @backstage/plugin-search-common@1.2.0

1.0.9

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.2
    • @backstage/plugin-search-common@1.2.0
    • @backstage/catalog-model@1.1.4

1.0.9-next.3

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.2-next.2
    • @backstage/catalog-model@1.1.4-next.1
    • @backstage/plugin-search-common@1.2.0-next.3

1.0.9-next.2

Patch Changes

  • Updated dependencies
    • @backstage/plugin-search-common@1.2.0-next.2
    • @backstage/catalog-model@1.1.4-next.1
    • @backstage/plugin-permission-common@0.7.2-next.1

1.0.9-next.1

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.1.4-next.1
    • @backstage/plugin-permission-common@0.7.2-next.1
    • @backstage/plugin-search-common@1.1.2-next.1

1.0.9-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.7.2-next.0
    • @backstage/catalog-model@1.1.4-next.0
    • @backstage/plugin-search-common@1.1.2-next.0

1.0.8

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.1.3
    • @backstage/plugin-permission-common@0.7.1
    • @backstage/plugin-search-common@1.1.1

1.0.8-next.0

Patch Changes

  • Updated dependencies
    • @backstage/catalog-model@1.1.3-next.0
    • @backstage/plugin-permission-common@0.7.1-next.0
    • @backstage/plugin-search-common@1.1.1-next.0

1.0.7

Patch Changes

  • 823acaa88b: Moved the following types from @backstage/plugin-catalog-backend to this package.

    • AnalyzeLocationResponse
    • AnalyzeLocationRequest
    • AnalyzeLocationExistingEntity
    • AnalyzeLocationGenerateEntity
    • AnalyzeLocationEntityField
  • Updated dependencies

    • @backstage/catalog-model@1.1.2
    • @backstage/plugin-permission-common@0.7.0
    • @backstage/plugin-search-common@1.1.0

1.0.7-next.2

Patch Changes

  • 823acaa88b: Moved the following types from @backstage/plugin-catalog-backend to this package.

    • AnalyzeLocationResponse
    • AnalyzeLocationRequest
    • AnalyzeLocationExistingEntity
    • AnalyzeLocationGenerateEntity
    • AnalyzeLocationEntityField
  • Updated dependencies

    • @backstage/plugin-permission-common@0.7.0-next.2
    • @backstage/plugin-search-common@1.1.0-next.2
    • @backstage/catalog-model@1.1.2-next.2

1.0.7-next.1

Patch Changes

  • Updated dependencies
    • @backstage/plugin-search-common@1.1.0-next.1
    • @backstage/plugin-permission-common@0.6.5-next.1

1.0.7-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.6.5-next.0
    • @backstage/plugin-search-common@1.0.2-next.0

1.0.6

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.6.4
    • @backstage/plugin-search-common@1.0.1

1.0.6-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.6.4-next.0
    • @backstage/plugin-search-common@1.0.1-next.0

1.0.5

Patch Changes

  • 92103db537: Export aggregated list of all catalog permissions

1.0.5-next.0

Patch Changes

  • 92103db537: Export aggregated list of all catalog permissions

1.0.4

Patch Changes

  • Updated dependencies
    • @backstage/plugin-search-common@1.0.0
    • @backstage/plugin-permission-common@0.6.3

1.0.4-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.6.3-next.0
    • @backstage/plugin-search-common@0.3.6-next.0

1.0.3

Patch Changes

  • 7d8acfc32e: Replaced all usages of @backstage/search-common with @backstage/plugin-search-common
  • Updated dependencies
    • @backstage/plugin-search-common@0.3.5
    • @backstage/plugin-permission-common@0.6.2

1.0.3-next.1

Patch Changes

  • 7d8acfc32e: Replaced all usages of @backstage/search-common with @backstage/plugin-search-common
  • Updated dependencies
    • @backstage/plugin-search-common@0.3.5-next.1

1.0.3-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.6.2-next.0
    • @backstage/search-common@0.3.5-next.0

1.0.2

Patch Changes

  • Updated dependencies
    • @backstage/search-common@0.3.4
    • @backstage/plugin-permission-common@0.6.1

1.0.2-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.6.1-next.0
    • @backstage/search-common@0.3.4-next.0

1.0.1

Patch Changes

  • ada4446733: Use createPermission helper when creating permissions.
  • 8c8bee47f4: Add @alpha CatalogEntityPermission convenience type, available for import from @backstage/plugin-catalog-common/alpha.
  • Updated dependencies
    • @backstage/plugin-permission-common@0.6.0
    • @backstage/search-common@0.3.3

1.0.1-next.1

Patch Changes

  • ada4446733: Use createPermission helper when creating permissions.
  • 8c8bee47f4: Add @alpha CatalogEntityPermission convenience type, available for import from @backstage/plugin-catalog-common/alpha.
  • Updated dependencies
    • @backstage/plugin-permission-common@0.6.0-next.0
    • @backstage/search-common@0.3.3-next.1

1.0.1-next.0

Patch Changes

  • Updated dependencies
    • @backstage/search-common@0.3.3-next.0

1.0.0

Major Changes

  • b58c70c223: This package has been promoted to v1.0! To understand how this change affects the package, please check out our versioning policy.

Patch Changes

  • Updated dependencies
    • @backstage/search-common@0.3.2
    • @backstage/plugin-permission-common@0.5.3

0.2.2

Patch Changes

  • b1aacbf96a: Applied the fix for the /alpha entry point resolution that was part of the v0.70.1 release of Backstage.
  • Updated dependencies
    • @backstage/search-common@0.3.1

0.2.2-next.0

Patch Changes

  • b1aacbf96a: Applied the fix for the /alpha entry point resolution that was part of the v0.70.1 release of Backstage.
  • Updated dependencies
    • @backstage/search-common@0.3.1-next.0

0.2.1

Patch Changes

  • Fixed runtime resolution of the /alpha entry point.

0.2.0

Minor Changes

  • e3c2bfef11: Remove resourceType property from catalogEntityCreatePermission. Resource type refers to the type of resources whose resourceRefs should be passed along with authorize requests, to allow conditional responses for that resource type. Since creation does not correspond to an entity (as the entity does not exist at the time of authorization), the resourceRef should not be included on the permission.
  • 81273e95cf: Breaking: Mark permission-related exports as alpha. This means that the exports below should now be imported from @backstage/plugin-catalog-common/alpha instead of @backstage/plugin-catalog-common.

    • RESOURCE_TYPE_CATALOG_ENTITY
    • catalogEntityReadPermission
    • catalogEntityCreatePermission
    • catalogEntityDeletePermission
    • catalogEntityRefreshPermission
    • catalogLocationReadPermission
    • catalogLocationCreatePermission
    • catalogLocationDeletePermission

Patch Changes

  • ab7b6cb7b1: DEPRECATION: Moved the CatalogEntityDocument to @backstage/plugin-catalog-common and deprecated the export from @backstage/plugin-catalog-backend.

    A new type field has also been added to CatalogEntityDocument as a replacement for componentType, which is now deprecated. Both fields are still present and should be set to the same value in order to avoid issues with indexing.

    Any search customizations need to be updated to use this new type field instead, including any custom frontend filters, custom frontend result components, custom search decorators, or non-default Catalog collator implementations.

  • Updated dependencies

    • @backstage/plugin-permission-common@0.5.2
    • @backstage/search-common@0.3.0

0.1.4

Patch Changes

  • Fix for the previous release with missing type declarations.
  • Updated dependencies
    • @backstage/plugin-permission-common@0.5.1

0.1.3

Patch Changes

  • c77c5c7eb6: Added backstage.role to package.json
  • Updated dependencies
    • @backstage/plugin-permission-common@0.5.0

0.1.2

Patch Changes

  • ba59832aed: Adds new catalogEntityCreatePermission which can be imported and used when authoring a permission policy to restrict/grant a user's access to the catalog import plugin. (And the "Register Existing Component" button which navigates there).

0.1.2-next.0

Patch Changes

  • ba59832aed: Adds new catalogEntityCreatePermission which can be imported and used when authoring a permission policy to restrict/grant a user's access to the catalog import plugin. (And the "Register Existing Component" button which navigates there).

0.1.1

Patch Changes

  • 7e38acaa9e: Remove Catalog Location resource type
  • Updated dependencies
    • @backstage/plugin-permission-common@0.4.0

0.1.1-next.0

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.4.0-next.0

0.1.0

Minor Changes

  • 393f107893: Create catalog-common and add catalog permissions.

Patch Changes

  • Updated dependencies
    • @backstage/plugin-permission-common@0.3.0