mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-01-18 05:18:24 +02:00
Help document fixes (#2793)
* byte code Fix * Help Url Fixes * Yaml Changes * Error Message changes Co-authored-by: Oliver Feldmann <oliver.feldmann@sap.com>
This commit is contained in:
parent
b82ecb0ff7
commit
05973a8fcd
@ -34,7 +34,7 @@ func IntegrationArtifactDeployCommand() *cobra.Command {
|
||||
var createIntegrationArtifactDeployCmd = &cobra.Command{
|
||||
Use: STEP_NAME,
|
||||
Short: "Deploy a CPI integration flow",
|
||||
Long: `With this step you can deploy a integration flow artifact in to SAP Cloud Platform integration runtime using OData API.Learn more about the SAP Cloud Integration remote API for deploying an integration artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/08632076a1114bc1b6a1ecafef8f0178.html)`,
|
||||
Long: `With this step you can deploy a integration flow artifact in to SAP Cloud Platform integration runtime using OData API.Learn more about the SAP Cloud Integration remote API for deploying an integration artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html)`,
|
||||
PreRunE: func(cmd *cobra.Command, _ []string) error {
|
||||
startTime = time.Now()
|
||||
log.SetStepName(STEP_NAME)
|
||||
|
@ -34,7 +34,7 @@ func IntegrationArtifactDownloadCommand() *cobra.Command {
|
||||
var createIntegrationArtifactDownloadCmd = &cobra.Command{
|
||||
Use: STEP_NAME,
|
||||
Short: "Download integration flow runtime artefact",
|
||||
Long: `With this step you can download a integration flow runtime artifact, which returns a zip file with the integration flow contents in to current workspace using the OData API. Learn more about the SAP Cloud Integration remote API for downloading an integration flow artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/460dee19f9c141e88ba0454ce892247a.html).`,
|
||||
Long: `With this step you can download a integration flow runtime artifact, which returns a zip file with the integration flow contents in to current workspace using the OData API. Learn more about the SAP Cloud Integration remote API for downloading an integration flow artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).`,
|
||||
PreRunE: func(cmd *cobra.Command, _ []string) error {
|
||||
startTime = time.Now()
|
||||
log.SetStepName(STEP_NAME)
|
||||
|
@ -64,7 +64,7 @@ func IntegrationArtifactGetMplStatusCommand() *cobra.Command {
|
||||
var createIntegrationArtifactGetMplStatusCmd = &cobra.Command{
|
||||
Use: STEP_NAME,
|
||||
Short: "Get the MPL status of an integration flow",
|
||||
Long: `With this step you can obtain information about the Message processing log status of integration flow using OData API.Learn more about the SAP Cloud Integration remote API for getting MPL status messages processed of an deployed integration artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/05fa2a8b31d14c11a4e72e833e5e9f7d.html).`,
|
||||
Long: `With this step you can obtain information about the Message processing log status of integration flow using OData API.Learn more about the SAP Cloud Integration remote API for getting MPL status messages processed of an deployed integration artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).`,
|
||||
PreRunE: func(cmd *cobra.Command, _ []string) error {
|
||||
startTime = time.Now()
|
||||
log.SetStepName(STEP_NAME)
|
||||
|
@ -64,7 +64,7 @@ func IntegrationArtifactGetServiceEndpointCommand() *cobra.Command {
|
||||
var createIntegrationArtifactGetServiceEndpointCmd = &cobra.Command{
|
||||
Use: STEP_NAME,
|
||||
Short: "Get an deployed CPI intgeration flow service endpoint",
|
||||
Long: `With this step you can obtain information about the service endpoints exposed by SAP Cloud Platform Integration on a tenant using OData API.Learn more about the SAP Cloud Integration remote API for getting service endpoint of deployed integration artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/26797fbe259349b387a74a5a8f9785c1.html).`,
|
||||
Long: `With this step you can obtain information about the service endpoints exposed by SAP Cloud Platform Integration on a tenant using OData API.Learn more about the SAP Cloud Integration remote API for getting service endpoint of deployed integration artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).`,
|
||||
PreRunE: func(cmd *cobra.Command, _ []string) error {
|
||||
startTime = time.Now()
|
||||
log.SetStepName(STEP_NAME)
|
||||
|
@ -36,7 +36,7 @@ func IntegrationArtifactUpdateConfigurationCommand() *cobra.Command {
|
||||
var createIntegrationArtifactUpdateConfigurationCmd = &cobra.Command{
|
||||
Use: STEP_NAME,
|
||||
Short: "Update integration flow Configuration parameter",
|
||||
Long: `With this step you can update the value for a configuration parameters of a designtime integration flow using the OData API. Learn more about the SAP Cloud Integration remote API for configuration update of the integration flow parameter [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/83733a65c0214aa6acba035e8640bb5a.html).`,
|
||||
Long: `With this step you can update the value for a configuration parameters of a designtime integration flow using the OData API. Learn more about the SAP Cloud Integration remote API for configuration update of the integration flow parameter [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).`,
|
||||
PreRunE: func(cmd *cobra.Command, _ []string) error {
|
||||
startTime = time.Now()
|
||||
log.SetStepName(STEP_NAME)
|
||||
|
@ -99,7 +99,7 @@ func runIntegrationArtifactUpload(config *integrationArtifactUploadOptions, tele
|
||||
return errors.Wrapf(readErr, "HTTP response body could not be read, Response status code: %v", iFlowStatusResp.StatusCode)
|
||||
}
|
||||
log.Entry().Errorf("a HTTP error occurred! Response body: %v, Response status code: %v", responseBody, iFlowStatusResp.StatusCode)
|
||||
return errors.Wrapf(httpErr, "HTTP %v request to %v failed with error: %v", httpMethod, iFlowStatusServiceURL, responseBody)
|
||||
return errors.Wrapf(httpErr, "HTTP %v request to %v failed with error: %v", httpMethod, iFlowStatusServiceURL, string(responseBody))
|
||||
}
|
||||
return errors.Errorf("Failed to check integration flow availability, Response Status code: %v", iFlowStatusResp.StatusCode)
|
||||
}
|
||||
@ -137,7 +137,7 @@ func UploadIntegrationArtifact(config *integrationArtifactUploadOptions, httpCli
|
||||
return errors.Wrapf(readErr, "HTTP response body could not be read, Response status code: %v", uploadIflowStatusResp.StatusCode)
|
||||
}
|
||||
log.Entry().Errorf("a HTTP error occurred! Response body: %v, Response status code: %v", responseBody, uploadIflowStatusResp.StatusCode)
|
||||
return errors.Wrapf(httpErr, "HTTP %v request to %v failed with error: %v", httpMethod, uploadIflowStatusURL, responseBody)
|
||||
return errors.Wrapf(httpErr, "HTTP %v request to %v failed with error: %v", httpMethod, uploadIflowStatusURL, string(responseBody))
|
||||
}
|
||||
return errors.Errorf("Failed to create Integration Flow artefact, Response Status code: %v", uploadIflowStatusResp.StatusCode)
|
||||
}
|
||||
@ -174,7 +174,7 @@ func UpdateIntegrationArtifact(config *integrationArtifactUploadOptions, httpCli
|
||||
return errors.Wrapf(readErr, "HTTP response body could not be read, Response status code: %v", updateIflowStatusResp.StatusCode)
|
||||
}
|
||||
log.Entry().Errorf("a HTTP error occurred! Response body: %v, Response status code: %v", responseBody, updateIflowStatusResp.StatusCode)
|
||||
return errors.Wrapf(httpErr, "HTTP %v request to %v failed with error: %v", httpMethod, updateIflowStatusURL, responseBody)
|
||||
return errors.Wrapf(httpErr, "HTTP %v request to %v failed with error: %v", httpMethod, updateIflowStatusURL, string(responseBody))
|
||||
}
|
||||
return errors.Errorf("Failed to update Integration Flow artefact, Response Status code: %v", updateIflowStatusResp.StatusCode)
|
||||
}
|
||||
|
@ -36,7 +36,7 @@ func IntegrationArtifactUploadCommand() *cobra.Command {
|
||||
var createIntegrationArtifactUploadCmd = &cobra.Command{
|
||||
Use: STEP_NAME,
|
||||
Short: "Upload or Update an integration flow designtime artefact",
|
||||
Long: `With this step you can either upload or update a integration flow designtime artifact using the OData API. Learn more about the SAP Cloud Integration remote API for updating an integration flow artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/83733a65c0214aa6acba035e8640bb5a.html).`,
|
||||
Long: `With this step you can either upload or update a integration flow designtime artifact using the OData API. Learn more about the SAP Cloud Integration remote API for updating an integration flow artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).`,
|
||||
PreRunE: func(cmd *cobra.Command, _ []string) error {
|
||||
startTime = time.Now()
|
||||
log.SetStepName(STEP_NAME)
|
||||
|
@ -139,7 +139,7 @@ func TestRunIntegrationArtifactUpload(t *testing.T) {
|
||||
httpClient := httpMockCpis{CPIFunction: "", ResponseBody: ``, TestType: "NegativeAndCreateIntegrationDesigntimeArtifactResBody"}
|
||||
|
||||
err = runIntegrationArtifactUpload(&config, nil, &files, &httpClient)
|
||||
assert.EqualError(t, err, "HTTP POST request to https://demo/api/v1/IntegrationDesigntimeArtifactSaveAsVersion?Id='flow4'&SaveAsVersion='1.0.4' failed with error: []: Internal error")
|
||||
assert.EqualError(t, err, "HTTP POST request to https://demo/api/v1/IntegrationDesigntimeArtifactSaveAsVersion?Id='flow4'&SaveAsVersion='1.0.4' failed with error: : 401 Unauthorized")
|
||||
})
|
||||
|
||||
t.Run("Failed case of Integration Flow Create Test", func(t *testing.T) {
|
||||
@ -165,6 +165,6 @@ func TestRunIntegrationArtifactUpload(t *testing.T) {
|
||||
httpClient := httpMockCpis{CPIFunction: "", ResponseBody: ``, TestType: "NegativeAndUpdateIntegrationDesigntimeArtifactResBody"}
|
||||
|
||||
err = runIntegrationArtifactUpload(&config, nil, &filesMock, &httpClient)
|
||||
assert.EqualError(t, err, "HTTP POST request to https://demo/api/v1/IntegrationDesigntimeArtifacts failed with error: []: Internal error")
|
||||
assert.EqualError(t, err, "HTTP POST request to https://demo/api/v1/IntegrationDesigntimeArtifacts failed with error: : 401 Unauthorized")
|
||||
})
|
||||
}
|
||||
|
@ -237,7 +237,7 @@ func GetRespBodyHTTPStatusServiceErrorResponse() (*http.Response, error) {
|
||||
StatusCode: 500,
|
||||
Body: ioutil.NopCloser(bytes.NewReader([]byte(``))),
|
||||
}
|
||||
return &resp, errors.New("Internal error")
|
||||
return &resp, errors.New("401 Unauthorized")
|
||||
}
|
||||
|
||||
//IntegrationArtifactDownloadCommandMockResponse -Provide http respose body
|
||||
|
@ -2,7 +2,7 @@ metadata:
|
||||
name: integrationArtifactDeploy
|
||||
description: Deploy a CPI integration flow
|
||||
longDescription: |
|
||||
With this step you can deploy a integration flow artifact in to SAP Cloud Platform integration runtime using OData API.Learn more about the SAP Cloud Integration remote API for deploying an integration artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/08632076a1114bc1b6a1ecafef8f0178.html)
|
||||
With this step you can deploy a integration flow artifact in to SAP Cloud Platform integration runtime using OData API.Learn more about the SAP Cloud Integration remote API for deploying an integration artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html)
|
||||
|
||||
spec:
|
||||
inputs:
|
||||
|
@ -2,7 +2,7 @@ metadata:
|
||||
name: integrationArtifactDownload
|
||||
description: Download integration flow runtime artefact
|
||||
longDescription: |
|
||||
With this step you can download a integration flow runtime artifact, which returns a zip file with the integration flow contents in to current workspace using the OData API. Learn more about the SAP Cloud Integration remote API for downloading an integration flow artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/460dee19f9c141e88ba0454ce892247a.html).
|
||||
With this step you can download a integration flow runtime artifact, which returns a zip file with the integration flow contents in to current workspace using the OData API. Learn more about the SAP Cloud Integration remote API for downloading an integration flow artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).
|
||||
|
||||
spec:
|
||||
inputs:
|
||||
|
@ -2,7 +2,7 @@ metadata:
|
||||
name: integrationArtifactGetMplStatus
|
||||
description: Get the MPL status of an integration flow
|
||||
longDescription: |
|
||||
With this step you can obtain information about the Message processing log status of integration flow using OData API.Learn more about the SAP Cloud Integration remote API for getting MPL status messages processed of an deployed integration artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/05fa2a8b31d14c11a4e72e833e5e9f7d.html).
|
||||
With this step you can obtain information about the Message processing log status of integration flow using OData API.Learn more about the SAP Cloud Integration remote API for getting MPL status messages processed of an deployed integration artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).
|
||||
|
||||
spec:
|
||||
inputs:
|
||||
|
@ -2,7 +2,7 @@ metadata:
|
||||
name: integrationArtifactGetServiceEndpoint
|
||||
description: Get an deployed CPI intgeration flow service endpoint
|
||||
longDescription: |
|
||||
With this step you can obtain information about the service endpoints exposed by SAP Cloud Platform Integration on a tenant using OData API.Learn more about the SAP Cloud Integration remote API for getting service endpoint of deployed integration artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/26797fbe259349b387a74a5a8f9785c1.html).
|
||||
With this step you can obtain information about the service endpoints exposed by SAP Cloud Platform Integration on a tenant using OData API.Learn more about the SAP Cloud Integration remote API for getting service endpoint of deployed integration artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).
|
||||
|
||||
spec:
|
||||
inputs:
|
||||
|
@ -2,7 +2,7 @@ metadata:
|
||||
name: integrationArtifactUpdateConfiguration
|
||||
description: Update integration flow Configuration parameter
|
||||
longDescription: |
|
||||
With this step you can update the value for a configuration parameters of a designtime integration flow using the OData API. Learn more about the SAP Cloud Integration remote API for configuration update of the integration flow parameter [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/83733a65c0214aa6acba035e8640bb5a.html).
|
||||
With this step you can update the value for a configuration parameters of a designtime integration flow using the OData API. Learn more about the SAP Cloud Integration remote API for configuration update of the integration flow parameter [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).
|
||||
|
||||
spec:
|
||||
inputs:
|
||||
|
@ -2,7 +2,7 @@ metadata:
|
||||
name: integrationArtifactUpload
|
||||
description: Upload or Update an integration flow designtime artefact
|
||||
longDescription: |
|
||||
With this step you can either upload or update a integration flow designtime artifact using the OData API. Learn more about the SAP Cloud Integration remote API for updating an integration flow artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/83733a65c0214aa6acba035e8640bb5a.html).
|
||||
With this step you can either upload or update a integration flow designtime artifact using the OData API. Learn more about the SAP Cloud Integration remote API for updating an integration flow artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).
|
||||
|
||||
spec:
|
||||
inputs:
|
||||
|
Loading…
x
Reference in New Issue
Block a user