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

Add developer documentation #65

Open
redshiftzero opened this issue Sep 24, 2018 · 1 comment
Open

Add developer documentation #65

redshiftzero opened this issue Sep 24, 2018 · 1 comment

Comments

@redshiftzero
Copy link
Contributor

To make issues like freedomofpress/securedrop-sdk#16 easier for developers, we should add some documentation of exactly what format is expected for the requests and responses (one can figure out from the examples / code but worth writing out explicitly). For example, these docs should describe the valid fields for a request (path_query, body, headers, method). This can go in the regular SecureDrop developer documentation, and be linked to in the README in this repository.

@sssoleileraaa sssoleileraaa transferred this issue from freedomofpress/securedrop-proxy May 16, 2023
@sssoleileraaa
Copy link
Contributor

[Backlog pruning, 5/16] This is still relevant and as part of this research into how it currently works, one could develop a proposal for interface improvement between the SDK and proxy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants