Skip to content

docs(research): document the full protein lookup entry - #1803

Merged
capy-ai[bot] merged 1 commit into
mainfrom
kris/protein-lookup-fields
Nov 18, 2026
Merged

capy-ai[bot] merged 1 commit into
mainfrom
kris/protein-lookup-fields

Conversation

@KrisOei

@KrisOei KrisOei commented Nov 18, 2026

Copy link
Copy Markdown
Contributor

The protein lookup returns more of the UniProt entry than the docs described. This adds the remaining fields to the guide, the endpoint page and the OpenAPI spec:

  • disease, ptm, subunit, tissueSpecificity and domain statements, with diseaseName, diseaseAcronym and mimId on disease statements
  • features and featureCount
  • interactions and interactionCount
  • variantCount
  • length, mass and pdbCrossReferenceCount

It also says that the entry's paperIds includes papers cited only in those fields.

The field names, types and limits come from the lookup service's response code. They were not checked against a recorded API response.

Show me

ResearchProteinEntry
├── subcellularLocation, function, goCellularComponent   (already documented)
├── disease, ptm, subunit, tissueSpecificity, domain      Statement[]   + new
├── features[≤50] + featureCount                          Feature[]     + new
├── interactions[≤25] + interactionCount                  Interaction[] + new
├── variantCount, length, mass, pdbCrossReferenceCount    integers      + new
└── paperIds   every paper cited anywhere in the entry, including the new fields

Validation

  • redocly lint reports the OpenAPI spec as valid.

@mintlify

mintlify Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Nov 18, 2026, 1:56 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@capy-ai
capy-ai Bot marked this pull request as ready for review November 18, 2026 19:59
@capy-ai
capy-ai Bot marked this pull request as draft November 18, 2026 20:03
@capy-ai
capy-ai Bot marked this pull request as ready for review November 18, 2026 20:03
@capy-ai
capy-ai Bot merged commit 934dd1a into main Nov 18, 2026
4 checks passed

This branch was successfully deployed

1 active deployment
staging — 55000412 Deployed Nov 18, 2026 by mintlify[bot]
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.

1 participant