Merge develop branch

.gitignore

@@ -5,3 +5,4 @@
 /drasl
 /node_modules
 /public/bundle.js
+/swagger

.pre-commit-config.yaml

@@ -1,5 +1,6 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+exclude: "^swagger.json$"
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.6.0
@@ -11,11 +12,23 @@ repos:
     rev: v1.0.0-rc.1
     hooks:
       - id: go-fmt-repo
+  - repo: https://github.com/muya/swaggo-hooks
+    rev: v1.1.1
+    hooks:
+      - id: swag-fmt
   - repo: https://github.com/kamadorueda/alejandra
     rev: 3.0.0
     hooks:
       - id: alejandra-system
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v4.0.0-alpha.8" # Use the sha or tag you want to point at
+    rev: v3.0.3
     hooks:
       - id: prettier
+  - repo: local
+    hooks:
+      - id: swag
+        name: Generate Swagger documentation
+        entry: make swag
+        language: system
+        files: \.go$
+        pass_filenames: false

.prettierignore

@@ -0,0 +1 @@
+swagger.json

Makefile

@@ -1,8 +1,13 @@
 prefix ?= /usr
 .DEFAULT_GOAL := build
 
-prebuild:
+npm-install:
 	npm install
+
+swag:
+	swag init --generalInfo api.go --output . --outputTypes json
+
+prebuild: npm-install swag
 	node esbuild.config.js
 
 build: prebuild
@@ -18,8 +23,9 @@ install: build
 	cp -R assets view public "$(prefix)/share/drasl/"
 
 clean:
-	rm drasl
-	rm -r public/* public/.*
+	rm -f drasl
+	rm -f swagger.json
+	rm -f public/bundle.js
 
 test: prebuild
 	go test

README.md

@@ -66,6 +66,8 @@ See [doc/usage.md](doc/usage.md) for post-installation instructions and guidance
 
 ## API
 
+Drasl has its own API for managing users and invitations, but consider it in a beta state. v1 of this API is likely to be deprecated quickly. Documentation is [here](https://doc.drasl.unmojang.org).
+
 Drasl implements the Mojang API, documented here on [wiki.vg](https://wiki.vg):
 
 - [Mojang API](https://wiki.vg/Mojang_API)
@@ -76,8 +78,6 @@ If you find that an API route behaves substantively different than the Mojang AP
 
 Drasl also implements (almost all of) the authlib-injector API at `/authlib-injector`, to the extent that it differs from Mojang's. The authlib-injector API is documented [here](https://github.com/yushijinhun/authlib-injector/wiki/Yggdrasil-%E6%9C%8D%E5%8A%A1%E7%AB%AF%E6%8A%80%E6%9C%AF%E8%A7%84%E8%8C%83) ([Google Translated to English](https://github-com.translate.goog/yushijinhun/authlib-injector/wiki/Yggdrasil-%E6%9C%8D%E5%8A%A1%E7%AB%AF%E6%8A%80%E6%9C%AF%E8%A7%84%E8%8C%83?_x_tr_sl=auto&_x_tr_tl=en&_x_tr_hl=en-US)).
 
-A Drasl API for creating and administering accounts is [planned](https://github.com/unmojang/drasl/issues/18).
-
 ## Building
 
 If using Nix (with flakes), simply run `nix build`.

account_test.go

@@ -24,6 +24,7 @@ func TestAccount(t *testing.T) {
 
 		t.Run("Test /users/profiles/minecraft/:playerName", ts.testAccountPlayerNameToID)
 		t.Run("Test /profiles/minecraft", ts.makeTestAccountPlayerNamesToIDs("/profiles/minecraft"))
+		t.Run("Test /users/security/location", ts.testAccountVerifySecurityLocation)
 	}
 	{
 		ts := &TestSuite{}
@@ -67,6 +68,7 @@ func (ts *TestSuite) testAccountPlayerNameToID(t *testing.T) {
 	rec = ts.Get(t, ts.Server, "/users/profiles/minecraft/"+TEST_USERNAME_UPPERCASE, nil, nil)
 	assert.Nil(t, json.NewDecoder(rec.Body).Decode(&response))
 	uuid, err = IDToUUID(response.ID)
+	assert.Nil(t, err)
 	assert.Equal(t, user.UUID, uuid)
 }
 
@@ -106,6 +108,7 @@ func (ts *TestSuite) testAccountPlayerNameToIDFallback(t *testing.T) {
 		assert.Equal(t, http.StatusOK, rec.Code)
 		assert.Nil(t, json.NewDecoder(rec.Body).Decode(&response))
 		uuid, err = IDToUUID(response.ID)
+		assert.Nil(t, err)
 		assert.Equal(t, uuid, user.UUID)
 	}
 
@@ -145,5 +148,5 @@ func (ts *TestSuite) testAccountPlayerNamesToIDsFallback(t *testing.T) {
 
 func (ts *TestSuite) testAccountVerifySecurityLocation(t *testing.T) {
 	rec := ts.Get(t, ts.Server, "/user/security/location", nil, nil)
-	assert.Equal(t, http.StatusOK, rec.Code)
+	assert.Equal(t, http.StatusNoContent, rec.Code)
 }