Align OpenAPI spec and docs with currently working live Jobsuche API#65
Merged
LilithWittmann merged 6 commits intomainfrom Apr 2, 2026
Merged
Conversation
…nd fix logo endpoint Agent-Logs-Url: https://github.com/bundesAPI/jobsuche-api/sessions/cda980ae-6654-42d8-8f3c-ebdbce4fd36f Co-authored-by: LilithWittmann <891030+LilithWittmann@users.noreply.github.com>
Agent-Logs-Url: https://github.com/bundesAPI/jobsuche-api/sessions/cda980ae-6654-42d8-8f3c-ebdbce4fd36f Co-authored-by: LilithWittmann <891030+LilithWittmann@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update Jobsuche documentation to match live API behavior
Align OpenAPI spec and docs with currently working live Jobsuche API
Mar 31, 2026
Member
|
@copilot resolve conflicts. |
…ails/logo endpoints Co-authored-by: LilithWittmann <891030+LilithWittmann@users.noreply.github.com>
Contributor
Author
Resolved in commit |
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
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.
The published OpenAPI spec and examples were missing the jobdetails endpoints entirely and referenced a broken logo endpoint (
ed/v1), making the documented API contract non-functional against the live API.OpenAPI spec (
openapi.yaml, v2.0.2 → v2.1.0)/pc/v4/jobdetails/{encryptedJobCode}(recommended) and/pc/v3/jobdetails/{encryptedJobCode}— path parameter isbase64(refnr)/ed/v1/arbeitgeberlogo/{hashID}(403) with/ct/v1/arbeitgeberlogo/{kundennummerHash}(working), using an OpenAPI 3.0 per-pathserversoverride for the different base URL (https://rest.arbeitsagentur.de/vermittlung/ag-darstellung-service)kundennummerHash(nullable) andexterneUrl(nullable) toJobSearchResponsestellenangebote itemsJobDetailsschema:arbeitgeberKundennummerHash,stellenangebotsBeschreibung,stellenangebotsTitel,referenznummer404on the logo endpoint as a normal "no logo available" caseExample code
Other files
README.md: Added Ablauf section documenting the full 3-step flow; jobdetails section with base64 encoding explanation; updated logo endpoint; edge cases (nullable hash, 404 semantics)api_example.py: Updated to demonstrate full search → details → logo flowapi_example.R: Fixed logo URL toct/v1; added jobdetails example usingbase64enc::base64encode(charToRaw(refnr))default_api.py): Replaceded_v1_arbeitgeberlogo_hash_id_getwithct_v1_arbeitgeberlogo_kundennummer_hash_get; addedpc_v4_jobdetails_encrypted_job_code_getandpc_v3_jobdetails_encrypted_job_code_get.gitignore: Added to exclude__pycache__and build artifacts