OVoverheid
Tools

Generate OpenAPI

Changed on

Genereert een boilerplate OpenAPI specificatie op basis van JSON-invoer. Body: { oasUrl } of { oasBody } (stringified JSON).

post/v1/oas/generate

Request

  • Base URL
    https://api.developer.overheid.nl/tools/v1
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Client credentials
      Token URL: https://auth.developer.overheid.nl/realms/don/protocol/openid-connect/token

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

OK

object required

Changes

  • f9481ba67e7eRevision changes
    • info

      the endpoint scheme security apiKey was added to the API

    • info

      the endpoint scheme security clientCredentials was added to the API

    • info

      the endpoint scheme security apiKey AND clientCredentials was removed from the API