Newer
Older
{/* Copyright 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH.
SPDX-License-Identifier: MIT */}
<div className="flex justify-center py-8">
<img src="/assets/overview.png" className="h-auto lg:h-[30rem]" alt="Schematische Darstellung der Architektur des Badge API"/>
</div>
### Fundamentals
The Badge API is a service scanning repositories for specific criteria and generating badges based on the results.
Alexandros Bouras
committed
The badges are displayed in the openCode software catalog and indicate the status of the repository in terms of
**security**, **maintenance**, and **reuse**.
Each badge is based on a set of criteria that the repository must meet to receive the badge. Actively
The criteria are divided into three levels: **Bronze**, **Silver**, and **Gold**, respectively
**Ready for Reuse** and **Actively Reused** for the reuse badge.
The higher the level, the more criteria the repository must meet.
All criteria are evaluated bluntly like a checklist and must therefore lead to a true or false result.
As a result, some checks are evaluated based on thresholds (e.g. the issue reaction time).
Alexandros Bouras
committed
To determine the thresholds, we examine the usual values of the projects on openCode and derive
the corresponding thresholds from their mean values and standard deviations.
Many checks are evaluated relative to a timeframe. Unless explicitly stated "timeframe" refers to now - 30 days.
### Explanation
We encourage that you integrate the [badge explanation endpoint](/api-docs/v1/badges#get-badge-explanation)
into your application to provide a detailed explanation of the badge result to your users.
A typical use case is to make the badge clickable and show the explanation on a detail page.