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.

Sign up for GitHub

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

Jump to bottom

Improve README with AWS API Gateway findings #868

Closed
fahernandez opened this issue Feb 14, 2019 · 2 comments
Closed

Improve README with AWS API Gateway findings #868

fahernandez opened this issue Feb 14, 2019 · 2 comments

Comments

@fahernandez
Copy link
Contributor

After trying to import swagger generated documentation into AWS API gateway I discover some helpful information that can be shared in README file to help other people through this process:

  1. Remove model circular dependencies.
  2. Remove security-related annotations (This annotation aren't well supported by the import functionality).
  3. Max length of the fields is reviewed by the parser but the errors aren't self-explanatory. Review the documentation to verify that the requirements are met.
  4. API gateway errors aren't good enough for troubleshooting so I recommend using this page for structure validation.
@fahernandez
Copy link
Contributor Author

fahernandez commented Feb 14, 2019 •
edited
Loading

Documentation was added on this pull request

@johanbrandhorst
Copy link
Collaborator

Closed by #869

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@fahernandez @johanbrandhorst