{"id":18383166,"url":"https://github.com/fugerit-org/yaml-doc-tool","last_synced_at":"2025-08-25T03:33:01.742Z","repository":{"id":95113516,"uuid":"471110771","full_name":"fugerit-org/yaml-doc-tool","owner":"fugerit-org","description":"Documentation tool for yaml (openapi)","archived":false,"fork":false,"pushed_at":"2025-04-18T13:58:45.000Z","size":144,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-21T13:34:13.842Z","etag":null,"topics":["documentation","freemarker","java","openapi","openapi3","snake-yaml","yaml"],"latest_commit_sha":null,"homepage":"https://www.fugerit.org/","language":"Java","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/fugerit-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2022-03-17T19:11:05.000Z","updated_at":"2025-04-18T13:48:05.000Z","dependencies_parsed_at":"2024-10-25T13:29:01.297Z","dependency_job_id":"ee0c3620-cf00-4978-a857-2b4cf9b8eb57","html_url":"https://github.com/fugerit-org/yaml-doc-tool","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/fugerit-org/yaml-doc-tool","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Fyaml-doc-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Fyaml-doc-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Fyaml-doc-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Fyaml-doc-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fugerit-org","download_url":"https://codeload.github.com/fugerit-org/yaml-doc-tool/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Fyaml-doc-tool/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272003719,"owners_count":24856775,"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-08-25T02:00:12.092Z","response_time":1107,"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":["documentation","freemarker","java","openapi","openapi3","snake-yaml","yaml"],"created_at":"2024-11-06T01:10:23.378Z","updated_at":"2025-08-25T03:33:01.733Z","avatar_url":"https://github.com/fugerit-org.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# yaml-doc-tool\n\n\u003e ⚠️ **Warning:** As of 2025-07-27 this repository is archived and substituted by [openapi-doc-tool](https://github.com/fugerit-org/openapi-doc-tool) (see [fugerit-org/openapi-doc-tool#1](https://github.com/fugerit-org/openapi-doc-tool/issues/1)).\n\nTool for auto documentation of yaml / openapi\n\n[![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](CHANGELOG.md) \n[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/yaml-doc-tool.svg)](https://mvnrepository.com/artifact/org.fugerit.java/yaml-doc-tool)\n[![license](https://img.shields.io/badge/License-Apache%20License%202.0-teal.svg)](https://opensource.org/licenses/Apache-2.0)\n[![code of conduct](https://img.shields.io/badge/conduct-Contributor%20Covenant-purple.svg)](https://github.com/fugerit-org/fj-universe/blob/main/CODE_OF_CONDUCT.md)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_yaml-doc-tool\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_yaml-doc-tool)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_yaml-doc-tool\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=fugerit-org_yaml-doc-tool)\n\n[![Java runtime version](https://img.shields.io/badge/run%20on-java%208+-%23113366.svg?style=for-the-badge\u0026logo=openjdk\u0026logoColor=white)](https://universe.fugerit.org/src/docs/versions/java11.html)\n[![Java build version](https://img.shields.io/badge/build%20on-java%2011+-%23ED8B00.svg?style=for-the-badge\u0026logo=openjdk\u0026logoColor=white)](https://universe.fugerit.org/src/docs/versions/java11.html)\n[![Apache Maven](https://img.shields.io/badge/Apache%20Maven-3.9.0+-C71A36?style=for-the-badge\u0026logo=Apache%20Maven\u0026logoColor=white)](https://universe.fugerit.org/src/docs/versions/maven3_9.html)\n\n## Quickstart (build)\n\n```\nmvn clean install -P singlepackage\t\t\n```\n\n## Quickstart (mode: single):\n\n```\njava -jar dist-yaml-doc-tool-*.jar --input-yaml [path-to-openapi] \\\n\t\t\t\t\t\t\t\t\t\t--output-file [output-file] \\\n\t\t\t\t\t\t\t\t\t\t--language [language] \\\n\t\t\t\t\t\t\t\t\t\t--labels-override [path-to-labels-properties]\n```\n\t\t\t\t\t\t\t\t\t\t\n**example :**  \n\n```\njava -jar dist-yaml-doc-tool-*.jar --input-yaml sample.yaml --output-file sample.pdf --language it\n```\n\n**output-file**   \ncurrently supported extensions : pdf, xlsx, xml, fo\n\n**language**  \ncurrently supported languages : it, en\n\n**labels-overrides**   \npath to alternate labels properties\ncurrently supported labels are available in : src/main/resources/lang/label.properties\n\n**maven plugin**  \nA [Maven Plugin](https://github.com/fugerit-org/yaml-doc-maven-plugin) is also available.\n\n\n## Quickstart (mode: config):\n\n```\njava -jar dist-yaml-doc-tool-*.jar \t\t--mode [config] \\\n\t\t\t\t\t\t\t\t\t\t--config-path [path-to-config] \\\n\t\t\t\t\t\t\t\t\t\t--id-catalog [id-catalog-in-config]\n```\n\n**config-path**   \npath to configuration (see [sample](src/test/resources/yaml-doc-config.xml))\n\n**id-catalog**   \nid of the catalog in config to use\n\n\n## Quickstart (mode: check-model):\n\nNode : the type to check need to be in classpath.\n\n```\njava -jar dist-yaml-doc-tool-*.jar \t\t--mode [check-model] \\\n\t\t\t\t\t\t\t\t\t\t--input-yaml [path-to-openapi] \\\n\t\t\t\t\t\t\t\t\t\t--output-file [output-file] \\\n\t\t\t\t\t\t\t\t\t\t--check-type [java type to check] \\\n\t\t\t\t\t\t\t\t\t\t--check-schema [openapi schema to check]\n\t\t\t\t\t\t\t\t\t\t--version [model-version]\n```\n\n## Model version info (param \"version\")\n\n### Version 0 - legacy version (up to 1.0.0 excluded)\n\n### Version 1\n\nhandling handling of constraints [OpenAPI data types](https://swagger.io/docs/specification/data-models/data-types/)\n - minLength\n - maxLength\n - minimum\n - maximum \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffugerit-org%2Fyaml-doc-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffugerit-org%2Fyaml-doc-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffugerit-org%2Fyaml-doc-tool/lists"}