PandelisZ / algoliasearch-client-specs

:mag: Algolia Search API Client Specifications & Common Test Suite

The perfect starting point to implement a new Algolia API client in your language of choice

Documentation • Community Forum • Stack Overflow • Report a bug • Support

✨ Summary

This repository serves as a technical documentation of the public API of the Algolia API Clients. It covers both the public API (methods, functions, etc.), their test coverage and implementation details.

The goal of this repository is to expose a common and consistent implementation across all our official API clients:

• algolia/algoliasearch-client-csharp
• algolia/algoliasearch-client-go
• algolia/algoliasearch-client-java-2 (compatible with Java 1.8 and above)
• algolia/algoliasearch-client-java (compatible with Java 1.7 and below)
• algolia/algoliasearch-client-javascript
• algolia/algoliasearch-client-kotlin
• algolia/algoliasearch-client-php
• algolia/algoliasearch-client-python
• algolia/algoliasearch-client-ruby
• algolia/algoliasearch-client-scala

📦 What's included

• 📜 Public API Specifications (Specs)
• ✅ Common Test Suite (CTS)
• 🛠 Implementation Details (Internals)