Integrations
Add New Integrations
Guidelines for contributing new integrations to Julep
Overview
This guide provides instructions for contributing new integrations to the Julep platform. Follow these steps to ensure your integration is successfully added to the project.
Steps to Contribute
-
Add a New Integration Provider:
- Add the provider name to the
integrationProvider
alias intypespec/tools/models.tsp
. - Create a new file in
typespec/tools/
with the provider name. Refer to existing files for examples.
- Add the provider name to the
-
Generate OpenAPI Schema and Pydantic Models:
- Run
./scripts/generate_openapi_code.sh
from the root directory to generate the necessary files.
- Run
-
Implement Integration Logic:
- Add the integration logic in
integration-service/integrations/utils/integrations
.
- Add the integration logic in
-
Register the Provider:
- Add the provider to the
available_providers
dictionary inintegrations-service/integrations/providers.py
.
- Add the provider to the
Additional Resources
- CONTRIBUTING.md for more detailed instructions.