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

Add universal relations service #1602

Merged
merged 91 commits into from
May 23, 2023
Merged

Add universal relations service #1602

merged 91 commits into from
May 23, 2023

Conversation

ksuess
Copy link
Member

@ksuess ksuess commented Mar 19, 2023 •
edited
Loading

Resolve #1432

See preview of docs: https://deploy-preview-1602--plone-restapi.netlify.app/endpoints/relations.html

Required for relations control panel: plone/volto#3382

@mister-roboto
Copy link

@ksuess thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

@netlify
Copy link

netlify bot commented Mar 19, 2023 •
edited
Loading

✅ Deploy Preview for plone-restapi ready!

Name Link
🔨 Latest commit 1c47262
🔍 Latest deploy log https://app.netlify.com/sites/plone-restapi/deploys/646b22654a542e00084310fe
😎 Deploy Preview https://deploy-preview-1602--plone-restapi.netlify.app/endpoints/relations.html
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@ksuess ksuess mentioned this pull request Mar 20, 2023
Merged
12 tasks
ksuess and others added 22 commits March 21, 2023 21:22
@ksuess
@relations: onlyBroken: Return broken relations
17f5415
@ksuess
Update relations.md
c6c190a
@ksuess
Add tests for relations
272223a
@avoinea
Merge branch 'master' into one-relations-endpoint
b8a3a72
@ksuess
Draft/placeholder: provide vocabulary query of relation
3d0ee49
@ksuess
Provide vocabulary query of relation for …
755046b 
fields with registered named StaticCatalogVocabularyQuery
@ksuess
Add relations
44d43f6
@ksuess
Modification of relations only if plone.api.relation available
64013e4
@ksuess
Delete relations.
ae40a67 
Now some more tests and it's done!
@ksuess
flake
ccbabdd
@ksuess
Create 1432.feature
0f2ccc4
@ksuess
Add UID to relationvalue_converter summary
63036e4 
Support RelationList field with named StaticCatalogVocabulary and SelectWidget
@ksuess
Update resps
b96c94c
@ksuess
Fix exceptions
7a9d0c7
@ksuess
Update resps
3211ab7
@ksuess
Restore make_summary
7f1d240
@ksuess
Update tests
e0f85fd
@ksuess
More tests
3c9bf4a
@ksuess
Delete relations by relation name, source, or target, or combination
1a985ed
@ksuess
Remove debug logging
1dfd97b
@ksuess
Fix f-strings
7bb849a
@ksuess
Fix error messages
b3eed50
stevepiercy
stevepiercy requested changes May 20, 2023
View reviewed changes
Copy link
Contributor

@stevepiercy stevepiercy 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 good and extremely detailed work. Thank you!

Finding trailing spaces in GitHub's UI is not easy, so would you please double-check to ensure there are no more? I found just the one trailing space.

docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Show resolved Hide resolved
docs/source/endpoints/relations.md Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
ksuess and others added 8 commits May 20, 2023 09:39
@ksuess
Uncomment "delete by relation name" after release of plone.api 2.0.2
6e6df7f
@ksuess
Respond with "Unprocessable Entity" if creating fails
0e60356
@ksuess
docu more precise
d2200c1
@ksuess
run black
5d927d4
@ksuess @stevepiercy
Apply suggestions from code review
72d1f9f 
Co-authored-by: Steve Piercy <web@stevepiercy.com>
@ksuess @stevepiercy
Apply suggestions from code review
646ea46 
Co-authored-by: Steve Piercy <web@stevepiercy.com>
@ksuess
Precise documentation on deleting list of relations
0a6f7ac 
A list of relations can be deleted in one request. Maybe the wording is not optimal 'list of single relations'
@ksuess
run black
9a51857
@ksuess
Copy link
Member Author

ksuess commented May 20, 2023

@jenkins-plone-org please run jobs

@ksuess ksuess requested review from davisagli and stevepiercy May 20, 2023 09:33
@ksuess
Copy link
Member Author

ksuess commented May 20, 2023

@jenkins-plone-org please run jobs

1 similar comment
@ksuess
Copy link
Member Author

ksuess commented May 20, 2023

@jenkins-plone-org please run jobs

@ksuess
Copy link
Member Author

ksuess commented May 20, 2023

BTW Jenkins is in a happy green color for this PR using plone.api not only for tests… @ericof

stevepiercy
stevepiercy requested changes May 20, 2023
View reviewed changes
Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

I think we're close. With these changes, it should be good to go.

docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Outdated Show resolved Hide resolved
docs/source/endpoints/relations.md Show resolved Hide resolved
docs/source/endpoints/relations.md Show resolved Hide resolved
docs/source/endpoints/relations.md Show resolved Hide resolved
@ksuess
Copy link
Member Author

ksuess commented May 22, 2023

@pgrunewald This might probably concern your work on the link view: We changed the format of the response of the GET request. Please have a look at the preview of the documentation which is linked above in this PR.

@ericof @stevepiercy
Apply docs suggestions from code review
1c47262 
Co-authored-by: Steve Piercy <web@stevepiercy.com>
stevepiercy
stevepiercy approved these changes May 22, 2023
View reviewed changes
Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

Thank you!

@davisagli davisagli merged commit 880e983 into master May 23, 2023
@davisagli davisagli deleted the one-relations-endpoint branch May 23, 2023 05:27
@mauritsvanrees mauritsvanrees mentioned this pull request May 23, 2023
Closed
37 tasks
@mauritsvanrees
Copy link
Member

Thanks Katja!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevepiercy stevepiercy stevepiercy approved these changes

@davisagli davisagli davisagli approved these changes

@tisto tisto Awaiting requested review from tisto

Assignees

@ksuess ksuess

Labels
None yet
Projects
Beethoven Sprint 2023
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add relations endpoint
8 participants
@ksuess @mister-roboto @tisto @mauritsvanrees @davisagli @stevepiercy @avoinea @ericof