← OBPv7.0.0 Get Message Docs as JSON Schema GET /obp/v7.0.0/message-docs/CONNECTOR/json-schema OBPv6.0.0-getMessageDocsJsonSchema No role required Message-DocDocumentationAPI Returns message documentation as JSON Schema format for code generation in any language. This endpoint provides machine-readable schemas instead of just examples, making it ideal for: AI-powered code generation Automatic adapter creation in multiple languages Type-safe client generation with tools like quicktype Supported Connectors: rabbitmq_vOct2024 - RabbitMQ connector message schemas rest_vMar2019 - REST connector message schemas akka_vDec2018 - Akka connector message schemas kafka_vMay2019 - Kafka connector message schemas (if available) Code Generation Examples: Generate Scala code with Circe: curl https://api.../message-docs/rabbitmq_vOct2024/json-schema > schemas.json quicktype -s schema schemas.json -o Messages.scala --framework circe Generate Python code: quicktype -s schema schemas.json -o messages.py --lang python Generate TypeScript code: quicktype -s schema schemas.json -o messages.ts --lang typescript Schema Structure: Each message includes: process - The connector method name (e.g., "obp.getAdapterInfo") description - Human-readable description of what the message does outbound_schema - JSON Schema for request messages (OBP-API -> Adapter) inbound_schema - JSON Schema for response messages (Adapter -> OBP-API) All nested type definitions are included in the definitions section for reuse. Authentication: This endpoint is publicly accessible (no authentication required) to facilitate adapter development. User Authentication is Optional. The User need not be logged in. URL Parameters: CONNECTOR: CONNECTOR JSON response body fields (0) Possible errors (2) OBP-30211: Invalid Connector. Please specify a valid value for CONNECTOR.OBP-50000: Unknown Error.