v1

latestOpenAPI 3.0.12026-07-138613.5 KB

Tools

Validate OpenAPI (POST)

Valideert een OpenAPI specificatie met de DON ADR ruleset. Standaard wordt ruleset 2.1 gebruikt; geef targetVersion "2.0" of "2.1" mee om een versie te kiezen. Body: { oasUrl } of { oasBody } (stringified JSON of YAML).

post/v1/oas/validate

Request body

oasBodystring

oasUrlstring

targetVersionstring

Doelversie. Voor conversie: 3.0 of 3.1. Voor validatie: 2.0 of 2.1.

Example request

{
  "oasUrl": "oasUrl",
  "oasBody": "oasBody",
  "targetVersion": "3.1"
}

Response

apiIdstring

createdAtstring date-time

failuresinteger

idstring

scoreinteger

successesboolean

rulesetVersionstring

De gebruikte ruleset-versie voor validatie.

Example response

{
  "createdAt": "2000-01-23T04:56:07.000Z",
  "score": 6,
  "failures": 0,
  "successes": true,
  "rulesetVersion": "2.1",
  "messages": [
    {
      "severity": "severity",
      "createdAt": "2000-01-23T04:56:07.000Z",
      "code": "code",
      "id": "id",
      "infos": [
        {
          "path": "path",
          "lintMessageId": "lintMessageId",
          "id": "id",
          "message": "message"
        },
        {
          "path": "path",
          "lintMessageId": "lintMessageId",
          "id": "id",
          "message": "message"
        }
      ]
    },
    {
      "severity": "severity",
      "createdAt": "2000-01-23T04:56:07.000Z",
      "code": "code",
      "id": "id",
      "infos": [
        {
          "path": "path",
          "lintMessageId": "lintMessageId",
          "id": "id",
          "message": "message"
        },
        {
          "path": "path",
          "lintMessageId": "lintMessageId",
          "id": "id",
          "message": "message"
        }
      ]
    }
  ],
  "id": "id",
  "apiId": "apiId"
}