Skip to content

Commit 273b6c7

Browse files
dklearjayair
andauthored
Update add-an-api-to-get-a-note.md to clarify generated API names (#775)
* Update add-an-api-to-get-a-note.md Added context for understanding that sst deploys a randomly generated subdomain for the API gateway with a standard format. I think this will reduce confusion for people reading the guide. * Update add-an-api-to-get-a-note.md --------- Co-authored-by: Jay <air@live.ca>
1 parent 019c652 commit 273b6c7

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

_chapters/add-an-api-to-get-a-note.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ If you switch over to your terminal, you will notice that your changes are being
6363
You’ll need to have `sst dev` running for this to happen. If you had previously stopped it, then running `npx sst dev` will deploy your changes again.
6464
{%endinfo%}
6565

66-
You should see that the new API has been deployed.
66+
You should see that the new API has been deployed and given an AWS generated subdomain that looks something like `https://<generated_subdomain>.execute-api.<aws_region>.amazonaws.com`.
6767

6868
```bash
6969
+ Complete
@@ -74,10 +74,10 @@ You should see that the new API has been deployed.
7474

7575
Let's test the get notes API. In the [previous chapter]({% link _chapters/add-an-api-to-get-a-note.md %}) we tested our create note API. It should've returned the new note's id as the `noteId`.
7676

77-
{%change%} Run the following in your terminal.
77+
{%change%} Run the following in your terminal. Remember to replace the generated subdomain and region with the values generated earlier.
7878

7979
``` bash
80-
$ curl https://5bv7x0iuga.execute-api.us-east-1.amazonaws.com/notes/<NOTE_ID>
80+
$ curl https://<generated_subdomain>.execute-api.<aws_region>.amazonaws.com/notes/<NOTE_ID>
8181
```
8282

8383
Make sure to replace the endpoint URL with your `ApiEndpoint` value and the <NOTE_ID> at the end of the URL with the `noteId` that was created previously.

0 commit comments

Comments
 (0)