openapi: 3.0.1
info:
  title: Edgegap Arbitrium App Versions Matchmaking API
  description: Representative OpenAPI description of the Edgegap Arbitrium REST API for distributed edge game-server orchestration. Covers applications, application versions, deployments, sessions, matchmaking, relays/networking, metrics, and private fleets. Auto-deploy dedicated game servers to Edgegap's global network of edge locations. This document is a faithful, representative subset authored for cataloging; consult the official Edgegap documentation for the complete, authoritative reference.
  termsOfService: https://edgegap.com/terms-of-service/
  contact:
    name: Edgegap Support
    url: https://edgegap.com/contact/
  version: '1.0'
servers:
- url: https://api.edgegap.com
  description: Edgegap Arbitrium Management API
security:
- AuthToken: []
tags:
- name: Matchmaking
  description: Create and poll matchmaking tickets.
paths:
  /tickets:
    post:
      operationId: createMatchmakingTicket
      tags:
      - Matchmaking
      summary: Create matchmaking ticket
      description: Creates a new matchmaking ticket on a deployed matchmaker service. Served from the matchmaker service URL.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TicketCreate'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ticket'
  /tickets/{ticket_id}:
    get:
      operationId: getMatchmakingTicket
      tags:
      - Matchmaking
      summary: Poll matchmaking ticket
      parameters:
      - name: ticket_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ticket'
    delete:
      operationId: deleteMatchmakingTicket
      tags:
      - Matchmaking
      summary: Delete matchmaking ticket
      parameters:
      - name: ticket_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
components:
  schemas:
    Ticket:
      type: object
      properties:
        id:
          type: string
        state:
          type: string
          enum:
          - PENDING
          - MATCHED
          - DEPLOYING
          - READY
          - CANCELLED
        assignment:
          type: object
          properties:
            host:
              type: string
            port:
              type: integer
    TicketCreate:
      type: object
      properties:
        profile:
          type: string
        attributes:
          type: object
          additionalProperties: true
  securitySchemes:
    AuthToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'API token generated in the Edgegap dashboard (User Settings / Tokens), sent as `Authorization: token <your_token>`.'