{"id":19777453,"url":"https://github.com/ilib-js/ilib-loctool-openapi","last_synced_at":"2025-02-28T05:50:35.515Z","repository":{"id":42126078,"uuid":"362881919","full_name":"iLib-js/ilib-loctool-openapi","owner":"iLib-js","description":"A plugin to localize openapi.json files using both the json and markdown plugins","archived":false,"fork":false,"pushed_at":"2024-01-11T17:05:01.000Z","size":51,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-11T02:04:22.154Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/iLib-js.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}},"created_at":"2021-04-29T16:34:31.000Z","updated_at":"2022-04-12T14:42:56.000Z","dependencies_parsed_at":"2024-01-11T01:30:20.672Z","dependency_job_id":null,"html_url":"https://github.com/iLib-js/ilib-loctool-openapi","commit_stats":{"total_commits":31,"total_committers":3,"mean_commits":"10.333333333333334","dds":0.4516129032258065,"last_synced_commit":"3e69bb96077f768820056638643df17cbeadb980"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iLib-js%2Filib-loctool-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iLib-js%2Filib-loctool-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iLib-js%2Filib-loctool-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iLib-js%2Filib-loctool-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iLib-js","download_url":"https://codeload.github.com/iLib-js/ilib-loctool-openapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241107734,"owners_count":19910975,"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","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":[],"created_at":"2024-11-12T05:24:56.381Z","updated_at":"2025-02-28T05:50:35.488Z","avatar_url":"https://github.com/iLib-js.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ilib-loctool-openapi\n\nIlib loctool plugin to parse and localize OpenAPI json files.\n\nThis plugin can parse and localize openapi.json files by using\neither default OpenAPI schema bundled with the plugin,\nor custom schema.\n\n## Configuration\n\nInternally, this plugin uses two other loctool plugins:\n[ilib-loctool-json](https://github.com/iLib-js/ilib-loctool-json)\nand\n[ilib-loctool-ghfm](https://github.com/iLib-js/ilib-loctool-ghfm)\n\nOpenAPI plugin configuration is identical to\n[JSON plugin's config](https://github.com/iLib-js/ilib-loctool-json#configuring-the-plugin).\nThe only difference is `openapi` key used instead of `json`\nin `settings` section.\n\nIn order to use built-in OpenAPI schema use `openapi-schema`\nschema id in mappings section.\n\nExample configuration:\n\n```json\n{\n    \"settings\": {\n        \"openapi\": {\n            \"schemas\": [\n                \"./schemas\"\n            ],\n            \"mappings\": {\n                \"**/openapi.json\": {\n                    \"schema\": \"openapi-schema\",\n                    \"method\": \"copy\",\n                    \"template\": \"resources/[localeDir]/appinfo.json\"\n                },\n                \"**/custom-openapi.json\": {\n                    \"schema\": \"custom-schema\",\n                    \"method\": \"copy\",\n                    \"template\": \"[dir]/strings.[locale].json\"\n                }\n            }\n        }\n    }\n}\n```\n\nIn the example above file `openapi.json` will be parsed using\nbuilt-in schema and `custom-openapi.json` using custom schema\nfrom `./schemas` folder.\n\n## License\n\nThis plugin is license under Apache2. See the [LICENSE](./LICENSE)\nfile for more details.\n\n## Release Notes\n\n### v1.0.7\n\n- update dependencies\n- convert all unit tests from nodeunit to jest\n\n### v1.0.6\n\n- update dependencies\n\n### v1.0.5\n\n- added more explicit logging so that it is easier to debug loctool\n  problems.\n- now uses the loctool logger via the API instead of its own logging\n\n### v1.0.4\n\n- fixed a problem with paths that contain \".\" or \"..\" dir not being\n  recognized as handled by this plugin\n- Update dependencies\n- minimum node version is now v10\n\n### v1.0.3\n- Add missing `tags` section to the defaults schema\n\n### v1.0.2\n\n- Add schema.json to bundled files in order to be available at NPM\n\n### v1.0.1\n\n- Fix errors while loading default schema, relative path was replaced\nwith an absolute.\n\n### v1.0.0\n\n- initial version\n- includes default schema for OpenAPI files parsing\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filib-js%2Filib-loctool-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Filib-js%2Filib-loctool-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filib-js%2Filib-loctool-openapi/lists"}