openapi-generators / openapi-generators/openapi-python-client

Lots of warnings when generating the geofox gti api

未关闭
#608 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

🐞bug
主要语言
Python
星标
2k
派生
293
平均合并
34 分钟
30 天内合并 PR
1

描述

When running openapi-python-client on the gti geofox api I get a lot of warnings:

$ openapi-python-client generate --url https://gti.geofox.de/v3/api-docs/public
Generating open-api-definition-client
Warning(s) encountered while generating. Client was generated, but some pieces may be missing

WARNING parsing POST /gti/public/ticketList within ticket_list_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/TicketListResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/tariffZoneNeighbours within tariff_zone_neighbours_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/TariffZoneNeighboursResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/tariffMetaData within tariff_meta_data_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/TariffMetaDataResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/singleTicketOptimizer within single_ticket_optimizer_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/SingleTicketOptimizerResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/listStations within list_stations_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/LSResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/listLines within list_lines_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/LLResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/init within init_request_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/InitResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/getVehicleMap within vehicle_map_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/VehicleMapResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/getTrackCoordinates within track_coords_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/TrackCoordinatesResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/getTariff within tariff_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/TariffResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/getStationInformation within station_information_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/StationInformationResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/getRoute within get_route_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/GRResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/getIndividualRoute within individual_route_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/IndividualRouteResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/getAnnouncements within announcement_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/AnnouncementResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/departureList within departure_list_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/DLResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/departureCourse within departure_course_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/DCResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/checkPostalCode within postal_code_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/PCResponse'), example=None, examples=None, encoding=None)}, links=None)

WARNING parsing POST /gti/public/checkName within check_name_controller.

Cannot parse response for status code 200, response will be ommitted from generated client

Response(description='OK', headers=None, content={'*/*': MediaType(media_type_schema=Reference(ref='#/components/schemas/CNResponse'), example=None, examples=None, encoding=None)}, links=None)

If you believe this was a mistake or this tool is missing a feature you need, please open an issue at https://github.com/openapi-generators/openapi-python-client/issues/new/choose

After generation, all the api files only contain sync_detailed and asyncio_detailed methods. sync and async methods are missing, e.g.:

$ grep def open-api-definition-client/open_api_definition_client/api/announcement_controller/get_announcements.py 
def _get_kwargs(
def _build_response(*, response: httpx.Response) -> Response[Any]:
def sync_detailed(
async def asyncio_detailed(

Is this a bug in your code or something I should report to Geofox?

$ openapi-python-client --version
openapi-python-client version: 0.11.1

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

使用版本 0.11.1 通过 openapi-python-client generate --url https://gti.geofox.de/v3/api-docs/public 重现,然后检查生成的 open_api_definition_client/api/announcement_controller/get_announcements.py 以及其他受影响的 API 文件。将 Geofox 的响应定义与生成器的解析行为进行比较;当有效响应能够生成预期的便捷方法且没有报告中的警告,或者证明该问题属于 Geofox 的规范时,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
tooling
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。