Helena Bioinformatics Reference API

openapi: 3.2.0
info:
  title: Helix Insight - Variant Analysis Service Reference API
  description: AI-powered variant analysis and interpretation service
  version: 0.1.0
tags:
- name: Reference
paths:
  /reference/cytoband/{chrom}:
    get:
      tags:
      - Reference
      summary: Get cytoband ideogram bands for a chromosome
      description: 'Return the UCSC cytoBandIdeo cytogenetic-band list for a chromosome, sorted by

        start_pos, for the SV ideogram lane.


        Accepts chr11 or 11; coordinates are returned AS PUBLISHED (UCSC 0-based half-open;

        see coord_system). arm is the None-safe leading char of band_name (p/q, or None).


        Degrade-clean: an unknown/garbage chrom, or a reference_db built before the cytoband

        asset loaded, returns 200 with bands: [] -- never a 4xx/5xx.'
      operationId: get_cytoband_reference_cytoband__chrom__get
      parameters:
      - name: chrom
        in: path
        required: true
        schema:
          type: string
          title: Chrom
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CytobandResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CytobandBand:
      properties:
        start_pos:
          type: integer
          title: Start Pos
        end_pos:
          type: integer
          title: End Pos
        band_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Band Name
        gie_stain:
          anyOf:
          - type: string
          - type: 'null'
          title: Gie Stain
        arm:
          anyOf:
          - type: string
          - type: 'null'
          title: Arm
          description: Chromosome arm (p/q), the leading char of band_name; None when band_name is absent
      type: object
      required:
      - start_pos
      - end_pos
      title: CytobandBand
      description: 'One cytogenetic band (UCSC cytoBandIdeo), AS PUBLISHED.


        Coordinates are 0-based half-open (see the response coord_system). arm is the

        None-safe leading char of band_name (p/q), or None when band_name is absent --

        derived at the read surface as `band_name[:1] if band_name else None` (the SLICE

        form; band_name is NULLABLE, so the index form band_name[0] is FORBIDDEN, Eunomia

        B1). gie_stain is the Giemsa class VERBATIM; the stain->fill mapping is the

        frontend''s.'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    CytobandResponse:
      properties:
        chrom:
          type: string
          title: Chrom
        coord_system:
          type: string
          title: Coord System
          default: ucsc-0-based-half-open
        bands:
          items:
            $ref: '#/components/schemas/CytobandBand'
          type: array
          title: Bands
      type: object
      required:
      - chrom
      - bands
      title: CytobandResponse
      description: 'The cytoband band list for one chromosome (the IdeogramLane read surface).


        bands is sorted by start_pos and is the WHOLE-chromosome list (the client draws the

        bar from it and scans it for the SV-midpoint containing band -- no second route).

        An unknown chrom or a pre-load reference_db yields bands: [] (degrade-clean), never

        a 4xx/5xx.'
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer