openapi: 3.2.0
info:
  title: Online Store Product Reviews API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: Product Reviews
paths:
  /product_reviews:
    get:
      summary: Get Product Reviews
      tags:
      - Product Reviews
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  product_revies:
                    type: array
                    items:
                      $ref: '#/components/schemas/product_reviews'
      operationId: get-product_reviews
      description: Gets an array of product reviews.
    post:
      summary: Create a Product Review
      operationId: post-product_reviews
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_reviews'
      tags:
      - Product Reviews
      description: Creates a product review.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  product_id: 31
                  title: Title Test
                  body: Noice
                  review_pros: ''
                  review_cons: ''
                  overall_rating: 5
                  customer_id: null
                  approved_by_user_id: null
                  approved_at: null
                  author_display_name: Display Name
                  author_email: asmith@americommerce.com
                  author_website: ''
                  author_location: ''
                  approval_status: Approved
                  origin_store_id: 1
                  profile_id: null
                  uploaded_image: ''
                  published_date: '2023-08-18T09:01:47.38-05:00'
              properties:
                product_id:
                  type: integer
                title:
                  type: string
                body:
                  type: string
                review_pros:
                  type: string
                review_cons:
                  type: string
                overall_rating:
                  type: number
                customer_id:
                  type: integer
                approved_by_user_id:
                  type: integer
                approved_at:
                  type: string
                author_display_name:
                  type: string
                author_email:
                  type: string
                author_website:
                  type: string
                author_location:
                  type: string
                approval_status:
                  type: string
                origin_store_id:
                  type: integer
                profile_id:
                  type: integer
                uploaded_image:
                  type: string
                published_date:
                  type: string
            examples:
              Example:
                value:
                  id: 13
                  product_id: 31
                  title: 5 Star Product
                  body: This is noice.
                  review_pros: ''
                  review_cons: ''
                  overall_rating: 5
                  customer_id: 2
                  approved_by_user_id: 1
                  approved_at: ''
                  author_display_name: Walter White
                  author_email: admin@email.com
                  author_website: ''
                  author_location: ''
                  approval_status: Approved
                  origin_store_id: 1
                  profile_id: 45
                  uploaded_image: ''
                  published_date: '2023-08-18T09:01:47.38-05:00'
  /product_reviews/{id}:
    parameters:
    - schema:
        type: integer
      name: id
      in: path
      required: true
      description: The ID of the `product_review`
    put:
      summary: Update a Product Review
      operationId: put-product_reviews-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_reviews'
      tags:
      - Product Reviews
      description: Updates a product review.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/product_reviews'
    delete:
      summary: Delete a Product Review
      operationId: delete-product_reviews-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
      - Product Reviews
      description: Deletes a product review.
components:
  responses:
    '404':
      description: Resource Not Found
      content:
        application/json:
          schema:
            description: Not Found
            type: object
            x-examples:
              example-1:
                status_code: 404
                message: Not Found
                details: No resource found
            properties:
              status_code:
                type: number
              message:
                type: string
              details:
                type: string
          examples: {}
      headers: {}
  schemas:
    product_reviews:
      type: object
      properties:
        id:
          type: integer
        product_id:
          type: integer
        title:
          type: string
        body:
          type: string
        review_pros:
          type: string
        review_cons:
          type: string
        overall_rating:
          type: integer
        customer_id:
          type: integer
        approved_by_user_id:
          type: integer
        approved_at:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        author_display_name:
          type: string
        author_email:
          type: string
        author_website:
          type: string
        author_location:
          type: string
        approval_status:
          type: string
        origin_store_id:
          type: integer
        profile_id:
          type: integer
        uploaded_image:
          type: string
        published_date:
          type: string
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header