[ruby/net-http] Prettify class hierarchies in Net::HTTP

https://github.com/ruby/net-http/commit/4a5732e210
This commit is contained in:
BurdetteLamar 2022-11-09 22:08:51 +00:00 committed by git
parent 04c5adf806
commit 4d9ada223b

View File

@ -298,98 +298,110 @@ module Net #:nodoc:
# #
# Compression can be disabled through the Accept-Encoding: identity header. # Compression can be disabled through the Accept-Encoding: identity header.
# #
# == HTTP Request Classes # == \HTTP Request Classes
# #
# Here is the HTTP request class hierarchy. # Here is the hierarchy of \HTTP request classes
# #
# * Net::HTTPRequest # - Net::HTTPRequest
# * Net::HTTP::Get
# * Net::HTTP::Head
# * Net::HTTP::Post
# * Net::HTTP::Patch
# * Net::HTTP::Put
# * Net::HTTP::Proppatch
# * Net::HTTP::Lock
# * Net::HTTP::Unlock
# * Net::HTTP::Options
# * Net::HTTP::Propfind
# * Net::HTTP::Delete
# * Net::HTTP::Move
# * Net::HTTP::Copy
# * Net::HTTP::Mkcol
# * Net::HTTP::Trace
# #
# == HTTP Response Classes # - Net::HTTP::Get
# - Net::HTTP::Head
# - Net::HTTP::Post
# - Net::HTTP::Patch
# - Net::HTTP::Put
# - Net::HTTP::Proppatch
# - Net::HTTP::Lock
# - Net::HTTP::Unlock
# - Net::HTTP::Options
# - Net::HTTP::Propfind
# - Net::HTTP::Delete
# - Net::HTTP::Move
# - Net::HTTP::Copy
# - Net::HTTP::Mkcol
# - Net::HTTP::Trace
# #
# Here is HTTP response class hierarchy. All classes are defined in Net # == \HTTP Response Classes
# module and are subclasses of Net::HTTPResponse.
# #
# HTTPUnknownResponse:: For unhandled HTTP extensions # Here is the \HTTP response class hierarchy (with status codes):
# HTTPInformation:: 1xx #
# HTTPContinue:: 100 # - Net::HTTPResponse:
# HTTPSwitchProtocol:: 101 #
# HTTPProcessing:: 102 # - Net::HTTPUnknownResponse (for unhandled \HTTP extensions).
# HTTPEarlyHints:: 103 #
# HTTPSuccess:: 2xx # - Net::HTTPInformation:
# HTTPOK:: 200 #
# HTTPCreated:: 201 # - Net::HTTPContinue (100)
# HTTPAccepted:: 202 # - Net::HTTPSwitchProtocol (101)
# HTTPNonAuthoritativeInformation:: 203 # - Net::HTTPProcessing (102)
# HTTPNoContent:: 204 # - Net::HTTPEarlyHints (103)
# HTTPResetContent:: 205 #
# HTTPPartialContent:: 206 # - Net::HTTPSuccess:
# HTTPMultiStatus:: 207 #
# HTTPAlreadyReported:: 208 # - Net::HTTPOK (200)
# HTTPIMUsed:: 226 # - Net::HTTPCreated (201)
# HTTPRedirection:: 3xx # - Net::HTTPAccepted (202)
# HTTPMultipleChoices:: 300 # - Net::HTTPNonAuthoritativeInformation (203)
# HTTPMovedPermanently:: 301 # - Net::HTTPNoContent (204)
# HTTPFound:: 302 # - Net::HTTPResetContent (205)
# HTTPSeeOther:: 303 # - Net::HTTPPartialContent (206)
# HTTPNotModified:: 304 # - Net::HTTPMultiStatus (207)
# HTTPUseProxy:: 305 # - Net::HTTPAlreadyReported (208)
# HTTPTemporaryRedirect:: 307 # - Net::HTTPIMUsed (226)
# HTTPPermanentRedirect:: 308 #
# HTTPClientError:: 4xx # - HTTPRedirection:
# HTTPBadRequest:: 400 #
# HTTPUnauthorized:: 401 # - Net::HTTPMultipleChoices (300)
# HTTPPaymentRequired:: 402 # - Net::HTTPMovedPermanently (301)
# HTTPForbidden:: 403 # - Net::HTTPFound (302)
# HTTPNotFound:: 404 # - Net::HTTPSeeOther (303)
# HTTPMethodNotAllowed:: 405 # - Net::HTTPNotModified (304)
# HTTPNotAcceptable:: 406 # - Net::HTTPUseProxy (305)
# HTTPProxyAuthenticationRequired:: 407 # - Net::HTTPTemporaryRedirect (307)
# HTTPRequestTimeOut:: 408 # - Net::HTTPPermanentRedirect (308)
# HTTPConflict:: 409 #
# HTTPGone:: 410 # - Net::HTTPClientError:
# HTTPLengthRequired:: 411 #
# HTTPPreconditionFailed:: 412 # - Net::HTTPBadRequest (400)
# HTTPRequestEntityTooLarge:: 413 # - Net::HTTPUnauthorized (401)
# HTTPRequestURITooLong:: 414 # - Net::HTTPPaymentRequired (402)
# HTTPUnsupportedMediaType:: 415 # - Net::HTTPForbidden (403)
# HTTPRequestedRangeNotSatisfiable:: 416 # - Net::HTTPNotFound (404)
# HTTPExpectationFailed:: 417 # - Net::HTTPMethodNotAllowed (405)
# HTTPMisdirectedRequest:: 421 # - Net::HTTPNotAcceptable (406)
# HTTPUnprocessableEntity:: 422 # - Net::HTTPProxyAuthenticationRequired (407)
# HTTPLocked:: 423 # - Net::HTTPRequestTimeOut (408)
# HTTPFailedDependency:: 424 # - Net::HTTPConflict (409)
# HTTPUpgradeRequired:: 426 # - Net::HTTPGone (410)
# HTTPPreconditionRequired:: 428 # - Net::HTTPLengthRequired (411)
# HTTPTooManyRequests:: 429 # - Net::HTTPPreconditionFailed (412)
# HTTPRequestHeaderFieldsTooLarge:: 431 # - Net::HTTPRequestEntityTooLarge (413)
# HTTPUnavailableForLegalReasons:: 451 # - Net::HTTPRequestURITooLong (414)
# HTTPServerError:: 5xx # - Net::HTTPUnsupportedMediaType (415)
# HTTPInternalServerError:: 500 # - Net::HTTPRequestedRangeNotSatisfiable (416)
# HTTPNotImplemented:: 501 # - Net::HTTPExpectationFailed (417)
# HTTPBadGateway:: 502 # - Net::HTTPMisdirectedRequest (421)
# HTTPServiceUnavailable:: 503 # - Net::HTTPUnprocessableEntity (422)
# HTTPGatewayTimeOut:: 504 # - Net::HTTPLocked (423)
# HTTPVersionNotSupported:: 505 # - Net::HTTPFailedDependency (424)
# HTTPVariantAlsoNegotiates:: 506 # - Net::HTTPUpgradeRequired (426)
# HTTPInsufficientStorage:: 507 # - Net::HTTPPreconditionRequired (428)
# HTTPLoopDetected:: 508 # - Net::HTTPTooManyRequests (429)
# HTTPNotExtended:: 510 # - Net::HTTPRequestHeaderFieldsTooLarge (431)
# HTTPNetworkAuthenticationRequired:: 511 # - Net::HTTPUnavailableForLegalReasons (451)
#
# - Net::HTTPServerError:
#
# - Net::HTTPInternalServerError (500)
# - Net::HTTPNotImplemented (501)
# - Net::HTTPBadGateway (502)
# - Net::HTTPServiceUnavailable (503)
# - Net::HTTPGatewayTimeOut (504)
# - Net::HTTPVersionNotSupported (505)
# - Net::HTTPVariantAlsoNegotiates (506)
# - Net::HTTPInsufficientStorage (507)
# - Net::HTTPLoopDetected (508)
# - Net::HTTPNotExtended (510)
# - Net::HTTPNetworkAuthenticationRequired (511)
# #
# There is also the Net::HTTPBadResponse exception which is raised when # There is also the Net::HTTPBadResponse exception which is raised when
# there is a protocol error. # there is a protocol error.