From 6738586fbc81c8bb8e8257d3207184e15dd0ca2d Mon Sep 17 00:00:00 2001 From: sureshms Date: Sun, 15 Aug 2021 16:15:40 -0700 Subject: [PATCH] Documentation update part14 - Add descriptions to tags and hide internal APIs --- .../org/openmetadata/catalog/resources/usage/UsageResource.java | 1 + .../src/main/resources/json/data/tags/personalDataTags.json | 2 +- .../src/main/resources/json/data/tags/piiTags.json | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/usage/UsageResource.java b/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/usage/UsageResource.java index f2c57cecef1..842a632daf4 100644 --- a/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/usage/UsageResource.java +++ b/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/usage/UsageResource.java @@ -195,6 +195,7 @@ public class UsageResource { @Path("/compute.percentile/{entity}/{date}") @Operation(summary = "Compute percentiles", tags = "usage", description = "Compute percentile ranking for an entity based on last 30 days of usage.", + hidden = true, responses = { @ApiResponse(responseCode = "201", description = "Percentiles computed"), @ApiResponse(responseCode = "400", description = "Bad request") diff --git a/catalog-rest-service/src/main/resources/json/data/tags/personalDataTags.json b/catalog-rest-service/src/main/resources/json/data/tags/personalDataTags.json index 1e684e91ccd..e1b4938c064 100644 --- a/catalog-rest-service/src/main/resources/json/data/tags/personalDataTags.json +++ b/catalog-rest-service/src/main/resources/json/data/tags/personalDataTags.json @@ -1,7 +1,7 @@ { "name": "PersonalData", "categoryType": "Classification", - "description": "Tags related classifying **Personal data** as defined by **GDPR.**\n\n\n\n**_Note to Legal_**\n\n_This tag category is provided as a starting point. Please review and update the tags based on your company policy. Also, add a reference to your GDPR policy document in this description._", + "description": "Tags related classifying **Personal data** as defined by **GDPR.**\n\n\n\n_Note to Legal_\n\n_This tag category is provided as a starting point. Please review and update the tags based on your company policy. Also, add a reference to your GDPR policy document in this description._", "children": [ { "name": "Personal", diff --git a/catalog-rest-service/src/main/resources/json/data/tags/piiTags.json b/catalog-rest-service/src/main/resources/json/data/tags/piiTags.json index d9b1ae58454..e91e1877d17 100644 --- a/catalog-rest-service/src/main/resources/json/data/tags/piiTags.json +++ b/catalog-rest-service/src/main/resources/json/data/tags/piiTags.json @@ -1,7 +1,7 @@ { "name": "PII", "categoryType": "Classification", - "description": "Personally Identifiable Information information that, when used alone or with other relevant data, can identify an individual.\n\n\n\n**_Note to Legal_**\n\n_This tag category is provided as a starting point. Please review and update the tags based on your company policy. Also, add a reference to your PII policy document in this description._", + "description": "Personally Identifiable Information information that, when used alone or with other relevant data, can identify an individual.\n\n\n\n_Note to Legal_\n\n_This tag category is provided as a starting point. Please review and update the tags based on your company policy. Also, add a reference to your PII policy document in this description._", "children": [ { "name": "None",