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

Add an API debug mode #152

Closed
2 tasks done
zepich opened this issue Nov 12, 2023 · 0 comments
Closed
2 tasks done

Add an API debug mode #152

zepich opened this issue Nov 12, 2023 · 0 comments
Assignees
@zepich
Labels
doc-prepared enhancement New feature or request
Milestone
v1.1

Comments

@zepich
Copy link
Member

zepich commented Nov 12, 2023 •
edited

Explanation

When you develop a new API client or integration, finding the reason for a problem can be challenging. Right now, the API does not explain why a verification didn't work so that an attacker cannot find the real issue.

To make it easier, we'll add a debug mode, which can be enabled for a project. If enabled, the debug mode will add more information to the response to make finding an issue with the verification process easier.

Changes

  • Add an option to enable the debug mode for a project
  • Collect and add the debug information in a good and explainable format to the response of the frontend and verification APIs

Suggested by

Discussion

#139
@zepich zepich added the enhancement New feature or request label Nov 12, 2023
@zepich zepich added this to the v1.1 milestone Nov 12, 2023
@zepich zepich self-assigned this Nov 12, 2023
zepich added a commit that referenced this issue Nov 18, 2023
@zepich
Added the options for #152 and #153
f614c6f
zepich added a commit that referenced this issue Nov 18, 2023
@zepich
Added the API debug mode (#152)
304dddc 
The API debug mode can help if someone tries to use the mosparo API to verify a submission. The additional information, which will be added to the API responses, can help determine why a verification failed.
@zepich zepich mentioned this issue Jan 10, 2024
Merged
@zepich zepich closed this as completed Jan 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zepich zepich

Labels
doc-prepared enhancement New feature or request
Projects
No open projects
mosparo v1.1
Status: Done
Milestone
v1.1
Development

No branches or pull requests
1 participant
@zepich