Skip to content

Commit

Permalink
fix: resolve conflicts and fix styling
Browse files Browse the repository at this point in the history
  • Loading branch information
@agrim-deriv
agrim-deriv committed Sep 5, 2024
2 parents 7be4a93 + e8cd4de commit 1b4ebb6
Show file tree
Hide file tree
Showing 217 changed files with 8,502 additions and 769 deletions.
3 changes: 2 additions & 1 deletion config/v3/mt5_new_account/send.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,8 @@
"p01_ts03",
"p01_ts04",
"p02_ts02",
"p03_ts01"
"p03_ts01",
"p03_ts02"
]
},
"state": {
Expand Down
5 changes: 5 additions & 0 deletions config/v3/partner_settings/receive.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@
"company"
]
},
"platform_URL": {
"description": "Platform URL for Dynamic works dashboard to be redirected from Partners Hub which will be set in BackOffice.",
"type": "string",
"pattern": "^[\\w_@./:#&+-]*$"
},
"provider": {
"description": "Defines the provider platform.",
"type": "string",
Expand Down
43 changes: 39 additions & 4 deletions config/v3/proposal/receive.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@
"description": "[Only for vanilla options] The choices of predefined strike price for client to choose",
"type": "array"
},
"barrier_spot_distance": {
"description": "[Only for Turbos] The relative distance between current spot and the barrier.",
"type": "string"
},
"cancellation": {
"description": "Contains information about contract cancellation option.",
"type": "object",
Expand Down Expand Up @@ -202,8 +206,15 @@
"description": "Localized display name",
"type": "string"
},
"display_order_amount": {
"description": "Stop loss amount for display purpose.",
"type": [
"null",
"string"
]
},
"order_amount": {
"description": "Stop loss amount",
"description": "Stop loss amount. Will be deprecated soon. Please use [display_order_amount].",
"type": [
"null",
"number"
Expand Down Expand Up @@ -231,9 +242,19 @@
"description": "Localized display name",
"type": "string"
},
"display_order_amount": {
"description": "Stop out amount for display purpose.",
"type": [
"null",
"string"
]
},
"order_amount": {
"description": "Stop out amount",
"type": "number"
"description": "Stop out amount. Will be deprecated soon. Please use [display_order_amount].",
"type": [
"null",
"number"
]
},
"order_date": {
"description": "Stop out order epoch",
Expand All @@ -254,8 +275,15 @@
"description": "Localized display name",
"type": "string"
},
"display_order_amount": {
"description": "Take profit amount for display purpose.",
"type": [
"null",
"string"
]
},
"order_amount": {
"description": "Take profit amount",
"description": "Take profit amount. Will be deprecated soon. Please use [display_order_amount].",
"type": [
"null",
"number"
Expand Down Expand Up @@ -299,6 +327,13 @@
10
]
},
"payout_choices": {
"description": "[Only for Turbos] The choices of predefined payout per point for client to choose",
"type": "array",
"items": {
"type": "string"
}
},
"spot": {
"description": "Spot value (if there are no Exchange data-feed licensing restrictions for the underlying symbol).",
"type": "number",
Expand Down
32 changes: 28 additions & 4 deletions config/v3/proposal_open_contract/receive.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -517,8 +517,15 @@
"description": "Localized display name",
"type": "string"
},
"display_order_amount": {
"description": "Stop loss amount for display purpose.",
"type": [
"null",
"string"
]
},
"order_amount": {
"description": "Stop loss amount",
"description": "Stop loss amount. Will be deprecated soon. Please use [display_order_amount].",
"type": [
"null",
"number"
Expand Down Expand Up @@ -546,9 +553,19 @@
"description": "Localized display name",
"type": "string"
},
"display_order_amount": {
"description": "Stop out amount for display purpose.",
"type": [
"null",
"string"
]
},
"order_amount": {
"description": "Stop out amount",
"type": "number"
"description": "Stop out amount. Will be deprecated soon. Please use [display_order_amount].",
"type": [
"null",
"number"
]
},
"order_date": {
"description": "Stop out order epoch",
Expand All @@ -569,8 +586,15 @@
"description": "Localized display name",
"type": "string"
},
"display_order_amount": {
"description": "Take profit amount for display purpose.",
"type": [
"null",
"string"
]
},
"order_amount": {
"description": "Take profit amount",
"description": "Take profit amount. Will be deprecated soon. Please use [display_order_amount].",
"type": [
"null",
"number"
Expand Down
3 changes: 2 additions & 1 deletion config/v3/trading_servers/receive.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@
"p01_ts03",
"p01_ts04",
"p02_ts02",
"p03_ts01"
"p03_ts01",
"p03_ts02"
]
},
"market_type": {
Expand Down
27 changes: 15 additions & 12 deletions docs/intro.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,34 @@ keywords:
description: Get an overview of the available Deriv API code examples and languages, and how to use it to create your trading app.
---

```mdx-code-block
import Link from '@docusaurus/Link';
import RenderOfficialContents from '@site/src/components/RenderOfficialContents';
```

Our Documentation is divided in several sections:

<RenderOfficialContents>
<ul>
<li>
<a href='category/core-concepts'>Core concepts</a>
<Link href='/docs/category/core-concepts'>Core concepts</Link>
</li>
<li>
<a href='category/code-examples'>Code examples</a>
<Link href='/docs/category/code-examples'>Code examples</Link>
</li>
<li>
<a href='category/languages'>Languages</a>
<Link href='/docs/category/languages'>Languages</Link>
</li>
<li>
<a href='category/guides'>Guides</a>
<Link href='/docs/category/guides'>Guides</Link>
</li>
<li>
<a href='setting-up-a-deriv-application'>Setting up a deriv app</a>
<Link href='/docs/setting-up-a-deriv-application'>Setting up a deriv app</Link>
</li>
</ul>
<ul>
<li>
<a href='category/code-examples'>Code examples</a>
<Link href='/docs/category/code-examples'>Code examples</Link>
</li>
</ul>
</RenderOfficialContents>
Expand All @@ -51,21 +54,21 @@ Our Documentation is divided in several sections:
</RenderOfficialContents>

<RenderOfficialContents>
Have a look at the <a href='/docs/category/core-concepts'>Core concepts</a> pages and take your
Have a look at the <Link href='/docs/category/core-concepts'>Core concepts</Link> pages and take your
time to read through it. These concepts will help you get familiar with our WebSocket server api
and how to use it more efficiently. They are not related to any of our frameworks or libraries.
</RenderOfficialContents>

<RenderOfficialContents>
When you read through the <a href='/docs/category/core-concepts'>Core concepts</a> page, you can
When you read through the <Link href='/docs/category/core-concepts'>Core concepts</Link> page, you can
start choosing your implementation approach based on the language, framework or library you want
to use in your application.
</RenderOfficialContents>

<h4>Code Examples</h4>

If you want to know how you can implement our API within your code, then we suggest to have a look
at our <a href='/docs/category/code-examples'>Code examples</a>. These code examples come in
at our <Link href='/docs/category/code-examples'>Code examples</Link>. These code examples come in
`CodeSandboxes`. This allows you to easily fork the code examples and experiment with them for
personal use. For now we only have JavaScript code examples, but, we plan to add more examples
that are created with different languages, frameworks and libraries in the near future.
Expand All @@ -76,7 +79,7 @@ that are created with different languages, frameworks and libraries in the near

<RenderOfficialContents>
When using our code examples, we also suggest to have a look at our{' '}
<a href='/docs/category/languages'>Languages</a> section. Here, we describe in detail how you
<Link href='/docs/category/languages'>Languages</Link> section. Here, we describe in detail how you
can setup your personal project properly to make use of our API. This will surely come helpful
when you try to integrate some of our code examples in your own project.
</RenderOfficialContents>
Expand All @@ -88,7 +91,7 @@ that are created with different languages, frameworks and libraries in the near
<RenderOfficialContents>
If you want to know for example how you can `monetize your application` or how to create a
`secure way for users to log in` to your application, then we provide a handful of{' '}
<a href='/docs/category/guides'>Guides</a> that can assist you with that.
<Link href='/docs/category/guides'>Guides</Link> that can assist you with that.
</RenderOfficialContents>

<RenderOfficialContents>
Expand All @@ -98,5 +101,5 @@ that are created with different languages, frameworks and libraries in the near
<RenderOfficialContents>
If you want to know more about the essentials that are needed to setup your own application,
then have a look at the{' '}
<a href='/docs/setting-up-a-deriv-application'>Setting up a Deriv application</a> section.
<Link href='/docs/setting-up-a-deriv-application'>Setting up a Deriv application</Link> section.
</RenderOfficialContents>
10 changes: 7 additions & 3 deletions docs/setting-up-a-deriv-application.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,15 @@ keywords:
description: A step-by-step guide on creating your Deriv API token and building your trading application with the help of our trading API. Learn more.
---

```mdx-code-block
import Link from '@docusaurus/Link';
```

#### Deriv account

If you don't have a Deriv account yet, you can easily create one by visiting our signup page or using the <a href="/api-explorer#new_account_virtual" target="_blank" rel="noopener noreferrer">new_account_virtual</a> API call. It's completely free. And if you have an account already, please log in using your account details. To avoid any accidental loss of funds during testing, we recommend using your demo account instead of a real account.
If you don't have a Deriv account yet, you can easily create one by visiting our signup page or using the <Link href="/api-explorer#new_account_virtual" target="_blank" rel="noopener noreferrer">new_account_virtual</Link> API call. It's completely free. And if you have an account already, please log in using your account details. To avoid any accidental loss of funds during testing, we recommend using your demo account instead of a real account.

To earn markup, get a Deriv real account to receive your monthly earnings. You can also create a real account using <a href="/api-explorer#new_account_real" target="_blank" rel="noopener noreferrer">new_account_real</a> or <a href="/api-explorer#new_account_maltainvest" target="_blank" rel="noopener noreferrer">new_account_maltainvest</a> API calls.
To earn markup, get a Deriv real account to receive your monthly earnings. You can also create a real account using <Link href="/api-explorer#new_account_real" target="_blank" rel="noopener noreferrer">new_account_real</Link> or <Link href="/api-explorer#new_account_maltainvest" target="_blank" rel="noopener noreferrer">new_account_maltainvest</Link> API calls.

:::caution
To create Deriv applications, you'll need an API token with the Admin scope for the account you wish to use for your application.
Expand All @@ -34,7 +38,7 @@ To create a new API token, follow these steps:
2. Provide a name for your token
3. Click **Create**

Alternatively, you can create an API token via the <a href="/api-explorer#api_token" target="_blank" rel="noopener noreferrer">api_token</a> API call.
Alternatively, you can create an API token via the <Link href="/api-explorer#api_token" target="_blank" rel="noopener noreferrer">api_token</Link> API call.

:::caution
You need a token with the `Admin` scope to create an application.
Expand Down
7 changes: 5 additions & 2 deletions docusaurus.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ const config = {
// If you aren't using GitHub pages, you don't need these.
organizationName: 'binary-com', // Usually your GitHub org/user name.
projectName: 'deriv-api-docs', // Usually your repo name.
trailingSlash: false,

customFields: {
trackJsToken: process.env.TRACKJS_TOKEN,
Expand All @@ -28,7 +27,7 @@ const config = {
// to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'en',
locales: ['en', 'es', 'fr'],
locales: ['en', 'fr'],
localeConfigs: {
en: {
label: 'English',
Expand Down Expand Up @@ -124,6 +123,10 @@ const config = {
type: 'custom-user-navbar-item',
position: 'right',
},
{
type: 'localeDropdown',
position: 'right',
},
],
},
prism: {
Expand Down
Loading

0 comments on commit 1b4ebb6

Please sign in to comment.