marshmallow-code / marshmallow-code/marshmallow-oneofschema

Generated OpenAPI Spec Documentation?

Open
#154 1 comment 0 reactions 0 assignees View on GitHub
question
Dominant language
Python
Stars
142
Forks
44
Avg merge
7h 7m
Merged PRs (30d)
3

Description

I am using `oneOfSchema` one of my api endpoints.

I also use autogenerated documentation using `apispec` library.

I was expecting to see generated docs based on `type_field` and `type_schemas`. But I see nothing being generated.

Does this class work with autogenerated docs? or am I missing some configuration?

Thanks,

Art

Contributor guide

Open the contributing guide

Research direction

Start by reproducing an endpoint using oneOfSchema with the apispec library, then inspect the generated OpenAPI output for type_field and type_schemas. Done means determining whether these fields should be emitted and documenting the required configuration or confirming an unsupported integration.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.