Skip to content

周伟奇 / bmw-ocr

Go to a project
Toggle navigation
Toggle navigation pinning
d38ccba2 by 周伟奇
Options

fix doc

1 parent 44b10463
Inline Side-by-side
Showing 2 changed files with 570 additions and 559 deletions
docs/cms.yaml
......@@ -174,327 +174,333 @@ definitions:
CMS:
type: object
required:
- financeCompany
- contractNo
- status
- branch
- fpCampaign
- applicationVersion
- submissionDate
- mortgageType
- dealerRegion
- insuranceRealNameCity
- totalFinanceAmount
- terms
- dealerName
- tier
- province
- fapiaoIssuerDealer
- customerName
- customerIdNo
- vehicleStatus
- applicationSource
- contractSource
- applicationRating
- applicantInformation
- autoApprovedDetails
- financialInformation
- paymentSchedule
- associatedServices
- vehicleInformation
- bankAccountDetails
- insuranceDetails
- corporateFinancialInformation
- settlemnetVerification
- content
properties:
financeCompany:
description: financeCompany
type: string
example: 宝马汽车金融有限公司
contractNo:
description: contractNo
type: string
example: CH-B100000123
status:
description: status
type: string
example: HIL
branch:
description: branch
type: string
example: 宝马汽车金融有限公司
fpCampaign:
description: fpCampaign
type: string
example: Q1_2021_BMW_BASIC
applicationVersion:
description: applicationVersion
type: integer
example: 1
submissionDate:
description: submissionDate
type: string
example: 2020-01-01
mortgageType:
description: mortgageType
type: string
example: Mortgage Contract
dealerRegion:
description: dealerRegion
type: string
example: West
insuranceRealNameCity:
description: insuranceRealNameCity
type: boolean
example: false
totalFinanceAmount:
description: totalFinanceAmount
type: number
format: float
example: 1234.56
terms:
description: terms
type: integer
example: 24
dealerName:
description: dealerName
type: string
example: 乐山长宝汽车销售服务有限公司
tier:
description: tier
type: string
example: 2
province:
description: province
type: string
example: 四川省
fapiaoIssuerDealer:
description: fapiaoIssuerDealer
type: string
example: 乐山长宝汽车销售服务有限公司
customerName:
description: customerName
type: string
example: 蔡红
customerIdNo:
description: customerIdNo
type: string
example: 511102196706080000
vehicleStatus:
description: vehicleStatus
type: string
example: Used
applicationSource:
description: applicationSource
type: string
example: eApp
contractSource:
description: contractSource
type: string
example: Online Sign
applicationRating:
description: applicationRating
type: integer
example: 100
applicantInformation:
description: applicantInformation
type: array
items:
$ref: '#/definitions/applicantInformation'
autoApprovedDetails:
description: autoApprovedDetails
content:
description: content
type: object
required:
- aaType
- financeCompany
- contractNo
- status
- branch
- fpCampaign
- applicationVersion
- submissionDate
- mortgageType
- dealerRegion
- insuranceRealNameCity
- totalFinanceAmount
- terms
- dealerName
- tier
- province
- fapiaoIssuerDealer
- customerName
- customerIdNo
- vehicleStatus
- applicationSource
- contractSource
- applicationRating
- applicantInformation
- autoApprovedDetails
- financialInformation
- paymentSchedule
- associatedServices
- vehicleInformation
- bankAccountDetails
- insuranceDetails
- corporateFinancialInformation
- settlemnetVerification
properties:
aaType:
description: aaType
financeCompany:
description: financeCompany
type: string
example: CAA1
financialInformation:
description: financialInformation
type: object
required:
- vehiclePrice
- grossPrice
- associatedServicePrice
- vehiclePrincipal
- associatedServicePrincipal
- originationPrincipal
- totalDownPayment
- vehicleDownPaymentRatio
- optionAmount
- sumOfMSRPAndOption
properties:
vehiclePrice:
description: vehiclePrice
type: number
format: float
example: 1234.56
grossPrice:
description: grossPrice
type: number
format: float
example: 1234.56
associatedServicePrice:
description: associatedServicePrice
type: number
format: float
example: 1234.56
vehiclePrincipal:
description: vehiclePrincipal
type: number
format: float
example: 1234.56
associatedServicePrincipal:
description: associatedServicePrincipal
type: number
format: float
example: 1234.56
originationPrincipal:
description: originationPrincipal
type: number
format: float
example: 1234.56
totalDownPayment:
description: totalDownPayment
type: number
format: float
example: 1234.56
vehicleDownPaymentRatio:
description: vehicleDownPaymentRatio
type: number
format: float
example: 1234.56
optionAmount:
description: optionAmount
type: number
format: float
example: 1234.56
sumOfMSRPAndOption:
description: sumOfMSRPAndOption
example: 宝马汽车金融有限公司
contractNo:
description: contractNo
type: string
example: CH-B100000123
status:
description: status
type: string
example: HIL
branch:
description: branch
type: string
example: 宝马汽车金融有限公司
fpCampaign:
description: fpCampaign
type: string
example: Q1_2021_BMW_BASIC
applicationVersion:
description: applicationVersion
type: integer
example: 1
submissionDate:
description: submissionDate
type: string
example: 2020-01-01
mortgageType:
description: mortgageType
type: string
example: Mortgage Contract
dealerRegion:
description: dealerRegion
type: string
example: West
insuranceRealNameCity:
description: insuranceRealNameCity
type: boolean
example: false
totalFinanceAmount:
description: totalFinanceAmount
type: number
format: float
example: 1234.56
paymentSchedule:
description: paymentSchedule
type: array
items:
$ref: '#/definitions/paymentSchedule'
associatedServices:
description: associatedServices
type: array
items:
$ref: '#/definitions/associatedServices'
vehicleInformation:
description: vehicleInformation
type: object
required:
- vinNo
properties:
vinNo:
description: vinNo
type: string
example: LBV23482934DJFKD
bankAccountDetails:
description: bankAccountDetails
type: object
required:
- bankName
- accountHolderName
- accountNo
properties:
bankName:
description: bankName
terms:
description: terms
type: integer
example: 24
dealerName:
description: dealerName
type: string
example: 中国银行
accountHolderName:
description: accountHolderName
example: 乐山长宝汽车销售服务有限公司
tier:
description: tier
type: string
example: 张三
accountNo:
description: accountNo
example: 2
province:
description: province
type: string
example: 12312123123123123
insuranceDetails:
description: insuranceDetails
type: object
required:
- insuranceType
- insuranceAmount
- startDate
- endDate
properties:
insuranceType:
description: insuranceType
example: 四川省
fapiaoIssuerDealer:
description: fapiaoIssuerDealer
type: string
example: ComprehensiveInsurance
insuranceAmount:
description: insuranceAmount
example: 乐山长宝汽车销售服务有限公司
customerName:
description: customerName
type: string
example: 60000000.0
startDate:
description: startDate
example: 蔡红
customerIdNo:
description: customerIdNo
type: string
example: 2020-01-01
endDate:
description: endDate
example: 511102196706080000
vehicleStatus:
description: vehicleStatus
type: string
example: 2020-01-01
corporateFinancialInformation:
description: corporateFinancialInformation
type: object
required:
- hashCode
- borrowerName
- fiscalYear
- totaAssets
- totalLiabilitiesAndOwnersEquity
- cashAndCashEquivalentAtEndOfPeriod
- netProfit
properties:
hashCode:
description: hashCode
example: Used
applicationSource:
description: applicationSource
type: string
example: 238231
borrowerName:
description: borrowerName
example: eApp
contractSource:
description: contractSource
type: string
example: 张三
fiscalYear:
description: fiscalYear
example: Online Sign
applicationRating:
description: applicationRating
type: integer
example: 2019
totaAssets:
description: totaAssets
type: number
format: float
example: 1234.56
totalLiabilitiesAndOwnersEquity:
description: totalLiabilitiesAndOwnersEquity
type: number
format: float
example: 1234.56
cashAndCashEquivalentAtEndOfPeriod:
description: cashAndCashEquivalentAtEndOfPeriod
type: number
format: float
example: 1234.56
netProfit:
description: netProfit
type: number
format: float
example: 1234.56
settlemnetVerification:
description: settlemnetVerification
type: object
required:
- applicationNo
properties:
applicationNo:
description: applicationNo
type: string
example: CH-B100000123
example: 100
applicantInformation:
description: applicantInformation
type: array
items:
$ref: '#/definitions/applicantInformation'
autoApprovedDetails:
description: autoApprovedDetails
type: object
required:
- aaType
properties:
aaType:
description: aaType
type: string
example: CAA1
financialInformation:
description: financialInformation
type: object
required:
- vehiclePrice
- grossPrice
- associatedServicePrice
- vehiclePrincipal
- associatedServicePrincipal
- originationPrincipal
- totalDownPayment
- vehicleDownPaymentRatio
- optionAmount
- sumOfMSRPAndOption
properties:
vehiclePrice:
description: vehiclePrice
type: number
format: float
example: 1234.56
grossPrice:
description: grossPrice
type: number
format: float
example: 1234.56
associatedServicePrice:
description: associatedServicePrice
type: number
format: float
example: 1234.56
vehiclePrincipal:
description: vehiclePrincipal
type: number
format: float
example: 1234.56
associatedServicePrincipal:
description: associatedServicePrincipal
type: number
format: float
example: 1234.56
originationPrincipal:
description: originationPrincipal
type: number
format: float
example: 1234.56
totalDownPayment:
description: totalDownPayment
type: number
format: float
example: 1234.56
vehicleDownPaymentRatio:
description: vehicleDownPaymentRatio
type: number
format: float
example: 1234.56
optionAmount:
description: optionAmount
type: number
format: float
example: 1234.56
sumOfMSRPAndOption:
description: sumOfMSRPAndOption
type: number
format: float
example: 1234.56
paymentSchedule:
description: paymentSchedule
type: array
items:
$ref: '#/definitions/paymentSchedule'
associatedServices:
description: associatedServices
type: array
items:
$ref: '#/definitions/associatedServices'
vehicleInformation:
description: vehicleInformation
type: object
required:
- vinNo
properties:
vinNo:
description: vinNo
type: string
example: LBV23482934DJFKD
bankAccountDetails:
description: bankAccountDetails
type: object
required:
- bankName
- accountHolderName
- accountNo
properties:
bankName:
description: bankName
type: string
example: 中国银行
accountHolderName:
description: accountHolderName
type: string
example: 张三
accountNo:
description: accountNo
type: string
example: 12312123123123123
insuranceDetails:
description: insuranceDetails
type: object
required:
- insuranceType
- insuranceAmount
- startDate
- endDate
properties:
insuranceType:
description: insuranceType
type: string
example: ComprehensiveInsurance
insuranceAmount:
description: insuranceAmount
type: string
example: 60000000.0
startDate:
description: startDate
type: string
example: 2020-01-01
endDate:
description: endDate
type: string
example: 2020-01-01
corporateFinancialInformation:
description: corporateFinancialInformation
type: object
required:
- hashCode
- borrowerName
- fiscalYear
- totaAssets
- totalLiabilitiesAndOwnersEquity
- cashAndCashEquivalentAtEndOfPeriod
- netProfit
properties:
hashCode:
description: hashCode
type: string
example: 238231
borrowerName:
description: borrowerName
type: string
example: 张三
fiscalYear:
description: fiscalYear
type: integer
example: 2019
totaAssets:
description: totaAssets
type: number
format: float
example: 1234.56
totalLiabilitiesAndOwnersEquity:
description: totalLiabilitiesAndOwnersEquity
type: number
format: float
example: 1234.56
cashAndCashEquivalentAtEndOfPeriod:
description: cashAndCashEquivalentAtEndOfPeriod
type: number
format: float
example: 1234.56
netProfit:
description: netProfit
type: number
format: float
example: 1234.56
settlemnetVerification:
description: settlemnetVerification
type: object
required:
- applicationNo
properties:
applicationNo:
description: applicationNo
type: string
example: CH-B100000123
ApiResponse:
description: 响应对象，code字段用于表示响应的状态; data字段用于存放响应内容
type: object
......
src/common/api_doc.py
......@@ -152,279 +152,284 @@ applicantInformation:
CMS:
type: object
required: [financeCompany, contractNo, status, branch, fpCampaign, applicationVersion, submissionDate, mortgageType, dealerRegion, insuranceRealNameCity, totalFinanceAmount, terms, dealerName, tier, province, fapiaoIssuerDealer, customerName, customerIdNo, vehicleStatus, applicationSource, contractSource, applicationRating, applicantInformation, autoApprovedDetails, financialInformation, paymentSchedule, associatedServices, vehicleInformation, bankAccountDetails, insuranceDetails, corporateFinancialInformation, settlemnetVerification]
required: [content]
properties:
financeCompany:
description: financeCompany
type: string
example: 宝马汽车金融有限公司
contractNo:
description: contractNo
type: string
example: CH-B100000123
status:
description: status
type: string
example: HIL
branch:
description: branch
type: string
example: 宝马汽车金融有限公司
fpCampaign:
description: fpCampaign
type: string
example: Q1_2021_BMW_BASIC
applicationVersion:
description: applicationVersion
type: integer
example: 1
submissionDate:
description: submissionDate
type: string
example: 2020-01-01
mortgageType:
description: mortgageType
type: string
example: Mortgage Contract
dealerRegion:
description: dealerRegion
type: string
example: West
insuranceRealNameCity:
description: insuranceRealNameCity
type: boolean
example: false
totalFinanceAmount:
description: totalFinanceAmount
type: number
format: float
example: 1234.56
terms:
description: terms
type: integer
example: 24
dealerName:
description: dealerName
type: string
example: 乐山长宝汽车销售服务有限公司
tier:
description: tier
type: string
example: 2
province:
description: province
type: string
example: 四川省
fapiaoIssuerDealer:
description: fapiaoIssuerDealer
type: string
example: 乐山长宝汽车销售服务有限公司
customerName:
description: customerName
type: string
example: 蔡红
customerIdNo:
description: customerIdNo
type: string
example: 511102196706080000
vehicleStatus:
description: vehicleStatus
type: string
example: Used
applicationSource:
description: applicationSource
type: string
example: eApp
contractSource:
description: contractSource
type: string
example: Online Sign
applicationRating:
description: applicationRating
type: integer
example: 100
applicantInformation:
description: applicantInformation
type: array
items:
$ref: "#/definitions/applicantInformation"
autoApprovedDetails:
description: autoApprovedDetails
content:
description: content
type: object
required: [aaType]
properties:
aaType:
description: aaType
required: [financeCompany, contractNo, status, branch, fpCampaign, applicationVersion, submissionDate, mortgageType, dealerRegion, insuranceRealNameCity, totalFinanceAmount, terms, dealerName, tier, province, fapiaoIssuerDealer, customerName, customerIdNo, vehicleStatus, applicationSource, contractSource, applicationRating, applicantInformation, autoApprovedDetails, financialInformation, paymentSchedule, associatedServices, vehicleInformation, bankAccountDetails, insuranceDetails, corporateFinancialInformation, settlemnetVerification]
properties:
financeCompany:
description: financeCompany
type: string
example: CAA1
financialInformation:
description: financialInformation
type: object
required: [vehiclePrice, grossPrice, associatedServicePrice, vehiclePrincipal, associatedServicePrincipal, originationPrincipal, totalDownPayment, vehicleDownPaymentRatio, optionAmount, sumOfMSRPAndOption]
properties:
vehiclePrice:
description: vehiclePrice
type: number
format: float
example: 1234.56
grossPrice:
description: grossPrice
type: number
format: float
example: 1234.56
associatedServicePrice:
description: associatedServicePrice
type: number
format: float
example: 1234.56
vehiclePrincipal:
description: vehiclePrincipal
type: number
format: float
example: 1234.56
associatedServicePrincipal:
description: associatedServicePrincipal
type: number
format: float
example: 1234.56
originationPrincipal:
description: originationPrincipal
type: number
format: float
example: 1234.56
totalDownPayment:
description: totalDownPayment
type: number
format: float
example: 1234.56
vehicleDownPaymentRatio:
description: vehicleDownPaymentRatio
type: number
format: float
example: 1234.56
optionAmount:
description: optionAmount
type: number
format: float
example: 1234.56
sumOfMSRPAndOption:
description: sumOfMSRPAndOption
example: 宝马汽车金融有限公司
contractNo:
description: contractNo
type: string
example: CH-B100000123
status:
description: status
type: string
example: HIL
branch:
description: branch
type: string
example: 宝马汽车金融有限公司
fpCampaign:
description: fpCampaign
type: string
example: Q1_2021_BMW_BASIC
applicationVersion:
description: applicationVersion
type: integer
example: 1
submissionDate:
description: submissionDate
type: string
example: 2020-01-01
mortgageType:
description: mortgageType
type: string
example: Mortgage Contract
dealerRegion:
description: dealerRegion
type: string
example: West
insuranceRealNameCity:
description: insuranceRealNameCity
type: boolean
example: false
totalFinanceAmount:
description: totalFinanceAmount
type: number
format: float
example: 1234.56
paymentSchedule:
description: paymentSchedule
type: array
items:
$ref: "#/definitions/paymentSchedule"
associatedServices:
description: associatedServices
type: array
items:
$ref: "#/definitions/associatedServices"
vehicleInformation:
description: vehicleInformation
type: object
required: [vinNo]
properties:
vinNo:
description: vinNo
type: string
example: LBV23482934DJFKD
bankAccountDetails:
description: bankAccountDetails
type: object
required: [bankName, accountHolderName, accountNo]
properties:
bankName:
description: bankName
terms:
description: terms
type: integer
example: 24
dealerName:
description: dealerName
type: string
example: 中国银行
accountHolderName:
description: accountHolderName
example: 乐山长宝汽车销售服务有限公司
tier:
description: tier
type: string
example: 张三
accountNo:
description: accountNo
example: 2
province:
description: province
type: string
example: 12312123123123123
insuranceDetails:
description: insuranceDetails
type: object
required: [insuranceType, insuranceAmount, startDate, endDate]
properties:
insuranceType:
description: insuranceType
example: 四川省
fapiaoIssuerDealer:
description: fapiaoIssuerDealer
type: string
example: ComprehensiveInsurance
insuranceAmount:
description: insuranceAmount
example: 乐山长宝汽车销售服务有限公司
customerName:
description: customerName
type: string
example: 60000000.00
startDate:
description: startDate
example: 蔡红
customerIdNo:
description: customerIdNo
type: string
example: 2020-01-01
endDate:
description: endDate
example: 511102196706080000
vehicleStatus:
description: vehicleStatus
type: string
example: 2020-01-01
corporateFinancialInformation:
description: corporateFinancialInformation
type: object
required: [hashCode, borrowerName, fiscalYear, totaAssets, totalLiabilitiesAndOwnersEquity, cashAndCashEquivalentAtEndOfPeriod, netProfit]
properties:
hashCode:
description: hashCode
example: Used
applicationSource:
description: applicationSource
type: string
example: 238231
borrowerName:
description: borrowerName
example: eApp
contractSource:
description: contractSource
type: string
example: 张三
fiscalYear:
description: fiscalYear
example: Online Sign
applicationRating:
description: applicationRating
type: integer
example: 2019
totaAssets:
description: totaAssets
type: number
format: float
example: 1234.56
totalLiabilitiesAndOwnersEquity:
description: totalLiabilitiesAndOwnersEquity
type: number
format: float
example: 1234.56
cashAndCashEquivalentAtEndOfPeriod:
description: cashAndCashEquivalentAtEndOfPeriod
type: number
format: float
example: 1234.56
netProfit:
description: netProfit
type: number
format: float
example: 1234.56
example: 100
settlemnetVerification:
description: settlemnetVerification
type: object
required: [applicationNo]
properties:
applicationNo:
description: applicationNo
type: string
example: CH-B100000123
applicantInformation:
description: applicantInformation
type: array
items:
$ref: "#/definitions/applicantInformation"
autoApprovedDetails:
description: autoApprovedDetails
type: object
required: [aaType]
properties:
aaType:
description: aaType
type: string
example: CAA1
financialInformation:
description: financialInformation
type: object
required: [vehiclePrice, grossPrice, associatedServicePrice, vehiclePrincipal, associatedServicePrincipal, originationPrincipal, totalDownPayment, vehicleDownPaymentRatio, optionAmount, sumOfMSRPAndOption]
properties:
vehiclePrice:
description: vehiclePrice
type: number
format: float
example: 1234.56
grossPrice:
description: grossPrice
type: number
format: float
example: 1234.56
associatedServicePrice:
description: associatedServicePrice
type: number
format: float
example: 1234.56
vehiclePrincipal:
description: vehiclePrincipal
type: number
format: float
example: 1234.56
associatedServicePrincipal:
description: associatedServicePrincipal
type: number
format: float
example: 1234.56
originationPrincipal:
description: originationPrincipal
type: number
format: float
example: 1234.56
totalDownPayment:
description: totalDownPayment
type: number
format: float
example: 1234.56
vehicleDownPaymentRatio:
description: vehicleDownPaymentRatio
type: number
format: float
example: 1234.56
optionAmount:
description: optionAmount
type: number
format: float
example: 1234.56
sumOfMSRPAndOption:
description: sumOfMSRPAndOption
type: number
format: float
example: 1234.56
paymentSchedule:
description: paymentSchedule
type: array
items:
$ref: "#/definitions/paymentSchedule"
associatedServices:
description: associatedServices
type: array
items:
$ref: "#/definitions/associatedServices"
vehicleInformation:
description: vehicleInformation
type: object
required: [vinNo]
properties:
vinNo:
description: vinNo
type: string
example: LBV23482934DJFKD
bankAccountDetails:
description: bankAccountDetails
type: object
required: [bankName, accountHolderName, accountNo]
properties:
bankName:
description: bankName
type: string
example: 中国银行
accountHolderName:
description: accountHolderName
type: string
example: 张三
accountNo:
description: accountNo
type: string
example: 12312123123123123
insuranceDetails:
description: insuranceDetails
type: object
required: [insuranceType, insuranceAmount, startDate, endDate]
properties:
insuranceType:
description: insuranceType
type: string
example: ComprehensiveInsurance
insuranceAmount:
description: insuranceAmount
type: string
example: 60000000.00
startDate:
description: startDate
type: string
example: 2020-01-01
endDate:
description: endDate
type: string
example: 2020-01-01
corporateFinancialInformation:
description: corporateFinancialInformation
type: object
required: [hashCode, borrowerName, fiscalYear, totaAssets, totalLiabilitiesAndOwnersEquity, cashAndCashEquivalentAtEndOfPeriod, netProfit]
properties:
hashCode:
description: hashCode
type: string
example: 238231
borrowerName:
description: borrowerName
type: string
example: 张三
fiscalYear:
description: fiscalYear
type: integer
example: 2019
totaAssets:
description: totaAssets
type: number
format: float
example: 1234.56
totalLiabilitiesAndOwnersEquity:
description: totalLiabilitiesAndOwnersEquity
type: number
format: float
example: 1234.56
cashAndCashEquivalentAtEndOfPeriod:
description: cashAndCashEquivalentAtEndOfPeriod
type: number
format: float
example: 1234.56
netProfit:
description: netProfit
type: number
format: float
example: 1234.56
settlemnetVerification:
description: settlemnetVerification
type: object
required: [applicationNo]
properties:
applicationNo:
description: applicationNo
type: string
example: CH-B100000123
ApiResponse:
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!