Commit Graph

179 Commits

Author SHA1 Message Date
Steven Reilly
d7b889767e simplify to use the script for this exact purpose
Co-authored-by: Ryan Ahearn <ryan.ahearn@gsa.gov>
2022-12-23 11:26:11 -05:00
Steven Reilly
276546fc99 simplify cleanup steps
Co-authored-by: Ryan Ahearn <ryan.ahearn@gsa.gov>
2022-12-23 11:25:44 -05:00
Steven Reilly
036a511e12 update sandbox teardown steps 2022-12-23 10:13:28 -05:00
Ryan Ahearn
0d0db5f6f6 Document potential PII and data storage policies 2022-12-12 16:46:31 -05:00
Ryan Ahearn
b32dbdf199 Add links to postman documentation and other additions to api docs 2022-12-02 11:44:56 -05:00
Ryan Ahearn
34def50f69 Add template list and show API methods to openapi 2022-12-02 11:43:53 -05:00
Ryan Ahearn
0ed7a31765 Merge pull request #126 from GSA/open-api
Add OpenAPI spec for selected api endpoints
2022-11-30 13:30:26 -05:00
stvnrlly
ae25998e52 add some docs about queues, esp what priority is 2022-11-30 11:56:49 -05:00
Ryan Ahearn
e0764a588f Add link to vscode extension for editing openapi 2022-11-21 14:27:10 -05:00
Ryan Ahearn
f9bb5cbb9a Expand docs for external-api call, include link to .gov.uk docs 2022-11-21 12:40:54 -05:00
Ryan Ahearn
1e7d99e853 Fix flake8 and isort findings 2022-11-18 12:39:50 -05:00
Ryan Ahearn
2efed403b1 Add external API for sending SMS to openapi 2022-11-18 12:25:45 -05:00
Ryan Ahearn
f71df236b7 Add more admin api endpoints 2022-11-18 11:43:46 -05:00
Ryan Ahearn
0a9ca6b231 Add organisation and service routes to openapi 2022-11-17 15:47:51 -05:00
Ryan Ahearn
3b7dbddc58 Add /user routes to openapi schema 2022-11-17 10:57:34 -05:00
Ryan Ahearn
7c611e993f Read openapi schema for the owasp scan 2022-11-16 15:50:08 -05:00
Ryan Ahearn
182dd2c28c Document _status routes in openapi 2022-11-16 15:47:51 -05:00
Ryan Ahearn
2e6deb1556 Document egress proxy and sandbox environment within deploying.md 2022-11-08 16:26:59 -05:00
Ryan Ahearn
afd855442b Create demo deploy workflows 2022-11-02 11:36:54 -04:00
stvnrlly
57adbf3f6b document create-test-user command 2022-11-01 12:14:26 -04:00
stvnrlly
64f8641013 improvements from feedback 2022-10-28 12:48:22 -04:00
stvnrlly
9b32bb55ea more ci info 2022-10-28 11:11:17 -04:00
stvnrlly
d87c224473 remove broadcast-related code, except migrations 2022-10-26 16:41:35 -04:00
stvnrlly
56329daa9a more docs 2022-10-26 15:45:45 +00:00
stvnrlly
a45e02d6e5 restructure readme & docs 2022-10-20 14:05:23 -04:00
stvnrlly
57f4df8ed1 remove broadcast-related code, except migrations 2022-10-04 15:28:27 +00:00
Ben Thorner
d1826af3c7 Remove out-of-date docs on new workers
In response to: https://github.com/alphagov/notifications-api/pull/3332#issuecomment-921897641

These were so out-of-date as to be misleading. We can always refer
back to them in the version history if needed.
2021-09-17 16:53:42 +01:00
Ben Thorner
f712bafc7f Add new guidance on writing public APIs
In response to: https://github.com/alphagov/notifications-api/pull/3305#issuecomment-896631475
2021-09-15 17:09:04 +01:00
Ben Thorner
14adddd566 Extract content about new workers into own doc
This is a bit too niche for the README, which should be focussed on
the bare minimum someone needs to know to get started with a repo.
Moving this content to its own doc is consistent with other apps [1]
and gives it more room to grow.

[1]: https://github.com/alphagov/notifications-admin/tree/master/docs
2021-09-15 16:11:54 +01:00