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

Lots of warnings when generating the geofox gti api

Ouverte
#608 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

🐞bug
Langage dominant
Python
Étoiles
2k
Forks
293
Merge moyen
34 min
PR mergées (30 j)
1

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Reproduire avec openapi-python-client generate --url https://gti.geofox.de/v3/api-docs/public en utilisant la version 0.11.1, puis examiner le fichier généré open_api_definition_client/api/announcement_controller/get_announcements.py et les autres fichiers API concernés. Comparer les définitions des réponses de Geofox avec le comportement d'analyse du générateur ; c'est terminé lorsque les réponses valides génèrent les méthodes utilitaires attendues sans les avertissements signalés, ou lorsque l'on démontre que le problème provient de la spécification de Geofox.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
tooling
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.