http.client: fix help-lint

mrjbq7 · mrjbq7 · commit 283d8b4d4434 · 2024-12-03T10:39:07.000-08:00
diff --git a/basis/http/client/client-docs.factor b/basis/http/client/client-docs.factor
@@ -44,100 +44,100 @@ HELP: <trace-request>
 { $notes "The request can be passed on to " { $link http-request } ", possibly after cookies and headers are set." } ;
 
 HELP: http-get
-{ $values { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Downloads the contents of a URL." }
 { $errors "Throws an error if the HTTP request fails." } ;
 
 HELP: http-get*
-{ $values { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Downloads the contents of a URL, but does not check the HTTP response code for success." } ;
 
 { http-get http-get* } related-words
 
 HELP: http-post
-{ $values { "data" object } { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "data" object } { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Submits an HTTP POST request." }
 { $errors "Throws an error if the HTTP request fails." } ;
 
 HELP: http-post*
-{ $values { "data" object } { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "data" object } { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Submits an HTTP POST request, but does not check the HTTP response code for success." } ;
 
 { http-post http-post* } related-words
 
 HELP: http-put
-{ $values { "data" object } { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "data" object } { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Submits an HTTP PUT request." }
 { $errors "Throws an error if the HTTP request fails." } ;
 
 HELP: http-put*
-{ $values { "data" object } { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "data" object } { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Submits an HTTP PUT request, but does not check the HTTP response code for success." } ;
 
 { http-put http-put* } related-words
 
 HELP: http-head
-{ $values { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Same as " { $link http-get } " except that the server is not supposed to return a message-body in the response, as per RFC2616. However in practise, most web servers respond to GET and HEAD method calls with identical responses." }
 { $errors "Throws an error if the HTTP request fails." } ;
 
 HELP: http-head*
-{ $values { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Same as " { $link http-get* } " except that the server is not supposed to return a message-body in the response, as per RFC2616. However in practise, most web servers respond to GET and HEAD method calls with identical responses." } ;
 
 { http-head http-head* } related-words
 
 HELP: http-delete
-{ $values { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Requests that the origin server delete the resource identified by the URL." }
 { $errors "Throws an error if the HTTP request fails." } ;
 
 HELP: http-delete*
-{ $values { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Requests that the origin server delete the resource identified by the URL, but does not check the HTTP response code for success." } ;
 
 { http-delete http-delete* } related-words
 
 HELP: http-options
-{ $values { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Submits an HTTP OPTIONS request." }
 { $errors "Throws an error if the HTTP request fails." } ;
 
 HELP: http-options*
-{ $values { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Submits an HTTP OPTIONS request, but does not check the HTTP response code for success." } ;
 
 { http-options http-options* } related-words
 
 HELP: http-patch
-{ $values { "data" object } { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "data" object } { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Submits an HTTP PATCH request." }
 { $errors "Throws an error if the HTTP request fails." } ;
 
 HELP: http-patch*
-{ $values { "data" object } { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "data" object } { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Submits an HTTP PATCH request, but does not check the HTTP response code for success." } ;
 
 { http-patch http-patch* } related-words
 
 HELP: http-trace
-{ $values { "url" "a " { $link url } " or " { $link string } } { "response" response } { "data" sequence } }
+{ $values { "url" "a " { $link url } " or " { $link string } } { "response" response } { "content" sequence } }
 { $description "Submits an HTTP TRACE request." }
 { $errors "Throws an error if the HTTP request fails." } ;
 
 HELP: http-trace*
-{ $values { "url" { $or url string } } { "response" response } { "data" sequence } }
+{ $values { "url" { $or url string } } { "response" response } { "content" sequence } }
 { $description "Submits an HTTP TRACE request, but does not check the HTTP response code for success." } ;
 
 { http-trace http-trace* } related-words
 
 HELP: http-request
-{ $values { "request" request } { "response" response } { "data" sequence } }
+{ $values { "request" request } { "response" response } { "content" sequence } }
 { $description "A variant of " { $link http-request* } " that checks that the response was successful." }
 { $errors "Throws an error if the HTTP request fails." } ;
 
 HELP: http-request*
-{ $values { "request" request } { "response" response } { "data" sequence } }
+{ $values { "request" request } { "response" response } { "content" sequence } }
 { $description "Sends an HTTP request to an HTTP server, and reads the response." } ;
 
 HELP: read-response-header
diff --git a/basis/http/client/client.factor b/basis/http/client/client.factor
@@ -277,11 +277,11 @@ SYMBOL: request-socket
 : with-http-request ( request quot: ( chunk -- ) -- response/stream )
     do-http-request check-response ; inline
 
-: http-request* ( request -- response data )
+: http-request* ( request -- response content )
     BV{ } clone [ '[ _ push-all ] do-http-request ] keep
     B{ } like over content-encoding>> decode [ >>body ] keep ;
 
-: http-request ( request -- response data )
+: http-request ( request -- response content )
     http-request* [ check-response ] dip ;
 
 : <rest-request-with-body> ( body url method -- request )
@@ -293,82 +293,82 @@ SYMBOL: request-socket
 : <rest-request> ( url method -- request )
     [ f ] 2dip <rest-request-with-body> ;
 
-: rest-request-with-body ( body url method -- response data )
+: rest-request-with-body ( body url method -- response content )
     <rest-request-with-body> http-request ;
 
-: rest-request ( url method -- response data )
+: rest-request ( url method -- response content )
     [ f ] 2dip rest-request-with-body ;
 
 : <get-request> ( url -- request )
     "GET" <client-request> ;
 
-: http-get ( url -- response data )
+: http-get ( url -- response content )
     <get-request> http-request ;
 
-: http-get* ( url -- response data )
+: http-get* ( url -- response content )
     <get-request> http-request* ;
 
 : <post-request> ( data url -- request )
     "POST" <client-request> swap >>data ;
 
-: http-post ( data url -- response data )
+: http-post ( data url -- response content )
     <post-request> http-request ;
 
-: http-post* ( data url -- response data )
+: http-post* ( data url -- response content )
     <post-request> http-request* ;
 
 : <put-request> ( data url -- request )
     "PUT" <client-request> swap >>data ;
 
-: http-put ( data url -- response data )
+: http-put ( data url -- response content )
     <put-request> http-request ;
 
-: http-put* ( data url -- response data )
+: http-put* ( data url -- response content )
     <put-request> http-request* ;
 
 : <delete-request> ( url -- request )
     "DELETE" <client-request> ;
 
-: http-delete ( url -- response data )
+: http-delete ( url -- response content )
     <delete-request> http-request ;
 
-: http-delete* ( url -- response data )
+: http-delete* ( url -- response content )
     <delete-request> http-request* ;
 
 : <head-request> ( url -- request )
     "HEAD" <client-request> ;
 
-: http-head ( url -- response data )
+: http-head ( url -- response content )
     <head-request> http-request ;
 
-: http-head* ( url -- response data )
+: http-head* ( url -- response content )
     <head-request> http-request* ;
 
 : <options-request> ( url -- request )
     "OPTIONS" <client-request> ;
 
-: http-options ( url -- response data )
+: http-options ( url -- response content )
     <options-request> http-request ;
 
-: http-options* ( url -- response data )
+: http-options* ( url -- response content )
     <options-request> http-request* ;
 
 : <patch-request> ( data url -- request )
     "PATCH" <client-request> swap >>data ;
 
-: http-patch ( patch-data url -- response data )
+: http-patch ( data url -- response content )
     <patch-request> http-request ;
 
-: http-patch* ( patch-data url -- response data )
+: http-patch* ( data url -- response content )
     <patch-request> http-request* ;
 
 : <trace-request> ( url -- request )
     "TRACE" <client-request> ;
 
-: http-trace ( url -- response data )
+: http-trace ( url -- response content )
     <trace-request> http-request ;
 
-: http-trace* ( url -- response data )
+: http-trace* ( url -- response content )
     <trace-request> http-request* ;
 
 { "http.client" "debugger" } "http.client.debugger" require-when
