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

a RESTful HTTPS API spec #32

Closed
pkarman opened this issue Jul 31, 2017 · 2 comments

Comments

Projects
None yet
3 participants
@pkarman
Copy link
Contributor

commented Jul 31, 2017

As an agency that uses a case management system, in order to receive requests from the portal, I need a RESTful HTTPS API spec and request payload schema that I can use to implement.

  • status code definitions
  • example of API request (ex: cURL request)
  • example of API response
  • security section describing implications of receiving request data

note: some of this is already available in the spec in this repo

@bsweger

This comment has been minimized.

Copy link

commented Aug 10, 2017

@usdoj usdoj deleted a comment from leahbannon Aug 10, 2017

@adborden

This comment has been minimized.

Copy link
Contributor

commented Aug 10, 2017

@leahbannon I moved the AC up to the description. I also added that we'll want to capture a note about security. Agencies implementing the API will go through some ATO process of their own, we won't be able to document all the details, but at least capture a high-level of what to expect. I expect this content to come from our DOJ security team and the question is captured in our cybersecurity doc https://docs.google.com/document/d/19_RsXMAu7eVwa97vpv36HsB9Xtnno7oSK4ocdNCkDX0/edit#

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.