Skip to content

API Language

DeclanBuckley edited this page Dec 12, 2018 · 3 revisions

Create

This method without any parameters will return the featured models from the front page of OurBricks. If the q parameter is given, it will instead search the database for the given query. This resource accepts only GET requests.

Authentication: Anonymous

Privilege : None

Method: PxStat.System.Settings.Language_API.Read

Parameters:

Name Type Default Description
LngIsoCode String Blah blah blah
LngIsoName Integer Blah blah blah

Return: Array [ Object ]

Name Type Description
LngIsoCode String Blah blah blah
LngIsoName String Blah blah blah

Read

This method without any parameters will return the featured models from the front page of OurBricks. If the q parameter is given, it will instead search the database for the given query. This resource accepts only GET requests.

Authentication: Anonymous

Privilege : None

Method: PxStat.System.Settings.Language_API.Read

Parameters:

Name Type Default Description
LngIsoCode string Blah blah blah
LngIsoName string Blah blah blah

Return: Array of Object

Name Type Description
LngIsoCode string Blah blah blah
LngIsoName string Blah blah blah
{
    "LNG_ISO_CODE": "en"
}

Example response:

[
  {
    "content" : "Here is an instruction how to deploy this project.",
    "format" : "markdown",
    "slug" : "deploy",
    "title" : "deploy"
  },
  {
    "content" : "Our development process is described here.",
    "format" : "markdown",
    "slug" : "development",
    "title" : "development"
  },{
    "content" : "*  [Deploy](deploy)\n*  [Development](development)",
    "format" : "markdown",
    "slug" : "home",
    "title" : "home"
  }
]

Methods

<static> commitWiki(repo, cb)

Commits all changes that were applied to the wiki due to re-generating the API docs.

Parameters:
Name Type Description
repo Object

information about the wiki repo to be committed

Properties
Name Type Description
url String

github url to the repo

dir String

directory into which the repo is currently checked out

cb function

called back when wiki is committed

Clone this wiki locally