New REST API Endpoints for the block editor #95

s3rgiosan · 2025-02-18T10:02:49Z

Warning

This PR is based on top of #96

Description of the Change

This PR adds REST API endpoints for searching, retrieving and managing post relationships, improving integration with the Block Editor and other WordPress components.

Closes #78

How to test the Change

Changelog Entry

Added - GET /content-connect/v2/relationships - Retrieves all relationships by type.
Added - GET /content-connect/v2/post/{post_id}/relationships - Retrieve all relationships associated with a post.
Added - GET /content-connect/v2/post/{post_id}/related - Retrieve entities related to a post.
Added - POST /content-connect/v2/post/{post_id}/related - Update the list of related entities for a post.
Added - PUT /content-connect/v2/post/{post_id}/related - Add a related entity to a post.
Added - DELETE /content-connect/v2/post/{post_id}/related - Remove a related entity from a post.

Credits

Props @s3rgiosan

Checklist:

I agree to follow this project's Code of Conduct.
I have updated the documentation accordingly.
I have added Critical Flows, Test Cases, and/or End-to-End Tests to cover my change.
All new and existing tests pass.

Bumps [minimist](https://github.com/minimistjs/minimist), [minimist](https://github.com/minimistjs/minimist) and [mkdirp](https://github.com/isaacs/node-mkdirp). These dependencies needed to be updated together. Updates `minimist` from 1.2.0 to 1.2.8 - [Release notes](https://github.com/minimistjs/minimist/releases) - [Changelog](https://github.com/minimistjs/minimist/blob/main/CHANGELOG.md) - [Commits](minimistjs/minimist@v1.2.0...v1.2.8) Updates `minimist` from 1.2.5 to 1.2.8 - [Release notes](https://github.com/minimistjs/minimist/releases) - [Changelog](https://github.com/minimistjs/minimist/blob/main/CHANGELOG.md) - [Commits](minimistjs/minimist@v1.2.0...v1.2.8) Updates `mkdirp` from 0.5.1 to 0.5.6 - [Release notes](https://github.com/isaacs/node-mkdirp/releases) - [Changelog](https://github.com/isaacs/node-mkdirp/blob/main/CHANGELOG.md) - [Commits](isaacs/node-mkdirp@0.5.1...v0.5.6) --- updated-dependencies: - dependency-name: minimist dependency-type: indirect - dependency-name: minimist dependency-type: indirect - dependency-name: mkdirp dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]>

Bumps the npm_and_yarn group with 10 updates: | Package | From | To | | --- | --- | --- | | [braces](https://github.com/micromatch/braces) | `2.3.2` | `3.0.3` | | [watchify](https://github.com/browserify/watchify) | `3.11.1` | `4.0.0` | | [browserify-sign](https://github.com/crypto-browserify/browserify-sign) | `4.0.4` | `4.2.3` | | [elliptic](https://github.com/indutny/elliptic) | `6.5.4` | `6.6.1` | | [fsevents](https://github.com/fsevents/fsevents) | `1.2.7` | `2.3.3` | | [got](https://github.com/sindresorhus/got) | `7.1.0` | `11.8.6` | | [vue-resource](https://github.com/pagekit/vue-resource) | `1.3.4` | `1.5.3` | | [shell-quote](https://github.com/ljharb/shell-quote) | `1.6.1` | `1.8.2` | | [tough-cookie](https://github.com/salesforce/tough-cookie) | `2.5.0` | `removed` | | [node-sass](https://github.com/sass/node-sass) | `7.0.0` | `9.0.0` | Updates `braces` from 2.3.2 to 3.0.3 - [Changelog](https://github.com/micromatch/braces/blob/master/CHANGELOG.md) - [Commits](https://github.com/micromatch/braces/commits/3.0.3) Updates `watchify` from 3.11.1 to 4.0.0 - [Release notes](https://github.com/browserify/watchify/releases) - [Changelog](https://github.com/browserify/watchify/blob/master/CHANGELOG.md) - [Commits](browserify/watchify@v3.11.1...v4.0.0) Updates `browserify-sign` from 4.0.4 to 4.2.3 - [Changelog](https://github.com/browserify/browserify-sign/blob/main/CHANGELOG.md) - [Commits](browserify/browserify-sign@v4.0.4...v4.2.3) Updates `elliptic` from 6.5.4 to 6.6.1 - [Commits](indutny/elliptic@v6.5.4...v6.6.1) Updates `fsevents` from 1.2.7 to 2.3.3 - [Release notes](https://github.com/fsevents/fsevents/releases) - [Commits](fsevents/fsevents@v1.2.7...v2.3.3) Updates `got` from 7.1.0 to 11.8.6 - [Release notes](https://github.com/sindresorhus/got/releases) - [Commits](sindresorhus/got@v7.1.0...v11.8.6) Updates `vue-resource` from 1.3.4 to 1.5.3 - [Release notes](https://github.com/pagekit/vue-resource/releases) - [Commits](pagekit/vue-resource@1.3.4...1.5.3) Updates `shell-quote` from 1.6.1 to 1.8.2 - [Changelog](https://github.com/ljharb/shell-quote/blob/main/CHANGELOG.md) - [Commits](ljharb/shell-quote@v1.6.1...v1.8.2) Removes `tough-cookie` Updates `node-sass` from 7.0.0 to 9.0.0 - [Release notes](https://github.com/sass/node-sass/releases) - [Changelog](https://github.com/sass/node-sass/blob/master/CHANGELOG.md) - [Commits](sass/node-sass@v7.0.0...v9.0.0) --- updated-dependencies: - dependency-name: braces dependency-type: indirect dependency-group: npm_and_yarn - dependency-name: watchify dependency-type: direct:development dependency-group: npm_and_yarn - dependency-name: browserify-sign dependency-type: indirect dependency-group: npm_and_yarn - dependency-name: elliptic dependency-type: indirect dependency-group: npm_and_yarn - dependency-name: fsevents dependency-type: indirect dependency-group: npm_and_yarn - dependency-name: got dependency-type: indirect dependency-group: npm_and_yarn - dependency-name: vue-resource dependency-type: direct:development dependency-group: npm_and_yarn - dependency-name: shell-quote dependency-type: indirect dependency-group: npm_and_yarn - dependency-name: tough-cookie dependency-type: indirect dependency-group: npm_and_yarn - dependency-name: node-sass dependency-type: direct:development dependency-group: npm_and_yarn ... Signed-off-by: dependabot[bot] <[email protected]>

…rs-on-search

# Conflicts: # package-lock.json

# Conflicts: # package-lock.json # package.json

…evelop

# Conflicts: # includes/Registry.php

# Conflicts: # includes/Helpers.php

# Conflicts: # content-connect.php # includes/API/Search.php # includes/Plugin.php

s3rgiosan · 2025-03-14T17:16:50Z

Hi @rickalee @jeffpaul, this is ready for review. This PR provides the foundational work for #94, and #97.

s3rgiosan · 2025-03-21T10:10:55Z

I've created a try/block-editor-ui all-in-one branch to make it easier to test the features in both the block and classic editors, as well as the Query Loop integration.

s3rgiosan · 2025-05-06T11:58:13Z

Added a new endpoint GET /content-connect/v2/relationships that retrieves all relationships by type (post-to-post or post-to-user).

# Conflicts: # composer.json # composer.lock

benlk · 2025-05-19T03:55:18Z

includes/API/V2/Route/Relationships.php

+
+		switch ( $rel_type ) {
+			case 'post-to-post':
+				$relationships = get_post_to_post_relationships_by();


It would be nice to be able to pass arguments to this function: $field and $value would let users filter this list to a specific post type.

It's possible to filter relationships now that I added the filter_by and filter_value parameters to the endpoint, @benlk.

benlk · 2025-05-19T04:21:28Z

The new API endpoint at /content-connect/v2/relationships/ is returning 404 on my site, and doesn't appear in the enumerationn of endpoints at /content-connect/v2/.

s3rgiosan · 2025-05-22T15:39:30Z

The new API endpoint at /content-connect/v2/relationships/ is returning 404 on my site, and doesn't appear in the enumerationn of endpoints at /content-connect/v2/.

@benlk Which branch are you using? This one or the try/block-editor-ui branch?

s3rgiosan · 2025-05-26T17:28:52Z

@rickalee I've added the links that we talked about on our last call.

For a specific post, the WP core REST endpoint (http://content-connect.test/wp-json/wp/v2/<post_type>/<post_id>) response will be something like:

dependabot bot and others added 30 commits March 1, 2023 18:02

Fix format

efb6236

Add route abstract for extensibility

3536dee

Add relationships endpoint

9f3e714

Fix $post variable override

4b4f2b5

Code alignment with PostToPost

fe9c655

Use constants instead of outdated Plugin properties

c90f294

Add filter phpdoc

a6dfd2a

Expose post relationships as REST fields

b9c6f99

Add editorconfig file

847d9ec

Update composer

2f67d66

Add phpcs.xml file

efc1b81

Update version

7a9ad5d

Small tweaks

36380e4

Small tweaks

f613f60

Merge branch 'dependabot-68' into feature/apply-final-post-user-filte…

d08cd90

…rs-on-search

Merge branch 'dependabot-70' into develop

77f23cd

Merge branch 'dependabot-71' into develop

f64f8b5

Merge branch 'dependabot-72' into develop

beb1364

# Conflicts: # package-lock.json

Merge branch 'dependabot-73' into develop

5489361

Merge branch 'dependabot-81' into develop

ff32ba6

# Conflicts: # package-lock.json # package.json

Merge branch 'feature/apply-final-post-user-filters-on-search' into d…

14a42b5

…evelop

Merge branch 'feature/helpers' into develop

de97b15

# Conflicts: # includes/Registry.php

Update assets

c97e0a8

Merge branch 'feature/helpers' into feature/rest-api-endpoint

36c44f1

# Conflicts: # includes/Helpers.php

Merge branch 'feature/update-6-7' into develop

78dc227

Merge branch 'develop' into feature/rest-api-endpoint

ad444e5

# Conflicts: # content-connect.php # includes/API/Search.php # includes/Plugin.php

Add REST API endpoints versioning

76d55d8

Add scaffold for new search REST API endpoint

a83104c

jeffpaul added this to the 1.7.0 milestone Mar 10, 2025

s3rgiosan added 6 commits March 14, 2025 12:43

Remove unused variable

8188ebf

Updates for the 10up Content Picker

744a992

Fix relationship return format for Content Picker

1da467f

Fix post type for REST related entities queries

15852ca

Fix related entities queries

dfcf7d7

Fix save sort data

fde2b8c

s3rgiosan mentioned this pull request Mar 14, 2025

Add helper functions for retrieving post relationships #96

Open

4 tasks

s3rgiosan requested a review from jeffpaul March 14, 2025 17:16

s3rgiosan added 3 commits March 14, 2025 17:18

Merge branch 'feature/helpers' into feature/rest-api-endpoint

ac252d3

Define plugin constants in plugin class for library usage

20ccd4c

Use __DIR__

27cb2bc

jeffpaul added this to Open Source Practice Mar 21, 2025

jeffpaul moved this to Code Review in Open Source Practice Mar 21, 2025

s3rgiosan added 2 commits May 6, 2025 12:56

Add REST endpoint that retrieves all relationships by type

2572e8b

Merge branch 'feature/helpers' into feature/rest-api-endpoint

9ecb4b9

s3rgiosan added 2 commits May 6, 2025 13:06

Merge branch 'feature/helpers' into feature/rest-api-endpoint

9ce0b6b

# Conflicts: # composer.json # composer.lock

Delete the Search endpoint since we are using 10up's Content Picker

07e424e

benlk reviewed May 19, 2025

View reviewed changes

s3rgiosan added 2 commits May 22, 2025 15:25

Remove REST field since its use was replaced by a custom store

be20df2

Add filter_by and filter_value to the Relationships endpoint

220503b

s3rgiosan added 3 commits May 26, 2025 12:05

Merge branch 'feature/helpers' into feature/rest-api-endpoint

4fbce70

Add links to the REST API responses for post types that support REST

4d80b92

Review modules setup

cc44db1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

New REST API Endpoints for the block editor #95

New REST API Endpoints for the block editor #95

Uh oh!

s3rgiosan commented Feb 18, 2025 •

edited

Loading

Uh oh!

s3rgiosan commented Mar 14, 2025

Uh oh!

s3rgiosan commented Mar 21, 2025

Uh oh!

s3rgiosan commented May 6, 2025

Uh oh!

benlk May 19, 2025

Uh oh!

s3rgiosan May 22, 2025

Uh oh!

benlk commented May 19, 2025

Uh oh!

s3rgiosan commented May 22, 2025 •

edited

Loading

Uh oh!

s3rgiosan commented May 26, 2025

Uh oh!

Uh oh!

New REST API Endpoints for the block editor #95

Are you sure you want to change the base?

New REST API Endpoints for the block editor #95

Uh oh!

Conversation

s3rgiosan commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of the Change

How to test the Change

Changelog Entry

Credits

Checklist:

Uh oh!

s3rgiosan commented Mar 14, 2025

Uh oh!

s3rgiosan commented Mar 21, 2025

Uh oh!

s3rgiosan commented May 6, 2025

Uh oh!

benlk May 19, 2025

Choose a reason for hiding this comment

Uh oh!

s3rgiosan May 22, 2025

Choose a reason for hiding this comment

Uh oh!

benlk commented May 19, 2025

Uh oh!

s3rgiosan commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

s3rgiosan commented May 26, 2025

Uh oh!

Uh oh!

s3rgiosan commented Feb 18, 2025 •

edited

Loading

s3rgiosan commented May 22, 2025 •

edited

Loading