Skip to content

Commit aeb7b3a

Browse files
shortcutsshortcuts
authored
docs: remove clients documentation (#3526)
1 parent 9c2efc9 commit aeb7b3a

File tree

66 files changed

+138
-3393
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+138
-3393
lines changed

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Welcome to the contributing guide for the api-clients-automation repository!
44

5-
Please read [our contributing guides](https://api-clients-automation.netlify.app/docs/contributing/introduction/) for advanced usage.
5+
Please read [our contributing guides](https://api-clients-automation.netlify.app/docs/introduction/) for advanced usage.
66

77
If you can't find what you are looking for, please [open an issue](https://github.com/algolia/api-clients-automation/issues/new/choose).
88

‎README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ The Algolia API clients are generated from [OpenAPI specs](https://swagger.io/sp
1717

1818
**Migration note from current API clients**
1919

20-
> In July 2022, we released an alpha version generated API clients for the JavaScript, Java and PHP languages. If you are using the latest stable of those clients and looking to upgrade, read the [migration guide](https://api-clients-automation.netlify.app/docs/clients/migration-guides/). You can still browse the documentation of the stable clients on [the Algolia documentation](https://www.algolia.com/doc/).
20+
> In July 2022, we released an alpha version generated API clients for the JavaScript, Java and PHP languages. If you are using the latest stable of those clients and looking to upgrade, read the [migration guide](https://www.algolia.com/doc/libraries/). You can still browse the documentation of the stable clients on [the Algolia documentation](https://www.algolia.com/doc/).
2121
2222
## 💡 Getting Started with the clients
2323

24-
You can read `getting started` guides and how to use the API clients on [our documentation](https://api-clients-automation.netlify.app/docs/clients/installation).
24+
You can read `getting started` guides and how to use the API clients on [our documentation](https://www.algolia.com/doc/libraries/).
2525

2626
## ✨ Contributing
2727

28-
> Looking to add a new client, or fix a bug? Make sure to take a look at [our contribution guides](https://api-clients-automation.netlify.app/docs/contributing/introduction).
28+
> Looking to add a new client, or fix a bug? Make sure to take a look at [our contribution guides](https://api-clients-automation.netlify.app/docs/introduction).
2929
3030
### Setup repository tooling
3131

@@ -41,31 +41,31 @@ nvm use && yarn
4141
yarn docker:setup
4242
```
4343

44-
[Read more on our documentation](https://api-clients-automation.netlify.app/docs/contributing/setup-repository)
44+
[Read more on our documentation](https://api-clients-automation.netlify.app/docs/setup-repository)
4545

4646
### CLI
4747

4848
The CLI allows you to make changes locally and run commands through the docker container.
4949

50-
- [Specs CLI commands](https://api-clients-automation.netlify.app/docs/contributing/CLI/specs-commands)
51-
- [Clients CLI commands](https://api-clients-automation.netlify.app/docs/contributing/CLI/clients-commands)
52-
- [CTS CLI commands](https://api-clients-automation.netlify.app/docs/contributing/CLI/cts-commands)
50+
- [Specs CLI commands](https://api-clients-automation.netlify.app/docs/CLI/specs-commands)
51+
- [Clients CLI commands](https://api-clients-automation.netlify.app/docs/CLI/clients-commands)
52+
- [CTS CLI commands](https://api-clients-automation.netlify.app/docs/CLI/cts-commands)
5353

5454
### Guides and requirements
5555

5656
Read the guides and requirements to:
5757

58-
- [Add a new client](https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client)
59-
- [Add a new language](https://api-clients-automation.netlify.app/docs/contributing/add-new-api-language)
58+
- [Add a new client](https://api-clients-automation.netlify.app/docs/add-new-api-client)
59+
- [Add a new language](https://api-clients-automation.netlify.app/docs/add-new-api-language)
6060

6161
### Tests
6262

6363
Test the generated clients by running:
6464

65-
- The [`playground`](./playground) (see [documentation](https://api-clients-automation.netlify.app/docs/contributing/testing/playground))
66-
- The [`Common Test Suite`](./tests/) (see [documentation](https://api-clients-automation.netlify.app/docs/contributing/testing/common-test-suite)).
65+
- The [`playground`](./playground) (see [documentation](https://api-clients-automation.netlify.app/docs/testing/playground))
66+
- The [`Common Test Suite`](./tests/) (see [documentation](https://api-clients-automation.netlify.app/docs/testing/common-test-suite)).
6767

68-
For full documentation, visit the **[online documentation](https://api-clients-automation.netlify.app/docs/contributing/introduction)**.
68+
For full documentation, visit the **[online documentation](https://api-clients-automation.netlify.app/docs/introduction)**.
6969

7070
## ❓ Troubleshooting
7171

‎clients/algoliasearch-client-csharp/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</p>
1313

1414
<p align="center">
15-
<a href="https://api-clients-automation.netlify.app/docs/clients/csharp/" target="_blank">Documentation</a> •
15+
<a href="https://www.algolia.com/doc/libraries/csharp/v7/" target="_blank">Documentation</a> •
1616
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
1717
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
1818
<a href="https://github.com/algolia/algoliasearch-client-csharp/issues" target="_blank">Report a bug</a> •
@@ -98,7 +98,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
9898

9999
## Contributing
100100

101-
This repository hosts the code of the generated Algolia API client for CSharp, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
101+
This repository hosts the code of the generated Algolia API client for CSharp, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
102102

103103
## 📄 License
104104

‎clients/algoliasearch-client-csharp/algoliasearch/Utils/SearchClientExtensions.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ private static async Task<T> RetryUntil<T>(Func<Task<T>> func, Func<T, bool> val
410410
/// Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are untouched.
411411
/// Replace all objects in an index without any downtime. Internally, this method copies the existing index settings, synonyms and query rules and indexes all passed objects.
412412
/// Finally, the temporary one replaces the existing index. (Synchronous version)
413-
/// See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
413+
/// See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
414414
/// </summary>
415415
/// <param name="indexName">The index in which to perform the request.</param>
416416
/// <param name="objects">The list of `objects` to store in the given Algolia `indexName`.</param>
@@ -425,7 +425,7 @@ public ReplaceAllObjectsResponse ReplaceAllObjects<T>(string indexName, IEnumera
425425
/// Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are untouched.
426426
/// Replace all objects in an index without any downtime. Internally, this method copies the existing index settings, synonyms and query rules and indexes all passed objects.
427427
/// Finally, the temporary one replaces the existing index.
428-
/// See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
428+
/// See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
429429
/// </summary>
430430
/// <param name="indexName">The index in which to perform the request.</param>
431431
/// <param name="objects">The list of `objects` to store in the given Algolia `indexName`.</param>

‎clients/algoliasearch-client-dart/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
104104

105105
## Contributing
106106

107-
This repository hosts the code of the generated Algolia API client for Dart, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
107+
This repository hosts the code of the generated Algolia API client for Dart, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
108108

109109
## 📄 License
110110

‎clients/algoliasearch-client-go/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
8888

8989
## Contributing
9090

91-
This repository hosts the code of the generated Algolia API client for Go, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
91+
This repository hosts the code of the generated Algolia API client for Go, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
9292

9393
## 📄 License
9494

‎clients/algoliasearch-client-java/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
7777

7878
## Contributing
7979

80-
This repository hosts the code of the generated Algolia API client for Java, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
80+
This repository hosts the code of the generated Algolia API client for Java, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
8181

8282
## 📄 License
8383

‎clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/extensions/SearchClient.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ public suspend fun SearchClient.partialUpdateObjects(
397397
* Internally, this method copies the existing index settings, synonyms and query rules and indexes all
398398
* passed objects. Finally, the temporary one replaces the existing index.
399399
*
400-
* See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
400+
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
401401
*
402402
* @param indexName The index in which to perform the request.
403403
* @param objects The list of objects to replace.

‎clients/algoliasearch-client-php/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
8181

8282
## Contributing
8383

84-
This repository hosts the code of the generated Algolia API client for PHP, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
84+
This repository hosts the code of the generated Algolia API client for PHP, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
8585

8686
## 📄 License
8787

‎clients/algoliasearch-client-python/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
8888

8989
## Contributing
9090

91-
This repository hosts the code of the generated Algolia API client for Python, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
91+
This repository hosts the code of the generated Algolia API client for Python, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
9292

9393
## 📄 License
9494

‎clients/algoliasearch-client-ruby/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
5555

5656
## Contributing
5757

58-
This repository hosts the code of the generated Algolia API client for Ruby, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
58+
This repository hosts the code of the generated Algolia API client for Ruby, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
5959

6060
## 📄 License
6161

‎clients/algoliasearch-client-scala/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
124124

125125
## Contributing
126126

127-
This repository hosts the code of the generated Algolia API client for Scala, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
127+
This repository hosts the code of the generated Algolia API client for Scala, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
128128

129129
## 📄 License
130130

‎clients/algoliasearch-client-scala/src/main/scala/algoliasearch/extension/package.scala

+1-1
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ package object extension {
326326
* settings, synonyms and query rules and indexes all passed objects. Finally, the temporary one replaces the
327327
* existing index.
328328
*
329-
* See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation
329+
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
330330
* details.
331331
*
332332
* @param indexName

‎clients/algoliasearch-client-swift/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
161161

162162
## Contributing
163163

164-
This repository hosts the code of the generated Algolia API client for Swift, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
164+
This repository hosts the code of the generated Algolia API client for Swift, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
165165

166166
## 📄 License
167167

‎clients/algoliasearch-client-swift/Sources/Search/Extra/SearchClientExtension.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ public extension SearchClient {
527527

528528
/// Replace all objects in an index
529529
///
530-
/// See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation
530+
/// See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
531531
/// details.
532532
/// - parameter indexName: The name of the index where to replace the objects
533533
/// - parameter objects: The new objects

‎generators/src/main/java/com/algolia/codegen/cts/tests/TestsRequest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ public void run(Map<String, CodegenModel> models, Map<String, CodegenOperation>
136136
operationId +
137137
".json'.\n" +
138138
"You can read more on the documentation:" +
139-
" https://api-clients-automation.netlify.app/docs/contributing/testing/common-test-suite"
139+
" https://api-clients-automation.netlify.app/docs/testing/common-test-suite"
140140
);
141141
}
142142
Request[] op = cts.get(operationId);

‎scripts/specs/format.ts

-5
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,6 @@ export async function transformBundle({
7070

7171
if (docs) {
7272
const snippets = transformCodeSamplesToGuideMethods(JSON.parse(JSON.stringify(snippetSamples)));
73-
// the JS file will be removed once algolia/doc leverages the JSON one
74-
await fsp.writeFile(
75-
toAbsolutePath(`website/src/generated/${clientName}-snippets.js`),
76-
`export const snippets = ${snippets}`,
77-
);
7873
await fsp.writeFile(toAbsolutePath(`snippets/guides/${clientName}-snippets.json`), snippets);
7974
}
8075

‎specs/bundled/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
**Please do not edit the files in this folder, they are generated and changes will be overwritten by our scripts**
44

5-
[Read more on our documentation](https://api-clients-automation.netlify.app/docs/contributing/introduction)
5+
[Read more on our documentation](https://api-clients-automation.netlify.app/docs/introduction)

‎templates/go/search_helpers.mustache

+2-2
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,7 @@ func (c *APIClient) ChunkedBatch(indexName string, objects []map[string]any, act
637637

638638
/*
639639
ReplaceAllObjects replaces all objects (records) in the given `indexName` with the given `objects`. A temporary index is created during this process in order to backup your data.
640-
See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
640+
See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
641641

642642
@param indexName string - the index name to replace objects into.
643643
@param objects []map[string]any - List of objects to replace.
@@ -690,4 +690,4 @@ func (c *APIClient) ReplaceAllObjects(indexName string, objects []map[string]any
690690
BatchResponses: batchResp,
691691
MoveOperationResponse: *moveResp,
692692
}, nil
693-
}
693+
}

‎templates/java/api_helpers.mustache

+2-2
Original file line numberDiff line numberDiff line change
@@ -597,7 +597,7 @@ public <T> List<BatchResponse> chunkedBatch(String indexName, Iterable<T> object
597597
/**
598598
* Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
599599
* untouched. Replace all records in an index without any downtime. See
600-
* https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for
600+
* https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for
601601
* implementation details.
602602
*
603603
* @param indexName The `indexName` to replace `objects` in.
@@ -715,7 +715,7 @@ return chunkedBatch(indexName, objects, createIfNotExists ? Action.PARTIAL_UPDAT
715715
/**
716716
* Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
717717
* untouched. Replace all records in an index without any downtime.
718-
* See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
718+
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
719719
*
720720
* @param indexName The `indexName` to replace `objects` in.
721721
* @param objects The array of `objects` to store in the given Algolia `indexName`.

‎templates/javascript/clients/client/api/helpers.mustache

+1-1
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ async partialUpdateObjects(
409409

410410
/**
411411
* Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
412-
* See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
412+
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
413413
*
414414
* @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
415415
* @param replaceAllObjects - The `replaceAllObjects` object.

0 commit comments

Comments
 (0)