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

fix(specs): crawler api #2949

Merged
merged 9 commits into from
Apr 4, 2024
Merged

fix(specs): crawler api #2949

merged 9 commits into from
Apr 4, 2024

Conversation

kai687
Copy link
Contributor

@kai687 kai687 commented Apr 3, 2024

🧭 What and Why

Update the specs for the Crawler API to be suited as API reference documentation.

🎟 JIRA Ticket:

Changes included:

  • Add spec for deleting a crawler
  • Complete crawler config and action parameters and descriptions
  • Introduce tags
  • Re-use schema objects if possible.

Only remaining issue is recordExtractor and linkExtractor since those are JavaScript functions as strings. I think it'll be better to document them outside the OpenAPI spec on a separate page.

@algolia-bot
Copy link
Collaborator

algolia-bot commented Apr 3, 2024

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

Copy link

github-actions bot commented Apr 3, 2024

@github-actions github-actions bot temporarily deployed to pull request April 3, 2024 10:25 Inactive
@github-actions github-actions bot temporarily deployed to pull request April 3, 2024 11:03 Inactive
@kai687 kai687 marked this pull request as ready for review April 3, 2024 11:57
@kai687 kai687 requested a review from a team as a code owner April 3, 2024 11:57
@github-actions github-actions bot temporarily deployed to pull request April 3, 2024 12:02 Inactive
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.

wow this is HUGE, gg!

specs/crawler/common/parameters.yml Outdated Show resolved Hide resolved
specs/crawler/common/parameters.yml Outdated Show resolved Hide resolved
specs/crawler/common/parameters.yml Outdated Show resolved Hide resolved
specs/crawler/spec.yml Show resolved Hide resolved
kai687 and others added 3 commits April 3, 2024 16:04
@github-actions github-actions bot temporarily deployed to pull request April 3, 2024 15:43 Inactive
@kai687 kai687 requested a review from shortcuts April 3, 2024 15:44
@github-actions github-actions bot temporarily deployed to pull request April 3, 2024 15:49 Inactive
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
shortcuts
shortcuts previously approved these changes Apr 3, 2024
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.

LOVELY

gg!!

@github-actions github-actions bot temporarily deployed to pull request April 3, 2024 16:28 Inactive
@kai687
Copy link
Contributor Author

kai687 commented Apr 3, 2024

@shortcuts can you merge it when you're happy? I don't have permissions to merge PRs here.

@github-actions github-actions bot temporarily deployed to pull request April 4, 2024 07:25 Inactive
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.

thanks a lot again for this!!

@shortcuts shortcuts merged commit 3e0d0dc into main Apr 4, 2024
13 checks passed
@shortcuts shortcuts deleted the docs/crawler-api branch April 4, 2024 07:50
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.

3 participants