Skip to content

Commit ddd1f6b

Browse files
iamchriswickiamchriswick
authored
Merge pull request #106 from SettleAPI/promTo/stage
Changes by create-pull-request action
2 parents 3720093 + c15f374 commit ddd1f6b

18 files changed

Lines changed: 79 additions & 45 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ At its core, **Netlify CMS** is an open-source React app that acts as a wrapper
4343

4444
1. ### Clone this repo
4545

46-
`git clone https://github.com/SettleForDevelopers/Developer-Docs.git`
46+
`git clone https://github.com/SettleAPI/settle-developer-docs.git`
4747

4848
2. ### Navigate into your newly created Settle API docs directory
4949

50-
`cd settle-api-docs`
50+
`cd settle-developer-docs`
5151

5252
3. ### Install dependencies
5353

‎docs/.vuepress/enhanceApp.js‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
module.exports = () => {
2-
// console.log('enhancedApp.js');
3-
}
1+

‎docs/.vuepress/nav/left/guides.js‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,22 @@ const introduction = {
1818
collapsable: false,
1919
sidebarDepth: 0,
2020
children: [
21-
'/api/guides/introduction/interacting',
22-
'/api/guides/introduction/callbacks',
23-
'/api/guides/introduction/error-responses',
24-
'/api/guides/introduction/media-type',
25-
'/api/guides/introduction/a-note-on-settle-api-users',
26-
'/api/guides/introduction/versioning',
27-
['/api/guides/introduction/resiliency', 'Resiliency'],
21+
['/api/guides/introduction/a-note-on-settle-api-users.md', 'A Note on Settle API Users'],
22+
['/api/guides/introduction/attachments.md','Attachments'],
23+
['/api/guides/introduction/authentication.md','Authentication'],
24+
['/api/guides/introduction/callbacks.md','Callbacks'],
25+
['/api/guides/introduction/error-responses.md','Error Responses'],
26+
['/api/guides/introduction/interacting.md','Interacting'],
27+
['/api/guides/introduction/ledgers.md','Ledgers'],
28+
['/api/guides/introduction/media-type.md','Media Types'],
29+
['/api/guides/introduction/payment-flows.md','Payment Flows'],
30+
['/api/guides/introduction/permission-requests.md','Permission Requests'],
31+
['/api/guides/introduction/qr-acceptance.md','QR Acceptance'],
32+
['/api/guides/introduction/resiliency.md','Resiliency'],
33+
['/api/guides/introduction/sandbox-environment.md','Sandbox Enviroment #1'],
34+
['/api/guides/introduction/settle-sandbox-environment.md',' Sandbox Enviroment #2'],
35+
['/api/guides/introduction/settlements.md','Settlements'],
36+
['/api/guides/introduction/versioning.md','Verioning'],
2837
],
2938
};
3039

