openapi.yaml

openapi: 3.1.0
info:
  title: TrueStar API
  description: API for fake review detection services
  version: 1.0.0
  contact:
    name: TrueStar Team
    email: hello@truestar.pro

servers:
  - url: https://api.truestar.pro
    description: Production
  - url: http://localhost:8080
    description: Local development

paths:
  /health:
    get:
      summary: Health check endpoint
      operationId: getHealth
      tags:
        - System
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'

  /check/amazon/reviews:
    post:
      summary: Check Amazon reviews for authenticity
      operationId: checkAmazonReviews
      tags:
        - Reviews
        - Amazon
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckAmazonReviewsRequest'
      responses:
        '200':
          description: Review check completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckAmazonReviewsResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

components:
  schemas:
    HealthResponse:
      type: object
      required:
        - status
        - timestamp
      properties:
        status:
          type: string
          enum: [ok]
          example: ok
        timestamp:
          type: string
          format: date-time
          example: '2024-12-22T10:00:00.000Z'

    CheckAmazonReviewsRequest:
      type: object
      required:
        - reviews
      properties:
        reviews:
          type: array
          minItems: 1
          description: Array of review data to analyze
          items:
            $ref: '#/components/schemas/AmazonReview'

    CheckAmazonReviewsResponse:
      type: object
      required:
        - result
        - timestamp
      properties:
        result:
          $ref: '#/components/schemas/ReviewChecker'
        timestamp:
          type: string
          format: date-time
          example: '2024-12-22T10:00:00.000Z'

    ReviewChecker:
      type: object
      required:
        - isFake
        - confidence
        - reasons
        - flags
        - summary
      properties:
        isFake:
          type: boolean
          description: Whether the review is likely fake
          example: true
        confidence:
          type: number
          format: float
          minimum: 0
          maximum: 1
          description: Confidence level of the analysis (0-1)
          example: 0.85
        reasons:
          type: array
          items:
            type: string
          description: Specific reasons for the assessment
          example: ["Excessive positivity without specific details", "Generic language patterns"]
        flags:
          type: array
          items:
            $ref: '#/components/schemas/ReviewFlag'
          description: Detected red flags
          example: ["excessive_positivity", "generic_language"]
        summary:
          type: string
          description: Brief explanation of the analysis
          example: "Review appears fake due to generic praise without specific product details"

    AmazonReview:
      type: object
      required:
        - id
        - rating
        - text
        - author
        - verified
      properties:
        id:
          type: string
          description: Unique identifier for the review
          example: "RQ1XFNZ96Y1ST"
        rating:
          type: number
          minimum: 1
          maximum: 5
          description: Review rating (1-5 stars)
          example: 5
        text:
          type: string
          minLength: 1
          description: The review text content
          example: "This product is amazing! Best purchase ever!"
        author:
          type: string
          description: The reviewer's name or username
          example: "John D."
        verified:
          type: boolean
          description: Whether this is a verified purchase
          example: true
        date:
          type: string
          description: The date when the review was posted
          example: "2024-01-15"
        helpfulVotes:
          type: number
          description: Number of helpful votes
          example: 42
        totalVotes:
          type: number
          description: Total number of votes
          example: 50
        productVariation:
          type: string
          description: Product variation purchased
          example: "Color: Blue, Size: Large"
        isVineReview:
          type: boolean
          description: Whether this is a Vine review
          example: false
        badges:
          type: array
          items:
            type: string
          description: Badges associated with the review
          example: ["Verified Purchase", "Top Contributor"]

    ReviewFlag:
      type: string
      enum:
        - generic_language
        - excessive_positivity
        - incentivized_review
        - competitor_mention
        - unnatural_language
        - repetitive_phrases
        - suspicious_timing
        - verified_purchase_missing
      description: Possible red flags in reviews

    ErrorResponse:
      type: object
      required:
        - statusCode
        - error
        - timestamp
      properties:
        statusCode:
          type: integer
          description: HTTP status code
          example: 400
        error:
          type: string
          description: Error message
          example: "Invalid request"
        details:
          type: string
          description: Additional error details
          example: "Review text is required"
        timestamp:
          type: string
          format: date-time
          example: '2024-12-22T10:00:00.000Z'

tags:
  - name: System
    description: System health and status endpoints
  - name: Reviews
    description: Review checker endpoints
  - name: Amazon