Skip to content

Document Directive API #4320

@taneba

Description

@taneba

I opened this issue based on the conversation on discord.

In the latest documentation, there's no detail pages about each directive's API.
It's great to have one that we can use it as a API reference, like we had in the old docs. (link)

API document would have:

  • A short definition or explanation of what the directive is about.
  • API Definition
  • Basic usage
  • Advanced usage
  • caveats

Additionally, I'd like to know how it affects corresponding AWS resources (e.g. index is going to create GSI in DynamoDB).

Metadata

Metadata

Labels

amplify/dataIssue related to aws-amplify/amplify-category-apip4guide needed/net new info

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions