Add MVP

Author: Brutus5000

.gitignore

@@ -0,0 +1 @@
+.idea/

faf-api-specs.iml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="GENERAL_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

lobby-to-client/v1/asyncapi.yml

@@ -0,0 +1,72 @@
+asyncapi: 3.0.0
+info:
+  title: FAForever Lobby Server API
+  version: 1.0.0
+  description: |-
+    Since AsyncAPI can only model a publish/subscribe model, this spec only covers the server side of the bidirectional lobby connection
+  license:
+    name: MIT
+    url: https://www.apache.org/licenses/LICENSE-2.0
+defaultContentType: application/json
+servers:
+  production:
+    host: ws.faforever.com
+    pathname: /
+    protocol: wss
+  test:
+    host: ws.faforever.xyz
+    pathname: /
+    protocol: wss
+  local:
+    host: localhost
+    pathname: /
+    protocol: wss
+channels:
+  server-inbound:
+    title: server to client communication
+    messages:
+      JoinGameRequest:
+        $ref: '#/components/messages/JoinGameRequest'
+  client-inbound:
+    title: client to server communication
+    messages:
+      JoinGameRequest:
+        $ref: '#/components/messages/JoinGameRequest'
+operations:
+  serverJoinGame:
+    action: receive
+    description: "Server receives clients request to join a game"
+    channel:
+      $ref: '#/channels/server-inbound'
+    messages:
+      - $ref: '#/channels/server-inbound/messages/JoinGameRequest'
+    tags:
+      - name: server
+  clientJoinGame:
+    action: send
+    description: "Client requests to join a game"
+    channel:
+      $ref: '#/channels/client-inbound'
+    messages:
+      - $ref: '#/channels/client-inbound/messages/JoinGameRequest'
+    tags:
+      - name: client
+components:
+  messages:
+    JoinGameRequest:
+      name: game_join
+      title: "Request to join a game"
+      payload:
+        type: object
+        required:
+          - command
+          - uid
+        properties:
+          command:
+            type: string
+            const: join_game
+          uid:
+            type: integer
+            minimum: 1
+          password:
+            type: string

readme.md

@@ -0,0 +1,6 @@
+# FAF API specs
+
+This repository contains API first specs of our application(s). Not all APIs can follow this approach as they are driven by other source (e.g. the faf-java-api spec is semi-automatically derived from the database schema).
+
+
+We support schemas for HTTP ([OpenAPI](https://www.openapis.org)) and messaging ([AsyncAPI](https://www.asyncapi.com/en)).