Sign in
System

Fetch the OpenAPI specification as JSON

Changed on

Returns this specification as a self-contained JSON document, with every reference resolved. It is generated from the same document the server validates requests against, so a client generated from it cannot describe a different API than the one that answers.

No credential is required: a client generator fetches this by URL before its user has a token, and every path here is already published in the API reference.

The response carries a strong ETag; send it back as If-None-Match to get 304 Not Modified instead of the whole document.

get/openapi.json

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/openapi.json
  • Auth: none required

Headers

If-None-Matchstring

Entity tag from an earlier response, returning 304 Not Modified while it still matches. Accepts the full condition: *, a comma-separated list, and weak tags of the form W/"tag".

Response

The OpenAPI specification

OpenAPISpecDocument required

This OpenAPI document, with every reference resolved. Shared by the JSON and YAML operations, which differ only in serialization.

Changes