Prepare plugin for release, #PG-5170#40
Conversation
lachiebol
changed the title
lachiebol
changed the title
lachiebol
changed the title
| ## Description | ||
|
|
||
| Allow generating OpenAPI documentation for the Matomo public APIs. | ||
| As APIs and plugins expose additional metadata, developers can browse available API endpoints, explore request parameters and response formats, and test API requests directly from the documentation interface. |
There was a problem hiding this comment.
Will update with marketing description once done
| @@ -1,7 +1,7 @@ | |||
| <?xml version="1.0"?> | |||
| <ruleset name="openapidocs" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"> | |||
There was a problem hiding this comment.
| <ruleset name="openapidocs" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"> | |
| <ruleset name="apireference" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"> |
AltamashShaikh
left a comment
AltamashShaikh
left a comment
There was a problem hiding this comment.
@lachiebol I still see alot of files referencing OpenApiDocs
Also we should, update Cloud and ensure this merge will not cause any issue on Cloud.
@AltamashShaikh Some of those will be your old generated annotations files, but I see some others there that should be fixed. Have just pushed a fix for that |
AltamashShaikh
left a comment
AltamashShaikh
left a comment
There was a problem hiding this comment.
@lachiebol The commands are still running with openapidocs they should also be changed to apireference
| protected function configure() | ||
| { | ||
| $this->setName('openapidocs:generate-spec-file'); | ||
| $this->setName('apireference:generate-spec-file'); |
There was a problem hiding this comment.
@AltamashShaikh did you pull recent changes? Should be fixed
|
I can still see references in API.php:77, phpcs.xml, Commands, ArtifactWriterTest |
AltamashShaikh
left a comment
AltamashShaikh
left a comment
There was a problem hiding this comment.
@lachiebol Can you check this
Medium-Risk Issues
docs/index.md:3 contains a public documentation link ending in PLACEHOLDER. If this goes into a release or marketplace metadata, users will hit a broken FAQ URL.
Low-Risk / Polish
git diff --check reports README.md:132: new blank line at EOF at README.md:132.
plugin.json:10 has a tab-indented keyword entry while the rest of the file uses spaces. Not functionally risky, but worth cleaning while touching packaging metadata.
I'll update the index.md when Giliian creates that private page. Just quickly fixed the other two concerns |
2 participants
Description
Updated README
Renamed/refactored plugin to use ApiReference.
Updated changelog to have 5.0.0 with an initial version.
added index.md
Issue No
Steps to Replicate the Issue
Checklist