feat: improve headers guideline (#769) #769
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tkrop
commented
Jul 12, 2023
Comment on lines
+20
to
+27
|
|
||
| [[using--headers]] | ||
| == Using Standard Header definitions | ||
|
|
||
| Usually, you can the standard HTTP request and response header definition | ||
| provided by the guideline to simplify API by using well recognized patterns. | ||
| The best practice importing headers providing the highest readability is as | ||
| follows: |
There was a problem hiding this comment.
May be we should introduce this as a new rule to reference headers - if possible - this way.
tkrop
commented
Jul 12, 2023
Comment on lines
+222
to
227
| [source,yaml] | ||
| ---- | ||
| include::../includes/etag.yaml[] | ||
| include::../includes/if-match.yaml[lines=3..-1] | ||
| include::../includes/if-none-match.yaml[lines=3..-1] | ||
| ---- |
There was a problem hiding this comment.
In the long run, I want this represented as collapsible block, that can be unfolded on demand. Since this currently does not work with our current asciidoc stile, I think, we need to keep this visible by default.
|
👍 |
SmilyOrg
reviewed
Jul 20, 2023
ePaul
reviewed
Jul 20, 2023
ePaul
reviewed
Jul 20, 2023
ePaul
reviewed
Jul 20, 2023
ePaul
reviewed
Jul 20, 2023
ePaul
reviewed
Jul 20, 2023
ePaul
reviewed
Jul 20, 2023
tkrop
pushed a commit
that referenced
this pull request
Jul 20, 2023
Co-authored-by: Paŭlo Ebermann <paul.ebermann@zalando.de>
|
👍 |
1 similar comment
|
👍 |
tkrop
pushed a commit
that referenced
this pull request
Sep 15, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request picks up a couple of header related tasks and left overs from previous pull request, e.g. #760, and from the rolling agenda to complete default header definition support via the guidelines:
Idempotency-Key,Prefer,Accept-Encoding,Content-Encoding,Sunset, andDeprecationheaders.If-Match,If-None-Match,ETag,Cache-Control, andVaryheaders.Generally, this pull request is editorial and does not require Zally to be changed, however, it would be good to add a hint about compression as a Zally rule, since we now can identify endpoints not supporting compression.