Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DX Issue] For Headless CLI commands make it easier for users to find the schemas #11780

Open
omenking opened this issue Jan 13, 2023 · 2 comments
Assignees
Labels
documentation Add or update documentation question General question

Comments

@omenking
Copy link

Amplify CLI Version

10.6.1

Question

If you want to use the headless input for amplify add auth or any other categories the schemas are not in the docs, there is no "help" command to see it using the CLI tool.

To find the schemas I had to walk through the code until I found them

https://github.com/aws-amplify/amplify-cli/blob/dev/packages/amplify-headless-interface/schemas/auth/2/AddAuthRequest.schema.json

This is a lot of labour to find basic information. Please uplift this information

@omenking omenking added pending-triage Issue is pending triage question General question labels Jan 13, 2023
@omenking
Copy link
Author

40 mins jsut trial end error, examples would be appreciated in the docs...

{
  "version": 2,
  "resourceName": "cruddurauth",
  "serviceConfiguration": {
    "includeIdentityPool": false,
    "serviceName": "Cognito",
    "userPoolConfiguration":  {
      "signinMethod": "EMAIL",
      "requiredSignupAttributes": ["EMAIL"],
      "aliasAttributes": ["EMAIL"],
      "userPoolName": "crudduruserpool",
      "userPoolGroups": [{
        "groupName": "customers"
      }],
      "readAttributes": ["EMAIL"],
      "writeAttributes": [],
      "autoVerifiedAttributes": [{
        "type": "EMAIL"
      }]
    }
  }
}

@josefaidt
Copy link
Contributor

Hey @omenking 👋 thanks for raising this and apologies for the rough experience! There was a PR addressing the help command that was recently merged and should be available in an upcoming release #11667

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add or update documentation question General question
Projects
None yet
Development

No branches or pull requests

2 participants