aws-amplify / aws-amplify/docs

Can't locate actual reference

Open
#8,297 2 comments 0 reactions 0 assignees View on GitHub
amplify/js
Dominant language
MDX
Stars
506
Forks
1.1k
Avg merge
3h 14m
Merged PRs (30d)
1

Description

**Describe the content issue**:

I'm going in circles trying to find an actual reference for the symbols/types in the API docs. For example, where can I see the type returned from `post()`, along with all properties and methods, with descriptions, of that type? What kind of errors are thrown by `post()` and what cause them?

**URL page where content issue is**:

https://docs.amplify.aws/javascript/build-a-backend/add-aws-services/rest-api/post-data/

Contributor guide

Open the contributing guide

Research direction

Start with the REST API post-data documentation page linked in the issue and trace the `post()` API reference from there. Determine where the returned type, its properties and methods, and possible errors are documented; done means the page provides a discoverable reference covering those requested details.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, javascript
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.