Skip to content

Document @KeyValue and @Read list support in README#42

Draft
Copilot wants to merge 3 commits intomasterfrom
copilot/update-readme-annotations
Draft

Document @KeyValue and @Read list support in README#42
Copilot wants to merge 3 commits intomasterfrom
copilot/update-readme-annotations

Conversation

Copy link

Copilot AI commented Dec 29, 2025

The @KeyValue annotation and @Read list return types were undocumented in the README.

Changes

Added "Additional Features" section to README documenting:

  • @keyvalue annotation: For reading key-value structured sheets where data is organized as two columns (key, value). The annotation transforms vertical key-value pairs into horizontal row format for data class mapping.

  • @READ list support: Clarifies that @Read returns either single objects or List<T> based on return type and query, with examples of both patterns.

Example

// Key-value sheet reading
interface ConfigApi {
    @KeyValue
    @Read("SELECT *")
    @GET("config")
    suspend fun getConfig(): Config  // Maps key-value pairs to object
}

// List vs single object
interface NotesApi {
    @Read("SELECT * WHERE id = :id")
    @GET("notes")
    suspend fun getNoteById(@Query("id") id: String): Note  // Single result
    
    @Read("SELECT * ORDER BY created_at DESC LIMIT 10")
    @GET("notes")
    suspend fun getRecentNotes(): List<Note>  // Multiple results
}
Original prompt

This section details on the original issue you should resolve

<issue_title>Update README</issue_title>
<issue_description>- Add @KeyValue and @ReadAsList annotations to README</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits December 29, 2025 18:28
Co-authored-by: theapache64 <9678279+theapache64@users.noreply.github.com>
Co-authored-by: theapache64 <9678279+theapache64@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README with new annotations Document @KeyValue and @Read list support in README Dec 29, 2025
Copilot AI requested a review from theapache64 December 29, 2025 18:30
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.

Update README

2 participants