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

Standardized HTTP request and response headers #9

Open

jpraet opened this issue Mar 25, 2024 · 1 comment · May be fixed by #12

Contributor

jpraet commented Mar 25, 2024

Reusable components could be added to openapi-common for the HTTP request and response headers standardized in the Belgif guide.

Caching (https://www.belgif.be/specification/rest/api-guide/#caching)
- Request headers:
  - If-None-Match
  - (If-Match) not sure, currently not referenced in the Belgif guide
  - (If-Modified-Since) not sure, guide recommends ETag
  - (If-Unmodified-Since) not sure, currently not referenced in the Belgif guide, and guide recommends ETag
- Response headers:
  - ETag
  - (Last-Modified) not sure, guide recommends ETag
  - Cache-Control
  - Vary
Other HTTP response headers:
- Location
- Retry-After

Contributor

pvdbosch commented Mar 25, 2024

Agree with the ones not in parentheses. the If-Match probably only after adding a rule on optimistic locking (belgif/rest-guide#37)

JDMKSZ linked a pull request

that will close this issue

WIP: first draft for conditional headers #12

Draft

JDMKSZ linked a pull request

that will close this issue

WIP: first draft for conditional headers #12

Draft

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