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

Added Cheat Sheet in glossary and file (for those who don’t have access to a running API Explorer instance)

Browse Source
This commit is contained in:
Simon Redfern 2018-12-20 14:29:45 +01:00
parent 9fc052d035
commit 346536cfe7
2 changed files with 82 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
cheat_sheet.md Normal file
View File

@ -0,0 +1,37 @@
#OBP Cheat Sheet.
## A selection of links to get you started using the Open Bank Project platform and surrounding tools.
## Note! *The latest version of this document is available at the glossary* [here](https://apiexplorersandbox.openbankproject.com/glossary#OBP.Cheat-Sheet)
[OBP API Installation](https://github.com/OpenBankProject/OBP-API/blob/develop/README.md)
[OBP API Contributing](https://github.com/OpenBankProject/OBP-API/blob/develop/CONTRIBUTING.md)
[Access Control](https://apiexplorersandbox.openbankproject.com/glossary#API.Access-Control)
[Authentication](https://github.com/OpenBankProject/OBP-API/wiki/Authentication)
[Interfaces](https://apiexplorersandbox.openbankproject.com/glossary#API.Interfaces)
[Endpoints](https://apiexplorersandbox.openbankproject.com)
[Versioning](https://github.com/OpenBankProject/OBP-API/wiki/API-Versioning)
[Glossary](https://apiexplorersandbox.openbankproject.com/glossary)
[Access Control](https://apiexplorersandbox.openbankproject.com/glossary#API.Access-Control)
[OBP Kafka](https://apiexplorersandbox.openbankproject.com/glossary#Adapter.Kafka.Intro)
[OBP Akka](https://apiexplorersandbox.openbankproject.com/glossary#Adapter.Akka.Intro)
[API Explorer](https://github.com/OpenBankProject/API-Explorer/blob/develop/README.md)
[API Manager](https://github.com/OpenBankProject/API-Manager/blob/master/README.md)
[API Tester](https://github.com/OpenBankProject/API-Tester/blob/master/README.md)

45
src/main/scala/code/api/util/Glossary.scala
View File

@ -85,6 +85,51 @@ object Glossary {
glossaryItems += GlossaryItem(
title = "OBP.Cheat Sheet",
description =
s"""
|## A selection of links to get you started using the Open Bank Project API platform, applications and tools.
|
|[OBP API Installation](https://github.com/OpenBankProject/OBP-API/blob/develop/README.md)
|
|[OBP API Contributing](https://github.com/OpenBankProject/OBP-API/blob/develop/CONTRIBUTING.md)
|
|[Access Control](/glossary#API.Access-Control)
|
|[Versioning](https://github.com/OpenBankProject/OBP-API/wiki/API-Versioning)
|
|[Authentication](https://github.com/OpenBankProject/OBP-API/wiki/Authentication)
|
|[Interfaces](/glossary#API.Interfaces)
|
|[Endpoints](https://apiexplorersandbox.openbankproject.com)
|
|[Glossary](/glossary)
|
|[Access Control](/glossary#API.Access-Control)
|
|[OBP Kafka](/glossary#Adapter.Kafka.Intro)
|
|[OBP Akka](/glossary#Adapter.Akka.Intro)
|
|[API Explorer](https://github.com/OpenBankProject/API-Explorer/blob/develop/README.md)
|
|[API Manager](https://github.com/OpenBankProject/API-Manager/blob/master/README.md)
|
|[API Tester](https://github.com/OpenBankProject/API-Tester/blob/master/README.md)
|
|
""")
glossaryItems += GlossaryItem(
title = "Adapter.Akka.Intro",
description =