mirror of
https://github.com/stoatchat/javascript-client-api.git
synced 2026-07-20 20:15:34 -04:00
Initial Commit
This commit is contained in:
@@ -0,0 +1,3 @@
|
||||
OpenAPI.json
|
||||
node_modules
|
||||
out
|
||||
Vendored
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"recommendations": [
|
||||
"emeraldwalk.runonsave"
|
||||
]
|
||||
}
|
||||
Vendored
+11
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"emeraldwalk.runonsave": {
|
||||
"commands": [
|
||||
{
|
||||
"match": ".md$",
|
||||
"isAsync": true,
|
||||
"cmd": "yarn build"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
Vendored
+13
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"version": "2.0.0",
|
||||
"tasks": [
|
||||
{
|
||||
"type": "npm",
|
||||
"script": "build",
|
||||
"group": "build",
|
||||
"problemMatcher": [],
|
||||
"label": "npm: build",
|
||||
"detail": "yarn generate:apib && yarn generate:html"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
FORMAT: 1A
|
||||
HOST: https://api.revolt.chat
|
||||
|
||||
# Revolt
|
||||
|
||||
# Data Structures
|
||||
|
||||
## User (object)
|
||||
+ _id: 01AN4Z07BY79KA1307SR9X4MV3 (string, required)
|
||||
+ username: insert (string, required)
|
||||
+ avatar (File)
|
||||
|
||||
# Group Users
|
||||
|
||||
### Fetch User [GET /users/{id}]
|
||||
+ Parameters
|
||||
+ id: - User ID
|
||||
|
||||
+ Request
|
||||
+ Headers
|
||||
x-user-id: 01AN4Z07BY79KA1307SR9X4MV3
|
||||
x-session-token: 01AN4Z07BY79KA1307SR9X4MV3
|
||||
|
||||
+ Response 200 (application/json)
|
||||
+ Attributes (User)
|
||||
|
||||
## sussy balls
|
||||
|
||||
# Data Structures
|
||||
|
||||
## File (object)
|
||||
+ _id: 01AN4Z07BY79KA1307SR9X4MV3 (string, required)
|
||||
+ tag: (string)
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"name": "api",
|
||||
"version": "0.0.0",
|
||||
"main": "index.js",
|
||||
"repository": "https://gitlab.insrt.uk/revolt/api.git",
|
||||
"author": "Paul <paulmakles@gmail.com>",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"aglio": "^2.3.0",
|
||||
"apib2swagger": "^1.12.0",
|
||||
"hercule": "^5.1.3",
|
||||
"sirv-cli": "^1.0.12"
|
||||
},
|
||||
"scripts": {
|
||||
"generate:apib": "hercule src/blueprint.md -o API.apib",
|
||||
"generate:html": "aglio -i API.apib -o out/index.html",
|
||||
"generate:openapi": "apib2swagger -i API.apib -o OpenAPI.json",
|
||||
"build": "yarn generate:apib && yarn generate:html && yarn generate:openapi",
|
||||
"preview": "sirv out"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
FORMAT: 1A
|
||||
HOST: https://api.revolt.chat
|
||||
|
||||
# Revolt
|
||||
|
||||
:[Users](resources/users.md)
|
||||
:[sussy](resources/autumn.md)
|
||||
@@ -0,0 +1 @@
|
||||
+ _id: :[ULID](../templates/ulid.md) (string, required)
|
||||
@@ -0,0 +1,7 @@
|
||||
## sussy balls
|
||||
|
||||
# Data Structures
|
||||
|
||||
## File (object)
|
||||
:[_id](../fields/_id.md)
|
||||
+ tag: (string)
|
||||
@@ -0,0 +1,21 @@
|
||||
# Data Structures
|
||||
|
||||
## User (object)
|
||||
:[_id](../fields/_id.md)
|
||||
+ username: insert (string, required)
|
||||
+ avatar (File)
|
||||
|
||||
# Group Users
|
||||
|
||||
### Fetch User [GET /users/{id}]
|
||||
+ Parameters
|
||||
+ id: - User ID
|
||||
|
||||
+ Request
|
||||
+ Headers
|
||||
x-user-id: :[ULID](../templates/ulid.md)
|
||||
x-session-token: :[ULID](../templates/ulid.md)
|
||||
|
||||
+ Response 200 (application/json)
|
||||
+ Attributes (User)
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
01AN4Z07BY79KA1307SR9X4MV3
|
||||
Reference in New Issue
Block a user