Files
datawave/microservices/services/modification/README.md
Ivan Bella 246642ff6f Merge submodules (#2654)
* git subrepo clone [email protected]:NationalSecurityAgency/datawave-type-utils.git core/utils/type-utils

subrepo:
  subdir:   "core/utils/type-utils"
  merged:   "867b89be18"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-type-utils.git"
  branch:   "main"
  commit:   "867b89be18"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-utils.git contrib/datawave-utils

subrepo:
  subdir:   "contrib/datawave-utils"
  merged:   "4348fc36a3"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-utils.git"
  branch:   "main"
  commit:   "4348fc36a3"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-base-rest-responses.git core/base-rest-responses

subrepo:
  subdir:   "core/base-rest-responses"
  merged:   "c5b77e8a35"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-base-rest-responses.git"
  branch:   "main"
  commit:   "c5b77e8a35"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-in-memory-accumulo.git core/in-memory-accumulo

subrepo:
  subdir:   "core/in-memory-accumulo"
  merged:   "8a9d2f46d2"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-in-memory-accumulo.git"
  branch:   "main"
  commit:   "8a9d2f46d2"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-metrics-reporter.git core/metrics-reporter

subrepo:
  subdir:   "core/metrics-reporter"
  merged:   "992378d629"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-metrics-reporter.git"
  branch:   "main"
  commit:   "992378d629"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-accumulo-utils.git core/utils/accumulo-utils

subrepo:
  subdir:   "core/utils/accumulo-utils"
  merged:   "638b3eda97"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-accumulo-utils.git"
  branch:   "main"
  commit:   "638b3eda97"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-common-utils.git core/utils/common-utils

subrepo:
  subdir:   "core/utils/common-utils"
  merged:   "c96ed21342"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-common-utils.git"
  branch:   "main"
  commit:   "c96ed21342"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone --branch=release/version4.0.9 [email protected]:NationalSecurityAgency/datawave-metadata-utils.git core/utils/metadata-utils

subrepo:
  subdir:   "core/utils/metadata-utils"
  merged:   "0d0872a05b"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-metadata-utils.git"
  branch:   "release/version4.0.9"
  commit:   "0d0872a05b"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-parent.git microservices/microservice-parent

subrepo:
  subdir:   "microservices/microservice-parent"
  merged:   "6207c9d657"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-parent.git"
  branch:   "main"
  commit:   "6207c9d657"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-service-parent.git microservices/microservice-service-parent

subrepo:
  subdir:   "microservices/microservice-service-parent"
  merged:   "8064d20ccf"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-service-parent.git"
  branch:   "main"
  commit:   "8064d20ccf"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-accumulo-service.git microservices/services/accumulo

subrepo:
  subdir:   "microservices/services/accumulo"
  merged:   "6d3839d289"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-accumulo-service.git"
  branch:   "main"
  commit:   "6d3839d289"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-audit-service.git microservices/services/audit

subrepo:
  subdir:   "microservices/services/audit"
  merged:   "2714c97b19"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-audit-service.git"
  branch:   "main"
  commit:   "2714c97b19"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-authorization-service.git microservices/services/authorization

subrepo:
  subdir:   "microservices/services/authorization"
  merged:   "292be85b63"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-authorization-service.git"
  branch:   "main"
  commit:   "292be85b63"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-config-service.git microservices/services/config

subrepo:
  subdir:   "microservices/services/config"
  merged:   "fc187c0e4b"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-config-service.git"
  branch:   "main"
  commit:   "fc187c0e4b"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-dictionary-service.git microservices/services/dictionary

subrepo:
  subdir:   "microservices/services/dictionary"
  merged:   "709957100d"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-dictionary-service.git"
  branch:   "main"
  commit:   "709957100d"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-file-provider-service.git microservices/services/file-provider

subrepo:
  subdir:   "microservices/services/file-provider"
  merged:   "27080f3b94"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-file-provider-service.git"
  branch:   "main"
  commit:   "27080f3b94"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-hazelcast-service.git microservices/services/hazelcast

subrepo:
  subdir:   "microservices/services/hazelcast"
  merged:   "8abc2ef7e9"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-hazelcast-service.git"
  branch:   "main"
  commit:   "8abc2ef7e9"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-map-service.git microservices/services/map

subrepo:
  subdir:   "microservices/services/map"
  merged:   "473ec43708"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-map-service.git"
  branch:   "main"
  commit:   "473ec43708"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-mapreduce-query-service.git microservices/services/mapreduce-query

subrepo:
  subdir:   "microservices/services/mapreduce-query"
  merged:   "22af8f93c8"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-mapreduce-query-service.git"
  branch:   "main"
  commit:   "22af8f93c8"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-modification-service.git microservices/services/modification

subrepo:
  subdir:   "microservices/services/modification"
  merged:   "768007f319"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-modification-service.git"
  branch:   "main"
  commit:   "768007f319"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-query-service.git microservices/services/query

subrepo:
  subdir:   "microservices/services/query"
  merged:   "14c65febd3"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-query-service.git"
  branch:   "main"
  commit:   "14c65febd3"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-query-executor-service.git microservices/services/query-executor

subrepo:
  subdir:   "microservices/services/query-executor"
  merged:   "4517c4c29e"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-query-executor-service.git"
  branch:   "main"
  commit:   "4517c4c29e"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-query-metric-service.git microservices/services/query-metric

subrepo:
  subdir:   "microservices/services/query-metric"
  merged:   "9123d49528"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-query-metric-service.git"
  branch:   "main"
  commit:   "9123d49528"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-spring-boot-starter-audit.git microservices/starters/audit

subrepo:
  subdir:   "microservices/starters/audit"
  merged:   "ef18c9e652"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-spring-boot-starter-audit.git"
  branch:   "main"
  commit:   "ef18c9e652"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone [email protected]:NationalSecurityAgency/datawave-spring-boot-starter-cache.git microservices/starters/cache

subrepo:
  subdir:   "microservices/starters/cache"
  merged:   "3019600791"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-spring-boot-starter-cache.git"
  branch:   "main"
  commit:   "3019600791"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-spring-boot-starter-cached-results.git microservices/starters/cached-results

subrepo:
  subdir:   "microservices/starters/cached-results"
  merged:   "b22a3d6a17"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-spring-boot-starter-cached-results.git"
  branch:   "main"
  commit:   "b22a3d6a17"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-spring-boot-starter.git microservices/starters/datawave

subrepo:
  subdir:   "microservices/starters/datawave"
  merged:   "081e0a028a"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-spring-boot-starter.git"
  branch:   "main"
  commit:   "081e0a028a"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-spring-boot-starter-metadata.git microservices/starters/metadata

subrepo:
  subdir:   "microservices/starters/metadata"
  merged:   "28337e6c23"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-spring-boot-starter-metadata.git"
  branch:   "main"
  commit:   "28337e6c23"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-spring-boot-starter-query.git microservices/starters/query

subrepo:
  subdir:   "microservices/starters/query"
  merged:   "ae730eab06"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-spring-boot-starter-query.git"
  branch:   "main"
  commit:   "ae730eab06"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* git subrepo clone (merge) [email protected]:NationalSecurityAgency/datawave-spring-boot-starter-query-metric.git microservices/starters/query-metric

subrepo:
  subdir:   "microservices/starters/query-metric"
  merged:   "fad3ed7859"
upstream:
  origin:   "[email protected]:NationalSecurityAgency/datawave-spring-boot-starter-query-metric.git"
  branch:   "main"
  commit:   "fad3ed7859"
git-subrepo:
  version:  "0.4.9"
  origin:   "https://github.com/ingydotnet/git-subrepo"
  commit:   "cce3d93"

* Updated profiles to optionally add former submodules into build/test
Updated test workflow to add all former submodules into build/.test
Changed README.md instructions from submodules to subrepo
Updated build readme
* Avoid periodic failures on a bunch of tests (force serial execution etc).
2025-02-23 13:28:07 -05:00

3.1 KiB

Modification Service

Apache License Build Status

The Dictionary service provides access to the modification api. Based on the datawave metadata, certain fields are modifiable (e.g. a document comment field) by users using this service.

Root Context

https://host:port/modification/


Modification

The root context for all modification operations is https://host:port/modification/v1/

Method Operation Description Request Body
GET / Retrieves the data dictionary N/A
GET /Descriptions Retrieves all descriptions from the dictionary N/A
GET /Descriptions/{datatype} Retrieves all descriptions for a data type from the dictionary N/A
GET /Descriptions/{datatype}/{fieldname} Retrieves from the dictionary the description for a field of a data type N/A
POST /Descriptions Uploads a set of descriptions into the dictionary [DefaultFields]
PUT /Descriptions/{datatype}/{fieldName}/{description} Sets the description for a field in a datatype N/A
POST /Descriptions Sets the description for a field in a datatype N/A
DELETE /Descriptions/{datatype}/{fieldname} Removes the description from a field of a data type N/A

Getting Started

  1. First, refer to services/README for launching the config, authorization, and audit services.

    • The authorization service should be launched with the mock profile to leverage test PKI materials and associated user configuration (see [authorization-mock.yml][auth-mock-yml]).
  2. Launch this service as follows, with the remoteauth profile to enable client cert authentication.

    java -jar service/target/modification-service*-exec.jar --spring.profiles.active=dev,remoteauth
    
  3. Ensure that the testUser.p12 (password: ChangeIt) cert is imported into your browser, and then visit any of the following:

    See sample_configuration/modification-dev.yml and configure as desired