Bug fixes and updates to description (#633)
Co-authored-by: Erik Lustgarten <elustgarten@nuvalence.io>
This commit is contained in:
Erik L
GitHub
Родитель
f5cad2ef8e
Коммит
8c491ec6ff
|
|
@ -1,13 +1,13 @@
|
|||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"description": "The Entity API provides access to information about corporate entities available in the Bitvore database. Companies can be searched for based on some criteria (e.g. name, ticker, industry, etc) or directly using a Bitvore ID which uniquely identifies an entity.",
|
||||
"description": "Bitvore Cellenus is a data analytics platform that uses advanced AI techniques to provide business insights on hundreds of thousands of public and private companies from diverse sets of unstructured data (including news, press releases, SEC filings/proxy statements, earnings call transcripts and more),both public and licensed. Continuously updated on a 24/7 basis, Bitvore Cellenus derives material events, trended sentiment, growth and risk scoring to drive better business outcomes for customers.",
|
||||
"version": "2.0",
|
||||
"title": "Bitvore Cellenus",
|
||||
"contact":{
|
||||
"name":"Bitvore Support",
|
||||
"url":"https://bitvore.com/contact-us/",
|
||||
"email":"support@bitvore.com"
|
||||
"contact": {
|
||||
"name": "Bitvore Support",
|
||||
"url": "https://bitvore.com/contact-us/",
|
||||
"email": "support@bitvore.com"
|
||||
}
|
||||
},
|
||||
"host": "api.bitvore.com",
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
"description": "Lookup option. Value is used to match multiple fields.",
|
||||
"required": false,
|
||||
"type": "string",
|
||||
"x-ms-summary":"lookup",
|
||||
"x-ms-visibility":"important"
|
||||
"x-ms-summary": "lookup",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
|
|
@ -53,8 +53,8 @@
|
|||
"type": "string"
|
||||
},
|
||||
"collectionFormat": "csv",
|
||||
"x-ms-summary":"name",
|
||||
"x-ms-visibility":"advanced"
|
||||
"x-ms-summary": "name",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
{
|
||||
"name": "ticker",
|
||||
|
|
@ -66,8 +66,8 @@
|
|||
"type": "string"
|
||||
},
|
||||
"collectionFormat": "csv",
|
||||
"x-ms-summary":"ticker",
|
||||
"x-ms-visibility":"advanced"
|
||||
"x-ms-summary": "ticker",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
{
|
||||
"name": "domainName",
|
||||
|
|
@ -79,8 +79,8 @@
|
|||
"type": "string"
|
||||
},
|
||||
"collectionFormat": "csv",
|
||||
"x-ms-summary":"domainName",
|
||||
"x-ms-visibility":"advanced"
|
||||
"x-ms-summary": "domainName",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
{
|
||||
"name": "location",
|
||||
|
|
@ -92,8 +92,8 @@
|
|||
"type": "string"
|
||||
},
|
||||
"collectionFormat": "csv",
|
||||
"x-ms-summary":"location",
|
||||
"x-ms-visibility":"advanced"
|
||||
"x-ms-summary": "location",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
{
|
||||
"name": "fips",
|
||||
|
|
@ -105,8 +105,8 @@
|
|||
"type": "string"
|
||||
},
|
||||
"collectionFormat": "csv",
|
||||
"x-ms-summary":"fips",
|
||||
"x-ms-visibility":"advanced"
|
||||
"x-ms-summary": "fips",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
{
|
||||
"name": "zip",
|
||||
|
|
@ -118,8 +118,8 @@
|
|||
"type": "string"
|
||||
},
|
||||
"collectionFormat": "csv",
|
||||
"x-ms-summary":"zip",
|
||||
"x-ms-visibility":"advanced"
|
||||
"x-ms-summary": "zip",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
{
|
||||
"name": "naics",
|
||||
|
|
@ -131,8 +131,8 @@
|
|||
"type": "string"
|
||||
},
|
||||
"collectionFormat": "csv",
|
||||
"x-ms-summary":"naics",
|
||||
"x-ms-visibility":"advanced"
|
||||
"x-ms-summary": "naics",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
{
|
||||
"name": "sic",
|
||||
|
|
@ -144,8 +144,8 @@
|
|||
"type": "string"
|
||||
},
|
||||
"collectionFormat": "csv",
|
||||
"x-ms-summary":"sic",
|
||||
"x-ms-visibility":"advanced"
|
||||
"x-ms-summary": "sic",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
{
|
||||
"name": "revRange",
|
||||
|
|
@ -153,8 +153,8 @@
|
|||
"description": "Revenue range (in millions) companies must fall in. The range is formated as lower-upper where lower and upper must be one of 0, 1, 10, 50, 100, 200, 1000. The upper bound can be ommited to report over 1B.",
|
||||
"required": false,
|
||||
"type": "string",
|
||||
"x-ms-summary":"revRange",
|
||||
"x-ms-visibility":"advanced"
|
||||
"x-ms-summary": "revRange",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
{
|
||||
"name": "empRange",
|
||||
|
|
@ -162,8 +162,8 @@
|
|||
"description": "Employee range companies must fall in. The range is formated as lower-upper where lower and upper must be one of 1, 10, 50, 200, 500, 1000, 5000, 10000. The upper bound can be ommited to report over 1B.",
|
||||
"required": false,
|
||||
"type": "string",
|
||||
"x-ms-summary":"empRange",
|
||||
"x-ms-visibility":"advanced"
|
||||
"x-ms-summary": "empRange",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
{
|
||||
"name": "pageNo",
|
||||
|
|
@ -173,8 +173,8 @@
|
|||
"type": "integer",
|
||||
"default": 1,
|
||||
"format": "int32",
|
||||
"x-ms-summary":"pageNo",
|
||||
"x-ms-visibility":"advanced"
|
||||
"x-ms-summary": "pageNo",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
{
|
||||
"name": "pageSize",
|
||||
|
|
@ -184,8 +184,8 @@
|
|||
"type": "integer",
|
||||
"default": 100,
|
||||
"format": "int32",
|
||||
"x-ms-summary":"pageSize",
|
||||
"x-ms-visibility":"advanced"
|
||||
"x-ms-summary": "pageSize",
|
||||
"x-ms-visibility": "advanced"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
|
|
@ -237,9 +237,9 @@
|
|||
"description": "id",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"x-ms-summary":"id",
|
||||
"x-ms-url-encoding":"single",
|
||||
"x-ms-visibility":"important"
|
||||
"x-ms-summary": "id",
|
||||
"x-ms-url-encoding": "single",
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
|
|
@ -296,7 +296,7 @@
|
|||
"$ref": "#/definitions/OrganizationMatchingSpecification"
|
||||
}
|
||||
},
|
||||
"x-ms-visibility":"important"
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
|
|
@ -339,7 +339,7 @@
|
|||
"200": {
|
||||
"description": "Success.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GeneralAPIResponse"
|
||||
"$ref": "#/definitions/VersionAPIResponse"
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
|
|
@ -359,20 +359,6 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"x-ms-connector-metadata": [
|
||||
{
|
||||
"propertyName": "Website",
|
||||
"propertyValue": "https://bitvore.com/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Privacy policy",
|
||||
"propertyValue": "https://bitvore.com/privacy-policy/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Categories",
|
||||
"propertyValue": "Business Intelligence;AI"
|
||||
}
|
||||
],
|
||||
"definitions": {
|
||||
"Exchange": {
|
||||
"type": "object",
|
||||
|
|
@ -425,6 +411,25 @@
|
|||
},
|
||||
"description": "Properties common to most API responses."
|
||||
},
|
||||
"VersionAPIResponse": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"response",
|
||||
"success"
|
||||
],
|
||||
"properties": {
|
||||
"response": {
|
||||
"type": "string",
|
||||
"description": "Version number"
|
||||
},
|
||||
"success": {
|
||||
"type": "boolean",
|
||||
"example": true,
|
||||
"description": "Indicates whether the call was successful or not"
|
||||
}
|
||||
},
|
||||
"description": "Properties for a successful version request."
|
||||
},
|
||||
"IndustrySummary": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
@ -444,8 +449,6 @@
|
|||
"OrgSearchResponse": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"reason",
|
||||
"reasonSupport",
|
||||
"response",
|
||||
"returned",
|
||||
"success",
|
||||
|
|
@ -647,10 +650,7 @@
|
|||
"description": "Detailed information about an organization."
|
||||
},
|
||||
"OrganizationMatchingSpecification": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"$ref": "#/definitions/List"
|
||||
}
|
||||
"type": "object"
|
||||
},
|
||||
"List": {
|
||||
"type": "object"
|
||||
|
|
@ -726,7 +726,7 @@
|
|||
},
|
||||
"description": "One potential matching organization."
|
||||
},
|
||||
"SingleOrganizationMatchingResult": {
|
||||
"OrganizationMatchingResult": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"candidates": {
|
||||
|
|
@ -738,14 +738,14 @@
|
|||
},
|
||||
"spec": {
|
||||
"type": "object",
|
||||
"description": "Input organization specification used to find candidates",
|
||||
"additionalProperties": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
"description": "Input organization specification used to find candidates"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SingleOrganizationMatchingResult": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/OrganizationMatchingResult"
|
||||
},
|
||||
"description": "Results of trying to match an organization using the input specification."
|
||||
}
|
||||
|
|
@ -769,5 +769,19 @@
|
|||
"name": "Entity",
|
||||
"description": "Entity API"
|
||||
}
|
||||
],
|
||||
"x-ms-connector-metadata": [
|
||||
{
|
||||
"propertyName": "Website",
|
||||
"propertyValue": "https://bitvore.com/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Privacy policy",
|
||||
"propertyValue": "https://bitvore.com/privacy-policy/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Categories",
|
||||
"propertyValue": "Business Intelligence;AI"
|
||||
}
|
||||
]
|
||||
}
|
||||
Загрузка…
Ссылка в новой задаче