Development#11
Conversation
…thorize flag to platform-api schema
…d update request parameter to commandId
There was a problem hiding this comment.
Code Review
This pull request updates the OpenAPI specifications for both the device and platform APIs. In device-api.yml, the descriptions for the authentication headers (Auth-mode and Authorization) have been clarified. In platform-api.yml, a new preAuthorize boolean flag was introduced, and the /commands/status endpoint was renamed to /commands/getDetails with its request parameter updated from id to commandId. The review feedback suggests maintaining naming consistency by using snake_case or lowercase for the new preAuthorize property, adding a default value, and ensuring that other related endpoints and response schemas are updated to use commandId instead of id for API consistency.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| preAuthorize: | ||
| type: boolean | ||
| description: Keep this flag `true` to preauthorize the node. |
There was a problem hiding this comment.
The new property preAuthorize uses camelCase, which is inconsistent with the other properties in the /node/create request body (such as node_name, node_desc, and preauth_id which use snake_case or lowercase). To maintain naming consistency, consider using preauthorize (matching the style of preauth_id) or pre_authorize. Additionally, since this is an optional boolean flag, it is recommended to specify a default: false value.
preauthorize:
type: boolean
description: Keep this flag true to preauthorize the node.
default: false| commandId: | ||
| type: string |
There was a problem hiding this comment.
The request parameter has been updated from id to commandId for the /commands/getDetails endpoint. However, the response schema for this same endpoint (around line 1690) still returns id instead of commandId. Additionally, other endpoints like /commands/invalidate (around line 1740) still use id in their request body.
To ensure API consistency and avoid confusion for consumers, please update the response schema of /commands/getDetails and the request body of /commands/invalidate to use commandId as well.
No description provided.