feat: prevent conflicting names in catalog-info #400
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When there are multiple apis defined (eg internal and public) that have specs with the same name, version, and stability we will generate the same name in the catalog-info. Since backstage uses the name as the unique identified this will result in one shadowing the other and not be available in backstage.
Backstage names need to be unique, there is nothing preventing users from having the same name across their api specs which would be fine up until we generate the backstage resources. To prevent us burdening developers with the chore of renaming them, we can add the api name to the name which is guaranteed to be unique.
Backstage has a limit on names to 63 characters. Truncate long names to fit this limit.
corneliu-petrescu
approved these changes
Nov 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backstage names need to be unique, there is nothing preventing users from
having the same name across their api specs which would be fine up until we
generate the backstage resources. To prevent us burdening developers with the
chore of renaming them, we can add the api name to the name which is guaranteed
to be unique.
This prevents the underlying issue and emits an error in case there is a different path to this error.