Get Cheap Games Reviews API

openapi: 3.2.0
info:
  title: getcheapgames Reviews API
  description: Game key price comparison. All money is integer cents; rankings are on the price each store lists, without the service fee a marketplace adds at checkout.
  version: 0.1.0
tags:
- name: Reviews
paths:
  /api/games/{slug}/reviews:
    get:
      tags:
      - Reviews
      summary: Get Reviews
      description: The GCG rating and a page of the visible reviews, newest first.
      operationId: get_reviews_api_games__slug__reviews_get
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: How many reviews to skip
          default: 0
          title: Offset
        description: How many reviews to skip
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 20
          minimum: 1
          description: How many to return
          default: 10
          title: Limit
        description: How many to return
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewPageOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/stores/{code}/reviews:
    get:
      tags:
      - Reviews
      summary: Get Store Reviews
      description: 'A listed store''s GCG rating over every review it has had, and a page of

        the reviews of the last 24 hours, newest first (`total` is how many of

        those): an older review''s words are no longer shown, its stars count in

        the rating alone (`service.STORE_TEXT_SHOWN`).'
      operationId: get_store_reviews_api_stores__code__reviews_get
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: How many reviews to skip
          default: 0
          title: Offset
        description: How many reviews to skip
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 20
          minimum: 1
          description: How many to return
          default: 10
          title: Limit
        description: How many to return
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewPageOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/stores/{code}/reviews/history:
    get:
      tags:
      - Reviews
      summary: Get Store Review History
      description: 'A listed store''s reviews kept over time: its rating over each period

        (`service.PERIODS`), and each period''s chart (`service.SERIES`): hour by

        hour today, day by day over 30 days, month by month for all time, each

        oldest first.'
      operationId: get_store_review_history_api_stores__code__reviews_history_get
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewHistoryOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/account/reviews/{slug}:
    get:
      tags:
      - Reviews
      summary: Get My Review
      description: 'The user''s own review of the product, hidden or not, or null: what the

        form opens with. An edition answers with the review of its game, where

        it is kept.'
      operationId: get_my_review_api_account_reviews__slug__get
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/MyReviewOut'
                - type: 'null'
                title: Response Get My Review Api Account Reviews  Slug  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/account/reviews:
    post:
      tags:
      - Reviews
      summary: Post Review
      description: 'The review written, or the one the user has rewritten: stars and text

        both replaced by what was sent (null text is stars alone), checked as

        `_write` says.'
      operationId: post_review_api_account_reviews_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewChangeOut'
  /api/account/reviews/delete:
    post:
      tags:
      - Reviews
      summary: Post Delete
      description: 'The user''s review of the product gone, and the rating without it. The

        same answer when there was none; another account''s is never touched.

        Open to any signed-in author, confirmed or not: taking one''s own words

        down is never refused for want of a check.'
      operationId: post_delete_api_account_reviews_delete_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewChangeOut'
  /api/account/store-reviews/{code}:
    get:
      tags:
      - Reviews
      summary: Get My Store Review
      description: The user's own review of the store, hidden or not, or null.
      operationId: get_my_store_review_api_account_store_reviews__code__get
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/MyReviewOut'
                - type: 'null'
                title: Response Get My Store Review Api Account Store Reviews  Code  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/account/store-reviews:
    post:
      tags:
      - Reviews
      summary: Post Store Review
      description: The user's review of a store, written or rewritten, as a game's is.
      operationId: post_store_review_api_account_store_reviews_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewChangeOut'
  /api/account/store-reviews/delete:
    post:
      tags:
      - Reviews
      summary: Post Store Delete
      description: The user's review of a store gone, and its rating without it.
      operationId: post_store_delete_api_account_store_reviews_delete_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewChangeOut'
components:
  schemas:
    ReviewItemOut:
      properties:
        id:
          type: integer
          title: Id
        username:
          type: string
          title: Username
        rating:
          type: number
          title: Rating
        body:
          anyOf:
          - type: string
          - type: 'null'
          title: Body
        createdAt:
          type: string
          format: date-time
          title: Createdat
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
      type: object
      required:
      - id
      - username
      - rating
      - body
      - createdAt
      - updatedAt
      title: ReviewItemOut
      description: One visible review, as the list shows it.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ReviewBucketOut:
      properties:
        start:
          type: string
          format: date-time
          title: Start
        average:
          type: number
          title: Average
        count:
          type: integer
          title: Count
      type: object
      required:
      - start
      - average
      - count
      title: ReviewBucketOut
      description: 'One bar of a store''s chart: when its hour, day or month starts (UTC), its stars, how many.'
    ReviewChangeOut:
      properties:
        review:
          anyOf:
          - $ref: '#/components/schemas/MyReviewOut'
          - type: 'null'
        summary:
          $ref: '#/components/schemas/ReviewSummaryOut'
      type: object
      required:
      - review
      - summary
      title: ReviewChangeOut
      description: 'What a write answers: the review as it now is (None once deleted), and

        the product''s rating with the change counted. The public list is cached

        at the edge for a minute, so this is how the page shows the author their

        change at once rather than asking `/reviews` again.'
    ReviewHistoryOut:
      properties:
        periods:
          additionalProperties:
            $ref: '#/components/schemas/ReviewSummaryOut'
          type: object
          title: Periods
        series:
          additionalProperties:
            items:
              $ref: '#/components/schemas/ReviewBucketOut'
            type: array
          type: object
          title: Series
      type: object
      required:
      - periods
      - series
      title: ReviewHistoryOut
      description: '`GET /api/stores/{code}/reviews/history`: the store''s rating over each

        period (`24h`, `30d`, `all`), and each period''s chart, oldest first:

        hourly for `24h`, daily for `30d`, monthly for `all`.'
    ReviewSummaryOut:
      properties:
        average:
          anyOf:
          - type: number
          - type: 'null'
          title: Average
        count:
          type: integer
          title: Count
        distribution:
          items:
            type: integer
          type: array
          title: Distribution
      type: object
      required:
      - average
      - count
      - distribution
      title: ReviewSummaryOut
      description: The GCG rating of a product, over its visible reviews (`service.Summary`).
    MyReviewOut:
      properties:
        id:
          type: integer
          title: Id
        rating:
          type: number
          title: Rating
        body:
          anyOf:
          - type: string
          - type: 'null'
          title: Body
        createdAt:
          type: string
          format: date-time
          title: Createdat
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
        hidden:
          type: boolean
          title: Hidden
      type: object
      required:
      - id
      - rating
      - body
      - createdAt
      - updatedAt
      - hidden
      title: MyReviewOut
      description: The signed-in user's own review of a product, as its author sees it.
    ReviewPageOut:
      properties:
        summary:
          $ref: '#/components/schemas/ReviewSummaryOut'
        items:
          items:
            $ref: '#/components/schemas/ReviewItemOut'
          type: array
          title: Items
        total:
          type: integer
          title: Total
      type: object
      required:
      - summary
      - items
      - total
      title: ReviewPageOut
      description: '`GET /api/games/{slug}/reviews`: the rating, and a page of the reviews, newest first.'