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

Recource Doc: id ->operation_id , description -> summary, overview -> description (as per swagger)

Browse Source
This commit is contained in:
Simon Redfern 2015-10-03 16:53:54 +02:00
parent d0e40e0c9c
commit c713435ecc
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/scala/code/lib/ObpAPI.scala
View File

@ -655,7 +655,7 @@ object ObpJson {
// Used to describe the OBP API calls for documentation and API discovery purposes
case class ResourceDocJson(id: String,
case class ResourceDocJson(operation_id: String,
request_verb: String,
request_url: String,
summary: String, // Summary of call should be 120 characters max

12
src/main/scala/code/snippet/ApiExplorer.scala
View File

@ -56,7 +56,7 @@ class ApiExplorer extends Loggable {
// The overview contains html. Just need to convert it to a NodeSeq so the template will render it as such
val resources = for {
r <- getResourceDocsJson.map(_.resource_docs).get
} yield ResourceDoc(id = r.id, verb = r.request_verb, url = r.request_url, summary = r.summary, description = stringToNodeSeq(r.description), request_body = r.request_body)
} yield ResourceDoc(id = r.operation_id, verb = r.request_verb, url = r.request_url, summary = r.summary, description = stringToNodeSeq(r.description), request_body = r.request_body)
@ -161,13 +161,13 @@ class ApiExplorer extends Loggable {
// replace the node identified by the class "resource" with the following
// This creates the list of resources in the DOM
".resource" #> resources.map { i =>
".resource_description *" #> i.summary &
".resource_description [href]" #> s"#${i.id}" &
".resource_description [name]" #> s"${i.id}" &
".resource_summary *" #> i.summary &
".resource_summary [href]" #> s"#${i.id}" &
".resource_summary [name]" #> s"${i.id}" &
// Replace attribute named overview_text with the value (whole div/span element is replaced leaving just the text)
"@overview_text" #> i.description &
"@description_text" #> i.description &
// Give attributes named overview an id
"@overview [id]" #> s"overview_${i.id}" &
"@resource_description [id]" #> s"description_${i.id}" &
".resource_url_td [id]" #> s"resource_url_td_${i.id}" & // Probably don't need this now
".resource_verb_td [id]" #> s"resource_verb_td_${i.id}" & // Probably don't need this now
".url_caller [id]" #> s"url_caller_${i.id}" &

4
src/main/webapp/api-explorer.html
View File

@ -18,8 +18,8 @@
<tr class="resource">
<!-- Some documentation -->
<td>
<a class="resource_description" href="#replace-me">Description</a>
<div name="overview" class="markdown"><span name="overview_text">Overview</span></div>
<a class="resource_summary" href="#replace-me">Summary</a>
<div name="resource_description" class="markdown"><span name="description_text">Description</span></div>
</td>
<td>