Ion Channel Resolution API

Base URL: /v1/search, Version: 0.0.3

for resolution of query strings with Ion Channel

Default response content-types: application/json
Schemes:

Summary

Tag: Resolution

Resolve meaning in the world

Operation Description

Tag: Rosita

Can't we all speak the same language

Operation Description

Tag: default

Operation Description
GET /productidentifiers

returns CPE and GH match candidates for product name/organization/version

GET /repositories

returns CPE and GH match candidates for a GitHub repository URL

Paths

returns CPE and GH match candidates for product name/organization/version

GET /productidentifiers

Returns an ordered list of objects ranked by TF-IDF containing all matched CPE and GH data for the input package name/organization/version.

product_identifier

a keyword that Rosita will match against any part of NVD data

query string
vendor

whatever organization is presumed to be behind the software

query string
version

The version of the product being identified.

query string

Uses default content-types: application/json

200 OK #/responses/ProductSearchResult

An array of Entities

404 Not Found #/responses/NotFoundError

Sorry couldn't find nothing

500 Internal Server Error #/responses/StandardizedError

An Error has occurred

503 Service Unavailable #/responses/StandardizedError

An Error has occurred

returns CPE and GH match candidates for a GitHub repository URL

GET /repositories

Returns an ordered list of objects ranked by TF-IDF containing all matched CPE and GH data for the input Github URL.

github

A properly formatted GitHub URL, https://github.com/{org}/{project}

query string

Uses default content-types: application/json

200 OK #/responses/ProductSearchResult

An array of Entities

404 Not Found #/responses/NotFoundError

Sorry couldn't find nothing

500 Internal Server Error #/responses/StandardizedError

An Error has occurred

503 Service Unavailable #/responses/StandardizedError

An Error has occurred

Response definitions

StandardizedError

An Error has occurred

NotFoundError

Sorry couldn't find nothing

ProductSearchResult

An array of Entities

Schema definitions

Error: object

code: integer (int32)
message: string
fields: string

Github: object

uri: string
committer_count: integer

Product: object

id: integer
name: string
org: string
version: string
up: string
edition: string
aliases: object
created_at: string
updated_at: string
References: string
Part: string
Language: string
ExternalID: string
Sources: object[]

ProductSearchResult: object

product: Product
github: Product
mean_score: number
scores: object[]

ProductSearchScore: object

term: string
score: number

Source: object

id: integer
name: string
description: string
created_at: string
update_at: string
attribution: string
license: string
copyright_url: string