-
Get Started
Concepts
Secure Access
HTTP for API Transport
Resources and URI Structure
Resource Collections
Hypermedia APIs
Representation Profiles and Schemas
Versioning
Revisions
Resource Sets
Optimistic Locking and Concurrency
Error Responses and Error Representation
Markdown
OpenAPI Reference
Release Notes
Apiture API License Agreement
Markdown
Several domain objects in the Apiture Open Banking APIs contain a description
property
which is a detailed description of the resource. These description values
can encode rich text by using Markdown.
Clients should render these properties by converting the Markdown source to rich text format.
Markdown provides simple text notation:
- headings
- paragraphs
- emphasis with italics or bold or both
- numbered or bulleted lists
- hyperlinks
See GitHub Flavored Markdown for specific syntax.
For example, the beginning of this section is defined with the following Markdown:
## Markdown
Several domain objects in the Apiture Open Banking APIs contain a `description` property
which is a detailed description of the resource. These description values
can encode _rich text_ by using [Markdown](https://help.github.com/articles/basic-writing-and-formatting-syntax/).
Clients should render these fields properties converting the Markdown source to rich text format.
Markdown provides simple text notation:
* headings
* paragraphs
* emphasis with _italics_ or **bold** or ***both***
* numbered or bulleted lists
* [hyperlinks](https://github.github.com/gfm/)