org.openmetadata.service.search.indexes.APIEndpointIndex Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmetadata-service Show documentation
There is a newer version: 1.5.11
package org.openmetadata.service.search.indexes;

import static org.openmetadata.service.search.EntityBuilderConstant.ES_MESSAGE_SCHEMA_FIELD;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Predicate;
import org.openmetadata.schema.entity.data.APIEndpoint;
import org.openmetadata.schema.type.Field;
import org.openmetadata.schema.type.TagLabel;
import org.openmetadata.service.Entity;
import org.openmetadata.service.search.ParseTags;
import org.openmetadata.service.search.models.FlattenSchemaField;
import org.openmetadata.service.search.models.SearchSuggest;
import org.openmetadata.service.util.FullyQualifiedName;

public class APIEndpointIndex implements SearchIndex {
  final Set excludeAPIEndpointFields = Set.of("sampleData");
  final APIEndpoint apiEndpoint;

  public APIEndpointIndex(APIEndpoint apiEndpoint) {
    this.apiEndpoint = apiEndpoint;
  }

  @Override
  public List getSuggest() {
    List suggest = new ArrayList<>();
    suggest.add(
        SearchSuggest.builder().input(apiEndpoint.getFullyQualifiedName()).weight(5).build());
    suggest.add(SearchSuggest.builder().input(apiEndpoint.getName()).weight(10).build());
    return suggest;
  }

  @Override
  public Object getEntity() {
    return apiEndpoint;
  }

  @Override
  public Set getExcludedFields() {
    return excludeAPIEndpointFields;
  }

  public Map buildSearchIndexDocInternal(Map doc) {
    List fieldSuggest = new ArrayList<>();
    List serviceSuggest = new ArrayList<>();
    Set> tagsWithChildren = new HashSet<>();
    List fieldsWithChildrenName = new ArrayList<>();
    serviceSuggest.add(
        SearchSuggest.builder().input(apiEndpoint.getService().getName()).weight(5).build());
    serviceSuggest.add(
        SearchSuggest.builder().input(apiEndpoint.getApiCollection().getName()).weight(5).build());

    if (apiEndpoint.getResponseSchema() != null
        && apiEndpoint.getResponseSchema().getSchemaFields() != null
        && !apiEndpoint.getResponseSchema().getSchemaFields().isEmpty()) {
      List flattenFields = new ArrayList<>();
      parseSchemaFields(apiEndpoint.getResponseSchema().getSchemaFields(), flattenFields, null);

      for (FlattenSchemaField field : flattenFields) {
        fieldSuggest.add(SearchSuggest.builder().input(field.getName()).weight(5).build());
        fieldsWithChildrenName.add(field.getName());
        if (field.getTags() != null) {
          tagsWithChildren.add(field.getTags());
        }
      }
      doc.put("response_field_names", fieldsWithChildrenName);
    }

    if (apiEndpoint.getRequestSchema() != null
        && apiEndpoint.getRequestSchema().getSchemaFields() != null
        && !apiEndpoint.getRequestSchema().getSchemaFields().isEmpty()) {
      List flattenFields = new ArrayList<>();
      parseSchemaFields(apiEndpoint.getResponseSchema().getSchemaFields(), flattenFields, null);

      for (FlattenSchemaField field : flattenFields) {
        fieldSuggest.add(SearchSuggest.builder().input(field.getName()).weight(5).build());
        fieldsWithChildrenName.add(field.getName());
        if (field.getTags() != null) {
          tagsWithChildren.add(field.getTags());
        }
      }
      doc.put("request_field_names", fieldsWithChildrenName);
    }

    ParseTags parseTags = new ParseTags(Entity.getEntityTags(Entity.API_ENDPOINT, apiEndpoint));
    tagsWithChildren.add(parseTags.getTags());
    List flattenedTagList =
        tagsWithChildren.stream()
            .flatMap(List::stream)
            .collect(ArrayList::new, ArrayList::add, ArrayList::addAll);
    Map commonAttributes = getCommonAttributesMap(apiEndpoint, Entity.API_ENDPOINT);
    doc.putAll(commonAttributes);
    doc.put("lineage", SearchIndex.getLineageData(apiEndpoint.getEntityReference()));
    doc.put(
        "requestSchema",
        apiEndpoint.getRequestSchema() != null ? apiEndpoint.getRequestSchema() : null);
    doc.put(
        "responseSchema",
        apiEndpoint.getResponseSchema() != null ? apiEndpoint.getResponseSchema() : null);
    doc.put("service", getEntityWithDisplayName(apiEndpoint.getService()));
    return doc;
  }

  private void parseSchemaFields(
      List fields, List flattenSchemaFields, String parentSchemaField) {
    Optional optParentField =
        Optional.ofNullable(parentSchemaField).filter(Predicate.not(String::isEmpty));
    List tags = new ArrayList<>();
    for (Field field : fields) {
      String fieldName = field.getName();
      if (optParentField.isPresent()) {
        fieldName = FullyQualifiedName.add(optParentField.get(), fieldName);
      }
      if (field.getTags() != null) {
        tags = field.getTags();
      }

      FlattenSchemaField flattenSchemaField =
          FlattenSchemaField.builder().name(fieldName).description(field.getDescription()).build();

      if (!tags.isEmpty()) {
        flattenSchemaField.setTags(tags);
      }
      flattenSchemaFields.add(flattenSchemaField);
      if (field.getChildren() != null) {
        parseSchemaFields(field.getChildren(), flattenSchemaFields, field.getName());
      }
    }
  }

  public static Map getFields() {
    Map fields = SearchIndex.getDefaultFields();
    fields.put(ES_MESSAGE_SCHEMA_FIELD, 7.0f);
    fields.put("responseSchema.schemaFields.name.keyword", 5.0f);
    fields.put("responseSchema.schemaFields.description", 1.0f);
    fields.put("responseSchema.schemaFields.children.name", 7.0f);
    fields.put("responseSchema.schemaFields.children.keyword", 5.0f);
    return fields;
  }
}