diff --git a/apis/brigs/company/swagger.json b/apis/brigs/company/swagger.json new file mode 100644 index 0000000..35d0d41 --- /dev/null +++ b/apis/brigs/company/swagger.json @@ -0,0 +1,94 @@ +{ + "openapi" : "3.0.0", + "info" : { + "title" : "demo", + "description" : "Bisnode Risk and Credit data API", + "contact" : { + "email" : "team-ninjas@bisnode.com" + }, + "version" : "v1" + }, + "servers" : [ { + "url" : "/" + } ], + "security" : [ { + "implicit" : [ "riskAndCredit" ] + } ], + "paths" : { + "/companies/se" : { + "post" : { + "summary" : "Fetch credit and risk data on a swedish registration-number", + "description" : "Fetch risk and credit data on swedish companies", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestModel" + }, + "example" : { + "mock" : { + "registrationNumber" : "00000000000", + "reason" : "My important reason" + } + } + } + } + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResponseModel" + } + } + } + } + } + } + } + }, + "components" : { + "schemas" : { + "RequestModel" : { + "title" : "RequestModel", + "required" : [ "registrationNumber" ], + "type" : "object", + "properties" : { + "registrationNumber" : { + "type" : "string", + "description" : "A national registrationNumber, can be a socialSecurityNumber for a Sole proprietor" + }, + "reason" : { + "type" : "string", + "description" : "The reason why the client is requesting this data. The client needs a legitimate reason in certain situations. TODO - when ????" + }, + "language" : { + "type" : "string", + "description" : "Supported languages for all the description fields where i18n is supported", + "enum" : [ "SE", "EN", "NO", "DK", "FI" ], + "default" : "EN" + } + }, + "description" : "The request model for credit data" + }, + "ResponseModel" : { + "$ref" : "https://api.swaggerhub.com/domains/bisnode-apis/SwedishCompanyCreditModel/1.0.0#/components/schemas/SwedishCompanyData" + } + }, + "securitySchemes" : { + "implicit" : { + "type" : "oauth2", + "flows" : { + "implicit" : { + "authorizationUrl" : "https://login.bisnode.com/as/token.oauth2", + "scopes" : { + "riskAndCredit" : "allows access to Bisnode risk and credit data" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/apis/brigs/company/sweden/Readme.md b/apis/brigs/company/sweden/Readme.md deleted file mode 100644 index c038857..0000000 --- a/apis/brigs/company/sweden/Readme.md +++ /dev/null @@ -1 +0,0 @@ -### Folder for Brigs swedish company report.