docs(http): replace http method return description (#47322)

PR Close #47322
This commit is contained in:
Giovanni Alberto Rivas 2022-09-01 19:54:12 -06:00 committed by Alex Rickabaugh
parent 9a623c03b2
commit 5dd72b7610

View file

@ -865,7 +865,7 @@ export class HttpClient {
/**
* Constructs a `DELETE` request that interprets the body as a JSON object and
* returns the response body as a JSON object.
* returns the response body as an object parsed from JSON.
*
* @param url The endpoint URL.
* @param options The HTTP options to send with the request.
@ -1178,13 +1178,13 @@ export class HttpClient {
/**
* Constructs a `GET` request that interprets the body as a JSON object and
* returns the response body as a JSON object.
* returns the response body as an object parsed from JSON.
*
* @param url The endpoint URL.
* @param options The HTTP options to send with the request.
*
*
* @return An `Observable` of the response body as a JSON object.
* @return An `Observable` of the response body as an object parsed from JSON.
*/
get(url: string, options?: {
headers?: HttpHeaders|{[header: string]: string | string[]},
@ -1490,12 +1490,12 @@ export class HttpClient {
/**
* Constructs a `HEAD` request that interprets the body as a JSON object and
* returns the response body as a JSON object.
* returns the response body as an object parsed from JSON.
*
* @param url The endpoint URL.
* @param options The HTTP options to send with the request.
*
* @return An `Observable` of the response, with the response body as a JSON object.
* @return An `Observable` of the response, with the response body as an object parsed from JSON.
*/
head(url: string, options?: {
headers?: HttpHeaders|{[header: string]: string | string[]},
@ -1852,12 +1852,12 @@ export class HttpClient {
/**
* Constructs an `OPTIONS` request that interprets the body as a JSON object and returns the
* response body as a JSON object.
* response body as an object parsed from JSON.
*
* @param url The endpoint URL.
* @param options HTTP options.
*
* @return An `Observable` of the response, with the response body as a JSON object.
* @return An `Observable` of the response, with the response body as an object parsed from JSON.
*/
options(url: string, options?: {
headers?: HttpHeaders|{[header: string]: string | string[]},
@ -2177,13 +2177,13 @@ export class HttpClient {
/**
* Constructs a `PATCH` request that interprets the body as a JSON object and
* returns the response body as a JSON object.
* returns the response body as an object parsed from JSON.
*
* @param url The endpoint URL.
* @param body The resources to edit.
* @param options HTTP options.
*
* @return An `Observable` of the response, with the response body as a JSON object.
* @return An `Observable` of the response, with the response body as an object parsed from JSON.
*/
patch(url: string, body: any|null, options?: {
headers?: HttpHeaders|{[header: string]: string | string[]},
@ -2502,13 +2502,13 @@ export class HttpClient {
/**
* Constructs a `POST` request that interprets the body as a
* JSON object and returns the response body as a JSON object.
* JSON object and returns the response body as an object parsed from JSON.
*
* @param url The endpoint URL.
* @param body The content to replace with.
* @param options HTTP options
*
* @return An `Observable` of the response, with the response body as a JSON object.
* @return An `Observable` of the response, with the response body as an object parsed from JSON.
*/
post(url: string, body: any|null, options?: {
headers?: HttpHeaders|{[header: string]: string | string[]},