artin/OBP-API
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-API.git synced 2026-02-06 18:46:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating documentation on the Resource Docs call

Browse Source
This commit is contained in:
Simon Redfern 2015-11-05 12:56:20 +01:00
parent 91c5f2aa0c
commit 9ea88c2ce0
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/main/scala/code/api/v1_4_0/APIMethods140.scala
View File

@ -302,13 +302,24 @@ trait APIMethods140 extends Loggable with APIMethods130 with APIMethods121{
"GET",
"/resource-docs/obp",
"Get Resource Documentation in OBP format.",
"Returns documentation about the resources on this server including example body for POST or PUT requests.",
"""Returns documentation about the RESTful resources on this server including example body for POST or PUT requests.
| Thus the OBP API Explorer (and other apps) can display and work with the API documentation.
| In the future this information will be used to create Swagger and RAML files.
|<ul>
|<li> operation_id is concatenation of version and function and should be unque (the aim of this is to allow links to code) </li>
|<li> version references the version that the API call is defined in.</li>
|<li> function is the (scala) function.</li>
|<li> request_url is empty for the root call, else the path.</li>
|<li> summary is a short description inline with the swagger terminology. </li>
|<li> description can contain html markup.</li>
|</ul>
""",
emptyObjectJson,
emptyObjectJson,
emptyObjectJson :: Nil
)
// Provides resource documents so that live docs (currently on Sofi) can display API documentation
// Provides resource documents so that API Explorer (or other apps) can display API documentation
lazy val getResourceDocs : PartialFunction[Req, Box[User] => Box[JsonResponse]] = {
case "resource-docs" :: "obp" :: Nil JsonGet _ => {
user => {