Update and maintain OpenAPI schema

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
django, openapi, python
Domain
api, backend

Research direction

Start by locating the Django REST Framework-generated OpenAPI schema and the API views or serializers whose information is incomplete. Review how @extend_schema can extend those definitions, then regenerate the schema and verify that it is complete and valid for clients such as orval.

Written by the indexing model from the issue text.

Description

backend

Feature Request

Is your feature request related to a problem or unsupported use case? Please describe.

Our OpenAPI schema is not accurate, we rely only on what is provided by DRF. It brings basic information but they are incomplete. With a complete and valid OpenAPI schema, the front can use it to maintain its types with library like orval

Describe the solution you'd like

The schema can be extended using the decorator @extend_schema.

Dominant language
Python
Stars
16.8k
Forks
638
Avg merge
1d 15h
Merged PRs (30d)
40

Contributor guide

Open the contributing guide

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 suitenumerique/docs

All issues in suitenumerique/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.