Select to view content in your preferred language

Publish OpenAPI v3 spec for APIs

2670
3
08-03-2023 09:18 AM
Status: Open
AaronBeckett
Emerging Contributor

The Python SDK package is OK and has been better than managing raw requests to the REST endpoints. However, we need to have a type-safe and convenient way to interact with the REST API in non-Python environments plus there are a few straight up bugs in the way the Python SDK package queries certain REST endpoints. For example, it's not possible to create a group that allows users from all orgs to join...

My proposal is to simply generate and publish the OpenAPI spec files for as much of the APIs as possible. It's a widely accepted standard for documenting REST APIs and it would allow devs to use the SDK generator of their choice targeting the language of their choice. Easy win for flexibility when interacting with the ArcGIS online ecosystem.

I'm sure there are legacy reasons why it's not as simple as just generating and publishing the OpenAPI spec, but its absence feels like ESRI intentionally deprioritizing developer experience so would love to see this gap filled.

3 Comments
david_hoffer1

I agree with the prior post.  Are you saying Ersi/AcrGIS has no OpenAPI spec?  That is very disappointing indeed.  As a professional software developer consuming REST services having an OpenAPI spec is a must have.

BruceHarold

We routinely hear from customers they want data virtualization - meaning on-demand read and write of 3rd party systems within ArcGIS.  This could be done with FME Flow data virtualization but the ideal first step is an OpenAPI specification, even just for feature layers@EddieIdolyantes is this in the road map?