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

Standardize HTTP update request methods and return codes #3

Open
ajoaoff opened this issue Jun 14, 2021 · 0 comments
Open

Standardize HTTP update request methods and return codes #3

ajoaoff opened this issue Jun 14, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@ajoaoff
Copy link

ajoaoff commented Jun 14, 2021

Original issue opened by @cmagnobarbosa at kytos#135.

Today, this NApp lacks a standard for the HTTP update request methods and successful response code.

Possible Solution:

Use PATCH to modify an existing resource [1, 2] and return the code 204 in success response.
Example:

  • Method: enable_interface:
    Description: Enable interfaces in the topology.
    • Today:
      • POST v3/interfaces/switch/<dpid>/enable success response: 200
    • Propose change:
      • PATCH v3/interfaces/switch/<dpid>/enablesuccess response: 204

References:
[1] - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH
[2] - https://tools.ietf.org/html/rfc5789#section-2

@ajoaoff ajoaoff added the enhancement New feature or request label Jun 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant