aws-amplify / aws-amplify/amplify-cli
Manual modification - where to find documentation on possible properties
- Dominant language
- TypeScript
- Stars
- 2.9k
- Forks
- 825
- Avg merge
- 11d 23h
- Merged PRs (30d)
- 2
Description
### Amplify CLI Version
N/A
### Question
Hello, I'd like to modify an api cli-inputs.json file manually, but can't find any documentation on the property values. Where can I find documentation? e.g. what are all the possible properties that go into "permissions"?
Also, you you probably want to edit [this ](https://github.com/aws-amplify/amplify-cli/blob/c85ed14b2fe61c09a026f7bb7c82857b5227dff2/packages/amplify-provider-awscloudformation/src/utils/consolidate-apigw-policies.ts#L20) comment, since this path does not exist anymore?
Contributor guide
Research direction
Start with the linked comment in packages/amplify-provider-awscloudformation/src/utils/consolidate-apigw-policies.ts and inspect the api cli-inputs.json structure, especially permissions. Document the possible property values and correct the obsolete path reference; done means the manual-editing question has a clear documentation location and the referenced path is valid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100