API Blueprint Cannot use Array in Response

Open
#23 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Domain
api

Research direction

Start by reproducing the @Response(200, body=...) example from the issue and confirm the “Expected PlainValue, got '['” exception. Trace the response-body handling for this annotation; done means an array response is accepted without that exception and the existing behavior remains intact.

Written by the indexing model from the issue text.

Description

use @Response(200, body={"data":[{"id":1, "name":"foo"},{"id":1, "name":"bar"}]}) will give a exception like Expected PlainValue, got '['

Dominant language
No language data
Stars
19
Forks
21
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dingo/api-docs

All issues in dingo/api-docs

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.