openapi-generators / openapi-generators/openapi-python-client
Unable to parse schema Errors
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 2k
- Forks
- 293
- Merge médio
- 34min
- PRs com merge (30d)
- 1
Descrição
Describe the bug
I'm attempting to convert a rather large open api schema to Pyhton bindings and am running across warnings that are dropping endpoints on the floor. I believe there is a couple of issues.
- Refs not supported: Do you know if there are plans to add support for references in request body? I'll look at ways to flatten this schema out without references and try this again
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataFieldGroupType"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/MetadataFieldGroupType"
}
}
},
"required": true,
"description": ""
}
WARNING` parsing PUT /collection within collection. Endpoint will not be generated.
Could not find reference in parsed models or enums
Reference(ref='#/components/schemas/ItemSearchType')
WARNING parsing POST /collection within collection. Endpoint will not be generated.
Could not find reference in parsed models or enums
Reference(ref='#/components/schemas/CollectionType')
- Parth parameters not match with path. I believe this may be due to the open "in path" vs "in query" issue.
WARNING parsing GET /collection/{collection-id}/item within collection. Endpoint will not be generated.
Incorrect path templating for /collection/{collection-id}/item (Path parameters do not match with path)
{
"required": true,
"schema": {
"type": "string"
},
"in": "path",
"name": "collection-id",
"description": "The collection id."
}
- Generic cannot parse parameter of endpoint getAccessGraphDot
cannot parse parameter of endpoint getAccessGraphDot
Schema(title=None, multipleOf=None, maximum=None, exclusiveMaximum=None, minimum=None, exclusiveMinimum=None, maxLength=None, minLength=None, pattern=None, maxItems=None, minItems=None, uniqueItems=None, maxProperties=None, minProperties=None, required=None, enum=['ancestor', 'grant'], type=<DataType.STRING: 'string'>, allOf=[], oneOf=[], anyOf=[], schema_not=None, items=None, properties=None, additionalProperties=None, description=None, schema_format=None, default=None, nullable=False, discriminator=None, readOnly=None, writeOnly=None, xml=None, externalDocs=None, example=None, deprecated=None)
To Reproduce
Steps to reproduce the behavior:
- Run
openapi-python-client generate --path openapi/spec.json - Run
openapi-python-client generate --path openapi/spec.yaml
Expected behavior
A full python client should be generated without warnings.
OpenAPI Spec File
Standby. Making sure I have approval to share this schema since its coming from a 3rd party vendor.
Desktop (please complete the following information):
- OS: macOS 12.4
- Python Version: 3.8.9
- openapi-python-client version: 0.11.4
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece com os comandos openapi-python-client generate --path openapi/spec.json e .yaml e revise os avisos sobre referências ao corpo da requisição, parâmetros de caminho e getAccessGraphDot. O schema do fornecedor não está incluído, então reproduza quando ele estiver disponível; considera-se concluído quando o cliente Python completo for gerado sem avisos ou endpoints descartados.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- openapi, python
- Domínio
- api, devtools
- Tipo de issue
- Bug
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 25/100