theovassiliou / doctrans Goto Github PK

#3 included an update to the openAPI specification of doctrans. This has to be reflected now in all existing artefacts.

.proto
services
etc.

We (@Re-Krass @B4rtware) have modified the already existing OpenAPI specification. Which also introduces some breaking changes. Important changes are:

• in every model the property of the plain text is named document
• a new generic error response was added
• options endpoint which should return a JSON Schema draft 7 valid response of available options of a service:

An example of a valid json schema of available options for a service:

{
    "properties": {
        "offset": {
            "type": "number",
            "minimum": 0,
            "maximum": 26
        },
        "reverse": {
            "type": "boolean"
        }
    }
}

A valid rest request would then be able to use:

{
  "offset": 23,
  "reverse": true
}

Example implementations in various languages can be found here:
https://json-schema.org/implementations.html

We would like to hear your opinion and discuss the schema.

Schema YAML
Schema HTML