aklivity / zilla-docs

0 stars 10 forks source link

Update schema checker and reference properties #248

Closed vordimous closed 5 days ago

vordimous commented 1 month ago

The auto schema checking script needs to be updated for the new changes to the schema definitions and used to determine correctness in the reference section of the docs.

PR for changes to zilla: https://github.com/aklivity/zilla/pull/1217

Current updates needed:

binding asyncapi add [
  'asyncapi.routes',
  'asyncapi.vault',
  'connect.password',
  'connect.username',
  'credentials.connect',
  'kafka.sasl',
  'mqtt.authorization',
  'options.kafka',
  'options.mqtt',
  'options.mqtt-kafka',
  'sasl.mechanism',
  'sasl.password',
  'sasl.username',
  'servers[].host',
  'servers[].pathname',
  'servers[].url',
  'tcp.host'
]
binding asyncapi remove [
  'asyncapi.mqtt-kafka',
  'servers.host',
  'servers.pathname',
  'servers.url',
  'tpc.host'
]
binding http add [
  'content.model',
  'content.model',
  'options.requests',
  'params.path',
  'params.query',
  'requests[].content',
  'requests[].content-type',
  'requests[].headers',
  'requests[].method',
  'requests[].params',
  'requests[].path',
  'requests[].responses',
  'responses[].content',
  'responses[].content-type',
  'responses[].headers',
  'responses[].status'
]
binding http-kafka remove [
  'merge.content-type',
  'patch.initial',
  'patch.path'
]
binding kafka add [
  'key.model',
  'value.model'
]
binding kafka remove [ 'topics[].defaultOffset' ]
binding mqtt add [
  'content.model',
  'topics[].user-properties'
]
binding mqtt remove [
  'publish[].topic',
  'session[].client-id',
  'subscribe[].topic'
]
binding mqtt-kafka add [
  'options.publish',
  'publish.qosMax'
]
binding openapi add [
  'openapi.routes',
  'openapi.vault',
  'servers[].url'
]
binding openapi remove [ 'servers.url' ]
binding proxy add [
  'when[].info',
  'info.alpn',
  'info.authority',
  'info.identity',
  'info.namespace',
  'info.secure',
  'proxy.catalog',
  'secure.cipher',
  'secure.key',
  'secure.name',
  'secure.signature',
  'secure.version'
]
binding sse add [
  'content.model',
  'options.requests',
  'requests[].content',
  'requests[].path',
]
catalog schema-registry add [ 'options.max-age' ]
exporter otlp add [
  'endpoint.overrides',
  'endpoint.protocol: http',
  'overrides.logs',
  'overrides.metrics'
]
exporter otlp remove [ 'endpoint.protocol' ]
binding grpc remove [ 'options.services' ]