Skip to content

"do not document" on status codes 502 + 504 #822

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

Merged
merged 2 commits into from
Jan 21, 2025
Merged

"do not document" on status codes 502 + 504 #822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3179f86
"do not document" on status codes 502 + 504
Jan 7, 2025
0bd1843
Remove duplicated section in the build instructions.
Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions BUILD.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,6 @@ the following command to find the next unused rule identifier.
make next-rule-id
----

== Watch for changes and rebuild

[source,bash]
----
make watch
----

It uses https://github.com/watchexec/watchexec[watchexec] to watch for
changes in the `.adoc` (and `.css`) files to rebuild the html on save.

Comment on lines -50 to -59
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This somehow got duplicated – it's also in lines 30 to 39 above.

== Generate Custom CSS

In order to generate custom CSS we have to use
Expand Down
6 changes: 3 additions & 3 deletions chapters/http-status-codes-and-errors.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,8 +398,8 @@ May be documented on endpoints that are planned to be implemented in the
future to indicate that they are still not available.

[[status-code-502]]
==== 502 Bad Gateway {rfc-status-502} {ALL}
[.indent]is meaningless
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose this was a copy+paste failure (or typing in the wrong window).

==== 502 Bad Gateway {rfc-status-502} {use} {do-not-document} {ALL}
[.indent]
The server, while acting as a gateway or proxy, received an invalid response
from an inbound server attempting to fulfill the request. May be used by a
server to indicate that an inbound service is creating an unexpected result
Expand All @@ -415,7 +415,7 @@ exponential back off pattern. If possible, the service should indicate how long
the client should wait by setting the {Retry-After} header.

[[status-code-504]]
==== 504 Gateway Timeout {rfc-status-504} {use} {ALL}
==== 504 Gateway Timeout {rfc-status-504} {use} {do-not-document} {ALL}
[.indent]
The server, while acting as a gateway or proxy, did not receive a timely
response. May be used by servers to indicate that an inbound service cannot
Expand Down
Loading