Hello,
I was very happy to see the OpenAPI auto-generated for my 3rd party apps but is there an OpenAPI spec that I can download for the Foundry API?
https://www.palantir.com/docs/foundry/api/v2/general/overview/introduction/
Hello,
I was very happy to see the OpenAPI auto-generated for my 3rd party apps but is there an OpenAPI spec that I can download for the Foundry API?
https://www.palantir.com/docs/foundry/api/v2/general/overview/introduction/
It’s not currently possible to download an OpenAPI file for the Foundry API but it’s something we are planning to work on soon. Just for awareness, what would you do with this file?
Hi @smith,
Glad to hear its something that is on your radar. The increase in Developer Experience is the same use-case for when palantir implemented generating the OAS for my 3rd party app.
Currently, for the Foundry API, I have to find the API I want, copy the curl command, paste it into my api tool of choice (postman, insomnia, bruno, etc) and then adjust the request and variables to match my setup.
With the OAS, I could just load the whole thing into postman, setup the variables once, and fire off requests right away (just like i can do with my 3rd party app). Other people might want to create an API client in their language of choice using the OpenAPI Generator.
If you can leverage what you guys did for the 3rd party app and just do the same for Foundry API, that would be perfect! No extra work needed
You used to have it but removed it here: https://github.com/palantir/foundry-platform-python/pull/25. @smith , I am guessing this was you? @Bougs - that PR has the old spec, which is better than nothing! It may solve your use case.
You guys should bring it back! Having the OpenAPI spec available is very valuable (for all the @Bougs said, and more). Additionally, a great new ecosystem is developing around SDK generation on top of OpenAPI specs (Fern and Stainless are two good examples). Instead of just having Python, you guys could have a bunch of languages for free. Plus, there are way better docs than you currently have in the repo.
I would highly recommend doing this if you want to be more developer-friendly and continue to lean into that as your adoption/growth strategy.
Yes you’re right we did have an OpenAPI spec (and that was me that removed it).
That file unfortunately only includes the V1 APIs (and certain V2 APIs) and there wasn’t a straightforward way to create an OpenAPI file for all of the newer V2 APIs until recently. We’re unblocked now and just need to figure out where we’re going to host it going forward
Better are on the roadmap for this year too! The platform API docs will be getting revamped with better code snippet examples as well.
This makes sense! I’ll follow up on this post once the OpenAPI file is available.