Capone

The Capone API was used by Sony’s Grief Reporting feature, allowing players to submit reports against others that were breaking the game’s Rules of Conduct.
Definitions

OpenAPI schema

Below is a complete OpenAPI 3 schema for the Capone service.

openapi: 3.0.0
info:
  title: Capone API
  version: 1.0.0 
  description: API for submitting reports and uploading related content.
paths:
  /capone/reportCollector/submit:
    post:
      summary: Submit a new report
      operationId: submitReport
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Report'
      responses:
        '200':
          description: Report successfully saved
        '500':
          description: Internal server error
  /capone/contentStore/10/{reportId}:
    post:
      summary: Upload report files for an existing report
      operationId: uploadReportFiles
      parameters:
        - name: reportId
          in: path
          required: true
          schema:
            type: string
          description: Unique identifier of the report
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - fileup0
                - fileup1
                - fileup2
              properties:
                fileup0:
                  type: string
                  format: binary
                  description: Report XML file
                fileup1:
                  type: string
                  format: binary
                  description: Chat log XML file
                fileup2:
                  type: string
                  format: binary
                  description: Screenshot image
      responses:
        '200':
          description: Files successfully uploaded and report finalised
        '400':
          description: Missing or invalid files
        '500':
          description: Internal server error
components:
  schemas:
    Report:
      type: object
      required:
        - id
        - timestamp
        - language
        - author
        - target
        - reason
        - platform
        - source
      properties:
        id:
          type: string
          description: Unique report identifier
        timestamp:
          type: string
          format: date-time
        language:
          $ref: '#/components/schemas/Language'
        chatLog:
          type: array
          items:
            $ref: '#/components/schemas/LogEntry'
          nullable: true
        location:
          $ref: '#/components/schemas/Location'
          nullable: true
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserInfo'
          nullable: true
        author:
          type: string
        target:
          type: string
        reason:
          type: integer
          description: Reason code
        platform:
          type: integer
        source:
          type: integer
        screenshot:
          type: string
          nullable: true
          description: URL or identifier of screenshot image
    Language:
      type: object
      description: Language information
      properties:
        # Fill with fields from LanguageSchema
        name:
          type: string
        code:
          type: string
    LogEntry:
      type: object
      description: Chat log entry
      properties:
        # Fill with fields from LogEntrySchema
        timestamp:
          type: string
          format: date-time
        message:
          type: string
        sender:
          type: string
    Location:
      type: object
      description: Location information
      properties:
        # Fill with fields from LocationSchema
        country:
          type: string
        city:
          type: string
    UserInfo:
      type: object
      description: User information
      properties:
        # Fill with fields from UserInfoSchema
        username:
          type: string
        id:
          type: string