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

Add rule to check repeatability headers #63

Open
mikekistler opened this issue Jan 29, 2022 · 0 comments
Open

Add rule to check repeatability headers #63

mikekistler opened this issue Jan 29, 2022 · 0 comments

Comments

@mikekistler
Copy link
Member

The Azure API guidelines recommend:

☑️ YOU SHOULD support repeatable requests according as defined in OASIS Repeatable Requests Version 1.0.

This involves adding two header parameters, Repeatability-Request-ID and Repeatability-First-Sent, to an operation definition. Recently a service team did this (at our recommendation) but made a few mistakes in doing so.

  • They specified x-ms-parameter-location: client on both parameters -- that is incorrect since the value of these headers should be set on each operation.
  • They did not specify format: date-time on Repeatability-First-Sent.

We may also want to recommend format: uuid on `

The API guidelines also state:

When [the repeatability header is] understood, all endpoints co-located behind a DNS name MUST understand the header.

This might be another thing to check for.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant