Write detailed API specification documentation

[jguertin]

First draft of an API document outlining the intent and current status. Includes a skeleton of what functionality still needs to be defined.

[codecov[bot]]

Codecov Report

Merging #870 into master will increase coverage by 0.04%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #870      +/-   ##
==========================================
+ Coverage   93.78%   93.82%   +0.04%     
==========================================
  Files          59       59              
  Lines        1352     1361       +9     
  Branches      118      122       +4     
==========================================
+ Hits         1268     1277       +9     
  Misses         82       82              
  Partials        2        2

Flag	Coverage Δ
#python_unittests	97.23% <ø> (+0.03%)	:arrow_up:

Impacted Files	Coverage Δ
ppr-api/src/endpoints/search.py	100% <0%> (ø)	:arrow_up:
ppr-api/src/models/collateral.py	100% <0%> (ø)	:arrow_up:
ppr-api/src/models/financing_statement.py	100% <0%> (ø)	:arrow_up:
ppr-api/src/schemas/collateral.py	100% <0%> (ø)	:arrow_up:

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update cdd7942...a3b6999. Read the comment docs.

[sonarcloud[bot]]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
No Duplication information