Adam Monsen
f28d252f17
* fix various typos, spacing, formatting issues * fix links to legacy docs in API docs * update keycloak oauth dev instructions * update default oauth URL for latest Keycloak * use consistent quoting in oauth docs (single quotes) * use asciidoc auto-enumerated lists whenever possible * migrate security topics from readme into asciidoc: oauth, 2FA, HTTPS * move :hardbreaks: setting to config file so all config settings are in one place. (I think it's fine that `license.adoc` will use hardbreaks -- that's how the plain text version is formatted so it should look more familiar) * add intro to security chapter * migrate in Securing Fineract wiki content from https://cwiki.apache.org/confluence/display/FINERACT/Securing+Fineract * just say "oauth" (not "oauth2") to conform terminology throughout docs -- OAuth 2.0 is just the latest version * cross-ref HTTPS section from Securing Fineract * reposition hardening options as tips * see also: https://lists.apache.org/thread/81qdxttffp6wn23c48zvk93hc13373qv * simplify/clarify example oauth curl requests * Testing just now and I didn't need --location. * Also I imagine folks will need --insecure with the self-signed default cert in dev. * don't change default oauth URL * no surprises for existing deployments * clarifies the keycloak v26 example
31 lines
1.2 KiB
Plaintext
31 lines
1.2 KiB
Plaintext
openapi: 3.0.3
|
|
info:
|
|
version: @VERSION@
|
|
title: Apache Fineract REST API
|
|
description: |-
|
|
Apache Fineract is a secure, multi-tenanted microfinance platform.
|
|
The goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform.
|
|
The [reference app](https://cui.fineract.dev) (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation.
|
|
Until we complete the new REST API documentation you still have the legacy documentation available [here](https://fineract.apache.org/docs/legacy/).
|
|
Please check [the current Fineract documentation](https://fineract.apache.org/docs/current/) for more information.
|
|
contact:
|
|
email: dev@fineract.apache.org
|
|
license:
|
|
name: Apache 2.0
|
|
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
|
|
servers:
|
|
- url: /fineract-provider/api
|
|
- url: https://demo.fineract.dev/fineract-provider/api
|
|
components:
|
|
securitySchemes:
|
|
basicAuth:
|
|
type: http
|
|
scheme: basic
|
|
tenantid:
|
|
type: apiKey
|
|
in: header
|
|
name: fineract-platform-tenantid
|
|
security:
|
|
- basicAuth: []
|
|
tenantid: []
|