@@ -48,3 +57,6 @@ module.exports = [
4857
// '/guides/qr-acceptance',
4958
// ];
5059
// }
60+
61+
62+

‎docs/.vuepress/nav/left/rest/v1/reference/merchant.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ function merchant_apiKeys() {
66
children: [
77
['/api/reference/rest/v1/merchant.apiKeys/', 'Overview'],
88
['/api/reference/rest/v1/merchant.apiKeys/create', 'create'],
9+
['/api/reference/rest/v1/merchant.apiKeys/list', 'list'],
910
['/api/reference/rest/v1/merchant.apiKeys/get', 'get'],
1011
['/api/reference/rest/v1/merchant.apiKeys/update', 'update'],
1112
['/api/reference/rest/v1/merchant.apiKeys/delete', 'delete'],

‎docs/.vuepress/theme/components/Models.vue‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<!-- <a :href="'#' + type.title" class="header-anchor">#</a> -->
2020
{{ type.title }}
2121
</h2>
22-
<p v-if="type.properties && type.description">
22+
<p v-if="type.properties || type.description">
2323
{{ type.description }}
2424
</p>
2525
<div v-if="type.properties" class="modelEntry">
@@ -112,7 +112,7 @@
112112
<p v-if="property.description">{{ property.description }}</p>
113113
</div>
114114
</div>
115-
<div v-else>
115+
<div v-if="!type.description && !type.properties">
116116
<p>
117117
No info available for <strong>{{ type.title }}</strong> at of this
118118
moment. Please
@@ -187,7 +187,7 @@ export default {
187187
} else if (site.pages[0].models) {
188188
data.types = site.pages[0].models;
189189
} else {
190-
console.warn('Neither page.models or site.pages[0].models found...');
190+
console.warn("Neither page.models or site.pages[0].models found...");
191191
}
192192
193193
// console.log(data.types);

‎docs/.vuepress/theme/components/PageResource.vue‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,16 @@
4848
:to="'/api/guides/introduction/authentication/#authentication-using-key'"
4949
>{{ $frontmatter.authLevel }}
5050
</router-link>
51+
<router-link
52+
v-if="$frontmatter.authLevel === 'JWT'"
53+
:to="'/api/guides/introduction/authentication/#authentication-using-secret'"
54+
>{{ $frontmatter.authLevel }}
55+
</router-link>
56+
<router-link
57+
v-if="$frontmatter.authLevel === 'RSA'"
58+
:to="'/api/guides/introduction/authentication/#authentication-using-key'"
59+
>{{ $frontmatter.authLevel }}
60+
</router-link>
5161
</li>
5262
<li>Authorized Roles: {{ $frontmatter.authRoles }}</li>
5363
</ul>
@@ -122,7 +132,7 @@
122132
"
123133
>
124134
Length: <code>{{ type.minLength }}</code>
125-
</li>
135+
</li
126136
<li v-else-if="type.minLength">
127137
Length: <code>&#8805; {{ type.minLength }}</code>
128138
</li>

‎docs/.vuepress/theme/components/PageResourceOverview.vue‎

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,14 @@
1717
<router-link :to="'#resource'" class="header-anchor">#</router-link>
1818
Resource
1919
</h3>
20-
<p>There is no persistent data associated with this resource.</p>
21-
&nbsp; &nbsp; &nbsp;
22-
<Content />
20+
<div v-if="$frontmatter.resourceDesc === true">
21+
<Content slot-key="resource" :hasDescription="true" />
22+
</div>
23+
<div v-else>
24+
<p>There is no persistent data associated with this resource.</p>
25+
</div>
26+
27+
<!-- <Content /> -->
2328
<h2 id="http-request">
2429
<router-link :to="'#http-request'" class="header-anchor">#</router-link>
2530
HTTP Requests
@@ -52,7 +57,10 @@
5257
</table>
5358
<div v-else class="warning custom-block">
5459
<p class="custom-block-title">WARNING</p>
55-
<p>No Methods found for <strong>{{ $frontmatter.schema }}</strong>.</p>
60+
<p>
61+
No Methods found for <strong>{{ $frontmatter.schema }}</strong
62+
>.
63+
</p>
5664
</div>
5765
</div>
5866
<PageEdit />
@@ -72,7 +80,7 @@ const _ = require("lodash");
7280
7381
const yaml = require("js-yaml");
7482
75-
console.clear();
83+
// console.clear();
7684
7785
let getMethods;
7886
@@ -98,6 +106,9 @@ export default {
98106
methods: [],
99107
};
100108
},
109+
async extendPageData($page) {
110+
$page.size = await getAsyncData();
111+
},
101112
async beforeMount() {
102113
site = this.$site;
103114
page = this.$page;

‎docs/api/guides/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ description: Getting started with the Settle API
88

99
To get started we recommend that you first create a consumer account and a business account in the [Sandbox environment](/sandbox). This allows you to try out Settle and test your integration without having to worry about real money.
1010

11-
You can then follow one the tutorials or checkout the API references directly.
11+
You can then follow one of the tutorials or checkout the API references directly.

‎docs/api/guides/introduction/interacting.md‎

100755100644
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Interacting with the REST API's
2+
title: 1. Interacting with the REST API's
33
description: How to interact with the Settle REST API's
44
---
55
# Creating, Retrieving, Updating and Deleting resources (CRUD)

‎docs/api/reference/rest/v1/merchant.apiKeys/create.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ schema: merchant.apiKeys
77
operationId: merchant.apiKeys.create
88
operation: post
99
method: create
10-
authLevel: KEY
11-
authRoles: All
10+
authLevel: RSA
11+
authRoles: SUPERUSER, INTEGRATOR
1212
---

0 commit comments

Comments
 (0)