Skip to content

Commit

Permalink
Merge pull request #14 from ButterCMS/ViolanteCodes-fix-readme-docs
Browse files Browse the repository at this point in the history
fix: update readme search functions
  • Loading branch information
ViolanteCodes authored Oct 18, 2023
2 parents 00bb200 + e0c2462 commit 1ccb948
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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|
| ---|---|---|
Expand All @@ -146,7 +146,7 @@ Map<String,String> queryParams = new HashMap<String,String>(){{
put("query", "search query");
...
}}
PostsResponse posts = butterClient.getPostSearch(queryParams);
PostsResponse posts = butterClient.getSearchPosts(queryParams);
```

## Authors
Expand Down Expand Up @@ -433,15 +433,15 @@ Retrieving a single page returns a [PageResponse&lt;T&gt;](#pageresponse-class)

Listing Pages returns a [PagesResponse&lt;T&gt;](#pagesresponse-class) object. This object consists of a [PaginationMeta](#pagination-meta) object and List&lt;T&gt;

#### getPageSearch() parameters
#### getSearchPages() parameters

| Parameter|Description|
| ---|---|
| pageTypeSlug | The slug of the type of pages you want to retrieve |
| queryParams | Map of additional Query Parameters|
| classType | Class that Page will be deserialized in to|

#### getPageSearch() query parameters
#### getSearchPages() query parameters

|Query Parameter|Description|
| ---|---|
Expand All @@ -461,7 +461,7 @@ Map<String,String> queryParams = new HashMap<String,String>(){{
put("query", "search query");
...
}}
PagesResponse posts = butterClient.getPageSearch(queryParams);
PagesResponse posts = butterClient.getSearchPages(queryParams);
```

##### Page Type Definition in the Butter Admin
Expand Down

0 comments on commit 1ccb948

Please sign in to comment.