Skip to content

Commit

Permalink
Start similarity plugin api
Browse files Browse the repository at this point in the history
  • Loading branch information
meier-rene committed Jan 22, 2024
1 parent edab30f commit 650d359
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
30 changes: 30 additions & 0 deletions api-similarity-plugin/openapi.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
openapi: 3.0.3
info:
title: MassBank3 spectral similarity API
description: An API to calculate the spectral similarity between a query spectrum and some reference spectra
version: 0.0.1
servers:
- url: 'https'
paths:
/version:
get:
summary: Get the version string of the implementation.
responses:
"200":
description: version string
content:
application/json:
schema:
type: string
/similarity:
summary: Calculates the spectral similarity between the query peaklist and the spectra in reflist.
post:
summary: Create a new similarity calculation
requestBody:
description: a similarity job
required: true
content:
application/json:
schema:
$ref: "./schemas/peaklist.yaml"

12 changes: 12 additions & 0 deletions api-similarity-plugin/schemas/peaklist.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
type: object
properties:
mz:
description: mz values
type: array
items:
type: number
intensity:
description: intensity values
type: array
items:
type: number

0 comments on commit 650d359

Please sign in to comment.