aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Rest/Module/Module.php
diff options
context:
space:
mode:
authordaniel <dkinzler@wikimedia.org>2024-08-19 20:47:40 +0200
committerdaniel <dkinzler@wikimedia.org>2024-08-19 20:47:40 +0200
commit057dda8588a1b9a0804880cfd3813ccd5e692c34 (patch)
treec1181d4fbf3fc258762f58a687d97116cc163653 /includes/Rest/Module/Module.php
parent5163f9b6acf6a5966ef60bdf8439ebda3b0d76b6 (diff)
downloadmediawikicore-057dda8588a1b9a0804880cfd3813ccd5e692c34.tar.gz
mediawikicore-057dda8588a1b9a0804880cfd3813ccd5e692c34.zip
REST: include version in generated OpenAPI spec
The generated OpenAPI spec should contain information from the info section of module spec files. Bug: T366834 Change-Id: I488f550adbf32205bdcdcb59b1e7f5273643bf69
Diffstat (limited to 'includes/Rest/Module/Module.php')
-rw-r--r--includes/Rest/Module/Module.php11
1 files changed, 11 insertions, 0 deletions
diff --git a/includes/Rest/Module/Module.php b/includes/Rest/Module/Module.php
index 31ac77196110..dcfc01af4550 100644
--- a/includes/Rest/Module/Module.php
+++ b/includes/Rest/Module/Module.php
@@ -445,4 +445,15 @@ abstract class Module {
return $spec;
}
+
+ /**
+ * Return an array with data to be included in an OpenAPI "info" object
+ * describing this module.
+ *
+ * @see https://spec.openapis.org/oas/v3.0.0#info-object
+ * @return array
+ */
+ public function getOpenApiInfo() {
+ return [];
+ }
}