Skip to content

Add a responseType quick table to the REST guide #3

@TDanks2000

Description

@TDanks2000

Background:
The REST guide documents responseType and binary responses. A compact table
would help users choose between auto, json, text, arrayBuffer, and
blob.

Proposed change:
Add a table near the response parsing section showing each supported
responseType, what it returns, and when to use it.

Acceptance criteria:

  • docs/guides/rest-requests.md lists all supported response types.
  • The table includes one practical use case per response type.
  • Existing binary response guidance remains intact.
  • No source code changes are required.

Files likely involved:

  • docs/guides/rest-requests.md
  • src/client/BaseHttpClient.ts for source reference only

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions