Skip to content

Latest commit

 

History

History
150 lines (116 loc) · 5.63 KB

AddonReviewsApi.md

File metadata and controls

150 lines (116 loc) · 5.63 KB

AddonReviewsApi

All URIs are relative to https://api.gmodstore.com/v2

Method HTTP request Description
getAddonReview GET /addons/{addon_id}/reviews/{review_id} Fetch a review of an addon
listAddonReviews GET /addons/{addon_id}/reviews Fetch all the reviews of an addon

getAddonReview

AddonReviewResponse getAddonReview(addonId, reviewId, with)

Fetch a review of an addon

Example

// Import classes:
import no.everyday.gmodstore_sdk.ApiClient;
import no.everyday.gmodstore_sdk.ApiException;
import no.everyday.gmodstore_sdk.Configuration;
import no.everyday.gmodstore_sdk.auth.*;
import no.everyday.gmodstore_sdk.models.*;
import no.everyday.gmodstore_sdk.api.AddonReviewsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.gmodstore.com/v2");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    AddonReviewsApi apiInstance = new AddonReviewsApi(defaultClient);
    Long addonId = 56L; // Long | Id of the addon
    Long reviewId = 56L; // Long | Id of the review
    Set<String> with = Arrays.asList(); // Set<String> | The relations you want to fetch with the `AddonReview`
    try {
      AddonReviewResponse result = apiInstance.getAddonReview(addonId, reviewId, with);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AddonReviewsApi#getAddonReview");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
addonId Long Id of the addon
reviewId Long Id of the review
with Set<String> The relations you want to fetch with the `AddonReview` [optional] [enum: addon, author]

Return type

AddonReviewResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successfully processed the request. * X-RateLimit-Limit -
* X-RateLimit-Remaining -
429 Too many requests * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-RateLimit-Reset - The UNIX timestamp at which your rate limit quota will reset.
0 Something went wrong * X-RateLimit-Limit -
* X-RateLimit-Remaining -

listAddonReviews

AddonReviewListResponse listAddonReviews(addonId, with)

Fetch all the reviews of an addon

Example

// Import classes:
import no.everyday.gmodstore_sdk.ApiClient;
import no.everyday.gmodstore_sdk.ApiException;
import no.everyday.gmodstore_sdk.Configuration;
import no.everyday.gmodstore_sdk.auth.*;
import no.everyday.gmodstore_sdk.models.*;
import no.everyday.gmodstore_sdk.api.AddonReviewsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.gmodstore.com/v2");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    AddonReviewsApi apiInstance = new AddonReviewsApi(defaultClient);
    Long addonId = 56L; // Long | Id of the addon
    Set<String> with = Arrays.asList(); // Set<String> | The relations you want to fetch with the `AddonReview`
    try {
      AddonReviewListResponse result = apiInstance.listAddonReviews(addonId, with);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AddonReviewsApi#listAddonReviews");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
addonId Long Id of the addon
with Set<String> The relations you want to fetch with the `AddonReview` [optional] [enum: addon, author]

Return type

AddonReviewListResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successfully processed the request. * X-RateLimit-Limit -
* X-RateLimit-Remaining -
429 Too many requests * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-RateLimit-Reset - The UNIX timestamp at which your rate limit quota will reset.
0 Something went wrong * X-RateLimit-Limit -
* X-RateLimit-Remaining -