search

kytos / maintenance

Kytos Maintenance Window NApp
0 stars 12 forks source link

Maintenance napp REST API documentation regarding status code is not correct #26

Closed dgarc330 closed 3 years ago

dgarc330 commented 3 years ago

In the maintenance napp rest API documentation found here: https://napps.kytos.io/kytos/maintenance, they specify the return code 200 as a success, but it should be 201 as that is what is return by the application and what Kytos searches for.

Therefore, the documentation should be updated to truly be accurate regarding this aspect.

dgarc330 commented 3 years ago

Also, I have noticed today that to delete a maintenance window the documentation says that 204 is the return code for success. However, thanks to Humberto's help we confirmed that "A successful response of DELETE requests SHOULD be HTTP response code 200 (OK) if the response includes an entity describing the status, 202 (Accepted) if the action has been queued, or 204 (No Content) if the action has been performed but the response does not include an entity."