LIBCAS / DL4DH-Kramerius-plus

DL4DH Kramerius +
0 stars 1 forks source link

Povinný parametr jobType pro ExportJobConfigDto a EnrichmentJobConfigDto v OpenAPI #69

Open daliboris opened 11 months ago

daliboris commented 11 months ago

Aktuální definice OpenAPI obsahuje diskriminátory typu jobType v objektech ExportJobConfigDto a EnrichmentJobConfigDto.

Podle specifikace musí být takový diskriminátor zároveň uveden jako povinná vlastnost objektu, tj. v rámci vlastnosti required, což nyní není.

"ExportJobConfigDto": {
        "type": "object",
        "properties": {
          "id": {"type": "string"},
          "params": {"$ref": "#/components/schemas/ParamsDto"},
          "exportFormat": {
            "type": "string",
            "enum": [
              "JSON",
              "TEI",
              "CSV",
              "ALTO",
              "TEXT"
            ]
          },
          "jobType": {
            "type": "string",
            "enum": [
              "CREATE_ENRICHMENT_REQUEST",
              "CREATE_EXPORT_REQUEST",
              "ENRICHMENT_EXTERNAL",
              "ENRICHMENT_NDK",
              "ENRICHMENT_TEI",
              "EXPORT_ALTO",
              "EXPORT_TEXT",
              "EXPORT_CSV",
              "EXPORT_JSON",
              "EXPORT_TEI",
              "MERGE_JOB"
            ]
          }
        },
        "discriminator": {"propertyName": "jobType"}
      }

Viz ukázka ze specifikace.

"Pet": {
    "type": "object",
    "discriminator": {
      "propertyName": "petType"
    },
    "properties": {
      "name": {
        "type": "string"
      },
      "petType": {
        "type": "string"
      }
    },
    "required": [
      "name",
      "petType"
    ]
  }