Skip to content

GitLab

Open
Created by Elias Häußler@eliashaeussler🐛0 of 2 tasks completed0/2 tasks

Feature request: Include "verified" state in REST API

Problem to solve

The REST API endpoint GET /extension/{key} (and probably other endpoints as well) should provide the current "verified" state of an extension.

Further details

TYPO3 Badges is a Symfony application that provides JSON endpoints for Badgen.net and Shields.io to create badges for TYPO3 extensions. Extension metadata is fetched via TER REST API. At the time of this writing, the GET /extension/{key} endpoint is used to fetch metadata.

With issue #135, a new feature was requested: The application should provide an endpoint for the "verified" state of an extension. Since the application itself fetches appropriate information from TER REST API, it's required for the REST API to provide this information.

Proposal

Include the "verified" state of an extension in the REST API endpoint GET /extension/{key} as property "verified": <true|false> (or similar):

 {
   "key": "container",
   "downloads": 177,
+  "verified": true,
   "versions_count": 22,
   "meta": {
     // ...
   }
 }

What does success look like, and how can we measure that?

As soon as the TER REST API provides the requested information, a pull request in TYPO3 Badges can be submitted. It will provide a new endpoint for the "verified" state of an extension inside the TYPO3 Badges Symfony application.

Acceptence Criterias

  • Include "verified" state of extensions in REST API endpoint GET /extension/{key}
  • Bump a new REST API version

Links / references