openapi-generators / openapi-generators/openapi-python-client
Lots of warnings when generating the geofox gti api
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 2k
- フォーク
- 293
- 平均マージ
- 34分
- マージ済み PR(30日)
- 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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 のレスポンス定義と、generator の解析動作を比較します。valid responses によって報告された警告なしで期待される convenience methods が生成されるか、または問題が Geofox の仕様に起因することが示されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- tooling
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100