JobMojito Feedback API

openapi: 3.2.0
info:
  title: JobMojito Feedback API
  version: 1.0.0
  description: Public API for JobMojito, served by Supabase Edge Functions. Authenticate with a Supabase JWT access token via the Authorization header.
servers:
- url: https://cool.jobmojito.com/functions/v1
  description: Production
tags:
- name: Feedback
  description: Send feature requests to the product team and report technical issues to support.
paths:
  /merchant-feature-request:
    post:
      tags:
      - Feedback
      summary: Submit a feature request
      description: Sends a feature request to the JobMojito product team. It is posted on the public feature request board under your name (from your account e-mail), where you get status updates and others can vote on it; your company is not named. At most 5 requests per user in 24 hours. Requires a user token (admin console session or MCP sign-in) of a merchant, merchant owner or admin.
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureRequestSubmitRequest'
      responses:
        '200':
          description: Request submitted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureRequestSubmitResponse'
        '401':
          description: Missing, expired or invalid access token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Your token is not allowed to use this endpoint (it is not the token of a merchant, merchant owner or admin user).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation error (title or description missing, too short or too long).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: You submitted 5 requests in the last 24 hours. Try again tomorrow.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Feature requests are not available right now.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: submit_feature_request
  /merchant-technical-issue:
    post:
      tags:
      - Feedback
      summary: Report a technical issue
      description: Reports a technical problem to JobMojito support. It opens a support conversation from your account (your e-mail), with your company and the ids you give; support answers there. At most 5 reports per user in 24 hours. Requires a user token (admin console session or MCP sign-in) of a merchant, merchant owner or admin.
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TechnicalIssueReportRequest'
      responses:
        '200':
          description: Issue reported.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TechnicalIssueReportResponse'
        '401':
          description: Missing, expired or invalid access token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Your token is not allowed to use this endpoint (it is not the token of a merchant, merchant owner or admin user).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation error (description missing, too short or too long; an id that is not a uuid).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: You reported 5 issues in the last 24 hours. Try again tomorrow.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Reporting issues is not available right now.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: report_technical_issue
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          example: Field is required.
        name:
          type: string
          example: interview_result_id
      required:
      - error
    TechnicalIssueReportResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the stored report.
        status:
          type: string
          enum:
          - sent
          - queued
          description: '`sent`: the support team has it. `queued`: stored, it is sent shortly (support could not be reached right now).'
        reference:
          type: string
          nullable: true
          description: The support conversation number, once sent (e.g. `#592`).
          example: '#592'
      required:
      - id
      - status
      - reference
      description: The reported technical issue.
    TechnicalIssueReportRequest:
      type: object
      properties:
        description:
          type: string
          minLength: 10
          maxLength: 4000
          description: 'What went wrong: what you did, what you expected, what happened instead (error messages as shown), and since when. Plain text; blank lines separate paragraphs. Do not include passwords or API keys.'
          example: The PDF report of a finished interview stays empty since this morning. Other results open fine.
        interview_id:
          type: string
          nullable: true
          format: uuid
          description: The interview (definition) the problem is about, if any.
        result_id:
          type: string
          nullable: true
          format: uuid
          description: The interview result the problem is about, if any.
      required:
      - description
    FeatureRequestSubmitResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the stored request.
        status:
          type: string
          enum:
          - posted
          - queued
          description: '`posted`: it is on the feature request board. `queued`: stored, it is posted shortly (the board could not be reached right now).'
      required:
      - id
      - status
      description: The submitted feature request.
    FeatureRequestSubmitRequest:
      type: object
      properties:
        title:
          type: string
          minLength: 5
          maxLength: 120
          description: A short summary of the feature, shown as the post title.
          example: Export all results of a position as one CSV
        description:
          type: string
          minLength: 10
          maxLength: 4000
          description: 'What the user needs and why: the problem, how they work around it today, who it would help. Plain text; blank lines separate paragraphs. The board is public: do not include candidate data, company names or other personal information.'
          example: We review applications in a spreadsheet every Friday. Today we export each interview separately; one CSV per position would save an hour a week.
      required:
      - title
      - description
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Supabase JWT — `Authorization: Bearer <token>`.'