From 98fe8707d983ef4b9f10cab28a1a540b8dafc078 Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sun, 10 Dec 2023 16:00:28 +0000 Subject: Deploying to docs from @ python-discord/bot-core@3ed1d4be2328b59577afde058105fd071184bd95 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v8.0.0/output/botcore.site_api.html | 52 ++++++++++++++++++++----------------- 1 file changed, 28 insertions(+), 24 deletions(-) (limited to 'v8.0.0/output/botcore.site_api.html') diff --git a/v8.0.0/output/botcore.site_api.html b/v8.0.0/output/botcore.site_api.html index 1e876069..17160aa2 100644 --- a/v8.0.0/output/botcore.site_api.html +++ b/v8.0.0/output/botcore.site_api.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
  • +
  • v10.3.0
  • @@ -437,9 +441,9 @@
    Parameters:
      -
    • site_api_url (str) – The URL of the site API.

    • -
    • site_api_token (str) – The token to use for authentication.

    • -
    • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

    • +
    • site_api_url (str) – The URL of the site API.

    • +
    • site_api_token (str) – The token to use for authentication.

    • +
    • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

    @@ -451,7 +455,7 @@

    Close the aiohttp session.

    Return type:
    -

    None

    +

    None

    @@ -463,13 +467,13 @@
    Parameters:
      -
    • endpoint (str) – The endpoint to send the request to.

    • -
    • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

    • -
    • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

    • +
    • endpoint (str) – The endpoint to send the request to.

    • +
    • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

    • +
    • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

    Return type:
    -

    Optional[dict]

    +

    Optional[dict]

    Returns:

    The JSON response the API returns, or None if the response is 204 No Content.

    @@ -483,7 +487,7 @@

    Equivalent to APIClient.request() with GET passed as the method.

    Return type:
    -

    dict

    +

    dict

    @@ -495,15 +499,15 @@
    Parameters:
      -
    • response (aiohttp.ClientResponse) – The response to check.

    • -
    • should_raise (bool) – Whether or not to raise an exception.

    • +
    • response (aiohttp.ClientResponse) – The response to check.

    • +
    • should_raise (bool) – Whether or not to raise an exception.

    Raises:

    ResponseCodeError – If the response is not OK and should_raise is True.

    Return type:
    -

    None

    +

    None

    @@ -514,7 +518,7 @@

    Equivalent to APIClient.request() with PATCH passed as the method.

    Return type:
    -

    dict

    +

    dict

    @@ -525,7 +529,7 @@

    Equivalent to APIClient.request() with POST passed as the method.

    Return type:
    -

    dict

    +

    dict

    @@ -536,7 +540,7 @@

    Equivalent to APIClient.request() with PUT passed as the method.

    Return type:
    -

    dict

    +

    dict

    @@ -548,14 +552,14 @@
    Parameters:
      -
    • method (str) – The HTTP method to use.

    • -
    • endpoint (str) – The endpoint to send the request to.

    • -
    • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

    • -
    • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

    • +
    • method (str) – The HTTP method to use.

    • +
    • endpoint (str) – The endpoint to send the request to.

    • +
    • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

    • +
    • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

    Return type:
    -

    dict

    +

    dict

    Returns:

    The JSON response the API returns.

    @@ -580,9 +584,9 @@
    Parameters:
      -
    • response (aiohttp.ClientResponse) – The response object from the request.

    • -
    • response_json (Optional[dict]) – The JSON response returned from the request, if any.

    • -
    • response_text (Optional[str]) – The text of the request, if any.

    • +
    • response (aiohttp.ClientResponse) – The response object from the request.

    • +
    • response_json (Optional[dict]) – The JSON response returned from the request, if any.

    • +
    • response_text (Optional[str]) – The text of the request, if any.

    -- cgit v1.2.3