bug6319: document ORC_API_KEY onboarding and how to obtain an ORC API key

Add an entry under "Tuning the Eclipse Installation" explaining that
ORC_API_KEY must be defined as an Eclipse String Substitution variable and
referenced as an environment variable in the test launch configuration, but
only if one wants to run the ORC public-certificate tests
(TestORCPublicCertificateDatabase, TestORCPerformanceCurve) locally with
success. Without the key these tests fail on purpose (rather than being
skipped) so the misconfiguration is noticed; offline tests still run.

Also describe how to obtain a key: ask the team lead, or request your own via
ORC Sailor Services -> Developers page (request API access, then create keys
once granted), noting that a key is shown only once at creation.

Assisted-By: Claude (claude-4.8-opus)
This commit is contained in:
Axel Uhl committed 2026-10-17 18:33:38 +02:00
1 parent 326cdc1acb
commit fd97a6b8a2
1 file changed
+1
+1
View File
@@ -106,6 +106,7 @@ B. Go to Window ⇒ Preferences and change the following settings:
- For YouTube API access, provide an Eclipse variable ``YOUTUBE_API_KEY``. You can use your own Google developer account to create such a key; see [here](https://console.cloud.google.com).
- In case you need to test with the payment provider (ChargeBee) active, you need to provide Eclipse variables (Run/Rebug ⇒ String Substitution) ``CHARGEBEE_SITE`` and ``CHARGEBEE_API_KEY`` where the recommendation is to use ``sailytics-test`` for the site and a corresponding test API key; there is one launch configuration running against the live ChargeBee site, but its use is not recommended for obvious reasons. For it, define the variables ``CHARGEBEE_SITE_LIVE`` and ``CHARGEBEE_API_KEY_LIVE``, respectively.
- To successfully obtain polar and wind estimation data from ``sapsailing.com``, you need to define the Eclipse variables (Run/Debug ⇒ String Substitution) ``POLAR_DATA_BEARER_TOKEN`` and ``WIND_ESTIMATION_MODEL_BEARER_TOKEN`` that need to authenticate a user with permissions to read the respective models.
- Only if you want to run the ORC public-certificate tests (e.g., ``TestORCPublicCertificateDatabase``, ``TestORCPerformanceCurve``) locally with success: define an Eclipse variable (Run/Debug ⇒ String Substitution) ``ORC_API_KEY`` and reference it as an environment variable in the test launch configuration. The adapter reads the key from the ``ORC_API_KEY`` environment variable and talks to the key-based ORC JSON API at ``https://sas.orc.org/api/{key}/``. Without the key these tests fail (rather than being skipped) on purpose, so the misconfiguration is noticed; offline tests in the same classes still run. To obtain a key, either ask your team lead for one, or request your own: sign in to ORC Sailor Services at [https://sas.orc.org/](https://sas.orc.org/), then open the [Developers page](https://sas.orc.org/developers.html) and request API access for your account (describe your project and how it will use the API); once ORC grants access (confirmed by email), you create your keys on that same Developers page. See the [API documentation](https://sas.orc.org/api-docs.php) for the full procedure and endpoint reference. Note that a key is shown only once at creation, so store it safely; if lost, revoke it and create a new one.
- Define a ``GITHUB_TOKEN`` variable; it may be empty (but has to be generally present), or you can use it to set a personal access token (PAT) which will then be used, in particular, for requesting application releases from GitHub.
- To work with the wind estimation model training launch configuration (e.g., SimpleModelsTrainingPart1.launch), define an Eclipse variable (Run/Debug ⇒ String Substitution) ``SAPSAILING_BEARER_TOKEN`` which needs to authenticate a user eligible to read all maneuver data from sapsailing.com
- In "GWT ⇒ Errors/Warnings" set "Missing SDK" to "Ignore"