feat: add docs on new Geo APIs - searchForSuggestions and searchByPlaceId #4615
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 tasks
thaddmt
added a commit
to aws-amplify/amplify-js
that referenced
this pull request
Oct 6, 2022
<!-- Please make sure to read the Pull Request Guidelines: https://github.com/aws-amplify/amplify-js/blob/main/CONTRIBUTING.md#pull-requests --> #### Description of changes <!-- Thank you for your Pull Request! Please provide a description above and review the requirements below. --> Add new Geo APIs - searchForSuggestions & searchByPlaceId #### Related documentation PR: aws-amplify/docs#4615 #### Issue #, if available <!-- Also, please reference any associated PRs for documentation updates. --> #### Description of how you validated changes - Unit tests - Manual testing from UI #### Checklist <!-- Remove items that do not apply. For completed items, change [ ] to [x]. --> - [x] PR description included - [x] `yarn test` passes - [x] Tests are [changed or added](https://github.com/aws-amplify/amplify-js/blob/main/CONTRIBUTING.md#steps-towards-contributions) - [x] Relevant documentation is changed or added (and PR referenced) By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. Co-authored-by: Thadd Trinh <thadtrin@amazon.com> Co-authored-by: thaddmt <68032955+thaddmt@users.noreply.github.com>
This was referenced Oct 17, 2022
israx
pushed a commit
to israx/amplify-js
that referenced
this pull request
Oct 19, 2022
<!-- Please make sure to read the Pull Request Guidelines: https://github.com/aws-amplify/amplify-js/blob/main/CONTRIBUTING.md#pull-requests --> #### Description of changes <!-- Thank you for your Pull Request! Please provide a description above and review the requirements below. --> Add new Geo APIs - searchForSuggestions & searchByPlaceId #### Related documentation PR: aws-amplify/docs#4615 #### Issue #, if available <!-- Also, please reference any associated PRs for documentation updates. --> #### Description of how you validated changes - Unit tests - Manual testing from UI #### Checklist <!-- Remove items that do not apply. For completed items, change [ ] to [x]. --> - [x] PR description included - [x] `yarn test` passes - [x] Tests are [changed or added](https://github.com/aws-amplify/amplify-js/blob/main/CONTRIBUTING.md#steps-towards-contributions) - [x] Relevant documentation is changed or added (and PR referenced) By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. Co-authored-by: Thadd Trinh <thadtrin@amazon.com> Co-authored-by: thaddmt <68032955+thaddmt@users.noreply.github.com>
5 tasks
thaddmt
reviewed
Nov 1, 2022
Comment on lines
+224
to
+233
| [ | ||
| { | ||
| text: "Amazon Go, 2131 7th Ave, Seattle, WA, 98121, USA", | ||
| placeId: "8fd9d4c6-2527-4190-a7df-0dae352c9dc6" | ||
| }, | ||
| { | ||
| text: "Amazon Go, 1906 Terry Ave, Seattle, WA, 98101, USA", | ||
| placeId: "5d04d071-dea2-4d86-bfce-86bd6a8f4787" | ||
| } | ||
| ] |
There was a problem hiding this comment.
Can you include an example here of result without a placeId and advice that they can use that result with the searchByText API. Otherwise LGTM
thaddmt
previously approved these changes
Nov 1, 2022
|
@sreeramsama Please add a note that customers who used search previously will need to upgrade to the latest version of the CLI and do an amplify push to update their IAM policies to allow for |
hdworld11
previously approved these changes
Nov 15, 2022
sreeramsama
commented
Nov 21, 2022
Comment on lines
+261
to
+265
| <Callout> | ||
|
|
||
| **Note:** Upgrade to the latest Amplify CLI version (greater than version 10.4) and do an ``amplify push`` to update your IAM policies to allow for ``getPlace`` API. | ||
|
|
||
| </Callout> |
thaddmt
approved these changes
Nov 21, 2022
hdworld11
approved these changes
Nov 23, 2022
nicholashu
pushed a commit
to airteamaus/aws-amplify-geo
that referenced
this pull request
Mar 4, 2024
<!-- Please make sure to read the Pull Request Guidelines: https://github.com/aws-amplify/amplify-js/blob/main/CONTRIBUTING.md#pull-requests --> #### Description of changes <!-- Thank you for your Pull Request! Please provide a description above and review the requirements below. --> Add new Geo APIs - searchForSuggestions & searchByPlaceId #### Related documentation PR: aws-amplify/docs#4615 #### Issue #, if available <!-- Also, please reference any associated PRs for documentation updates. --> #### Description of how you validated changes - Unit tests - Manual testing from UI #### Checklist <!-- Remove items that do not apply. For completed items, change [ ] to [x]. --> - [x] PR description included - [x] `yarn test` passes - [x] Tests are [changed or added](https://github.com/aws-amplify/amplify-js/blob/main/CONTRIBUTING.md#steps-towards-contributions) - [x] Relevant documentation is changed or added (and PR referenced) By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. Co-authored-by: Thadd Trinh <thadtrin@amazon.com> Co-authored-by: thaddmt <68032955+thaddmt@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available
Description of changes
Add documentation on new Geo APIs - searchForSuggestions and searchByPlaceId
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Screenshot