Verbesserungen an Dokumentation, OpenAPI-Spezifikation und Python-Beispiel#66
Open
timpara wants to merge 1 commit intobundesAPI:mainfrom
Open
Verbesserungen an Dokumentation, OpenAPI-Spezifikation und Python-Beispiel#66timpara wants to merge 1 commit intobundesAPI:mainfrom
timpara wants to merge 1 commit intobundesAPI:mainfrom
Conversation
…spiel
- openapi.yaml: Fehlenden Query-Parameter 'pav' (Private
Arbeitsvermittlung) für /pc/v4/jobs und /pc/v4/app/jobs ergänzt.
Dieser Parameter war im README dokumentiert, fehlte aber in der
Spezifikation und damit auch im generierten Client.
- openapi.yaml: Beschreibungen für mehrwertige Parameter 'befristung'
und 'arbeitszeit' präzisiert.
- api_example.py: 'verify=False' entfernt (TLS-Verifikation war unnötig
deaktiviert und erzeugte InsecureRequestWarning). Timeout, Typ-Hints
und 'raise_for_status()' für robustere Fehlerbehandlung ergänzt.
Demo-Aufrufe in 'if __name__ == "__main__":' Block verschoben,
damit das Modul importierbar ist, ohne Netzwerk-Requests auszulösen.
- README.md: Tippfehler zu Beginn des Authentifizierungs-Abschnitts
korrigiert ('ie' -> 'Die') und Konsistenz der Parameter-Markup-
Formatierung für 'behinderung' und 'corona' hergestellt.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Zusammenfassung
Dieser PR enthält drei zusammenhängende Qualitätsverbesserungen an Doku, OpenAPI-Spezifikation und Python-Beispiel.
openapi.yamlpav(Private Arbeitsvermittlung) für/pc/v4/jobsund/pc/v4/app/jobsergänzt. Dieser Parameter war bereits im README dokumentiert, fehlte aber in der OpenAPI-Spezifikation und somit auch im automatisch generierten Python-Client.befristungundarbeitszeitpräzisiert, damit klarer wird, dass Werte semikolon-separiert übergeben werden können.api_example.pyverify=Falseentfernt. Die TLS-Verifikation war unnötigerweise deaktiviert und erzeugteInsecureRequestWarning.rest.arbeitsagentur.deliefert gültige Zertifikate aus.timeout=60undresponse.raise_for_status()hinzugefügt für robustere Fehlerbehandlung.if __name__ == "__main__":Block eingeführt, damit das Modul importierbar ist, ohne beim Import direkt Netzwerk-Requests auszulösen.import urllib.parsenach oben verschoben; deutsche Docstrings überarbeitet.README.mdie Authentifizierung→Die Authentifizierung).behinderungundcoronahergestellt (fetter**Parameter:**-Präfix analog zu den übrigen Parametern).Nicht enthalten
Der generierte
python-client/wurde bewusst nicht regeneriert – dies kann der Maintainer per CI-Workflow (.github/workflows/) nach dem Merge auslösen, um sicherzustellen, dass Generator-Version und Regeln konsistent bleiben.