Skip to content

OpenAPI Metadata Note

The openapi target emits openapi.json for HTTP-oriented interfaces.

Generate OpenAPI

xidlc --lang openapi --out-dir generated api.idl

Metadata pragmas

The current OpenAPI generator reads the following #pragma xidlc values:

#pragma xidlc package "Smart City Public APIs"
#pragma xidlc version "v2.0.0"

Effects:

  • package sets info.title
  • version sets info.version

If omitted, the generator falls back to default metadata values.