flasgger / flasgger/flasgger

Support plain definition $ref

Open
#85 3 comments 0 reactions 0 assignees View on GitHub
hacktoberfest
Dominant language
Python
Stars
3.7k
Forks
525
PR merge metrics
No merged PRs in 30d

Description

Currently we need ` $ref: '#/definitions/Color'` and we should support `$ref: Color`

```yaml
Palette:
type: object
properties:
palette_name:
type: array
items:
$ref: '#/definitions/Color'
Color:
type: string
```

The idea is to support

```yaml
Palette:
type: object
properties:
palette_name:
type: array
items:
$ref: Color
Color:
type: string
```

Internally flasgger should transform `$ref: Color` in to ` $ref: '#/definitions/Color'` in the json output.

Contributor guide

No contributing guide indexed for this repository

Research direction

No files or tests are named. Start by tracing how Flasgger reads schema references and produces JSON output, then identify the normalization point for `$ref` values; done means `$ref: Color` is emitted as `#/definitions/Color` while the existing form continues to work.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python
Domain
api, documentation
Issue type
Feature
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.