Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

readOnly property not marked as optional in the generated model

Aberta
#1,204 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
42/100
Tipo de issue
Bug
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
tooling

Direção de pesquisa

Comece executando a reprodução fornecida de OpenAPI 3.1 com openapi-python-client 0.22 e inspecionando o modelo Bug gerado e o uso de POST. Rastreie onde os campos readOnly e required são convertidos; estará concluído quando os campos readOnly não forem obrigatórios para a entrada POST, mas continuarem disponíveis nos modelos de resposta gerados, com cobertura de regressão.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Describe the bug
Fields marked as readOnly in a schema in the OpenAPI document are not set as optional in the generated model.
This makes them required in the body of any POST request in which this model is used, defeating the purpose of using the readOnly property.

OpenAPI Spec File

openapi: 3.1.0
info:
  title: Minimal bug reproduction API
  version: 1.0.0
paths:
  /bug:
    get:
      summary: Get all bugs
      responses:
        "200":
          description: A list of bugs
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Bug"
    post:
      summary: Create a bug
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Bug"
      responses:
        "201":
          description: Bug created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bug"

components:
  schemas:
    Bug:
      type: object
      properties:
        id:
          readOnly: true
          type: integer
        created_at:
          readOnly: true
          type: string
          format: date-time
        name:
          type: string
        description:
          type: string
        status:
          type: string
          enum:
            - open
            - closed
      required:
        - id
        - name
        - description
        - status
        - created_at

Desktop (please complete the following information):

  • OS: [Windows 11]
  • Python Version: [3.12]
  • openapi-python-client version [0.22]
Linguagem predominante
Python
Estrelas
2k
Forks
293
Merge médio
34min
PRs com merge (30d)
1

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de openapi-generators/openapi-python-client

Todas as issues de openapi-generators/openapi-python-client

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.