The OpenDXL API Specification defines a standard interface description for applications which connect to the McAfee Data Exchange Layer (DXL) messaging fabric. The specification provides a mechanism for describing the API for DXL-based solutions, including:
- Services that solutions register with a DXL fabric.
- Events that solutions send to a DXL fabric.
- Requests which can be made to a service through a DXL fabric (and the corresponding responses that the service produces).
The OpenDXL API Specification is heavily inspired by the work done in the OpenAPI Specification to describe REST APIs. Where possible, schema definitions in the OpenDXL API Specification utilize corresponding definitions in the OpenAPI Specification. For example, the core Schema Object from the OpenAPI Specification is used by the OpenDXL API Specification to define the payload for a DXL message.
The draft version of the OpenDXL API Specification is OpenDXL API Specification 0.1.
JSON Schema documents which can be used for syntactic validation of an OpenDXL API document reside in the schemas directory. The schema for the latest specification version is here.
Current OpenDXL API document examples include:
- ACME [json] [yaml] - Simple example which utilizes each of the major schema components to describe an API - solutions, services, requests, and events.
Copyright 2018 McAfee, LLC
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.