bundesAPI / bundesAPI/sofortmassnahmen

API-API

Open
#68 9 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
99
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Aktuell ist das [API-Register](https://github.com/bundesAPI/apis) nicht automatisiert. Gibt es irgendwelche technischen Hürden, die gegen eine Automatisierung sprechen?

* `name`: `openapi.yaml` -> `info.title`
* `office`: aktuell glaub nicht systematisiert, vielleicht `info.x-office` in den OpenAPI-Specs?
* `description`: ~`openapi.yaml` -> `info.description`~ GitHub repo description
* `documentationUrl`: ~`CNAME.bund.dev`~ GitHub repo project URL
* `githubUrl`: klar

Am einfachsten wäre wahrscheinlich ein GitHub-Actions-Cronjob in https://github.com/bundesAPI/apis, der folgendes macht:

* Liste öffentlicher Repos von `bundesAPI` laden (via https://github.com/octokit/action.js/)
* Liste nach `*-api` filtern
* Alle OpenAPI-Specs laden und verwursten
* Resultat committen

Contributor guide

Open the contributing guide

Research direction

Start in the bundesAPI/apis repository and review the proposed GitHub Actions cronjob using Octokit action.js. Define how public bundesAPI repositories are filtered by *-api, how OpenAPI metadata maps to registry fields, and how the generated result is committed. The unresolved office and metadata-source questions need decisions before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, openapi
Domain
api, ci-cd
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.