DEVELOPER_GUIDE.md

• Developer Guide
  • Prerequisites
  • Install Docker Image
  • Running Tests
  • Client Code Generator

Developer Guide

Prerequisites

The .NET 6.0 SDK is required:

$ dotnet --list-sdks
6.0.xxx

Running Tests

The integration tests will download opensearch and run a local cluster for you. To run the full suite of tests, all you need to do is call the below script.

.\build.bat

build.sh

Client Code Generator

OpenSearch publishes an OpenAPI specification in the opensearch-api-specification repository, which is used to auto-generate the less interesting parts of the client.

./build.sh codegen --branch main

or

./build.bat codegen --branch main