MyOme Resources API

openapi: 3.2.0
info:
  title: MyOme Resources API
  version: 2.51.0
  contact:
    email: support@myome.com
  description: 'The MyOme API enables clients to:

    - List sequencing and analysis products available to the client.'
servers:
- url: /0/
  description: local development server
- url: https://api.sbx.myome.com/0/
  description: External sandbox instance for partner testing/development
- url: https://api.myome.com/0/
  description: Production API
tags:
- name: Resources
  description: Reference data—orderable products and consent types (general and product-specific).
paths:
  /consent:
    get:
      operationId: myome.api.endpoints.consent.consent_get
      security: []
      summary: List consent types
      description: Returns available consent types (general and, when requested via query, product-specific). Used to know which consent URIs to send when granting consent.
      tags:
      - Resources
      responses:
        '200':
          $ref: '#/components/responses/ConsentListResponse'
        '401':
          $ref: '#/components/responses/StructuredError'
      parameters:
      - name: consents
        in: query
        required: true
        example:
        - DNAVISIT
        - PR-2019
        schema:
          type: array
          items:
            type: string
            pattern: '[A-Z_0-9]+(-\d+\.\d+\.\d+)?$'
  /product:
    get:
      operationId: myome.api.endpoints.product.product_get
      security:
      - jwt: []
      tags:
      - Resources
      summary: List orderable products
      description: Returns the list of products that can be ordered (for use when creating requisitions).
      responses:
        '200':
          $ref: '#/components/responses/ProductListResponse'
        '401':
          $ref: '#/components/responses/StructuredError'
components:
  schemas:
    ProductId:
      type: string
      description: A reference to an ordered product.
      pattern: ^PR-?\d+$
      examples:
      - PR-0123456
      - PR0123456
    ConsentUri:
      type: string
      pattern: ^myome:consent:[A-Z_0-9]+(-\d+\.\d+\.\d+)?(-dev\.\d+)?$
      examples:
      - myome:consent:GENERAL-0.1.4
      - myome:consent:PR2008-0.0.1
      - myome:consent:DNAVISIT
      - myome:consent:PRODUCT_NOTIFICATIONS-0.0.1
      - myome:consent:PR5004-0.0.1-dev.0
      - myome:consent:HIE_ACCESS__TREATMENT
      - myome:consent:CONTACT__RESEARCH_OPPORTUNITIES
      - myome:consent:CONTACT__TRANSACTIONAL_SMS
      - myome:consent:CONTACT__MARKETING
    Product:
      type: object
      required:
      - product_id
      properties:
        description:
          type:
          - string
          - 'null'
          description: Description of analysis product
        name:
          type:
          - string
          - 'null'
          description: Short analysis product name
        product_id:
          $ref: '#/components/schemas/ProductId'
  responses:
    ProductListResponse:
      description: List of products
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Product'
          example:
          - - description: MyOme product for analysis of ACMG Secondary Findings Version 3.
              name: MyOme Personal Genome, Proactive Health, 81 Genes
              product_id: PR-2019
    StructuredError:
      description: Generic structured error message
      content:
        application/json:
          schema:
            type: object
            additionalProperties: false
            required:
            - title
            - detail
            properties:
              title:
                type: string
              detail:
                type: string
              code:
                type:
                - string
                - 'null'
                description: The type of error that occurred
              errors:
                type:
                - object
                - 'null'
                additionalProperties: true
                description: Dictionary of field names and error messages
              extra:
                oneOf:
                - type: object
                  additionalProperties: true
                - type: string
          examples:
            simple_error:
              value:
                detail: There was an error validating the request
                title: Validation error
            flat_field_errors:
              value:
                code: validation_error
                detail: Validation error
                title: Validation error
                errors:
                  field1: field is required
            nested_field_errors:
              value:
                code: validation_error
                detail: Validation error
                title: Validation error
                errors:
                  field1: field is required
                  field2:
                    field3: field is invalid
            no_field_errors:
              value:
                code: validation_error
                detail: Validation error
                title: Validation error
    ConsentListResponse:
      description: List of general and product specific consents
      content:
        application/json:
          schema:
            type: array
            items:
              type: object
              additionalProperties: false
              properties:
                consent_uri:
                  allOf:
                  - $ref: '#/components/schemas/ConsentUri'
                name:
                  type:
                  - string
                  - 'null'
                  description: Consent name
                consent_text:
                  type:
                  - string
                  - 'null'
          example:
          - - consent_uri: myome:consent:GENERAL-0.0.1
              name: MyOme General Consent
              consent_text: Example consent text
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'JSON Web Token (JWT) obtained from Keycloak.

        '
      x-bearerInfoFunc: myome.api.support.auth.validate_kc_token