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

Разработать эндпоинт api/reference #122

Open
const8ine opened this issue Jan 31, 2023 · 0 comments
Open

Разработать эндпоинт api/reference #122

const8ine opened this issue Jan 31, 2023 · 0 comments

Comments

@const8ine
Copy link
Member

const8ine commented Jan 31, 2023

Разработать новый GET эндпоинт, отдающий данные о ссылках на литературу для каждого эксперимента каждого гена.

Формат ответа:

"items": [
  {
    "id": 1,
    "publication": "10.1210/en.2003-0374",
    "type": "doi",
    "gene": "GHR",
    "section": {
      "type": "study", 
      "position": "ageRelatedChangesOfGene"
    }
  },
  {
    "id": 2,
    "publication": "10.1210/en.2003-0374",
    "type": "pmid",
    "gene": "GHR",
    "section": {
      "type": "commentEvolution", 
      "position": "in text"
    }
  }
]

Для того, чтобы отдать данные в этом эндпоинте, нужно собрать следующие данные, относящиеся к гену в таблице gene:

все исследования из связанных таблиц

commentEvolution или commentEvolutionEN

commentCause или commentCauseEN

uniprot_summary или uniprot_summary_en (мы потом поправим эту разницу в нейминге, и то что где-то снейк кейс, где-то кэмел кейс)

в зависимости от языка

Пояснения к структуре ответа:

  • id — внутренний id в БД

  • publication — это строка с идентификатором статьи из полей pmid или reference. Если заполнено и то и другое, будет два объекта с одним и тем же геном, но разными публикациями

  • type — собственно doi или pmid соответственно тому откуда взята строка

  • gene — symbol гена

  • section — хранит объект, в котором поле type хранит название поля, в котором у одного гена в эндпоинте api/gene/*ген* можно найти ссылку на эту публикацию. Поле position: если type "study", то в position будет указана строка с названием поля с экспериментом. Если у type другое значение, то в position будет строка “in text“.

Подробнее про section

Поле Значения
type 'researches' | 'commentEvolution' | 'proteinDescriptionUniProt' | 'commentCause'
position 'increaseLifespan' | 'ageRelatedChangesOfGene' | 'interventionToGeneImprovesVitalProcesses' |  'proteinRegulatesOtherGenes' | 'geneAssociatedWithProgeriaSyndromes' | 'geneAssociatedWithLongevityEffects' | 'additionalEvidences' | 'in text'
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

No branches or pull requests

1 participant