Package io.github.evisentin.wordpress.client.domain.api

Interface PostRevisionAPIs

All Known Implementing Classes:

PostRevisionApiClientModule

public interface PostRevisionAPIs

Defines operations for managing WordPress post revisions through the WordPress REST API.

This interface provides methods for listing and retrieving WpPostRevision resources associated with a parent post.

Implementations are expected to communicate with the /wp-json/wp/v2/posts/<parent>/revisions endpoint or compatible APIs.

Method Summary

Modifier and Type	Method	Description
WpPostRevision	get(long postId, long revisionId)	Retrieves a specific post revision by its unique identifier.
WpPagedResponse<WpPostRevision>	list(long postId, WpPagingQuery pageQuery, WpPostRevisionQuery postQuery)	Retrieves a paginated list of revisions for a post.

Method Details

get

WpPostRevision get(long postId,
 long revisionId)

Retrieves a specific post revision by its unique identifier.

Retrieves a single revision record belonging to the specified parent post.

Parameters:

postId - the ID of the parent post

revisionId - the unique identifier of the revision to retrieve

Returns:

the matching WpPostRevision

list

WpPagedResponse<WpPostRevision> list(long postId,
 WpPagingQuery pageQuery,
 WpPostRevisionQuery postQuery)

Retrieves a paginated list of revisions for a post.

The result set can be controlled and filtered using pagination and revision query parameters.

Parameters:

postId - the ID of the parent post whose revisions should be listed

pageQuery - the pagination settings, including page number and page size; must not be null

postQuery - additional revision query parameters; may be null when no extra filtering is needed

Returns:

a paginated response containing WpPostRevision items