Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing properties in API specs #162

Open
jakajancar opened this issue Sep 3, 2024 · 2 comments
Open

Missing properties in API specs #162

jakajancar opened this issue Sep 3, 2024 · 2 comments

Comments

@jakajancar
Copy link

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

@abdolence
Copy link
Owner

abdolence commented Sep 5, 2024

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.

@jakajancar
Copy link
Author

Hey @abdolence,

Thanks for the explanation!

Created a PR upstream:
APIs-guru/openapi-directory#1290

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants