yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-09-26 09:22:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update part14 - Add descriptions to tags and hide internal APIs

Browse Source
This commit is contained in:
sureshms 2021-08-15 16:15:40 -07:00
parent a761150de4
commit 6738586fbc
3 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/usage/UsageResource.java
View File

@ -195,6 +195,7 @@ public class UsageResource {
@Path("/compute.percentile/{entity}/{date}") @Path("/compute.percentile/{entity}/{date}")
@Operation(summary = "Compute percentiles", tags = "usage", @Operation(summary = "Compute percentiles", tags = "usage",
description = "Compute percentile ranking for an entity based on last 30 days of usage.", description = "Compute percentile ranking for an entity based on last 30 days of usage.",
hidden = true,
responses = { responses = {
@ApiResponse(responseCode = "201", description = "Percentiles computed"), @ApiResponse(responseCode = "201", description = "Percentiles computed"),
@ApiResponse(responseCode = "400", description = "Bad request") @ApiResponse(responseCode = "400", description = "Bad request")

2
catalog-rest-service/src/main/resources/json/data/tags/personalDataTags.json
View File

@ -1,7 +1,7 @@
{ {
"name": "PersonalData", "name": "PersonalData",
"categoryType": "Classification", "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": [ "children": [
{ {
"name": "Personal", "name": "Personal",

2
catalog-rest-service/src/main/resources/json/data/tags/piiTags.json
View File

@ -1,7 +1,7 @@
{ {
"name": "PII", "name": "PII",
"categoryType": "Classification", "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": [ "children": [
{ {
"name": "None", "name": "None",