Skip to content
This repository was archived by the owner on Oct 2, 2025. It is now read-only.

document api v2 auth and pagination#9

Merged
narthur merged 1 commit intomasterfrom
api-docs
Jun 10, 2025
Merged

document api v2 auth and pagination#9
narthur merged 1 commit intomasterfrom
api-docs

Conversation

@narthur
Copy link
Collaborator

@narthur narthur commented Jun 10, 2025

No description provided.

Copilot AI review requested due to automatic review settings June 10, 2025 14:50
@narthur narthur temporarily deployed to api-docs - docs.tr.com PR #9 June 10, 2025 14:50 — with Render Destroyed
@github-actions
Copy link

User-Visible Improvements

This PR contains 2 user-visible improvements:

  1. Added an example request for the 'me/tasks' endpoint in the API documentation. (This provides a clear example for users on how to use this specific endpoint, improving usability.)
  2. Updated the API documentation to include examples of how to make requests with the API key. (This change makes it easier for users to understand how to use the API key in their requests.)

Last updated: 2025-06-10T14:50:36.489Z

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances the API v2 documentation by updating the authentication section with a concrete example and adding a pagination example for task listing.

  • Clarified API key usage with header example
  • Introduced a pagination request example for the /me/tasks endpoint
Comments suppressed due to low confidence (2)

src/api-v2.md:20

  • [nitpick] This line repeats the contact instruction already given above; consider removing it or combining both into one concise sentence.
Please reach out to support@taskratchet.com to get an API key.

src/api-v2.md:82

  • [nitpick] It would be helpful to document the pagination parameters (e.g., that pages are zero-indexed and the default page size) so consumers know how to navigate results.
curl "https://api.taskratchet.com/api2/me/tasks?page=0" \

@narthur narthur merged commit f676fc6 into master Jun 10, 2025
4 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants