Olympus Entertainment Wiki

https://wiki.olympus-entertainment.com/wiki
Admin
Olympus Entertainment Wiki is a comprehensive community documentation resource providing server...
Tokens:182,144
Snippets:1,582
Trust Score:7.7
Update:7 months ago
Show doc for...
Tokens:
Raw
### Complete Upload with Warnings Ignored (API Example)

Source: https://wiki.olympus-entertainment.com/wiki/Special%3AApiHelp/upload

This example shows how to complete a file upload that may have encountered warnings. It uses the filekey from a previous upload attempt, sets ignorewarnings to 1 to bypass any issues, and requires a CSRF token. The request should be made using GET.

```url
api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1&token=123ABC
```

--------------------------------

### Create User Account Example (PHP)

Source: https://wiki.olympus-entertainment.com/wiki/Special%3AApiHelp/createaccount

Example demonstrating how to initiate the user account creation process using the MediaWiki API. It includes parameters for username, password, return URL, and a create account token. This example assumes you have a valid token.

```php
<?php

$api_url = 'https://wiki.olympus-entertainment.com/api.php';
$username = 'Example';
$password = 'ExamplePassword';
$retype_password = 'ExamplePassword';
$return_url = 'http://example.org/';
$create_token = '123ABC'; // Replace with a valid token obtained from action=query&meta=tokens

$params = [
    'action' => 'createaccount',
    'username' => $username,
    'password' => $password,
    'retype' => $retype_password,
    'createreturnurl' => $return_url,
    'createtoken' => $create_token
];

$url = $api_url . '?' . http_build_query($params);

echo "Initiating account creation. Please visit: <a href=\"" . htmlspecialchars($url) . "\">" . htmlspecialchars($url) . "</a>";

// In a real application, you would handle the response from the API.
// This might involve checking for redirects, UI prompts, or success/failure messages.

?>
```

--------------------------------

### GET /api.php?action=themelist

Source: https://wiki.olympus-entertainment.com/wiki/Special%3AApiHelp/themelist

Retrieves a list of all available skins and their associated themes from the MediaWiki installation. This module requires read permissions.

```APIDOC
## GET /api.php?action=themelist

### Description
This endpoint retrieves a list of all available skins and their themes. It requires read rights.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Must be set to "themelist".

### Request Example
```
GET /api.php?action=themelist
```

### Response
#### Success Response (200)
- **skins** (object) - An object containing skin names as keys and their theme lists as values.
  - **theme** (array) - A list of themes available for a specific skin.

#### Response Example
```json
{
  "batchcomplete": "",
  "query": {
    "themelist": {
      "vector": [
        "default",
        "light",
        "dark"
      ],
      "timeless": [
        "default"
      ]
    }
  }
}
```
```

--------------------------------

### Upload File from URL (API Example)

Source: https://wiki.olympus-entertainment.com/wiki/Special%3AApiHelp/upload

This example demonstrates how to upload a file to MediaWiki by providing a URL. It requires the action=upload parameter, a filename, the URL of the file, and a CSRF token for authentication. The request should be made using GET.

```url
api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png&token=123ABC
```

--------------------------------

### Validate Password API Call (GET Example)

Source: https://wiki.olympus-entertainment.com/wiki/Special%3AApiHelp/validatepassword

This example demonstrates how to validate a password using the MediaWiki API's 'validatepassword' action via a GET request. It shows validating the password 'foobar' for the current user. Note: The actual API call often uses POST for security, but GET examples are provided for illustration.

```http
GET /api.php?action=validatepassword&password=foobar HTTP/1.1
Host: wiki.olympus-entertainment.com
```

--------------------------------

### Query Site Info in PHP Format

Source: https://wiki.olympus-entertainment.com/wiki/Special%3AApiHelp/php

This example demonstrates how to query site information (namespaces) from the MediaWiki API and receive the output formatted as serialized PHP.

```APIDOC
## GET /api.php

### Description
Retrieves site information, specifically namespaces, formatted as serialized PHP.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - The action to perform, typically 'query'.
- **meta** (string) - Required - The metadata module to query, 'siteinfo' in this case.
- **siprop** (string) - Required - The specific site info properties to retrieve, 'namespaces' in this case.
- **format** (string) - Required - The desired output format, 'php'.
- **formatversion** (integer) - Optional - Specifies the version of the PHP output format. Accepts '1', '2', or 'latest'. Defaults to '1'.

### Request Example
```
api.php?action=query&meta=siteinfo&siprop=namespaces&format=php
```

### Response
#### Success Response (200)
- **query** (object) - Contains the query results.
  - **namespaces** (object) - An object where keys are namespace IDs and values are namespace details.
    - **-1** (object) - Details for the MediaWiki namespace.
      - **id** (integer) - The namespace ID.
      - **case** (string) - The case sensitivity of the namespace name.
      - **name** (string) - The name of the namespace.
    - **0** (object) - Details for the Main namespace.
      - **id** (integer) - The namespace ID.
      - **case** (string) - The case sensitivity of the namespace name.
      - **name** (string) - The name of the namespace.
    - ... (other namespaces)

#### Response Example
```php
{
    "query": {
        "namespaces": {
            "-1": {
                "id": -1,
                "case": "case-sensitive",
                "name": "MediaWiki"
            },
            "0": {
                "id": 0,
                "case": "case-insensitive",
                "name": ""
            },
            "1": {
                "id": 1,
                "case": "case-sensitive",
                "name": "Talk"
            }
        }
    }
}
```
```

--------------------------------

### Validate Password API Call for New User (GET Example)

Source: https://wiki.olympus-entertainment.com/wiki/Special%3AApiHelp/validatepassword

This example shows how to validate a password for a new user account creation using the MediaWiki API's 'validatepassword' action via a GET request. It includes validating the password 'querty' for a user named 'Example'. Similar to other examples, POST is generally preferred for actual use.

```http
GET /api.php?action=validatepassword&password=querty&user=Example HTTP/1.1
Host: wiki.olympus-entertainment.com
```

--------------------------------

### Help Module

Source: https://wiki.olympus-entertainment.com/wiki/Special%3AApiHelp/main

Provides help information for the MediaWiki API. You can retrieve general help or recursively include help for all submodules.

```APIDOC
## GET /api.php?action=help

### Description
Retrieves help information for the MediaWiki API. This endpoint can be used to get general help or to recursively fetch help for all associated submodules.

### Method
GET

### Endpoint
`/api.php`

### Query Parameters

- **action** (string) - Required - Must be set to `help`.
- **recursivesubmodules** (boolean) - Optional - If set to `1`, includes help for all submodules recursively.

### Request Example

**General Help:**
```
api.php?action=help
```

**Recursive Help:**
```
api.php?action=help&recursivesubmodules=1
```

### Response

#### Success Response (200)

- **helptext** (string) - The help text for the API or submodule(s).

#### Response Example (Illustrative)

```json
{
  "batchcomplete": "",
  "query": {
    "helptext": "This is the main help text for the MediaWiki API..."
  }
}
```
```

--------------------------------

### Initiate MediaWiki Login (API)

Source: https://wiki.olympus-entertainment.com/wiki/Special%3AApiHelp/clientlogin

Initiates the login process to a MediaWiki instance using the `clientlogin` API module. This requires providing username, password, a return URL for third-party authentication, and a login token. The request is made via GET to `api.php`.

```api
api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC
```

--------------------------------

### MediaWiki API: Change User Group Membership (GET Request)

Source: https://wiki.olympus-entertainment.com/wiki/Special%3AApiHelp/userrights

This example demonstrates how to change a user's group membership using the MediaWiki API's userrights action via a GET request. It requires parameters such as the user, groups to add or remove, expiry time, and a userrights token.

```api
https://wiki.olympus-entertainment.com/w/api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC
```

```api
https://wiki.olympus-entertainment.com/w/api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC
```

```api
https://wiki.olympus-entertainment.com/w/api.php?action=userrights&user=SometimeSysop&add=sysop&expiry=1%20month&token=123ABC
```

--------------------------------

### GET /api.php?action=query&meta=siteinfo

Source: https://wiki.olympus-entertainment.com/wiki/Special%3AApiHelp/query%2Bsiteinfo

Retrieves general information about the MediaWiki site. This endpoint can be customized to fetch specific details using the 'siprop' parameter.

```APIDOC
## GET /api.php?action=query&meta=siteinfo

### Description
Retrieves general information about the MediaWiki site. This endpoint can be customized to fetch specific details using the 'siprop' parameter.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Must be set to "query".
- **meta** (string) - Required - Must be set to "siteinfo".
- **siprop** (string) - Optional - Specifies which information to get. Multiple values can be separated by `|`. Available values include: `general`, `namespaces`, `namespacealiases`, `specialpagealiases`, `magicwords`, `interwikimap`, `dbrepllag`, `statistics`, `usergroups`, `libraries`, `extensions`, `fileextensions`, `rightsinfo`, `restrictions`, `languages`, `languagevariants`, `skins`, `extensiontags`, `functionhooks`, `showhooks`, `variables`, `protocols`, `defaultoptions`, `uploaddialog`. Defaults to `general`.
- **sifilteriw** (string) - Optional - Used with `siprop=interwikimap`. Filters the interwiki map to return only `local` or `!local` (nonlocal) entries.
- **sishowalldb** (boolean) - Optional - Used with `siprop=dbrepllag`. Lists all database servers, not just the one lagging the most.
- **sinumberingroup** (boolean) - Optional - Lists the number of users in user groups.
- **siinlanguagecode** (string) - Optional - Language code for localized language names and skin names.

### Request Example
```json
{
  "example": "api.php?action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics"
}
```

### Response
#### Success Response (200)
- **query.general** (object) - Overall system information.
- **query.namespaces** (object) - List of registered namespaces and their canonical names.
- **query.namespacealiases** (object) - List of registered namespace aliases.
- **query.statistics** (object) - Site statistics.

#### Response Example
```json
{
  "example": "{\n  \"batchcomplete\": \"\",\n  \"continue\": {\n    \"continue\": -1,\n    \"sroffset\": 1\n  },\n  \"query\": {\n    \"general\": {\n      \"minprefixlen\": 3,\n      \"maxuploadsize\": 805306368,\n      \"maxfilesize\": 805306368,\n      \"fallback\": \"en\",\n      \"writeapi\": 1,\n      \"variantarticlecounts\": 1,\n      \"forcelatest\": 0,\n      \"readonly\": 0,\n      \"basetimestamp\": \"2023-10-27T10:00:00Z\",\n      \"case\": \"first-letter\",\n      \"magicwordvalues\": {\n        \"#redirect\": 0,\n        \"#defaultsort\": 0,\n        \"#invoke\": 0\n      }\n    },\n    \"namespaces\": {\n      \"-2\": {\n        \"id\": -2,\n        \"name\": \"Media\",\n        \"canonical\": \"Media\"\n      },\n      \"0\": {\n        \"id\": 0,\n        \"name\": \"\",\n        \"canonical\": \"\"\n      }\n      // ... other namespaces
    },\n    \"namespacealiases\": {\n      \"User\": 2,\n      \"Talk\": 3\n      // ... other aliases
    },\n    \"statistics\": {\n      \"pagesize\": 0,\n      \"articles\": 10000,\n      \"views\": 1000000,\n      \"edits\": 500000,\n      \"imagins\": 1000\n    }\n  }\n}" 
}
```
```
Tokens:
Raw