Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixed the level 1 representation for the get endpoint #52

Merged
merged 2 commits into from
Sep 25, 2023

Conversation

waterflow80
Copy link
Collaborator

fixes #48
The refactor was straightforward, because we coded the seqcol level attributes in a separate class: JSONLevelOne, and it is separated from the meta-data, like the naming_convention, and digest.

The output of the GET (retrieval) endpoint with level=1 is now:

{
    "sequences": "dda3Kzi1Wkm2A8I99WietU1R8J4PL-D6",
    "names": "mfxUkK3J5y7BGVW7hJWcJ3erxuaMX6xm",
    "lengths": "Ms_ixPgQMJaM54dVntLWeovXSO7ljvZh",
    "md5-sequences": "_6iaYtcWw4TZaowlL7_64Wu9mbHpDUw4",
    "sorted-name-length-pairs": "Yz3kB58sQCEWKRbx9KOW5x6Gc7OJlgIs"
}

Note: we fixed the hyphen convention-underscore convention in another PR.

Suggestion

We can add another endpoint that gives the user the possibility to fetch the seqcol object with other metadata.

So the new endpoint may be like:

  • ../collection/{digest}/metadata
  • or ../collection/{digest}/extended
  • or ../collection/{digest}?level=1&moreInfo=1

A discussion must be done to choose the best endpoint schema

@waterflow80 waterflow80 requested a review from tcezard September 21, 2023 17:25
Copy link
Member

@tcezard tcezard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.
As stated in the meeting, sequence collection is meant to be able to contain any metadata we want so we should add the naming convention and source assembly directly in the collection.

@waterflow80 waterflow80 merged commit 3199dc5 into EBIvariation:main Sep 25, 2023
@waterflow80 waterflow80 deleted the level_1_repr_fix branch October 20, 2023 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Level1 representation is incorrect
2 participants