ppalaga commented on a change in pull request #1967:
URL: https://github.com/apache/camel-quarkus/pull/1967#discussion_r514263583



##########
File path: integration-tests/zendesk/README.adoc
##########
@@ -0,0 +1,22 @@
+== Camel Quarkus Zendesk Integration Tests
+
+By default the Zendesk integration tests use WireMock to stub the API 
interactions.
+
+To run the `camel-quarkus-zendesk` integration tests against the real API, you 
must first create a Zendesk account https://www.zendesk.com/register/.
+
+This https://develop.zendesk.com/hc/en-us/articles/360001068527[guide] 
explains how to enable API access and configure password authentication. Once 
done, set the following environment variables:
+
+[source,shell]
+----
+export ZENDESK_USERNAME=your-user-name
+export ZENDESK_PASSWORD=your-password
+export ZENDESK_SERVER_URL=your-unique-server-url
+----
+
+If the WireMock stub recordings need updating, then remove the existing files 
from `src/test/resources/mappings` and run tests with either:
+
+System property `-Dwiremock.record=true`
+
+Or
+
+Set environment variable `WIREMOCK_RECORD=true`

Review comment:
       Great README!




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to