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

Robot HTTP Api: Establish error codes and structures #4636

Closed
sfoster1 opened this issue Dec 18, 2019 · 1 comment · Fixed by #5208
Closed

Robot HTTP Api: Establish error codes and structures #4636

sfoster1 opened this issue Dec 18, 2019 · 1 comment · Fixed by #5208
Assignees
@iansolano
Labels
api Affects the `api` project robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). shared data Affects the `shared-data` project WIP
Milestone
CPX Sprint 2

Comments

@sfoster1
Copy link
Member

overview

Well-structured APIs have well structured error conventions and data. We will create such structured errors and use them on both the API and the app sides, at least through the HTTP api and maybe temporarily through the RPC API.

We should create a json document in shared-data that establishes error numbers, shortnames, and additional types. This document is, essentially, a schema, but also specifies some level of content - the list of available errors.

Once the document is created, we can start adding to it and using it in HTTP responses.
@sfoster1 sfoster1 added api Affects the `api` project shared data Affects the `shared-data` project labels Dec 18, 2019
@sfoster1 sfoster1 added this to the API: HTTP API Refactor milestone Dec 18, 2019
@mcous mcous added the robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). label Jan 17, 2020
@mcous
Copy link
Contributor

mcous commented Jan 17, 2020

https://tools.ietf.org/html/rfc7807

@mcous mcous added the WIP label Jan 22, 2020
@iansolano iansolano self-assigned this Feb 7, 2020
iansolano added a commit that referenced this issue Mar 11, 2020
@iansolano
feat(api): adds response formatting to api requests
be6e0f9 
Adds response formatting to api requests in new fastapi framework

closes #4636
iansolano added a commit that referenced this issue Mar 11, 2020
@iansolano
feat(api): adds response formatting to api requests
e1adc9d 
Adds response formatting to api requests in new fastapi framework

closes #4636
iansolano added a commit that referenced this issue Mar 11, 2020
@iansolano
feat(robot-server): adds formatted json responses and error handling
e32d2d4 
Adds formatted json responses and error handling in FastAPI framework

closes #4636
@iansolano iansolano mentioned this issue Mar 11, 2020
Merged
7 tasks
iansolano added a commit that referenced this issue Mar 13, 2020
@iansolano
feat(robot-server): adds formatted json responses and error handling
48c234f 
Adds formatted json responses and error handling in FastAPI framework

closes #4636
iansolano added a commit that referenced this issue Mar 16, 2020
@iansolano
feat(robot-server): add formatted json responses and error handling
ab6f3b5 
Add formatted json responses and error handling in FastAPI framework

closes #4636
iansolano added a commit that referenced this issue Mar 16, 2020
@iansolano
feat(robot-server): add formatted json responses and error handling
bf814b3 
Add formatted json responses and error handling in FastAPI framework

closes #4636
iansolano added a commit that referenced this issue Mar 18, 2020
@iansolano
feat(robot-server): add formatted json responses and error handling
473bd28 
Add formatted json responses and error handling in FastAPI framework

closes #4636
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@iansolano iansolano

Labels
api Affects the `api` project robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). shared data Affects the `shared-data` project WIP
Projects
None yet
Milestone
CPX Sprint 2
Development

Successfully merging a pull request may close this issue.

feat(robot-server): add formatted json responses and error handling Opentrons/opentrons
4 participants
@umbhau @iansolano @mcous @sfoster1