Merge pull request #50 from IlyaChichkov/develop

Develop 1.8.2

Author: IlyaChichkov

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "csharpier": {
-      "version": "1.8.1",
+      "version": "1.8.2",
       "commands": [
         "csharpier"
       ],

.github/workflows/deploy.yml

@@ -30,7 +30,19 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install -y libcairo2-dev pkg-config python3-dev
-          pip install cairosvg pycairo mkdocs mkdocs-material mkdocs-mermaid2-plugin mkdocs-minify-plugin mkdocs-macros-plugin mkdocs-llmstxt mkdocs-static-i18n
+          # Added pyyaml to ensure the scripts have it available
+          pip install cairosvg pycairo mkdocs mkdocs-material mkdocs-mermaid2-plugin mkdocs-minify-plugin mkdocs-macros-plugin mkdocs-llmstxt mkdocs-static-i18n pyyaml
+
+      - name: Format, Fix, and Validate API Docs
+        run: |
+          echo "🧹 Formatting YAML files..."
+          python scripts/docs/mkdocs_format_yaml.py
+          
+          echo "🔧 Auto-fixing HTTP methods..."
+          python scripts/docs/mkdocs_fix_yaml_methods.py
+          
+          echo "🔍 Running final validation check..."
+          python scripts/docs/mkdocs_check_api.py
 
       - name: Build site
         run: mkdocs build --site-dir public

.gitignore

@@ -1,12 +1,44 @@
-.cursor
-.vscode/obj
-.venv
+# =========================
+# Python
+# =========================
+__pycache__/
+*.py[cod]
+*$py.class
+.venv/
 */.venv/
-*.cache
+
+# =========================
+# C# & .NET
+# =========================
+[Bb]in/
+[Oo]bj/
+*.user
+.vs/
+*.suo
+
+# =========================
+# MkDocs
+# =========================
 site/
+public/
+
+# =========================
+# IDEs & OS
+# =========================
+.cursor/
+.vscode/
+.DS_Store
+Thumbs.db
+
+# =========================
+# Temp & Cache
+# =========================
+*.cache
 tmp/
 lib/
 
-Source/RIMAPI/obj/
+# =========================
+# RimWorld Build Outputs
+# =========================
 1.5/
 1.6/

About/About.xml

@@ -4,7 +4,7 @@
   <description>RIMAPI is a mod that give you an REST API useable for your current game</description>
   <packageId>RedEyeDev.RIMAPI</packageId>
   <author>RedEyeDev</author>
-  <modVersion>1.8.1</modVersion>
+  <modVersion>1.8.2</modVersion>
   <url></url>
   <supportedVersions>
     <li>1.5</li>

About/Manifest.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <Manifest>
     <identifier>redeyedev.rimapi</identifier>
-    <version>1.8.1</version>
+    <version>1.8.2</version>
     <manifestUri>
         https://raw.githubusercontent.com/IlyaChichkov/RIMAPI/refs/heads/main/About/Manifest.xml</manifestUri>
     <downloadUri>https://github.com/IlyaChichkov/RIMAPI/releases</downloadUri>

CHANGELOG.md

@@ -1,4 +1,22 @@
 # Changelog
+## v1.8.2
+
+### Documentation Infrastructure (Refactor)
+
+- Migrated from a single API YAML file to a modular, folder-based structure.
+- Multi-Language Support — Added dedicated localization folders (ja/, ru/) with fallback logic to ensure translated pages remain functional even if specific endpoints aren't yet translated.
+- Automated Validation — Introduced a Python-based sanity checker (mkdocs_check_api.py) that cross-references C# [Route] attributes against YAML documentation to prevent "documentation drift".
+- Auto-Fixer Tools — Added a synchronization script (mkdocs_fix_yaml_methods.py) that automatically updates YAML HTTP methods to match the C# source of truth.
+- Visual Enhancements — Implemented a tagging system (e.g., UI, Map, Pawn) with custom CSS badges to help users filter endpoints by category.
+
+### Developer Workflow & CI/CD
+
+- GitHub Actions Integration — Integrated the formatting, fixing, and validation scripts into the deployment pipeline to guarantee documentation accuracy on every push to master.
+- Improved Repository Hygiene — Optimized .gitignore to prevent Python bytecode (.pyc) and C# build artifacts from bloating the repository.
+
+### Bug Fixes & API Refinement
+
+- Unique Endpoint Routing — Refactored ImageController to use unique paths for GET and POST actions (e.g., /api/v1/item/change/image), resolving documentation collisions and improving REST clarity.
 
 ## v1.8.1
 

Source/RIMAPI/RIMAPI_Settings.cs

@@ -16,7 +16,7 @@ public class RIMAPI_Settings : ModSettings
         /// Current version of the RIMAPI mod.
         /// <para>Not saved to XML; used for UI display.</para>
         /// </summary>
-        public string version = "1.8.1";
+        public string version = "1.8.2";
 
         /// <summary>
         /// Current supported API protocol version.

Source/RIMAPI/RimApi.csproj

@@ -6,7 +6,7 @@
     <RootNamespace>RIMAPI</RootNamespace>
     <AssemblyName>RIMAPI</AssemblyName>
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
-    <Version>1.8.1</Version>
+    <Version>1.8.2</Version>
   </PropertyGroup>
 
   <!-- Conditional properties for RimWorld 1.5 -->

…Api/Core/Docs/DocumentationController.cs …seControllers/DocumentationController.csSource/RIMAPI/RimworldRestApi/Core/Docs/DocumentationController.cs renamed to Source/RIMAPI/RimworldRestApi/BaseControllers/DocumentationController.cs Source/RIMAPI/RimworldRestApi/Core/Docs/DocumentationController.cs renamed to Source/RIMAPI/RimworldRestApi/BaseControllers/DocumentationController.cs

@@ -17,7 +17,6 @@ public ImageController(IImageService imageService)
         }
 
         [Get("/api/v1/item/image")]
-        [EndpointMetadata("Get item's texture image in base64 format")]
         public async Task GetItemImage(HttpListenerContext context)
         {
             var name = RequestParser.GetStringParameter(context, "name");
@@ -26,16 +25,14 @@ public async Task GetItemImage(HttpListenerContext context)
         }
 
         [Get("/api/v1/terrain/image")]
-        [EndpointMetadata("Get terrain's texture image in base64 format")]
         public async Task GetTerrainImage(HttpListenerContext context)
         {
             var name = RequestParser.GetStringParameter(context, "name");
             var result = _imageService.GetTerrainImage(name);
             await context.SendJsonResponse(result);
         }
 
-        [Post("/api/v1/item/image")]
-        [EndpointMetadata("Get item's texture image in base64 format")]
+        [Post("/api/v1/item/change/image")]
         public async Task SetItemImage(HttpListenerContext context)
         {
             var requestData = await context.Request.ReadBodyAsync<ImageUploadRequest>();