Initial Commit

This commit is contained in:
Paul
2021-07-10 21:04:39 +01:00
commit 05721a0873
12 changed files with 3544 additions and 0 deletions
+3
View File
@@ -0,0 +1,3 @@
OpenAPI.json
node_modules
out
+5
View File
@@ -0,0 +1,5 @@
{
"recommendations": [
"emeraldwalk.runonsave"
]
}
+11
View File
@@ -0,0 +1,11 @@
{
"emeraldwalk.runonsave": {
"commands": [
{
"match": ".md$",
"isAsync": true,
"cmd": "yarn build"
}
]
}
}
+13
View File
@@ -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"
}
]
}
+33
View File
@@ -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)
+21
View File
@@ -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"
}
}
+7
View File
@@ -0,0 +1,7 @@
FORMAT: 1A
HOST: https://api.revolt.chat
# Revolt
:[Users](resources/users.md)
:[sussy](resources/autumn.md)
+1
View File
@@ -0,0 +1 @@
+ _id: :[ULID](../templates/ulid.md) (string, required)
+7
View File
@@ -0,0 +1,7 @@
## sussy balls
# Data Structures
## File (object)
:[_id](../fields/_id.md)
+ tag: (string)
+21
View File
@@ -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)
+1
View File
@@ -0,0 +1 @@
01AN4Z07BY79KA1307SR9X4MV3
+3421
View File
File diff suppressed because it is too large Load Diff