{"id":20711936,"url":"https://github.com/bundesapi/api-doc-template","last_synced_at":"2025-09-04T04:21:36.545Z","repository":{"id":38274618,"uuid":"403296146","full_name":"bundesAPI/api-doc-template","owner":"bundesAPI","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-11T18:14:55.000Z","size":29,"stargazers_count":4,"open_issues_count":3,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-11T06:29:34.228Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bundesAPI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-05T11:57:07.000Z","updated_at":"2024-04-14T16:27:06.000Z","dependencies_parsed_at":"2023-02-09T04:01:28.970Z","dependency_job_id":null,"html_url":"https://github.com/bundesAPI/api-doc-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/bundesAPI/api-doc-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bundesAPI%2Fapi-doc-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bundesAPI%2Fapi-doc-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bundesAPI%2Fapi-doc-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bundesAPI%2Fapi-doc-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bundesAPI","download_url":"https://codeload.github.com/bundesAPI/api-doc-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bundesAPI%2Fapi-doc-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273549820,"owners_count":25125376,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-04T02:00:08.968Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-17T02:17:27.836Z","updated_at":"2025-09-04T04:21:36.513Z","avatar_url":"https://github.com/bundesAPI.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"[[DE]](README.md)/[[EN]](README_en.md)\n\n\n# [_TEMPLATE_]\n\n## Quickstart\n\n- Add openAPI spec in German to _openapi.yml_\n- Add openAPI spec in English to _openapi_en.yml_ (or remove _openapi_en.yml_ )\n- Update _index.html_ (insert the API-name in the title)\n- Update _generator_config.yaml_ (Update all values surrounded with \u003c\u003e)\n- Update the url in _CNAME_ once the api has its own subdomain\n- Replace the content of README.md with a German description of the API\n- Fill (or remove) README_en.md or add README-files in other languages.\n\n\n## Add Library to deutschland package\n\nFork the [deutschland](https://github.com/bundesAPI/deutschland) package:\n\n1. In the `pyproject.toml` of the [deutschland-package](https://github.com/bundesAPI/deutschland/blob/main/pyproject.toml) add a entry in the dependency section. The values for `\u003cNAME\u003e` and `\u003cVERSION\u003e` must match with the values in `generator_config.yaml`\n   For Example: \n\n   ```de-`\u003cNAME\u003e`  = {version= \"^`\u003cVERSION\u003e`\", optional = true}```\n2. Under the ```[tool.poetry.extras]``` section add the following\n   ```\u003cNAME\u003e`  =[\"de-`\u003cNAME\u003e`\"]```\n    \n   Also add de-name in the all list:\n```\n    all = [\"de-bundestag-lobbyregister\",\"de-dip-bundestag\",\"de-pegel-online\",\"de-ausbildungssuche\",\n    \"de-berufssprachkurssuche\",\"de-coachingangebote\",\"de-dip-bundestag\",\"de-entgeltatlas\",\n    \"de-hochwasserzentralen\",\"de-pflanzenschutzmittelzulassung\",\"de-studiensuche\",\n    \"de-tagesschau\", \"de-weiterbildungssuche\",\"de-feiertage\",...,\"de-`\u003cNAME\u003e`\"]\n```\n\n3. Add apis into [test_imports.py](https://github.com/bundesAPI/deutschland/blob/main/tests/test_imports.py)\n    ```\n    from deutschland.\u003cNAME\u003e.apis import DefaultApi\n   ```\n\n4. Open a [merge request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbundesapi%2Fapi-doc-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbundesapi%2Fapi-doc-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbundesapi%2Fapi-doc-template/lists"}