https://github.com/ilib-js/ilib-loctool-openapi

A plugin to localize openapi.json files using both the json and markdown plugins
https://github.com/ilib-js/ilib-loctool-openapi

Last synced: 3 days ago
JSON representation

A plugin to localize openapi.json files using both the json and markdown plugins

• Host: GitHub
• URL: https://github.com/ilib-js/ilib-loctool-openapi
• Owner: iLib-js
• License: apache-2.0
• Created: 2021-04-29T16:34:31.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-11T17:05:01.000Z (10 months ago)
• Last Synced: 2024-11-06T15:17:18.329Z (9 days ago)
• Language: JavaScript
• Size: 49.8 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ilib-loctool-openapi

Ilib loctool plugin to parse and localize OpenAPI json files.

This plugin can parse and localize openapi.json files by using

either default OpenAPI schema bundled with the plugin,

or custom schema.

## Configuration

Internally, this plugin uses two other loctool plugins:

[ilib-loctool-json](https://github.com/iLib-js/ilib-loctool-json)

and

[ilib-loctool-ghfm](https://github.com/iLib-js/ilib-loctool-ghfm)

OpenAPI plugin configuration is identical to

[JSON plugin's config](https://github.com/iLib-js/ilib-loctool-json#configuring-the-plugin).

The only difference is `openapi` key used instead of `json`

in `settings` section.

In order to use built-in OpenAPI schema use `openapi-schema`

schema id in mappings section.

Example configuration:

```json

{

    "settings": {

        "openapi": {

            "schemas": [

                "./schemas"

            ],

            "mappings": {

                "**/openapi.json": {

                    "schema": "openapi-schema",

                    "method": "copy",

                    "template": "resources/[localeDir]/appinfo.json"

                },

                "**/custom-openapi.json": {

                    "schema": "custom-schema",

                    "method": "copy",

                    "template": "[dir]/strings.[locale].json"

                }

            }

        }

    }

}

```

In the example above file `openapi.json` will be parsed using

built-in schema and `custom-openapi.json` using custom schema

from `./schemas` folder.

## License

This plugin is license under Apache2. See the [LICENSE](./LICENSE)

file for more details.

## Release Notes

### v1.0.7

- update dependencies

- convert all unit tests from nodeunit to jest

### v1.0.6

- update dependencies

### v1.0.5

- added more explicit logging so that it is easier to debug loctool

  problems.

- now uses the loctool logger via the API instead of its own logging

### v1.0.4

- fixed a problem with paths that contain "." or ".." dir not being

  recognized as handled by this plugin

- Update dependencies

- minimum node version is now v10

### v1.0.3

- Add missing `tags` section to the defaults schema

### v1.0.2

- Add schema.json to bundled files in order to be available at NPM

### v1.0.1

- Fix errors while loading default schema, relative path was replaced

with an absolute.

### v1.0.0

- initial version

- includes default schema for OpenAPI files parsing