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

Convert query parameters to camelCase for GET /tasks endpoint #57

Closed
Tracked by #43
MrRefactoring opened this issue Jun 23, 2023 · 3 comments · Fixed by #89
Closed
Tracked by #43

Convert query parameters to camelCase for GET /tasks endpoint #57

MrRefactoring opened this issue Jun 23, 2023 · 3 comments · Fixed by #89
Assignees
Labels
duplicate Marks a topic that has been previously addressed or reported; helps in reducing redundancy enhancement Denotes a suggestion or request aimed at improving or adding new features to the project good first issue Highlights beginner-friendly tasks, ideal for those looking to contribute for the first time help wanted Signals that additional assistance or expertise is needed on a particular issue or feature wontfix Indicates that, while acknowledged, the particular issue or request won't be acted upon

Comments

@MrRefactoring
Copy link
Owner

MrRefactoring commented Jun 23, 2023

The GET /tasks endpoint in confluence.js library currently supports several query parameters as described in the Confluence OpenAPI documentation. However, these parameters are currently in a dash-case format, which is not consistent with the camelCase convention commonly used in JavaScript.

The task at hand is to convert all of these parameter names to camelCase format. Here are the parameters that need to be renamed:

  1. body-format should be bodyFormat
  2. include-blank-tasks should be includeBlankTasks
  3. task-id should be taskId
  4. space-id should be spaceId
  5. page-id should be pageId
  6. blogpost-id should be blogpostId
  7. created-by should be createdBy
  8. assigned-to should be assignedTo
  9. completed-by should be completedBy
  10. created-at-from should be createdAtFrom
  11. created-at-to should be createdAtTo
  12. due-at-from should be dueAtFrom
  13. due-at-to should be dueAtTo
  14. completed-at-from should be completedAtFrom
  15. completed-at-to should be completedAtTo

By converting these parameter names to camelCase, we will ensure that our library adheres to the common naming conventions of JavaScript, making it more intuitive and easier to use for developers.

Please make sure that this change does not break any existing functionality, and update all relevant function calls and documentations accordingly.

@MrRefactoring MrRefactoring changed the title GetTasks properties with dash (-) replaced to camelCase. Convert query parameters to camelCase for GET /tasks endpoint Jun 23, 2023
@MrRefactoring MrRefactoring added this to the Version 2 API support milestone Jun 23, 2023
@MrRefactoring MrRefactoring added enhancement Denotes a suggestion or request aimed at improving or adding new features to the project help wanted Signals that additional assistance or expertise is needed on a particular issue or feature good first issue Highlights beginner-friendly tasks, ideal for those looking to contribute for the first time labels Jun 23, 2023
@MrRefactoring MrRefactoring pinned this issue Jun 23, 2023
@HussienSayed14
Copy link

I can solve this issue.

@MrRefactoring
Copy link
Owner Author

MrRefactoring commented Jun 23, 2023

Hello @HussienSayed14! Thank you so much! Let's do it

@MrRefactoring MrRefactoring added duplicate Marks a topic that has been previously addressed or reported; helps in reducing redundancy wontfix Indicates that, while acknowledged, the particular issue or request won't be acted upon labels Jun 26, 2023
@MrRefactoring
Copy link
Owner Author

@HussienSayed14 Hello, you can take another ticket for work. Looks like I missed and create 2 duplicate issues and now it was fixed

@MrRefactoring MrRefactoring closed this as not planned Won't fix, can't repro, duplicate, stale Jun 26, 2023
@MrRefactoring MrRefactoring linked a pull request Jun 26, 2023 that will close this issue
@MrRefactoring MrRefactoring unpinned this issue Jun 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate Marks a topic that has been previously addressed or reported; helps in reducing redundancy enhancement Denotes a suggestion or request aimed at improving or adding new features to the project good first issue Highlights beginner-friendly tasks, ideal for those looking to contribute for the first time help wanted Signals that additional assistance or expertise is needed on a particular issue or feature wontfix Indicates that, while acknowledged, the particular issue or request won't be acted upon
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants