Skip to content

Host functional swagger docs at publicly-accessible URL #49

@jennifer-bowser

Description

@jennifer-bowser

Feature description

Alex has requested the following via our Slack channel:

I want a simple URL I can point to that takes me to swagger docs. Like normalize.cancervariants.org/variation. Ideally this is live before my presentation to GREGoR (exact date TBD, but likely last week of January)

Use case

This is required for us to be able to show our work on AnyVLM to people who can't use AnyVLM locally

Acceptance Criteria

  • Given a user wants to view the AnyVLM swagger docs
    When they go to https://services.genomicmedlab.org/anyvlm
    Then they should be able to access each AnyVLM endpoint

  • Given a user wants to interact with an AnyVLM endpoint,
    When they make a GET request,
    Then they should receive a response back

  • Given a user wants to write data,
    When they make a POST or PUT request to and endpoint that writes data
    Then they should receive a 403 forbidden error since this should be RO

Proposed solution

NCH will host this, so we'll need to create a CAB ticket. Since we want to get this deployed fast, we'll probably just end up re-using our Elastic Beanstalk templates and use RDS for db.

Potential Impact

No response

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions