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

✏️ Added role details to generated API spec #1021

Closed
wants to merge 22 commits into from

Conversation

sreehari-aot
Copy link
Member

@sreehari-aot sreehari-aot commented Nov 24, 2022

Issue Tracking

JIRA: https://aottech.atlassian.net/browse/FWF-1856
Issue Type: DOCUMENTATION

Changes

Added role details to generated /formio/roles API spec
Minimal refactoring to fix server crash

How has the change been tested?

Manual verification, etc.

Screenshots (if applicable)

image
image

@sreehari-aot sreehari-aot added the python Pull requests that update Python code label Nov 24, 2022
@sreehari-aot sreehari-aot requested review from a team as code owners November 24, 2022 16:28
Copy link
Contributor

@abilpraju-aot abilpraju-aot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sreehari-aot
Copy link
Member Author

@sumesh-aot
flake8 new version has incompatibilities with flake8-quotes
zheller/flake8-quotes#111
This would be a fix from their side.
Should we specify the flake8 previous version or wait till they merge?

@sreehari-aot sreehari-aot marked this pull request as draft November 25, 2022 05:10
auslin-aot and others added 22 commits November 29, 2022 17:44
This reverts commit 9b3d98e.
author sreehari ps <sreehari.ps@aot-technologies.com> 1669306984 +0530
committer sreehari ps <sreehari.ps@aot-technologies.com> 1669724657 +0530
gpgsig -----BEGIN PGP SIGNATURE-----

 iQIzBAABCAAdFiEEOvBh6i/OYh+KrN73I9eVgkGStTMFAmOF+fEACgkQI9eVgkGS
 tTMaBRAAxoKFb5CWiNxwyh9htvnGEpQtWf/OKN1mMnhuHdC4Krdz1L64+Ltd/fcp
 R1klzCXBQu9zJMrUS6d49h4cIyALzQ6DN9VxSua6JnZZISuksIUpvmzZ5LK6JgtS
 m3jRcEZNv9jUgc4Wfa5GWzQz9M6Abyvrv/276ZdKslvwXEPWBsOuQdkQvrdXO95a
 vSV6T+5FVcz0Z4DR99ymkq0GPAMiCPJ0Zf/zdY9LhQlHX8H8T6KDY1u+N0ZzLGhm
 Ixue2ZP5gfnKeSI7TtFZHYfDcs8zb3997XhZk0poWOJUKIepG1XhiLQexNxTmOml
 gWaC7KzqJItVvkkGIDdtFKc2rjQprEZPhc6jtmE2aD+XgZCcUMXWKcy0QHZ/fazF
 JVHMdWXOE8w6bRShBCvpU8VMDhk4iB9wAgh6efJJ+6q/MoveoNzuhrKW0N4M+HuD
 1KcVFaPUFnmFDUZSkXf4/6/k80/yfBsg+3wjrR75KUF3JxUWXFwU+CpzIQWeLSRx
 cWD8IycZshHCzg9DVlycWcLlgBZCk55n8c8/7otNY1FgV4N+krbXDfgGyb9weXfB
 qy+NqZREEDoMmkPdRz8uS8UrjqIne0seb1mlNiBw679nQ+DDosSgewm0dF7xlFS6
 Esen04pNpv+i6PJ46ct+evLvMPHYnYss4RsLDUWstIwWU9Fcwoc=
 =MfQP
 -----END PGP SIGNATURE-----

Add detailed documentation for formsflow-api.

Updated all API resources to have detailed API spec. The existing
API spec doesn't provide details such as query parameters, request
payload, response body, response status and also the details of
authorized user role/group for the specific API.
@sreehari-aot
Copy link
Member Author

Closing due to bad commit tree

@sreehari-aot sreehari-aot deleted the api-doc branch November 29, 2022 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants