Skip to content

Commit e6a4af8

Browse files
authored
"do not document" on status codes 502 + 504 (#822)
* "do not document" on status codes 502 + 504 This was missed before. Also, fix the indentation of the text for 504. * Remove duplicated section in the build instructions.
1 parent 324dca5 commit e6a4af8

File tree

2 files changed

+3
-13
lines changed

2 files changed

+3
-13
lines changed

BUILD.adoc

-10
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,6 @@ the following command to find the next unused rule identifier.
4747
make next-rule-id
4848
----
4949

50-
== Watch for changes and rebuild
51-
52-
[source,bash]
53-
----
54-
make watch
55-
----
56-
57-
It uses https://github.com/watchexec/watchexec[watchexec] to watch for
58-
changes in the `.adoc` (and `.css`) files to rebuild the html on save.
59-
6050
== Generate Custom CSS
6151

6252
In order to generate custom CSS we have to use

chapters/http-status-codes-and-errors.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -398,8 +398,8 @@ May be documented on endpoints that are planned to be implemented in the
398398
future to indicate that they are still not available.
399399

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

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

0 commit comments

Comments
 (0)