AuraVMS Feedback API

openapi: 3.2.0
info:
  title: AuraVMS Feedback API
  version: 1.1.0
  description: Create RFQs, manage suppliers, compare supplier quotations, and place purchase orders. Mutating operations can send supplier email or create business records; obtain user confirmation before calling them.
  contact:
    name: AuraVMS
    url: https://www.auravms.com/contact
  license:
    name: Proprietary
  x-versioning-policy: Stable versions are encoded in URL paths. Deprecated operations identify a replacement and advertise Deprecation and Sunset response headers before removal. See https://www.auravms.com/api-versioning.md.
  x-deprecation-policy: https://www.auravms.com/api-versioning.md
servers:
- url: https://api.auravms.com
  description: Production API
security:
- BearerAuth: []
tags:
- name: Feedback
  description: Submit feature requests, bug reports, or general feedback to the AuraVMS team.
paths:
  /api/request-a-feature/:
    post:
      operationId: post_feedback_api_request_a_feature_1
      tags:
      - Feedback
      summary: Submit feedback, a feature request, or a bug report.
      description: Submit feedback, a feature request, or a bug report. Sends an email to the AuraVMS team. category can be "feature_request", "bug_report", or "general_feedback". Defaults to "feature_request" if not specified.
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        description: Replay key for JSON mutations. Reuse with the same body returns the original response for 24 hours; reuse with a different body returns 409.
        schema:
          type: string
          minLength: 8
          maxLength: 255
          pattern: ^[A-Za-z0-9._:-]+$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                subject:
                  type: string
                message:
                  type: string
                category:
                  type: string
              required:
              - subject
              - message
              - category
              additionalProperties: true
            example:
              subject: Add CSV export for supplier list
              message: It would be helpful to export the supplier directory as CSV directly from the API.
              category: feature_request
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                required:
                - success
                - message
                additionalProperties: true
              example:
                success: true
                message: Thank you for your feedback. The AuraVMS team has been notified.
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '401':
          description: Authentication required or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '403':
          description: The token cannot perform this action
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '404':
          description: The requested resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '409':
          description: The idempotency key is still processing or was reused with a different request body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: authentication_failed
                  message: A valid Bearer token is required.
components:
  schemas:
    ApiError:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or avms_ API key
      description: Use a JWT access token or an API key created under Settings > API Keys. AuraVMS does not currently expose OAuth authorization.
externalDocs:
  description: AuraVMS API and agent guide
  url: https://www.auravms.com/docs