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.

Sign up for GitHub

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

Jump to bottom

docs: insights api reference #2859

Merged
merged 27 commits into from Mar 13, 2024
Merged

docs: insights api reference #2859

merged 27 commits into from Mar 13, 2024

Conversation

kai687
Copy link
Contributor

@kai687 kai687 commented Mar 12, 2024 •
edited

🧭 What and Why

Update the insights spec for the Insights API reference documentation.

kai687 and others added 23 commits March 3, 2024 10:40
@kai687
docs: reference overhaul
5eeab4e
@kai687
docs: update redocly settings
37b77ce 
Make the API reference a little nicer with things like sorting
parameters and enums alphabetically.
@kai687
docs: change primary color for API reference
cea3fcf
@kai687
docs: improve Search API reference
3c65e26
@kai687
fix: no default value for language enum
9029b64
@kai687
fix: language must be nullable
7843ecd
@kai687
fix: not null as an array
830e2f8
@kai687
fix: no language enum for now
f512cf3
@kai687
fix: no format date-time for now
d5859e5
@kai687
Merge branch 'main' into docs/reference-overhaul
af92092
@kai687
fix: no sortFacetValuesBy enum for now
d94472e
@kai687
fix: update yarn website script
18791a4
@kai687
docs: search api hopefully done
0d39c7c
@kai687
fix: remove attributes from test
6188c4a
@millotp
fix search dictionary response
058ed47
@kai687
Merge branch 'main' into docs/reference-overhaul
53a868b
@kai687
Update specs/search/paths/rules/clearRules.yml
ee50585
@kai687
docs: update helpers docs
a934041
@kai687
docs: update get settings
bf48362
@kai687
fix: rename CSharp to C#
c5ef13a
@kai687
Merge branch 'main' into docs/reference-overhaul
d30872e
@kai687
Revert "fix: rename CSharp to C#"
2b59c41 
This reverts commit c5ef13a.
@kai687
docs: insights api reference
232f2b4
@algolia-bot
Copy link
Collaborator

algolia-bot commented Mar 12, 2024 •
edited

✗ 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.

@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 12, 2024 •
edited

🚀 Deployed on https://65f185c5156b5f02c8b2f00b--api-clients-automation.netlify.app

@github-actions github-actions bot temporarily deployed to pull request March 12, 2024 09:22 Inactive
Base automatically changed from docs/reference-overhaul to main March 12, 2024 12:50
@github-actions github-actions bot temporarily deployed to pull request March 13, 2024 05:47 Inactive
@kai687 kai687 marked this pull request as ready for review March 13, 2024 08:09
@kai687 kai687 requested a review from a team as a code owner March 13, 2024 08:09
shortcuts
shortcuts reviewed Mar 13, 2024
View reviewed changes
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.

that's super nice

specs/insights/common/schemas/EventAttributes.yml
@@ -174,7 +176,6 @@ objectDataAfterSearchList:

currency:
type: string
format: ISO 4217
Copy link
Member

Choose a reason for hiding this comment

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

too technical? The description properly explains it anyway

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure about the guidance given in the OpenAPI spec.
For the format parameter of a type: string field, there are optional formatters, but it also seems to be a free-form field. Since this is probably the only use of this, I thought it's better to remove it (as you said, we're explaining it in the description.

specs/insights/paths/deleteUserToken.yml Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to pull request March 13, 2024 08:20 Inactive
@shortcuts
Copy link
Member

I've uncommented your change because locally it worked 🤔

@kai687 @shortcuts
Update specs/insights/paths/deleteUserToken.yml
56c5b2b 
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
@kai687 kai687 requested a review from shortcuts March 13, 2024 10:45
@github-actions github-actions bot temporarily deployed to pull request March 13, 2024 10:54 Inactive
shortcuts
shortcuts approved these changes Mar 13, 2024
View reviewed changes
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.

awesome!!

@shortcuts shortcuts merged commit 0f8d443 into main Mar 13, 2024
25 checks passed
@shortcuts shortcuts deleted the docs/insights-api branch March 13, 2024 10:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shortcuts shortcuts shortcuts approved these changes

@morganleroi morganleroi Awaiting requested review from morganleroi morganleroi is a code owner automatically assigned from algolia/api-clients-automation

@millotp millotp Awaiting requested review from millotp millotp is a code owner automatically assigned from algolia/api-clients-automation

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@kai687 @algolia-bot @shortcuts @millotp