Skip to content

docs: lot of guides #4355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 67 commits into from
Jan 22, 2025
Merged

docs: lot of guides #4355

merged 67 commits into from
Jan 22, 2025

Conversation

shortcuts
Copy link
Member

@shortcuts shortcuts commented Jan 13, 2025

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DI-3385

How to:

  1. Pick a guide in the google sheet
  2. Add a valid test case to the corresponding tests/CTS/requests/<CLIENT_NAME>/<METHOD_NAME>.json file
    a. Use a descriptive testName (see sheet for the snippet key column)
    b. Set isSnippet to true
  3. Generate the test case for your favorite API client: yarn cli cts generate python <CLIENT_NAME>
    a. The CI will do the generate for all of them
  4. Generate the snippet for your favorite API client, from your test case: yarn cli snippets python <CLIENT_NAME>
    a. The CI will do the generate for all of them
    b. The >SEPARATOR line in the added newly added snippet should reflect the test name, e.g. >SEPARATOR setSettings keywordSearch in snippets/python/search.py
  5. Finally, build the end JSON snippet file with yarn cli build specs search -d -s

@shortcuts shortcuts self-assigned this Jan 13, 2025
@algolia-bot
Copy link
Collaborator

algolia-bot commented Jan 13, 2025

💥 Breaking changes detected !!

Either this PR or a previous PR not released yet introduced breaking changes, be careful when merging.
You can find the details in the 'client java@17' CI job.

✔️ Code generated!

Name Link
🪓 Triggered by 01be31d0886929428f4f0cd0004e9f6dacce3817
🍃 Generated commit 709e8ce3fae76a08bcb7d98a7abf1e7da5745691
🌲 Generated branch generated/feat/guide-hackathon
📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
javascript 1628
go 1620
php 1514
csharp 1404
python 1132
java 1117
ruby 837
swift 763

@shortcuts shortcuts force-pushed the feat/guide-hackathon branch from 7e46cdf to b57f0b8 Compare January 20, 2025 09:27
@shortcuts
Copy link
Member Author

saveRule({
  objectID: 'director-rule',
  conditions: [{
    pattern: '{facet:director} director',
    anchoring: 'contains'
  }],
  consequence: {
    params: {
      automaticFacetFilters: ['director'],
      query: {
        edits: [{
          type: 'remove',
          delete: 'director'
      }]
      }
    }
  }
})

this throws because of automaticFacetFilters oneOf

@shortcuts shortcuts marked this pull request as ready for review January 21, 2025 13:40
@shortcuts shortcuts requested a review from a team as a code owner January 21, 2025 13:40
millotp
millotp previously approved these changes Jan 22, 2025
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did not review the snippets themselves, let's do that on the doc repo !

@shortcuts shortcuts enabled auto-merge (squash) January 22, 2025 08:27
@shortcuts shortcuts merged commit eb83e3b into main Jan 22, 2025
28 checks passed
@shortcuts shortcuts deleted the feat/guide-hackathon branch January 22, 2025 09:37
algolia-bot added a commit that referenced this pull request Jan 22, 2025
Co-authored-by: Clément Vannicatte <[email protected]>
Co-authored-by: Morgan Leroi <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
Co-authored-by: Thomas Raffray <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-csharp that referenced this pull request Jan 22, 2025
algolia/api-clients-automation#4355

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>
Co-authored-by: Morgan Leroi <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
Co-authored-by: Thomas Raffray <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-go that referenced this pull request Jan 22, 2025
algolia/api-clients-automation#4355

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>
Co-authored-by: Morgan Leroi <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
Co-authored-by: Thomas Raffray <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-java that referenced this pull request Jan 22, 2025
algolia/api-clients-automation#4355

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>
Co-authored-by: Morgan Leroi <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
Co-authored-by: Thomas Raffray <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants