docs icon indicating copy to clipboard operation
docs copied to clipboard

Add configurable parameters section to the latest document of GraphQL API

Open jaga810 opened this issue 3 years ago • 3 comments

Is your feature request related to a problem? Please describe. Legacy doc of GraphQL API has section called "Configurable parameters" https://docs.amplify.aws/cli-legacy/graphql-transformer/config-params/ Though we can use configurable parameters with GraphQL transformer v2, there is no documentation about it now.

Describe the solution you'd like It would be nice to replicate "Configurable parameters" page of legacy doc to the latest doc.

Additional context If "configurable parameters" is not recommended now, I'd like to know why it's not recommended.

jaga810 avatar Jan 26 '22 11:01 jaga810

hi @jaga810 - while the configurable parameters approach is backwards compatible in v2, we have opened up a more flexible approach to override the settings via amplify override api https://docs.amplify.aws/cli/graphql/override/

Is there a particular workflow you're missing via the overrides approach? Also would love to hear if your thoughts on the different developer experiences here to achieve the results.

renebrandel avatar Jan 26 '22 17:01 renebrandel

Hello. I would like to know the answer ("Configurable parameters" will be deprecated or not) too.

Because I use the DynamoDBEnablePointInTimeRecovery setting by "Configurable parameters" now. If "Configurable parameters" will be deprecated, I should prepare to move this setting to an override approach.

enishenish avatar Jan 27 '22 00:01 enishenish

Hi @renebrandel, I agree with using amplify override api approach which is so flexible and it could cover almost all the use cases once configurable parameters covered.

On the other hand, we have 2 problems here

  1. New docs missing some examples of override settings once covered by configurable parameters in the documentation such as DynamoDBEnablePointInTimeRecovery , DynamoDBModelTableWriteIOPS and ElasticSearchInstanceType. Not all the Amplify users are familiar with CDK or CloudFormation, it would be great if we have specific examples of CDK overrides sample codes in doc.
  2. Amplify users wonders if they should migrate settings from configurable parameters to overrides as @enishenish mentioned.

jaga810 avatar Jan 27 '22 05:01 jaga810

@AnilMaktala is going to add a few more examples to this page: https://docs.amplify.aws/cli/graphql/override/#customize-amplify-generated-resources-for-model-directive. Our goal is primarily make edits from overrides moving forward.

renebrandel avatar Mar 15 '23 16:03 renebrandel