Skip to content

Lyric API Improvements #135

@MitchellShiell

Description

@MitchellShiell

This ticket is an aggregation of issues and oddities discovered during prelude testing/development:

1) /dictionary/register endpoint

  • returns an error when defaultCentricEntity is supplied as and empty value
  • truncates version numbers inputed into the swagger (1.0 turns to 1 here: -d 'categoryName=demo&dictionaryName=example-dictionary&dictionaryVersion=1')
Image

2) No GET /dictionary endpoint for lyric

Having a GET dictionary endpoint would allow me as a user to easily see what dictionaries have been registered to lyric

3) Make Swagger Spec accessible

4) (Optional/for review) Enable category name to be used on submission or update categoryIds to be user inputed values

I have the following categories

[
  {
    "id": 1,
    "name": "mutations"
  },
  {
    "id": 2,
    "name": "correlations"
  },
  {
    "id": 3,
    "name": "expression"
  },
  {
    "id": 4,
    "name": "protein"
  }
]

Providing a category ID is not super intuitive as the admin/user would input the category as a name see the following screenshot:

Image

Ignore validation error

5) When submitting faulty csv data (missing CSV seperator in one entry) i get the following non-descript error

2025-05-13T23:59:50.124Z [error]: There was an error processing files: genecorrelations - {"records":[],"errors":[]}

On review it looks like this occurs due to malformed csvs with empty columns not denoted by seperators

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions