|
|
# Welcome
|
|
Welcome to the ironapi-gw wiki!
|
|
|
|
|
|
|
|
Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
|
|
### TOC
|
|
|
|
|
|
|
|
## Wiki features
|
|
For API users:
|
|
|
|
|
|
|
|
This wiki uses the [Markdown](http://daringfireball.net/projects/markdown/) syntax. The [MarkDownDemo tutorial](https://bitbucket.org/tutorials/markdowndemo) shows how various elements are rendered. The [Bitbucket documentation](https://confluence.atlassian.com/x/FA4zDQ) has more information about using a wiki.
|
|
* [[Available Endpoints]]
|
|
|
|
|
* [[Queries]]
|
|
|
The wiki itself is actually a git repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
|
|
* [[Useful Queries]]
|
|
|
|
|
* [[Query Search Options]]
|
|
|
Go ahead and try:
|
|
* [[Saved Queries]]
|
|
|
|
|
* [[Storing Files]]
|
|
|
```
|
|
* Release Notes
|
|
|
$ git clone https://bitbucket.org/ironapigenesis/ironapi-gw.git/wiki
|
|
* [[Release Notes 2018-05-08]]
|
|
|
```
|
|
|
|
|
|
|
For API developers:
|
|
|
Wiki pages are normal files, with the .md extension. You can edit them locally, as well as creating new ones.
|
|
|
|
|
|
|
* [[Scripts]]
|
|
|
## Syntax highlighting
|
|
* [[run.sh|Run]]
|
|
|
|
|
* [[Setup Script|Setup]]
|
|
|
|
|
* [[Listener]]
|
|
|
You can also highlight snippets of text (we use the excellent [Pygments][] library).
|
|
* [[Gateway]]
|
|
|
|
|
* [[Testserver]]
|
|
|
[Pygments]: http://pygments.org/
|
|
* [[Configuration]]
|
|
|
|
|
* [[Logging]]
|
|
|
|
|
* [[Docker]]
|
|
|
Here's an example of some Python code:
|
|
* [[Testing]] |
|
|
|
|
|
|
|
```
|
|
|
|
|
#!python
|
|
|
|
|
|
|
|
|
|
def wiki_rocks(text):
|
|
|
|
|
formatter = lambda t: "funky"+t
|
|
|
|
|
return formatter(text)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can check out the source of this page to see how that's done, and make sure to bookmark [the vast library of Pygment lexers][lexers], we accept the 'short name' or the 'mimetype' of anything in there.
|
|
|
|
|
[lexers]: http://pygments.org/docs/lexers/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Have fun! |
|
|
