Adapter repository file reference
The following table describes all Markdown files provided in an adapter GitLab repository.
| File | Description |
|---|---|
AUTH.md | Steps for authenticating the adapter and bringing it online. See the authentication overview for more information. |
BROKER.md | Information on integrating an adapter with the Itential Platform Device Broker, including descriptions of the calls the Device Broker uses. Integrating with the Device Broker allows devices to appear in and be managed from the Configuration Manager application. Correctly configuring the adapter properties in Itential Platform is critical for the Device Broker integration to work. |
CALLS.md | A summary of the calls the adapter makes available to the rest of Itential Platform, including generic adapter calls, Device Broker calls, adapter cache calls, and adapter-specific calls. This file may initially be generic and lack adapter-specific calls. If you find information missing, create an issue in the adapter’s GitLab repository. |
CHANGELOG.md | A versioned timeline of changes made to the adapter. |
CODE_OF_CONDUCT.md | Itential’s conduct standards for contributing to a project, covering the community pledge, standards, and responsibilities. |
CONTRIBUTING.md | Contributing standards, guidelines, and information for submitting adapter requests. See the adapter contributing guide for more information. |
ENHANCE.md | Instructions for modifying an adapter, including changes to properties, calls, authentication, integration tests, and adding a second instance. |
PROPERTIES.md | Definitions of all service instance configuration properties available for the adapter and what each property controls. See the Itential Platform service instance configuration articles for more information. |
README.md | General information about the adapter, including versioning, installation instructions, testing guidance, and links to other files in the repository. |
SUMMARY.md | An overview of the external system and the APIs used to build the adapter. |
SYSTEMINFO.md | Information about the external system the adapter integrates with and why you might want to integrate with it. Like AUTH.md and CALLS.md, this file is originally generated from the adapter build process and should be updated with system-specific information. |
TROUBLESHOOT.md | Guidance for resolving issues that may arise while using the adapter. |
