search

dlt-hub / dlt-init-openapi

MIT License
20 stars 3 forks source link

Test by Anuun #71

Closed anuunchin closed 6 months ago

anuunchin commented 6 months ago

Noob alert! I have no solid experience with OpenAPIs and just tried the Pokémon API and several other ones, which I was more or less familiar with or thought were not too heavy. Please take what I wrote here with a grain of salt. 👀

To answer the provided questions:

  1. Is it clear why we have created this, why it is useful, and what it is about?

    • Absolutely!

  2. Is it clear how the generator works? Did you manage to generate anything in the first 10 minutes after selecting a spec? What is missing from the setup instructions or the output of the generator?

    • I did manage to generate everything, except for Coinpaprika. It says 'no endpoints found,' but I'm not sure why.

  3. Is the resulting dlt rest_api source legible? Should it be structured differently or annotated with comments better?

    • Yes, it is legible. The 'FILL ME IN' comment was helpful for the Star Trek example.

  4. Could you run the pipeline after generation? Did it produce some data?

    • Yes, I managed to load the data from Star Trek, Game of Thrones, MeowFacts, and Pokémon, but the Pokémon data is resulting in a type error in Streamlit for some reason.

  5. If something failed, was the reason for the failure clear? What error message would have been better?

    • Not sure why the Coinpaprika thing failed. The 'no endpoints found' message is clear, but there are indeed endpoints.

  6. Was anything incorrectly converted from the spec to the rest_api definition although it is clear how it should have been generated? If so, which section and what should have been produced?

    • I didn't see any issues with the ones that were actually generated.

  7. Are there any settings, options, or commands you are missing from the tool?

    • Not qualified to answer this question.

I think a small tutorial on how to properly use it would be awesome. 🧠

sh-rp commented 6 months ago

Hey @anuunchin , thanks for your feedback! I made a ticket to look into coinpaprika. And of course you would've been qualified to answer the options question :)

sh-rp commented 6 months ago

@anuunchin i had a look at the coinpaprika spec, there are no endpoints defined, or rather the spec points to another file where they are defined. This is not supported at the moment, but I put a better error message.