@flow-industries/id 0.21.2 → 0.22.1

package/contracts/v1/openapi.json

@@ -0,0 +1,818 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Flow ID service reports",
+    "version": "1.0.0",
+    "description": "Versioned game report boundary. Other Auth endpoints are not yet described."
+  },
+  "paths": {
+    "/api/actions/start": {
+      "post": {
+        "operationId": "startAction",
+        "security": [
+          {
+            "serviceBearer": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$schema": "https://json-schema.org/draft/2020-12/schema",
+                "type": "object",
+                "properties": {
+                  "sub": {
+                    "type": "string"
+                  },
+                  "sessionId": {
+                    "type": "string"
+                  },
+                  "source": {
+                    "type": "string"
+                  },
+                  "showTimer": {
+                    "type": "boolean"
+                  }
+                },
+                "required": ["sub", "sessionId", "source"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Report accepted",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$schema": "https://json-schema.org/draft/2020-12/schema",
+                  "type": "object",
+                  "properties": {
+                    "ok": {
+                      "type": "boolean",
+                      "const": true
+                    }
+                  },
+                  "required": ["ok"],
+                  "additionalProperties": false
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid report"
+          },
+          "401": {
+            "description": "Invalid service credential"
+          },
+          "503": {
+            "description": "Service reporting disabled"
+          }
+        }
+      }
+    },
+    "/api/actions/event": {
+      "post": {
+        "operationId": "eventAction",
+        "security": [
+          {
+            "serviceBearer": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$schema": "https://json-schema.org/draft/2020-12/schema",
+                "type": "object",
+                "properties": {
+                  "sessionId": {
+                    "type": "string"
+                  },
+                  "kind": {
+                    "type": "string",
+                    "enum": ["pause", "resume", "focus_lost", "focus_gained"]
+                  }
+                },
+                "required": ["sessionId", "kind"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Report accepted",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$schema": "https://json-schema.org/draft/2020-12/schema",
+                  "type": "object",
+                  "properties": {
+                    "ok": {
+                      "type": "boolean",
+                      "const": true
+                    },
+                    "recorded": {
+                      "type": "boolean"
+                    }
+                  },
+                  "required": ["ok", "recorded"],
+                  "additionalProperties": false
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid report"
+          },
+          "401": {
+            "description": "Invalid service credential"
+          },
+          "503": {
+            "description": "Service reporting disabled"
+          }
+        }
+      }
+    },
+    "/api/actions/finish": {
+      "post": {
+        "operationId": "finishAction",
+        "security": [
+          {
+            "serviceBearer": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$schema": "https://json-schema.org/draft/2020-12/schema",
+                "type": "object",
+                "properties": {
+                  "sessionId": {
+                    "type": "string"
+                  }
+                },
+                "required": ["sessionId"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Report accepted",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$schema": "https://json-schema.org/draft/2020-12/schema",
+                  "type": "object",
+                  "properties": {
+                    "ok": {
+                      "type": "boolean",
+                      "const": true
+                    },
+                    "xpGranted": {
+                      "anyOf": [
+                        {
+                          "type": "object",
+                          "properties": {
+                            "granted": {
+                              "type": "boolean"
+                            },
+                            "amount": {
+                              "type": "number"
+                            },
+                            "totalXp": {
+                              "type": "number"
+                            },
+                            "flowScore": {
+                              "type": "number"
+                            },
+                            "level": {
+                              "type": "number"
+                            },
+                            "tier": {
+                              "type": "number"
+                            },
+                            "xpIntoLevel": {
+                              "type": "number"
+                            },
+                            "xpForNextLevel": {
+                              "type": "number"
+                            }
+                          },
+                          "required": [
+                            "granted",
+                            "amount",
+                            "totalXp",
+                            "flowScore",
+                            "level",
+                            "tier",
+                            "xpIntoLevel",
+                            "xpForNextLevel"
+                          ],
+                          "additionalProperties": false
+                        },
+                        {
+                          "type": "null"
+                        }
+                      ]
+                    }
+                  },
+                  "required": ["ok", "xpGranted"],
+                  "additionalProperties": false
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid report"
+          },
+          "401": {
+            "description": "Invalid service credential"
+          },
+          "503": {
+            "description": "Service reporting disabled"
+          }
+        }
+      }
+    },
+    "/api/actions/state-time": {
+      "post": {
+        "operationId": "reportStateTime",
+        "security": [
+          {
+            "serviceBearer": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$schema": "https://json-schema.org/draft/2020-12/schema",
+                "type": "object",
+                "properties": {
+                  "sub": {
+                    "type": "string"
+                  },
+                  "day": {
+                    "type": "string"
+                  },
+                  "states": {
+                    "type": "object",
+                    "propertyNames": {
+                      "type": "string"
+                    },
+                    "additionalProperties": {
+                      "type": "number"
+                    }
+                  }
+                },
+                "required": ["sub", "day", "states"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Report accepted",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$schema": "https://json-schema.org/draft/2020-12/schema",
+                  "type": "object",
+                  "properties": {
+                    "ok": {
+                      "type": "boolean",
+                      "const": true
+                    }
+                  },
+                  "required": ["ok"],
+                  "additionalProperties": false
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid report"
+          },
+          "401": {
+            "description": "Invalid service credential"
+          },
+          "503": {
+            "description": "Service reporting disabled"
+          }
+        }
+      }
+    },
+    "/api/xp/events": {
+      "post": {
+        "operationId": "reportXp",
+        "security": [
+          {
+            "serviceBearer": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$schema": "https://json-schema.org/draft/2020-12/schema",
+                "type": "object",
+                "properties": {
+                  "sub": {
+                    "type": "string"
+                  },
+                  "source": {
+                    "type": "string"
+                  },
+                  "durationSeconds": {
+                    "type": "number"
+                  },
+                  "idempotencyKey": {
+                    "type": "string"
+                  }
+                },
+                "required": ["sub", "source"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Report accepted",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$schema": "https://json-schema.org/draft/2020-12/schema",
+                  "type": "object",
+                  "properties": {
+                    "granted": {
+                      "type": "boolean"
+                    },
+                    "amount": {
+                      "type": "number"
+                    },
+                    "totalXp": {
+                      "type": "number"
+                    },
+                    "flowScore": {
+                      "type": "number"
+                    },
+                    "level": {
+                      "type": "number"
+                    },
+                    "tier": {
+                      "type": "number"
+                    },
+                    "xpIntoLevel": {
+                      "type": "number"
+                    },
+                    "xpForNextLevel": {
+                      "type": "number"
+                    }
+                  },
+                  "required": [
+                    "granted",
+                    "amount",
+                    "totalXp",
+                    "flowScore",
+                    "level",
+                    "tier",
+                    "xpIntoLevel",
+                    "xpForNextLevel"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid report"
+          },
+          "401": {
+            "description": "Invalid service credential"
+          },
+          "503": {
+            "description": "Service reporting disabled"
+          }
+        }
+      }
+    },
+    "/api/rooms/presence/report": {
+      "post": {
+        "operationId": "reportPresence",
+        "security": [
+          {
+            "serviceBearer": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$schema": "https://json-schema.org/draft/2020-12/schema",
+                "type": "object",
+                "properties": {
+                  "channel": {
+                    "type": "string",
+                    "enum": ["game", "voice", "text"]
+                  },
+                  "rooms": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "roomId": {
+                          "type": "string"
+                        },
+                        "occupants": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "sub": {
+                                "type": "string"
+                              }
+                            },
+                            "required": ["sub"],
+                            "additionalProperties": {}
+                          }
+                        }
+                      },
+                      "required": ["roomId", "occupants"]
+                    }
+                  }
+                },
+                "required": ["channel", "rooms"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Report accepted",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$schema": "https://json-schema.org/draft/2020-12/schema",
+                  "type": "object",
+                  "properties": {
+                    "ok": {
+                      "type": "boolean",
+                      "const": true
+                    }
+                  },
+                  "required": ["ok"],
+                  "additionalProperties": false
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid report"
+          },
+          "401": {
+            "description": "Invalid service credential"
+          },
+          "503": {
+            "description": "Service reporting disabled"
+          }
+        }
+      }
+    },
+    "/api/rooms/position/report": {
+      "post": {
+        "operationId": "reportPosition",
+        "security": [
+          {
+            "serviceBearer": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$schema": "https://json-schema.org/draft/2020-12/schema",
+                "type": "object",
+                "properties": {
+                  "positions": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "roomId": {
+                          "type": "string"
+                        },
+                        "sub": {
+                          "type": "string"
+                        },
+                        "x": {
+                          "type": "number",
+                          "minimum": -1000000,
+                          "maximum": 1000000
+                        },
+                        "y": {
+                          "type": "number",
+                          "minimum": -1000000,
+                          "maximum": 1000000
+                        },
+                        "z": {
+                          "type": "number",
+                          "minimum": -1000000,
+                          "maximum": 1000000
+                        },
+                        "yaw": {
+                          "type": "number",
+                          "minimum": -1000000,
+                          "maximum": 1000000
+                        },
+                        "worldId": {
+                          "type": "string",
+                          "maxLength": 64
+                        }
+                      },
+                      "required": [
+                        "roomId",
+                        "sub",
+                        "x",
+                        "y",
+                        "z",
+                        "yaw",
+                        "worldId"
+                      ]
+                    }
+                  }
+                },
+                "required": ["positions"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Report accepted",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$schema": "https://json-schema.org/draft/2020-12/schema",
+                  "type": "object",
+                  "properties": {
+                    "ok": {
+                      "type": "boolean",
+                      "const": true
+                    },
+                    "stored": {
+                      "type": "number"
+                    }
+                  },
+                  "required": ["ok", "stored"],
+                  "additionalProperties": false
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid report"
+          },
+          "401": {
+            "description": "Invalid service credential"
+          },
+          "503": {
+            "description": "Service reporting disabled"
+          }
+        }
+      }
+    },
+    "/api/auth/jwks": {
+      "get": {
+        "operationId": "getJwks",
+        "responses": {
+          "200": {
+            "description": "Public Ed25519 verification keys",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$schema": "https://json-schema.org/draft/2020-12/schema",
+                  "type": "object",
+                  "properties": {
+                    "keys": {
+                      "minItems": 1,
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "kid": {
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "kty": {
+                            "type": "string",
+                            "const": "OKP"
+                          },
+                          "crv": {
+                            "type": "string",
+                            "const": "Ed25519"
+                          },
+                          "x": {
+                            "type": "string",
+                            "pattern": "^[A-Za-z0-9_-]{43}$"
+                          },
+                          "alg": {
+                            "type": "string",
+                            "const": "EdDSA"
+                          },
+                          "use": {
+                            "type": "string",
+                            "const": "sig"
+                          },
+                          "d": {
+                            "not": {}
+                          }
+                        },
+                        "required": ["kid", "kty", "crv", "x"],
+                        "additionalProperties": false
+                      }
+                    }
+                  },
+                  "required": ["keys"],
+                  "additionalProperties": false
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "serviceBearer": {
+        "type": "http",
+        "scheme": "bearer"
+      }
+    },
+    "schemas": {
+      "Jwks": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "keys": {
+            "minItems": 1,
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "kid": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "kty": {
+                  "type": "string",
+                  "const": "OKP"
+                },
+                "crv": {
+                  "type": "string",
+                  "const": "Ed25519"
+                },
+                "x": {
+                  "type": "string",
+                  "pattern": "^[A-Za-z0-9_-]{43}$"
+                },
+                "alg": {
+                  "type": "string",
+                  "const": "EdDSA"
+                },
+                "use": {
+                  "type": "string",
+                  "const": "sig"
+                },
+                "d": {
+                  "not": {}
+                }
+              },
+              "required": ["kid", "kty", "crv", "x"],
+              "additionalProperties": false
+            }
+          }
+        },
+        "required": ["keys"],
+        "additionalProperties": false
+      },
+      "JwtClaims": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "sub": {
+            "type": "string",
+            "minLength": 1
+          },
+          "aud": {
+            "type": "string",
+            "minLength": 1
+          },
+          "iss": {
+            "type": "string",
+            "minLength": 1
+          },
+          "iat": {
+            "type": "integer",
+            "minimum": -9007199254740991,
+            "maximum": 9007199254740991
+          },
+          "exp": {
+            "type": "integer",
+            "minimum": -9007199254740991,
+            "maximum": 9007199254740991
+          },
+          "guest": {
+            "type": "boolean"
+          },
+          "username": {
+            "type": "string"
+          }
+        },
+        "required": ["sub", "aud", "iss", "iat", "exp", "guest"],
+        "additionalProperties": {}
+      },
+      "SessionResponse": {
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "type": "object",
+        "properties": {
+          "jwt": {
+            "type": "string",
+            "minLength": 1
+          },
+          "refreshToken": {
+            "type": "string",
+            "minLength": 1
+          },
+          "user": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "username": {
+                "type": "string"
+              },
+              "isGuest": {
+                "type": "boolean"
+              }
+            },
+            "required": ["id", "username"],
+            "additionalProperties": {}
+          },
+          "credential": {
+            "anyOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "publicKey": {
+                    "type": "string"
+                  }
+                },
+                "required": ["id", "publicKey"],
+                "additionalProperties": false
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "additionalSessions": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "audience": {
+                  "type": "string"
+                },
+                "jwt": {
+                  "type": "string"
+                },
+                "refreshToken": {
+                  "type": "string"
+                }
+              },
+              "required": ["audience", "jwt", "refreshToken"],
+              "additionalProperties": false
+            }
+          }
+        },
+        "required": ["jwt", "refreshToken", "user", "credential"],
+        "additionalProperties": {}
+      }
+    }
+  }
+}