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

Downloaders/Parser/Refresher Function signatures #292

Open
carlosparadis opened this issue Apr 4, 2024 · 3 comments
Open

Downloaders/Parser/Refresher Function signatures #292

carlosparadis opened this issue Apr 4, 2024 · 3 comments
Assignees

Comments

@carlosparadis
Copy link
Member

@ian-lastname @Ssunoo2 @anthonyjlau

Could you paste here the list of function signatures your downloders/refreshers/parsers will have? I want to see side by side just to make sure we are not introducing inconsistencies (much as we noticed inconsistencies on the way data was stored by the issue trackers).

Just a bullet list of function signatures, no need to explain them here since they are already discussed in the respective issues.

@carlosparadis carlosparadis changed the title Downloaders/Parser/Refresher Function signtures Downloaders/Parser/Refresher Function signatures Apr 5, 2024
@Ssunoo2
Copy link
Collaborator

Ssunoo2 commented Apr 5, 2024

Jira

  • download_jira_issues()
  • download_jira_issues_by_date()
  • download_jira_issues_by_issue_key()
  • refresh_jira_issues()

Github

  • github_api_project_issue_refresh()
  • github_api_project_issue_or_pr_comment_refresh

These look different from the Jira ones that we agreed upon. I was attempting to follow the naming conventions for existing github functions. Here are some example of github download function names in github.R:

  • github_api_project_issue_or_pr_comments
  • github_api_project_pull_request
  • github_api_project_issue

@ian-lastname
Copy link
Collaborator

ian-lastname commented Apr 5, 2024

Jira

  • parse_jira(save_path)
  • parse_jira_latest_date(save_path)

mbox

  • mbox_download_refresh(current_latest_date, save_folder_path)
  • mbox_parse_latest_date(save_folder_path)

@anthonyjlau
Copy link
Collaborator

anthonyjlau commented Apr 6, 2024

Bugzilla

  • download_bugzilla_rest_issues_comments(bugzilla_site, start_timestamp, save_folder_path, limit_upperbound = 500)
  • parse_bugzilla_rest_issues(issues_folder_path)
  • parse_bugzilla_rest_issues_comments(bugzilla_folder_path)

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

No branches or pull requests

4 participants