Repository navigation
ApiOps CLI Publisher fails with empty urlTemplate error. #317
Description
Command that triggered the bug
npx apiops publish
Expected behavior
The publisher pipeline can publish the Websocket onHandshake API with a empty urlTemplate.
Actual behavior
Our Publisher pipeline is failing when running the apiops publish command with this error:
The Command from the pipeline:
npx apiops publish `
--resource-group '${{ parameters.resourceGroupName }}' `
--service-name '${{ parameters.apiManagementServiceName }}' `
--source '${{ parameters.artifactSource }}' `
--overrides '${{ parameters.configurationPath }}' `
--subscription-id $subscriptionId `
--commit-id '$(Build.SourceVersion)'
The Error:
ERROR PUT apioperation/notification-socket-v1/onHandshake: HTTP 400: {"error":{"code":"ValidationError","message":"One or more fields contain incorrect values:","details":[{"code":"ValidationError","target":"urlTemplate","message":"'urlTemplate' should not be empty."}]}}
The API is a WebSocket API & the Socket is opening a handshake to the PubSub. We need an empty urlTemplate for it because we cant change it in azure.
This is the artifact file from it (apim-artifacts\apis\notification-socket-v1\operations\onHandshake\operationInformation.json):
{
"id": "/subscriptions/<>/resourceGroups/<>/providers/Microsoft.ApiManagement/service/<>/apis/notification-socket-v1/operations/onHandshake",
"type": "Microsoft.ApiManagement/service/apis/operations",
"name": "onHandshake",
"properties": {
"displayName": "onHandshake",
"method": "GET",
"urlTemplate": "",
"templateParameters": [],
"description": "WebSocket opening handshake",
"responses": [],
"policies": null,
"effectivePath": null
}
}
apiops CLI version
1.0.4
Environment details
- Image: ubuntu-latest
- NodeJs: 22.x
CI/CD environment
Azure DevOps
Is this bug blocking you?
Yes
Activity
fix: skip WebSocket onHandshake operation on publish
TomHaefele commentedon Oct 19, 2026
The fix is working, thank you.