From e0c24627da32f6b82d715095da3faa4e3b014fd5 Mon Sep 17 00:00:00 2001 From: Maria Violante <67020552+ViolanteCodes@users.noreply.github.com> Date: Wed, 18 Oct 2023 09:39:49 -0400 Subject: [PATCH] fix: update readme search functions Readme had incorrect function names for getSearchPages() and getSearchPosts(). Corrected. --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f389c65..eddb0af 100644 --- a/README.md +++ b/README.md @@ -125,13 +125,13 @@ PostResponse controversialPost = butterClient.getPost("tabs-vs-spaces-throwdown" Searching posts will return a PostsResponseObject [PostsResponse](#postsresponse-class) object. This object consists of a [PaginationMeta](#paginationmeta-class) object and List<[Post](#post-class)> -#### getPostsSearch() parameters +#### getSearchPosts() parameters | Parameter|Description| | ---|---| | queryParams | Map of additional Query Parameters| -#### getPostsSearch() Query Parameters +#### getSearchPosts() Query Parameters | Query Parameter|Default|Description| | ---|---|---| @@ -146,7 +146,7 @@ Map queryParams = new HashMap(){{ put("query", "search query"); ... }} -PostsResponse posts = butterClient.getPostSearch(queryParams); +PostsResponse posts = butterClient.getSearchPosts(queryParams); ``` ## Authors @@ -433,7 +433,7 @@ Retrieving a single page returns a [PageResponse<T>](#pageresponse-class) Listing Pages returns a [PagesResponse<T>](#pagesresponse-class) object. This object consists of a [PaginationMeta](#pagination-meta) object and List<T> -#### getPageSearch() parameters +#### getSearchPages() parameters | Parameter|Description| | ---|---| @@ -441,7 +441,7 @@ Listing Pages returns a [PagesResponse<T>](#pagesresponse-class) object. T | queryParams | Map of additional Query Parameters| | classType | Class that Page will be deserialized in to| -#### getPageSearch() query parameters +#### getSearchPages() query parameters |Query Parameter|Description| | ---|---| @@ -461,7 +461,7 @@ Map queryParams = new HashMap(){{ put("query", "search query"); ... }} -PagesResponse posts = butterClient.getPageSearch(queryParams); +PagesResponse posts = butterClient.getSearchPages(queryParams); ``` ##### Page Type Definition in the Butter Admin