{"id":42761223,"url":"https://github.com/starwit/starwit-aic-transparency-api","last_synced_at":"2026-01-29T20:34:10.490Z","repository":{"id":230927626,"uuid":"780439372","full_name":"starwit/starwit-aic-transparency-api","owner":"starwit","description":"Starwit's implementation of transparency API of AI cockpit research project","archived":false,"fork":false,"pushed_at":"2025-09-10T12:41:45.000Z","size":432,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-10T16:55:15.606Z","etag":null,"topics":["ai-cockpit","aicockpit"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/starwit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-04-01T13:41:05.000Z","updated_at":"2025-09-10T12:41:46.000Z","dependencies_parsed_at":"2024-08-08T14:46:44.802Z","dependency_job_id":"11c30e9f-532d-4e2f-84e3-7c8bee8a8f06","html_url":"https://github.com/starwit/starwit-aic-transparency-api","commit_stats":null,"previous_names":["starwit/starwit-aic-transparency-api"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/starwit/starwit-aic-transparency-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/starwit%2Fstarwit-aic-transparency-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/starwit%2Fstarwit-aic-transparency-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/starwit%2Fstarwit-aic-transparency-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/starwit%2Fstarwit-aic-transparency-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/starwit","download_url":"https://codeload.github.com/starwit/starwit-aic-transparency-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/starwit%2Fstarwit-aic-transparency-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28884291,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T19:55:09.949Z","status":"ssl_error","status_checked_at":"2026-01-29T19:55:08.490Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["ai-cockpit","aicockpit"],"created_at":"2026-01-29T20:34:09.755Z","updated_at":"2026-01-29T20:34:10.485Z","avatar_url":"https://github.com/starwit.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Starwits implementation of AI Cockpit transparency API\n\nComplex software systems that uses AI mechanisms are difficult to understand. This API is part of an effort to add transparency and control to such systems. It is Starwit Technologies' implementation of the transparency interface. It shall provide statistical insights to an AI system's capabilities and give users an easy as possible way to understand, how this system work.\n\nAPI reference can be found here: \u003chttps://gitlab.opencode.de/ki-cockpit/ai-cockpit-api/-/blob/main/api/transparency/ai-cockpit-transparency.yml?ref_type=heads\u003e\n\nMore details can be found at \u003chttps://www.kicockpit.eu/\u003e. All shared components necessary for this repo can be found [here](https://github.com/KI-Cockpit/ai-cockpit-api). There you also can find more info about all other activities \u0026 results of this project.\n\n## Overview\n\nThis implementation aims to be a micro service, that can be deployed into a system landscape, that contains complex AI-based decision mechanism. It is written in Java / Spring Boot and was initially generated by the [OpenAPI Generator](https://openapi-generator.tech) project.\n\n## Starwit's implementation\n\nThis component is part of Starwit's implementation for an AI Cockpit. For an overview of all components see [deployment repo](https://github.com/starwit/ai-cockpit-deployment).\n\n## Run Docker image\n\n    docker run -it -p 8080:8080 starwit-aicapi-transparency\n\nOnce running you can access:\n\n* interactive API at [http://localhost:8080/swagger-ui.html](http://localhost:8080/swagger-ui.html)\n* API spec at: [http://localhost:8080/v0/api-docs/](http://localhost:8080/v0/api-docs/)\n\n## Build \u0026 run locally\n\nApplication can be build and run like so:\n\n```bash\nmvn package\njava -jar target/starwit-aicapi-transparency-x.y.z.jar\n```\n\nThis app needs other components to function properly:\n\n* Minio -\u003e upload sbom, pdf \u0026 excel reports\n* sbom-generator -\u003e create pdf/excel reports from sboms\n* ai-cockpit \u0026 database\n\nIn folder [docker-compose](deployment/docker-compose/) a docker compose file starts all necessary components. This can be started this way:\n\n```bash\ndocker compose -f start-services-noauth.yaml up\n```\n\nTo start fresh shutdown all services like so:\n\n```bash\ndocker compose -f start-services-noauth.yaml down -v\n```\n\nFor more details how to use Docker compose, [see readme](deployment/docker-compose/Readme.md).\n\nAfter successful start api documentation is available at:\n\u003chttp://localhost:8080/swagger-ui.html\u003e\n\n### Config file\n\n```properties\n# sets URL for swagger UI\napp.service_uri=http://localhost:8080\n\n# URL for cockpit\ncockpit.hostname=http://localhost:8081/ai-cockpit/ \n# context path module API\ncockpit.moduleapi=api/module\n# context path AIC functions\ncockpit.aicapi=api/aic/modules \n\n# if true sample data will be send to cockpit\nscenario.setup=true \n# if internal prepackaged data will be imported else folder location\nscenario.importFolder=internal \n\n# Authentication against IdP\ncockpit.auth.enabled=true\ncockpit.auth.client_id=aicockpit\ncockpit.auth.username=username \ncockpit.auth.password=secret \ncockpit.auth.url=https://hostname/auth/realms/default/protocol/openid-connect/token\n```\n\n## Contact \u0026 Contribution\n\nThe “KI-Cockpit” (AI Cockpit) project was funded by the Federal Ministry of Labor and Social Affairs. See [project repo](https://github.com/ki-cockpit) for more details..\n\n\u003cimg src=\"doc/foerderlogo.png\" alt=\"BMAS Logo\" style=\"width:33%; height:auto;\"\u003e\n\n## License\n\nThis software is licensed under AGPL and license text can be found at: \u003chttps://github.com/starwit/starwit-aic-transparency-api/blob/main/LICENSE\u003e\n\nMore info about Starwit can be found here: \u003chttps://starwit-technologies.de/\u003e\n\n## Research Links\n\n* [Implementing AI Bill of Materials (AI BOM) with SPDX 3.0](https://arxiv.org/pdf/2504.16743)\n* [Hugging Face AI sBOM Generator](https://huggingface.co/spaces/aetheris-ai/aibom-generator)\n* [SPDX Meetings](https://github.com/spdx/meetings?tab=readme-ov-file#tech-team-meetings)\n* [SPDX Incident Reporting](https://www.oecd.org/en/publications/towards-a-common-reporting-framework-for-ai-incidents_f326d4ac-en.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstarwit%2Fstarwit-aic-transparency-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstarwit%2Fstarwit-aic-transparency-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstarwit%2Fstarwit-aic-transparency-api/lists"}