Page MenuHomePhabricator

Add 400. 404 and 500 response to docs
Closed, ResolvedPublic

Description

We only have documentation for 200 status code in device-analytics code. Need to update docs for 400. 404 and 500 responses

To do:

  • Add lines to the annotations in the handler that describe the error responses:
// @failure	400		{object}	object{detail=string,method=string,status=int,title=string,uri=string}    "Bad request"
// @failure	404		{object}	object{detail=string,method=string,status=int,title=string,uri=string}    "Not found"
// @failure	500		{object}	object{detail=string,method=string,status=int,title=string,uri=string}     "Internal server error"
  • Run swag fmt to format the annotations
  • Run make docs to update the spec

Related Objects

Event Timeline

Change 935624 had a related patch set uploaded (by Sg912; author: Sg912):

[generated-data-platform/aqs/device-analytics@main] Minor updates

https://gerrit.wikimedia.org/r/935624

Sfaci triaged this task as Medium priority.
Sfaci subscribed.

Change 935624 merged by jenkins-bot:

[generated-data-platform/aqs/device-analytics@main] Minor updates

https://gerrit.wikimedia.org/r/935624

Sfaci assigned this task to SGupta-WMF.
apaskulin moved this task from Sign off to Done on the AQS2.0 (Sprint 10) board.

Checked and signed off. Thanks!