{"id":15178561,"url":"https://github.com/grimmjo/jaxrs-analyzer-gradle-plugin","last_synced_at":"2025-10-26T17:30:51.083Z","repository":{"id":57719840,"uuid":"105573383","full_name":"grimmjo/jaxrs-analyzer-gradle-plugin","owner":"grimmjo","description":"Gradle plugin for the https://github.com/sdaschner/jaxrs-analyzer [JAX-RS Analyzer].","archived":false,"fork":false,"pushed_at":"2023-03-28T12:44:29.000Z","size":195,"stargazers_count":7,"open_issues_count":2,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-07T22:35:38.507Z","etag":null,"topics":["asciidoc","gradle-plugin","groovy","jaxrs","swagger"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grimmjo.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"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}},"created_at":"2017-10-02T19:03:47.000Z","updated_at":"2024-10-30T07:47:34.000Z","dependencies_parsed_at":"2024-10-11T06:01:12.843Z","dependency_job_id":"9f095b2c-e0b4-491d-a937-a6ac8c902ecb","html_url":"https://github.com/grimmjo/jaxrs-analyzer-gradle-plugin","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/grimmjo/jaxrs-analyzer-gradle-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grimmjo%2Fjaxrs-analyzer-gradle-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grimmjo%2Fjaxrs-analyzer-gradle-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grimmjo%2Fjaxrs-analyzer-gradle-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grimmjo%2Fjaxrs-analyzer-gradle-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grimmjo","download_url":"https://codeload.github.com/grimmjo/jaxrs-analyzer-gradle-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grimmjo%2Fjaxrs-analyzer-gradle-plugin/sbom","scorecard":{"id":445791,"data":{"date":"2025-08-11","repo":{"name":"github.com/grimmjo/jaxrs-analyzer-gradle-plugin","commit":"93a954a477d9f9791644180fe93256f54d291ed9"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 1/17 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/gradle.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: gradle/wrapper/gradle-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/gradle.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/grimmjo/jaxrs-analyzer-gradle-plugin/gradle.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/gradle.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/grimmjo/jaxrs-analyzer-gradle-plugin/gradle.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/gradle.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/grimmjo/jaxrs-analyzer-gradle-plugin/gradle.yml/master?enable=pin","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 5 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T06:41:32.452Z","repository_id":57719840,"created_at":"2025-08-19T06:41:32.452Z","updated_at":"2025-08-19T06:41:32.452Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281140881,"owners_count":26450536,"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-10-26T02:00:06.575Z","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":["asciidoc","gradle-plugin","groovy","jaxrs","swagger"],"created_at":"2024-09-27T15:05:30.506Z","updated_at":"2025-10-26T17:30:50.792Z","avatar_url":"https://github.com/grimmjo.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"= JAX-RS Analyzer Gradle Plugin\n\nGradle plugin for the https://github.com/sdaschner/jaxrs-analyzer[JAX-RS Analyzer].\n\nUsing the plugin:\n\n----\n\nplugins {\n  id(\"io.github.grimmjo.jaxrs-analyzer\") version \"0.4\"\n}\n\n----\n\nAfter building your project, the documentation resides under 'build/jaxrs-analyzer/'.\n\n== Changelog\n\n=== Version 0.4\n\nIMPORTANT: The plugin id changed from `com.github.grimmjo` to `io.github.grimmjo.jaxrs-analyzer`\n\n* update to gradle 8\n* migrates the plugin to kotlin\n* support all main source sets\n\n\n=== Version 0.3\n* updates jax-rs-analyzer dependency to 0.17\n* updates gradle to 4.10.2\n\n=== Version 0.2\n\n* adds gradle's cache support to analyze task\n* generate documentation for multiple backends\n* updates jax-rs-analyzer dependency to 0.16\n* adds a example build\n\n== Roadmap\n\n=== Version 0.4\n* support groovy and kotlin classes for analysis\n\n== Full Example\n\nA full working example can be found https://github.com/grimmjo/jaxrs-analyzer-gradle-plugin-samples[here]\n\n== Configuration\n\n----\njaxRsAnalyzer {\n    // Available backends are plaintext, asciidoc and swagger (default)\n    backend 'swagger', 'asciidoc'\n    // Domain of the deployed project, defaults to \"\"\n    domain 'localhost:8080'\n    // Comma separated list of Swagger schemes (only for if backend is swagger, defaults to http)\n    schemes 'http', 'https'\n    // Enables rendering of Swagger tags (defaults to false -\u003e default tag will be used)\n    renderTags true\n    // The number at which path position the Swagger tags will be extracted (defaults to 0)\n    tagPathOffset 0\n    // Directory (relative to buildDir) where resources will be generated (defaults to jaxrs-analyzer)\n    outputDirectory 'jaxrs-analyzer'\n}\n----\n\n=== Output directory\n\nThe `outputDirectory` parameter defines the relative path to the build directory.\n\n=== Backend\nThe `backend` parameter specifies the output format of the analysis.\nThe available formats are plaintext, asciidoc and swagger.\nMultiple values are allowed. E.g.\njaxRsAnalyzer {\n    // Available backends are plaintext (default), swagger and asciidoc\n    backend 'swagger', 'asciidoc'\n    ...\n}\nThis would generate the documentation for swagger and asciidoc.\n\nFor further use of the created formats see the https://github.com/sdaschner/jaxrs-analyzer/blob/master/Documentation.adoc[JAX-RS Analyzer documentation].\n\n=== Domain\nWith `domain` the user may specify the URL which will contain the REST API later on.\nTools like Swagger make use of this information (and offer possibilities to send calls directly, etc.).\n\n=== Swagger options\n\n* `schemes` The comma separated list of Swagger schemes: `http` (default), `https`, `ws`, `wss`\n* `renderTags` Enables rendering of Swagger tags (defaults to false, then the default tag will be used)\n* `tagPathOffset` The number at which path position the Swagger tags will be extracted (defaults to 0)\n\n== Contributing\nFeedback, bug reports and ideas for improvement are very welcome! Feel free to fork, comment, file an issue, etc. ;-)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrimmjo%2Fjaxrs-analyzer-gradle-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrimmjo%2Fjaxrs-analyzer-gradle-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrimmjo%2Fjaxrs-analyzer-gradle-plugin/lists"}