Merge pull request #137 from nextcloud/feat/scopes/ex-app

composer.json

@@ -20,7 +20,8 @@
 		"phpstan/phpdoc-parser": "^1.28"
 	},
 	"require-dev": {
-		"nextcloud/coding-standard": "^1.2"
+		"nextcloud/coding-standard": "^1.2",
+		"nextcloud/ocp": "dev-master"
 	},
 	"scripts": {
 		"lint": "find . -name \\*.php -not -path './tests/*' -not -path './vendor/*' -not -path './build/*' -print0 | xargs -0 -n1 php -l && php -l generate-spec && php -l merge-specs",

generate-spec

@@ -446,6 +446,7 @@ foreach ($parsedRoutes as $key => $value) {
 		$isDeprecated = Helpers::classMethodHasAnnotationOrAttribute($methodFunction, "deprecated");
 		$isIgnored = Helpers::classMethodHasAnnotationOrAttribute($methodFunction, "IgnoreOpenAPI");
 		$isPasswordConfirmation = Helpers::classMethodHasAnnotationOrAttribute($methodFunction, "PasswordConfirmationRequired");
+		$isExApp = Helpers::classMethodHasAnnotationOrAttribute($methodFunction, "ExAppRequired");
 		$scopes = Helpers::getOpenAPIAttributeScopes($classMethod, $routeName);
 
 		if ($isIgnored) {
@@ -469,6 +470,8 @@ foreach ($parsedRoutes as $key => $value) {
 		if (empty($scopes)) {
 			if (!empty($controllerScopes)) {
 				$scopes = $controllerScopes;
+			} elseif ($isExApp) {
+				$scopes = ['ex_app'];
 			} elseif ($isAdmin) {
 				$scopes = ['administration'];
 			} else {

tests/appinfo/routes.php

@@ -31,6 +31,9 @@
 		['name' => 'AdminSettings#movedToSettingsTag', 'url' => '/api/{apiVersion}/moved-with-tag', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
 		['name' => 'AdminSettings#movedToSettingsTagUnnamed', 'url' => '/api/{apiVersion}/moved-with-unnamed-tag', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
 
+		['name' => 'ExAppSettings#exAppScopeAttribute', 'url' => '/api/{apiVersion}/ex-app-attribute', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
+		['name' => 'ExAppSettings#exAppScopeOverride', 'url' => '/api/{apiVersion}/ex-app-override', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
+
 		['name' => 'Federation#federationByController', 'url' => '/api/{apiVersion}/controller-scope', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
 		['name' => 'Federation#movedToDefaultScope', 'url' => '/api/{apiVersion}/default-scope', 'verb' => 'POST', 'requirements' => ['apiVersion' => '(v2)']],
 

tests/lib/Controller/ExAppSettingsController.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\Notifications\Controller;
+
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\ExAppRequired;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\OpenAPI;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\OCSController;
+
+class ExAppSettingsController extends OCSController {
+	/**
+	 * Route is in ex_app scope because of the attribute
+	 *
+	 * @return DataResponse<Http::STATUS_OK, array<empty>, array{}>
+	 *
+	 * 200: Personal settings updated
+	 */
+	#[ExAppRequired]
+	public function exAppScopeAttribute(): DataResponse {
+		return new DataResponse();
+	}
+
+	/**
+	 * Route is in ex_app scope because of the override
+	 *
+	 * @return DataResponse<Http::STATUS_OK, array<empty>, array{}>
+	 *
+	 * 200: Personal settings updated
+	 */
+	#[NoAdminRequired]
+	#[OpenAPI(OpenAPI::SCOPE_EX_APP)]
+	public function exAppScopeOverride(): DataResponse {
+		return new DataResponse();
+	}
+}