Generator: Update SDK /services/telemetrylink#6789
Conversation
| @param regionId The STACKIT region name the resource is located in. | ||
| @return ApiPatchFolderTelemetryLinkRequest | ||
| */ | ||
| PatchFolderTelemetryLink(ctx context.Context, folderId string, regionId string) ApiPatchFolderTelemetryLinkRequest |
There was a problem hiding this comment.
The patch methods should be named "PartialUpdate..."
| @param regionId The STACKIT region name the resource is located in. | ||
| @return ApiPutFolderTelemetryLinkRequest | ||
| */ | ||
| PutFolderTelemetryLink(ctx context.Context, folderId string, regionId string) ApiPutFolderTelemetryLinkRequest |
There was a problem hiding this comment.
Those "Put" methods should be named "Update"
https://developers.stackit.schwarz/domains/customer-touchpoints/developer-tools/adr/uniformity-layer/#naming-guidelines
There was a problem hiding this comment.
In this specific case, it will be "CreateOrUpdate" because based on the description, the Put endpoint is also used for the Createion
|
|
||
| // GetFolderTelemetryLinkExecute executes the request | ||
| // @return TelemetryLinkResponse | ||
| GetFolderTelemetryLinkExecute(r ApiGetFolderTelemetryLinkRequest) (*TelemetryLinkResponse, error) |
There was a problem hiding this comment.
At the moment all GET, PUT and PATCH endpoints share the same response schema/struct TelemetryLinkResponse. So the response should be everywhere the same. Is this correct?
If you want to change in the future the response of only the [Action]FolderTelemetryLink endpoints, this will be a breaking change. Because then you would need to replace the schema, what results here to a new go struct and customers have to make changes.
So I would suggest to have separate response schemas to be in the future more flexible.
|
fixed in #7123 |
3 participants
Generated from GitHub run 25000604884
spec comparison: