gcloud-sdk-rs icon indicating copy to clipboard operation
gcloud-sdk-rs copied to clipboard
verified publisher icon abdolence

Missing properties in API specs

Open jakajancar opened this issue 1 year ago • 2 comments

Hey,

I'm looking at the instances.insert "REST" API documentation and it has properties maxRunDuration and terminationTime, but this seems to be absent from both the openapi-directory as well as the protobuf interface definitions.

Am I missing something? Have to admit I'm a bit confused by the state of Google APIs 😬

Jaka

jakajancar avatar Sep 03 '24 04:09 jakajancar

Hey,

REST APIs are generated and patched manually by external contributors since Google doesn't provide them officially. So they might missing information or incorrect (we had to patch some fields already even in this project). In general if there is gRPC officially available, it is better since protobuf declarations coming from Google.

In this case, while Google has protobuf declaration, I don't believe it is available officially (on their docs they usually mark it when available through gRPC), this is probably whey they don't bother to update it.

So, there are two options:

  • Open an issue/PR in Open API directory asking to update the spec.
  • Prepare some kind of patch here to update the Open API spec. This is not ideal, since it will be hard to manage those patches, but I had to do it before.

abdolence avatar Sep 05 '24 15:09 abdolence

Hey @abdolence,

Thanks for the explanation!

Created a PR upstream: https://github.com/APIs-guru/openapi-directory/pull/1290

jakajancar avatar Sep 05 '24 18:09 jakajancar