Teamwork / Teamwork/kommentaar

Response $ref type != struct

Open
#54 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
34
Forks
6
Avg merge
14h 5m
Merged PRs (30d)
2

Description

/*
GET /v1/test
tests

Response 200: $ref: bool
*/

throws could not parse response 200 params: GetReference: could not find type "bool" in package ...

then tried:

type TestResponse bool

/*
GET /v1/test
tests

Response 200: $ref: TestResponse
*/

and throws: could not parse response 200 params: GetReference: TestResponse is not a struct or interface but a *ast.Ident

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.

Research direction

Start by reproducing the two response examples and trace the response $ref handling around GetReference and the reported AST type error. Done means the documented behavior for scalar or non-struct response types is defined and covered for the examples shown.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.