Update documentation - calls that obfuscate coordinates

AtlasOfLivingAustralia / ala-sensitive-data-service

Sensitive data service suitable for use with the pipelines project

Other

1 stars 4 forks source link

Update documentation - calls that obfuscate coordinates #31

Open kylie-m opened 7 months ago

kylie-m commented 7 months ago

documentation should point out the calls that pipelines uses to obfuscate coordinates

For context, see Slack message https://atlaslivingaustralia.slack.com/archives/C03EJ7ARZQW/p1710905128896649

raised by @peggynewman

adam-collins commented 7 months ago

Related to #32

This is content for developers. It is intended for the github readme. Depends on https://github.com/AtlasOfLivingAustralia/ala-api-portal/issues/109

ALA Usage

ALA uses the sensitive service to generalise sensitive occurrences. Using ala-sensitive-data-client it will get a record report ALASDSServiceClient::report and apply each generalisation from ALASDSServiceClient::getGeneralisations with Generalisation::process to produce the generalised output. See pipelines code.

adam-collins commented 6 months ago

Now awaiting the next docs release. In the mean time link