Skip to content
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

feat(specs): Add tags to the settings and search params #768

Merged
merged 3 commits into from
Jun 30, 2022

Conversation

clemfromspace
Copy link
Contributor

@clemfromspace clemfromspace commented Jun 29, 2022

🧭 What and Why

Tagging search and index params to be able to generate nicer doc from the specs :)

Changes included:

  • Tags in the form of x-category: <list> on the search and settings params

The resulting output of the Algolia CLI -h on the search command 👇

Screenshot 2022-06-30 at 10 37 33

@netlify
Copy link

netlify bot commented Jun 29, 2022

Deploy Preview for api-clients-automation ready!

Name Link
🔨 Latest commit a59c26a
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/62bdaa23983c6d0008b309f6
😎 Deploy Preview https://deploy-preview-768--api-clients-automation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@algolia-bot
Copy link
Collaborator

algolia-bot commented Jun 29, 2022

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

@clemfromspace clemfromspace changed the title feat(specs) Add tags to the settings and search params feat:specs Add tags to the settings and search params Jun 29, 2022
@millotp millotp changed the title feat:specs Add tags to the settings and search params feat(specs): Add tags to the settings and search params Jun 30, 2022
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.

This is very useful thank you !

specs/common/schemas/IndexSettings.yml Outdated Show resolved Hide resolved
Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

Looks really great, thanks :D

The final form of the specs (bundled), will transform it in list without quotes, maybe it's worth having the same shape in our non-bundled specs too to avoid confusion?

e.g.

x-categories:
  - Languages
  - ...

Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

Looks great! It would be nice on our side to sort them by x-categories and also maybe sort properties, to make those specs more consistent

specs/common/schemas/SearchParams.yml Outdated Show resolved Hide resolved
Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks :D

@shortcuts shortcuts merged commit bc14a8c into main Jun 30, 2022
@shortcuts shortcuts deleted the feat/parameter-tags branch June 30, 2022 14:02
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.

4 participants