Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace implementsApis with providesApis and add consumesApis #3449

Merged
merged 5 commits into from
Nov 26, 2020

Conversation

Fox32
Copy link
Contributor

@Fox32 Fox32 commented Nov 25, 2020

As the new relations are using the term "provides" we should rename it in the spec too. implementsApis is now called providesApis. In addition, the new field consumesApis is added to fill the new "consumes" relationship.

This PR only deprecated the implementsApis field for future removal (after Dec 14th, 2020). Please not that code that is not using the relations will not work when only the field providesApis is filled. Code that is using the new relations will work as before.

@freben / @Rugvip what do you think?

Till now, this PR doesn't remove the usage of implementsApis in the frontend, but I plan to add these changes to this PR too. I wouldn't switch to the new spec properties, but directly to the relations instead (done). In my opinion this would support both implementsApis and providesApis during the deprecation phase. Consumers outside of this repository have to make sure that they fill both fields.

After deprecation we have to:

  • Fix example specs.
  • Remove the implementsApis property from the entity.

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)

@Fox32 Fox32 marked this pull request as ready for review November 25, 2020 17:11
@Fox32 Fox32 requested a review from a team as a code owner November 25, 2020 17:11
Copy link
Member

@freben freben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really well made - thanks. Just some language remarks :)

.changeset/short-singers-serve.md Outdated Show resolved Hide resolved
.changeset/short-singers-serve.md Outdated Show resolved Hide resolved
plugins/api-docs/README.md Outdated Show resolved Hide resolved
plugins/api-docs/src/catalog/Router.tsx Outdated Show resolved Hide resolved
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
@changeset-bot
Copy link

changeset-bot bot commented Nov 26, 2020

🦋 Changeset detected

Latest commit: 032aba5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@backstage/plugin-api-docs Patch
@backstage/plugin-catalog Patch
@backstage/catalog-model Patch
@backstage/plugin-catalog-backend Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@Fox32
Copy link
Contributor Author

Fox32 commented Nov 26, 2020

Thanks, I made the changes. Once this is merged I will prepare the PR that we can merge after Dec 14th

@Fox32 Fox32 merged commit f76626c into backstage:master Nov 26, 2020
@Fox32 Fox32 deleted the feat/provides-consumse-api branch November 26, 2020 16:27
@Fox32 Fox32 mentioned this pull request Nov 26, 2020
4 tasks
Fox32 added a commit to SDA-SE/backstage that referenced this pull request Dec 7, 2020
This was deprecated in backstage#3449. This should not be merged sooner then Dec 14th, 2020!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants