fix comments

bcgov · Aug 16, 2024 · e7ce6a4 · e7ce6a4
1 parent e7eaeca
commit e7ce6a4
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 6 deletions.
diff --git a/api/src/paths/taxonomy/taxon/index.ts b/api/src/paths/taxonomy/taxon/index.ts
@@ -9,7 +9,7 @@ export const GET: Operation = [findTaxonBySearchTerms()];
 
 GET.apiDoc = {
   description: 'Find taxon records by search criteria.',
-  tags: ['taxon_id'],
+  tags: ['taxonomy'],
   security: [
     {
       Bearer: []

diff --git a/api/src/paths/taxonomy/taxon/tsn/index.ts b/api/src/paths/taxonomy/taxon/tsn/index.ts
@@ -10,7 +10,7 @@ export const GET: Operation = [getTaxonByTSN()];
 
 GET.apiDoc = {
   description: 'Get taxon records by TSN ids.',
-  tags: ['taxon_id'],
+  tags: ['taxonomy'],
   security: [
     {
       Bearer: []

diff --git a/api/src/repositories/search-index-repository.test.ts b/api/src/repositories/search-index-repository.test.ts
@@ -187,7 +187,7 @@ describe('SearchIndexRepository', () => {
           feature_property_type_name: 'number',
           feature_property_id: 3,
           feature_property_type_id: 2,
-          name: 'taxon_id',
+          name: 'taxonomy',
           display_name: 'Taxonomy Id',
           description: 'The taxonomy Id associated to the record',
           parent_feature_property_id: null,
@@ -392,7 +392,7 @@ describe('SearchIndexRepository', () => {
           feature_property_type_name: 'number',
           feature_property_id: 3,
           feature_property_type_id: 2,
-          name: 'taxon_id',
+          name: 'taxonomy',
           display_name: 'Taxonomy Id',
           description: 'The taxonomy Id associated to the record',
           parent_feature_property_id: null,

diff --git a/api/src/services/itis-service.ts b/api/src/services/itis-service.ts
@@ -89,7 +89,7 @@ export class ItisService {
    * Returns the parent hierarchy for multiple TSNs
    *
    * @param {number[]} tsnIds
-   * @return {*}  {Promise<ItisSolrSearchResponse[]>}
+   * @return {*}  {Promise<TSNWithHierarchy[]>}
    * @memberof ItisService
    */
   async getHierarchyForTSNs(tsnIds: number[]): Promise<TSNWithHierarchy[]> {
@@ -110,6 +110,7 @@ export class ItisService {
    * Cleans up the ITIS search response data
    *
    * @param {ItisSolrSearchResponse[]} data
+   * @return {*}  {Promise<TaxonSearchResult[]>}
    * @memberof ItisService
    */
   _sanitizeItisData = (data: ItisSolrSearchResponse[]): TaxonSearchResult[] => {
@@ -187,7 +188,7 @@ export class ItisService {
   }
 
   /**
-   * Get the ITIS SOLR search-by-tsn URL with hierarchy
+   * Get the ITIS SOLR search-by-tsn URL for hierarchy information
    *
    * @param {number[]} tsnIds
    * @return {*}  {Promise<string>}

diff --git a/...src/seeds/02_population_feature_tables.ts → ...e/src/seeds/02_populate_feature_tables.ts b/...src/seeds/02_population_feature_tables.ts → ...e/src/seeds/02_populate_feature_tables.ts