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.

Sign up for GitHub

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

Jump to bottom

Improvement to the doc service API #20017

Merged
merged 6 commits into from Apr 8, 2024
Merged

Improvement to the doc service API #20017

merged 6 commits into from Apr 8, 2024

Conversation

alexandrebodin
Copy link
Member

@alexandrebodin alexandrebodin commented Apr 3, 2024 •
edited

What does it do?

  • simplify components api in doc service and fix some typings

Why is it needed?

Describe the issue you are solving.

How to test it?

  • history & i18n are impacted
  • basic component management

Todo

  • Unify method responses
  • Unify method params
  • Add middleware match filters

example

strapi.documents.use((ctx, next) => {}, { uid: ['a', 'b'], action: ['a', 'b'] })
  • expose components methods
  • expose entries methods

@alexandrebodin alexandrebodin added pr: chore This PR contains chore tasks (cleanups, configs, tooling...) source: core:core Source is core/core labels Apr 3, 2024
@alexandrebodin alexandrebodin self-assigned this Apr 3, 2024
@vercel Vercel
Copy link

vercel bot commented Apr 3, 2024 •
edited

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
contributor-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 8, 2024 9:28am

@alexandrebodin alexandrebodin mentioned this pull request Apr 3, 2024
Closed
@alexandrebodin alexandrebodin changed the title chore: simplify components api in doc service and fix some typings Improvement to the doc service API Apr 3, 2024
@alexandrebodin
Copy link
Member Author

@Marc-Roig putting is as ready so we can merge this 1st round of changes and then I'll improve the entires/components/transform code. The typings will also need some love

@alexandrebodin alexandrebodin marked this pull request as ready for review April 4, 2024 20:39
@alexandrebodin alexandrebodin force-pushed the v5/document-service-api branch 2 times, most recently from 5372315 to 12cb554 Compare April 5, 2024 09:35
Marc-Roig
Marc-Roig approved these changes Apr 5, 2024
View reviewed changes
Copy link
Contributor

@Marc-Roig Marc-Roig left a comment

Choose a reason for hiding this comment

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

AMAZING ✨
I would warn people internally if they are working on backend stuff to know about this change

@alexandrebodin alexandrebodin mentioned this pull request Apr 8, 2024
Merged
@alexandrebodin alexandrebodin merged commit 8dc428d into v5/main Apr 8, 2024
77 of 82 checks passed
@alexandrebodin
Copy link
Member Author

Continuing the work here #20060

@alexandrebodin alexandrebodin deleted the v5/document-service-api branch April 8, 2024 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Marc-Roig Marc-Roig Marc-Roig approved these changes

Assignees

@alexandrebodin alexandrebodin

Labels
pr: chore This PR contains chore tasks (cleanups, configs, tooling...) source: core:core Source is core/core
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@alexandrebodin @Marc-Roig