{"id":36822885,"url":"https://github.com/hoereth/springfox-enum-plugin","last_synced_at":"2026-01-12T14:01:56.300Z","repository":{"id":57730820,"uuid":"154529705","full_name":"hoereth/springfox-enum-plugin","owner":"hoereth","description":"✏️ Annotate your enums and have this Springfox-plugin automatically enhance your Swagger documents with it.","archived":false,"fork":false,"pushed_at":"2022-12-10T03:28:02.000Z","size":74,"stargazers_count":42,"open_issues_count":4,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-04T19:20:40.373Z","etag":null,"topics":["spring","springfox","swagger"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hoereth.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}},"created_at":"2018-10-24T16:01:31.000Z","updated_at":"2025-04-09T08:29:05.000Z","dependencies_parsed_at":"2023-01-25T19:50:11.223Z","dependency_job_id":null,"html_url":"https://github.com/hoereth/springfox-enum-plugin","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/hoereth/springfox-enum-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoereth%2Fspringfox-enum-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoereth%2Fspringfox-enum-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoereth%2Fspringfox-enum-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoereth%2Fspringfox-enum-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hoereth","download_url":"https://codeload.github.com/hoereth/springfox-enum-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoereth%2Fspringfox-enum-plugin/sbom","scorecard":{"id":467377,"data":{"date":"2025-08-11","repo":{"name":"github.com/hoereth/springfox-enum-plugin","commit":"c84d9df5a0fb3991672f830591c19373a57678a3"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"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":"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":"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 2/26 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":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"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/maven.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/hoereth/springfox-enum-plugin/maven.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/maven.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/hoereth/springfox-enum-plugin/maven.yml/master?enable=pin","Info:   0 out of   2 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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/maven.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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: 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":"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":"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 7 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"}},{"name":"Vulnerabilities","score":0,"reason":"12 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v2xm-76pq-phcf","Warn: Project is vulnerable to: GHSA-36p3-wjmg-h94x","Warn: Project is vulnerable to: GHSA-hh26-6xwr-ggv7","Warn: Project is vulnerable to: GHSA-4gc7-5j7h-4qph","Warn: Project is vulnerable to: GHSA-4wp7-92pw-q264","Warn: Project is vulnerable to: GHSA-g5mm-vmx4-3rg7","Warn: Project is vulnerable to: GHSA-6gf2-pvqw-37ph","Warn: Project is vulnerable to: GHSA-rfmp-97jj-h8m6","Warn: Project is vulnerable to: GHSA-558x-2xjg-6232","Warn: Project is vulnerable to: GHSA-564r-hj7v-mcr5","Warn: Project is vulnerable to: GHSA-9cmq-m9j5-mvww","Warn: Project is vulnerable to: GHSA-wxqc-pxw9-g2p8"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T12:53:04.591Z","repository_id":57730820,"created_at":"2025-08-19T12:53:04.591Z","updated_at":"2025-08-19T12:53:04.591Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28340223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T12:22:26.515Z","status":"ssl_error","status_checked_at":"2026-01-12T12:22:10.856Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":["spring","springfox","swagger"],"created_at":"2026-01-12T14:01:53.270Z","updated_at":"2026-01-12T14:01:56.158Z","avatar_url":"https://github.com/hoereth.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ✏️ springfox-enum-plugin\n\nOpenAPI / Swagger / Springfox provide no way of documenting enumerations in a structured way (as of [OpenAPI 3.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md)). This Springfox plugin introduces the [@ApiEnum](src/main/java/de/pentabyte/springfox/ApiEnum.java) annotation to automate the current suggestion: _\"If you need to specify descriptions for enum items, you can do this in the description of the parameter or property\"_ ([swagger.io](https://swagger.io/docs/specification/data-models/enums/)).\n\n## Compatibility with Springfox\n\nSpringfox **2.x** \u003c-\u003e springfox-enum-plugin **1.x**.\n\nSpringfox **3.x** \u003c-\u003e springfox-enum-plugin **3.x**.\n\n## Maven Coordinates\n\n```xml\n\u003c!-- https://mvnrepository.com/artifact/de.pentabyte/springfox-enum-plugin --\u003e\n\u003cdependency\u003e\n    \u003cgroupId\u003ede.pentabyte\u003c/groupId\u003e\n    \u003cartifactId\u003espringfox-enum-plugin\u003c/artifactId\u003e\n    \u003cversion\u003e3.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Usage\n\nMake your Spring application use this component: [ApiEnumDescriptionPlugin](src/main/java/de/pentabyte/springfox/ApiEnumDescriptionPlugin.java). Example:\n\n```java\n@Configuration\n@Import(ApiEnumDescriptionPlugin.class) // add this line\npublic void MySpringConfiguration {\n\t...\n}\n```\n\nThe plugin automatically registers with Springfox and will process these proprietary [@ApiEnum](src/main/java/de/pentabyte/springfox/ApiEnum.java) annotations:\n\n```java\npublic enum SomeEnum {\n\t/**\n\t * Java Doc comment\n\t */\n\t@ApiEnum(\"First Option\")\n\tA, //\n\t@ApiEnum(\"Second Option\")\n\tB, //\n\tC\n}\n```\n\nThen - whenever such an enumeration is used in combination with _@ApiModelProperty_ property or _@ApiParam_, the plugin will extend the standard description. Examples:\n\n```java\n@Getter\n@Setter\n...\n@ApiModelProperty(\"Some description.\")\nSomeEnum attribute;\n\n@ApiModelProperty(value = \"Some description.\", dataType = \"org.example.SomeEnum\")\nInteger attribute2;\n\npublic void someMethod(@ApiParam(\"Some description.\") SomeEnum param) { ... }\n```\n\nIt effectively produces this description in markdown syntax for _attribute_, _attribute2_ and _param_. It will not touch the description if none of the enums are annotated, though.\n\n```\nSome description.\n* A: First option\n* B: Second option\n* C: _@ApiEnum annotation not available_\n```\n\n### Custom Enum Names\n\nThe plugin will also pick up Jackson's custom mapping of enum names like this one:\n\n```java\npublic enum SomeEnumWithJsonValueAnnotation {\n    @ApiEnum(\"A One\")\n    A_1, //\n    @ApiEnum(\"B Two\")\n    B_2;\n\n    @com.fasterxml.jackson.annotation.JsonValue\n    /**\n     * A_1 and B_2 will be mapped to a-1 and b-2.\n     */\n    public String toJson() {\n        return name().toLowerCase().replace('_', '-');\n    }\n}\n```\n\n## Outlook\n\nIt seems obvious that this a temporary solution. Once the OpenAPI specs provide a relevant new feature for handling enumerations, it should be fairly simple to drop the usage of this plugin and replace all [@ApiEnum](src/main/java/de/pentabyte/springfox/ApiEnum.java) annotations with their future counterparts.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoereth%2Fspringfox-enum-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhoereth%2Fspringfox-enum-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoereth%2Fspringfox-enum-plugin/lists"}