-
Notifications
You must be signed in to change notification settings - Fork 4
[auto] Update openapi dependency #1478
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
base: main
Are you sure you want to change the base?
[auto] Update openapi dependency #1478
Conversation
| export interface PatchObjectConfigContentRequest { | ||
| /** | ||
| * The ID of the user group that has access to this installation. | ||
| * Either groupRef or installationId must be provided. | ||
| * @type {string} | ||
| * @memberof PatchObjectConfigContentRequest | ||
| */ | ||
| groupRef: string; | ||
| /** | ||
| * The action type for the object config (read, subscribe, or write). | ||
| * @type {string} | ||
| * @memberof PatchObjectConfigContentRequest | ||
| */ | ||
| action: PatchObjectConfigContentRequestActionEnum; | ||
| /** | ||
| * Array of JSON Patch operations to apply. | ||
| * @type {Array<JSONPatchOperation>} | ||
| * @memberof PatchObjectConfigContentRequest | ||
| */ | ||
| changes: Array<JSONPatchOperation>; | ||
| /** | ||
| * The installation ID. | ||
| * Either groupRef or installationId must be provided. | ||
| * @type {string} | ||
| * @memberof PatchObjectConfigContentRequest | ||
| */ | ||
| installationId: string; | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Critical bug: Both groupRef and installationId are marked as required fields (lines 35 and 54), but the documentation clearly states "Either groupRef or installationId must be provided" (lines 31-32 and 50-51). This makes both fields mandatory when only one should be required.
This will cause runtime failures when trying to use the API because:
- TypeScript will require both fields to be provided
- The API likely expects only one to be provided
- Callers cannot correctly use this interface
// Current (incorrect) - both required:
groupRef: string;
installationId: string;
// Should be (one required via union or both optional):
groupRef?: string;
installationId?: string;
// with runtime validation that at least one is providedThe oneOf schemas (PatchObjectConfigContentRequestAllOfOneOf and PatchObjectConfigContentRequestAllOfOneOf1) correctly model this as mutually exclusive options, but this combined interface breaks that contract.
| export interface PatchObjectConfigContentRequest { | |
| /** | |
| * The ID of the user group that has access to this installation. | |
| * Either groupRef or installationId must be provided. | |
| * @type {string} | |
| * @memberof PatchObjectConfigContentRequest | |
| */ | |
| groupRef: string; | |
| /** | |
| * The action type for the object config (read, subscribe, or write). | |
| * @type {string} | |
| * @memberof PatchObjectConfigContentRequest | |
| */ | |
| action: PatchObjectConfigContentRequestActionEnum; | |
| /** | |
| * Array of JSON Patch operations to apply. | |
| * @type {Array<JSONPatchOperation>} | |
| * @memberof PatchObjectConfigContentRequest | |
| */ | |
| changes: Array<JSONPatchOperation>; | |
| /** | |
| * The installation ID. | |
| * Either groupRef or installationId must be provided. | |
| * @type {string} | |
| * @memberof PatchObjectConfigContentRequest | |
| */ | |
| installationId: string; | |
| } | |
| export interface PatchObjectConfigContentRequest { | |
| /** | |
| * The ID of the user group that has access to this installation. | |
| * Either groupRef or installationId must be provided. | |
| * @type {string} | |
| * @memberof PatchObjectConfigContentRequest | |
| */ | |
| groupRef?: string; | |
| /** | |
| * The action type for the object config (read, subscribe, or write). | |
| * @type {string} | |
| * @memberof PatchObjectConfigContentRequest | |
| */ | |
| action: PatchObjectConfigContentRequestActionEnum; | |
| /** | |
| * Array of JSON Patch operations to apply. | |
| * @type {Array<JSONPatchOperation>} | |
| * @memberof PatchObjectConfigContentRequest | |
| */ | |
| changes: Array<JSONPatchOperation>; | |
| /** | |
| * The installation ID. | |
| * Either groupRef or installationId must be provided. | |
| * @type {string} | |
| * @memberof PatchObjectConfigContentRequest | |
| */ | |
| installationId?: string; | |
| } |
Spotted by Graphite Agent
Is this helpful? React 👍 or 👎 to let us know.
This updates the dependency to version 9ee5e5b871722ec4187ea8ddaf44c7344f9483cd from main