# OpenAPI

> API reference files localization

URL: https://store.crowdin.com/openapi
Category: File Formats, Development
Type: App
Author: Crowdin

OpenAPI / Swagger files translation in Crowdin. Both YML and JSON formats are supported. The plugin has been tested with all major and widely used versions of the specification.

## File Format Details

| Attribute | Value |
| --------- | ----- |
| File Extension | .json, .yml, .yaml |
| [API Type](https://developer.crowdin.com/api/v2/#operation/api.projects.files.post) | openapi |
| Source can be edited in Crowdin | No |
| Generating translated files via [Bundles](https://support.crowdin.com/bundles/) | [Search Crowdin Store](https://store.crowdin.com/tags/string-exporter) |
| Supports pluralization | No |
| WYSIWYG Preview in the editor | Yes |
| Supported types of contextual information | WYSIWYG |
| Custom attributes | No |
| Existing translations import possibility | Key-value mapping (trivial) |

## Sample File

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Non-oAuth Scopes example",
    "version": "1.0.0"
  },
  "paths": {
    "/users": {
      "get": {
        "security": [
          {
            "bearerAuth": [
              "read:users",
              "public"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "jwt",
        "description": "note: non-oauth scopes are not defined at the securityScheme level"
      }
    }
  }
}
```

## Translating OpenAPI


Note: YAML files will lose comments in translated files. Formatting will not be preserved either. This will not influence files rendering, your API documentation will look as original with just texts translated.