Merge branch 'development' into release

Author: ssddanbrown

.github/ISSUE_TEMPLATE/api_request.yml

@@ -1,6 +1,5 @@
 name: New API Endpoint or API Ability
 description: Request a new endpoint or API feature be added
-title: "[API Request]: "
 labels: [":nut_and_bolt: API Request"]
 body:
   - type: textarea

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,6 +1,5 @@
 name: Bug Report
 description: Create a report to help us improve or fix things
-title: "[Bug Report]: "
 labels: [":bug: Bug"]
 body:
   - type: textarea

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,6 +1,5 @@
 name: Feature Request
-description: Request a new language to be added to CrowdIn for you to translate
-title: "[Feature Request]: "
+description: Request a new feature or idea to be added to BookStack
 labels: [":hammer: Feature Request"]
 body:
   - type: textarea
@@ -13,8 +12,42 @@ body:
   - type: textarea
     id: benefits
     attributes:
-      label: Describe the benefits this feature would bring to BookStack users
-      description: Explain the measurable benefits this feature would achieve for existing BookStack users
+      label: Describe the benefits this would bring to existing BookStack users
+      description: |
+        Explain the measurable benefits this feature would achieve for existing BookStack users.
+        These benefits should details outcomes in terms of what this request solves/achieves, and should not be specific to implementation.
+        This helps us understand the core desired goal so that a variety of potential implementations could be explored.
+        This field is important. Lack if input here may lead to early issue closure.
+    validations:
+      required: true
+  - type: textarea
+    id: already_achieved
+    attributes:
+      label: Can the goal of this request already be achieved via other means?
+      description: |
+        Yes/No. If yes, please describe how the requested approach fits in with the existing method.
+    validations:
+      required: true
+  - type: checkboxes
+    id: confirm-search
+    attributes:
+      label: Have you searched for an existing open/closed issue?
+      description: |
+        To help us keep these issues under control, please ensure you have first [searched our issue list](https://github.com/BookStackApp/BookStack/issues?q=is%3Aissue)
+        for any existing issues that cover the fundemental benefit/goal of your request.
+      options:
+        - label: I have searched for existing issues and none cover my fundemental request
+          required: true
+  - type: dropdown
+    id: existing_usage
+    attributes:
+      label: How long have you been using BookStack?
+      options:
+        - Not using yet, just scoping
+        - 0 to 6 months
+        - 6 months to 1 year
+        - 1 to 5 years
+        - Over 5 years
     validations:
       required: true
   - type: textarea

.github/ISSUE_TEMPLATE/language_request.yml

@@ -1,6 +1,5 @@
 name: Language Request
 description: Request a new language to be added to CrowdIn for you to translate
-title: "[Language Request]: "
 labels: [":earth_africa: Translations"]
 assignees:
   - ssddanbrown

.github/ISSUE_TEMPLATE/support_request.yml

@@ -1,6 +1,5 @@
 name: Support Request
 description: Request support for a specific problem you have not been able to solve yourself
-title: "[Support Request]: "
 labels: [":dog2: Support"]
 body:
   - type: checkboxes

.github/translators.txt

@@ -158,7 +158,7 @@ HenrijsS :: Latvian
 Pascal R-B (pborgner) :: German
 Boris (Ginfred) :: Russian
 Jonas Anker Rasmussen (jonasanker) :: Danish
-Gerwin de Keijzer (gdekeijzer) :: Dutch; German; German Informal
+Gerwin de Keijzer (gdekeijzer) :: Dutch; German Informal; German
 kometchtech :: Japanese
 Auri (Atalonica) :: Catalan
 Francesco Franchina (ffranchina) :: Italian
@@ -215,3 +215,18 @@ Saeed (saeed205) :: Persian
 Julesdevops :: French
 peter cerny (posli.to.semka) :: Slovak
 Pavel Karlin (pavelkarlin) :: Russian
+SmokingCrop :: Dutch
+Maciej Lebiest (Szwendacz) :: Polish
+DiscordDigital :: German; German Informal
+Gábor Marton (dodver) :: Hungarian
+Jasell :: Swedish
+Ghost_chu (ghostchu) :: Chinese Simplified
+Ravid Shachar (ravidshachar) :: Hebrew
+Helga Guchshenskaya (guchshenskaya) :: Russian
+daniel chou (chou0214) :: Chinese Traditional
+Manolis PATRIARCHE (m.patriarche) :: French
+Mohammed Haboubi (haboubi92) :: Arabic
+roncallyt :: Portuguese, Brazilian
+goegol :: Dutch
+msevgen :: Turkish
+Khroners :: French

.github/workflows/phpstan.yml

@@ -1,19 +1,14 @@
 name: phpstan
 
-on:
-  push:
-    branches-ignore:
-      - l10n_development
-  pull_request:
-    branches-ignore:
-      - l10n_development
+on: [push, pull_request]
 
 jobs:
   build:
+    if: ${{ github.ref != 'refs/heads/l10n_development' }}
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php: ['7.3']
+        php: ['7.4']
     steps:
     - uses: actions/checkout@v1
 

.github/workflows/phpunit.yml

@@ -1,19 +1,14 @@
 name: phpunit
 
-on:
-  push:
-    branches-ignore:
-      - l10n_development
-  pull_request:
-    branches-ignore:
-      - l10n_development
+on: [push, pull_request]
 
 jobs:
   build:
+    if: ${{ github.ref != 'refs/heads/l10n_development' }}
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php: ['7.3', '7.4', '8.0', '8.1']
+        php: ['7.4', '8.0', '8.1']
     steps:
     - uses: actions/checkout@v1
 

.github/workflows/test-migrations.yml

@@ -1,19 +1,14 @@
 name: test-migrations
 
-on:
-  push:
-    branches-ignore:
-      - l10n_development
-  pull_request:
-    branches-ignore:
-      - l10n_development
+on: [push, pull_request]
 
 jobs:
   build:
+    if: ${{ github.ref != 'refs/heads/l10n_development' }}
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php: ['7.3', '7.4', '8.0', '8.1']
+        php: ['7.4', '8.0', '8.1']
     steps:
       - uses: actions/checkout@v1
 

app/Api/ApiDocsGenerator.php

@@ -3,11 +3,13 @@
 namespace BookStack\Api;
 
 use BookStack\Http\Controllers\Api\ApiController;
+use Exception;
 use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\Str;
+use Illuminate\Validation\Rules\Password;
 use ReflectionClass;
 use ReflectionException;
 use ReflectionMethod;
@@ -100,11 +102,37 @@ protected function getBodyParamsFromClass(string $className, string $methodName)
             $this->controllerClasses[$className] = $class;
         }
 
-        $rules = $class->getValdationRules()[$methodName] ?? [];
+        $rules = collect($class->getValidationRules()[$methodName] ?? [])->map(function ($validations) {
+            return array_map(function ($validation) {
+                return $this->getValidationAsString($validation);
+            }, $validations);
+        })->toArray();
 
         return empty($rules) ? null : $rules;
     }
 
+    /**
+     * Convert the given validation message to a readable string.
+     */
+    protected function getValidationAsString($validation): string
+    {
+        if (is_string($validation)) {
+            return $validation;
+        }
+
+        if (is_object($validation) && method_exists($validation, '__toString')) {
+            return strval($validation);
+        }
+
+        if ($validation instanceof Password) {
+            return 'min:8';
+        }
+
+        $class = get_class($validation);
+
+        throw new Exception("Cannot provide string representation of rule for class: {$class}");
+    }
+
     /**
      * Parse out the description text from a class method comment.
      */