Final changes, #PG-5170 (#47)

* change parameter examples

* Cleaning up for marketplace & changing readme

Author: lachiebol

README.md

@@ -20,7 +20,7 @@ The API Reference plugin improves API discoverability while supporting modern AP
 Navigate to:
 
 ```text
-Administration → System → SwaggerUI
+Administration → System → API
 ```
 
 The Swagger UI page will display API documentation for installed plugins.
@@ -37,6 +37,22 @@ To manually regenerate specifications:
 
 This is useful after installing, enabling, or updating plugins.
 
+**NOTE:** The initial generation process may take some time to complete, depending on the number of installed plugins.
+
+## Read Specs Via the Reporting API
+
+This plugin exposes a Reporting API method for reading generated OpenAPI specs directly.
+
+To read a previously generated spec for a plugin:
+
+```text
+index.php?module=API&method=ApiReference.getOpenApiSpec&pluginName=Login&format=json
+```
+
+This returns the JSON spec file for the requested plugin.
+
+If you are calling these endpoints outside the Matomo UI, include your usual authentication parameters such as `token_auth`.
+
 ## Authorise API Requests
 
 To test API endpoints from Swagger UI:

config/ParameterExamples.php

@@ -17,8 +17,8 @@
     'segmentName:string' => 'New Zealand visitors',
     'idSite:int' => 1,
     'idExperiment:int' => 1,
-    'successMetric:string' => 'conversion_rate',
-    'name:string' => 'Pricing page signup test',
+    'successMetric:string' => 'nb_visits',
+    'name:string' => 'Pricing',
     'hypothesis:string' => 'A shorter signup flow will improve conversions.',
     'description:string' => 'Compare the pricing page signup experience for New Zealand traffic.',
     'variations:array<int,array<string,mixed>>' => [
@@ -95,7 +95,6 @@
     'metricIds:string[]' => [
         'nb_visits',
         'nb_conversions',
-        'conversion_rate',
     ],
     'idSubtable:int|string|false' => 1,
     'login:string' => 'alice',

docs/index.md

@@ -1,3 +1,3 @@
 ## Documentation
 
-The [ApiReference User Guide](https://matomo.org/faq/how-to/PLACEHOLDER) and the [README.md](https://github.com/matomo-org/plugin-ApiReference/blob/5.x-dev/README.md#features) cover how to get the most out of this plugin.
+The [ApiReference User Guide](https://matomo.org/faq/how-to/how-to-use-the-api-reference-in-matomo) and the [README.md](https://github.com/matomo-org/plugin-ApiReference/blob/5.x-dev/README.md#features) cover how to get the most out of this plugin.