Project

General

Profile

Fix #7527

Document expected response codes in REST API

Added by Yan-Fa Li about 10 years ago. Updated about 10 years ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
Docs (REST API)
Target version:
-
% Done:

0%

Source:
other
Tags:
Backport:
Reviewed:
Affected Versions:
ceph-qa-suite:
Crash signature (v1):
Crash signature (v2):

Description

Only one API login/ has documentation about what the expected response codes are from a particular API end-point. Some return 202 and some return 204. It would be great if we had a list of expected responses from an API to code the clients against.

History

#1 Updated by Yan-Fa Li about 10 years ago

  • Subject changed from Calamari Rest-API docs to Calamari Rest-API docs Expected Response Code

#2 Updated by John Spray about 10 years ago

  • Subject changed from Calamari Rest-API docs Expected Response Code to Document expected response codes in REST API
  • Target version deleted (v1.2 Backlog)

The pattern is that for PATCH/DELETE operations that are actioned synchronously return 204, while asynchronous operations return 202 (with request ID in the body). It's not random (remote operations are going to be 202s while calamari server housekeeping operations are going to be 204s), but it should be more explicit in the docs.

#3 Updated by John Spray about 10 years ago

  • Category changed from Backend (REST API) to Docs (REST API)

#4 Updated by John Spray about 10 years ago

  • translation missing: en.field_story_points set to 3.0

#5 Updated by John Spray about 10 years ago

  • Assignee deleted (John Spray)

Also available in: Atom PDF