{"id":20911782,"url":"https://github.com/catallog/dgeni-jsonschema","last_synced_at":"2026-03-11T03:04:20.208Z","repository":{"id":79844981,"uuid":"82315894","full_name":"catallog/dgeni-jsonschema","owner":"catallog","description":"A Dgeni package for generating JSON Schema from JSDoc documentation in source code","archived":false,"fork":false,"pushed_at":"2017-03-31T12:51:34.000Z","size":19,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-24T00:04:09.494Z","etag":null,"topics":["dgeni","dgeni-package","documentation","jsdoc","json","jsonschema"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/catallog.png","metadata":{"files":{"readme":"README.md","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-02-17T16:26:51.000Z","updated_at":"2025-08-25T16:37:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"fe1bb93f-5e76-42b6-af8a-5d894bbea1f1","html_url":"https://github.com/catallog/dgeni-jsonschema","commit_stats":null,"previous_names":["collabo-br/dgeni-jsonschema"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/catallog/dgeni-jsonschema","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catallog%2Fdgeni-jsonschema","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catallog%2Fdgeni-jsonschema/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catallog%2Fdgeni-jsonschema/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catallog%2Fdgeni-jsonschema/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/catallog","download_url":"https://codeload.github.com/catallog/dgeni-jsonschema/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catallog%2Fdgeni-jsonschema/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30368662,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T21:41:54.280Z","status":"online","status_checked_at":"2026-03-11T02:00:07.027Z","response_time":84,"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":["dgeni","dgeni-package","documentation","jsdoc","json","jsonschema"],"created_at":"2024-11-18T14:23:50.267Z","updated_at":"2026-03-11T03:04:20.190Z","avatar_url":"https://github.com/catallog.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dgeni-jsonschema\nA [Dgeni](https://github.com/angular/dgeni) package for generating [JSON Schema](http://json-schema.org/) from [JSDoc](http://usejsdoc.org/) documentation in source code.\n\n\n# What does this do?\n\nIt uses the JSDoc markup to structure a JSON Schema and then renders it to the file.\nSo, this anippet ...\n\n``` javascript\n/**\n * @name multyParameterComponent\n *\n * @description\n * Here goes this component description\n *\n * @param {string} title - title description\n * @param {int} counter - counter description\n * @param {string} [default-optional=defaultValue] - default-optional description\n * @param {array} list - list description\n * @param {array} [only-optional] - only-optional description\n *\n **/\nconst componentConfig = {\n  bindings: {\n    title: '@',\n    counter: '@',\n    defaultOptional: '@?',\n    list: '\u003c',\n    onlyOptional: '\u003c?'\n  },\n  controller: [ComponentController],\n  templateUrl: templateUrl\n};\n```\n\n... will be rendered as ...\n\n\n```json\n{\n  \"type\": \"object\",\n  \"title\": \"multyParameterComponent\",\n  \"description\": \"Here goes this component description\",\n  \"properties\": {\n    \"title\": {\n      \"type\": \"string\",\n      \"description\": \"title description\"\n    },\n    \"counter\": {\n      \"type\": \"int\",\n      \"description\": \"counter description\"\n    },\n    \"default-optional\": {\n      \"type\": \"string\",\n      \"description\": \"default-optional description\",\n      \"default\": \"defaultValue\"\n    },\n    \"list\": {\n      \"type\": \"array\",\n      \"description\": \"list description\"\n    },\n    \"only-optional\": {\n      \"type\": \"array\",\n      \"description\": \"only-optional description\"\n    }\n  },\n  \"required\": [\n    \"counter\",\n    \"list\",\n    \"title\"\n  ]\n}\n```\n\n# Dgeni configurations\n- [basic_schema/dgeni-conf.js](./tests/basic_schema/dgeni-conf.js)\n\n\n# Todos\n- Generate live example;\n- Provide more configurations samples.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatallog%2Fdgeni-jsonschema","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcatallog%2Fdgeni-jsonschema","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatallog%2Fdgeni-jsonschema/lists"}