Skip to content

Commit 994681f

Browse files
WickWick
authored andcommitted
Modified 2 files
1 parent 09bf6da commit 994681f

2 files changed

Lines changed: 67 additions & 35 deletions

File tree

models/PubKey.yaml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
title: PubKey
2-
type: object
3-
properties:
4-
id:
5-
type: string
2+
type: string
63
description: |-
74
Field for Public Key.
85

reference/merchant.v1.yaml

Lines changed: 66 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,29 @@ servers:
1818
- url: 'https://api.settle.eu/merchant/v1'
1919
description: Production
2020
paths:
21+
/api_key:
22+
get:
23+
summary: merchant.apiKeys.list
24+
tags: []
25+
responses: {}
26+
operationId: merchant.apiKeys.list
27+
description: List Merchant API Keys
28+
post:
29+
summary: merchant.apiKeys.create
30+
operationId: merchant.apiKeys.create
31+
responses:
32+
'201':
33+
$ref: '#/components/responses/apiKeys.create.201'
34+
'400':
35+
description: Bad Request
36+
'409':
37+
description: 'Conflict, Api key already exists.'
38+
description: Create API Key for the Merchant given in the X-Settle-Merchant header.
39+
requestBody:
40+
content:
41+
application/json:
42+
schema:
43+
$ref: '#/components/schemas/apiKeys.create'
2144
/payment_request:
2245
post:
2346
summary: merchant.payment.request.create
@@ -709,13 +732,6 @@ paths:
709732
examples: {}
710733
operationId: merchant.balance.get
711734
description: Get Merchant Account Balance
712-
/api_key:
713-
get:
714-
summary: merchant.apiKeys.list
715-
tags: []
716-
responses: {}
717-
operationId: merchant.apiKeys.list
718-
description: List Merchant API Keys
719735
components:
720736
schemas:
721737
payment.request.create:
@@ -1261,7 +1277,7 @@ components:
12611277
default: 'null'
12621278
description: URI called by Settle when user scans shortlink.
12631279
ssp.users.create:
1264-
title: ssp.users.create
1280+
title: 'Request Body: ssp.users.create'
12651281
type: object
12661282
description: 'Creates a MerchantSspUser and returns 201 CREATED (unless a user with the same email already exists, which results in a 409 CONFLICT response).'
12671283
properties:
@@ -1277,54 +1293,64 @@ components:
12771293
$ref: ../models/Name.yaml
12781294
required:
12791295
- email
1280-
users.create:
1281-
title: users.create
1296+
apiKeys.update:
1297+
title: 'Request Body: users.update'
12821298
type: object
1283-
description: Create user for the Merchant given in the X-Settle-Merchant header.
1299+
description: Update API Key
12841300
properties:
1285-
id:
1286-
type: string
1287-
default: 'null'
1288-
description: User ID
12891301
netmask:
12901302
type: string
1291-
default: 'null'
12921303
description: 'Limit user connections by netmask, for example 192.168.1.0/24'
12931304
format: ipv4
12941305
example: 192.168.1.0/24
12951306
label:
12961307
type: string
1297-
default: 'null'
1298-
description: User given name to RSA key/secret
1308+
description: User given name to RSA key/secret.
12991309
secret:
13001310
type: string
1301-
default: 'null'
1302-
description: Secret used when authenticating with Settle.
13031311
minLength: 8
13041312
maxLength: 64
1313+
description: Secret used when authenticating with Settle.
13051314
pubkey:
13061315
$ref: ../models/PubKey.yaml
1307-
users.update:
1308-
title: users.update
1316+
x-examples: {}
1317+
apiKeys.create:
1318+
title: 'Request Body: apiKeys.create'
13091319
type: object
1310-
description: Update user
1320+
description: Create API Key
1321+
x-examples: {}
13111322
properties:
1312-
netmask:
1323+
id:
13131324
type: string
1314-
description: 'Limit user connections by netmask, for example 192.168.1.0/24'
1315-
format: ipv4
1316-
example: 192.168.1.0/24
1317-
label:
1325+
description: User ID
1326+
key_type:
13181327
type: string
1319-
description: User given name to RSA key/secret.
1328+
enum:
1329+
- secret
1330+
- rsa_generated
1331+
- rsa_user
1332+
description: Type of API Key to create.
1333+
roles:
1334+
type: string
1335+
description: 'Role. Value in user, superuser (case insensitive).'
1336+
enum:
1337+
- user
1338+
- superuser
1339+
- integrator
1340+
default: 'null'
1341+
netmask:
1342+
type: string
1343+
description: 'Limit user connections by netmask, for example 192.168.1.0/24.'
13201344
secret:
13211345
type: string
1346+
description: Secret used when authenticating with Settle.
13221347
minLength: 8
13231348
maxLength: 64
1324-
description: Secret used when authenticating with Settle.
13251349
pubkey:
13261350
$ref: ../models/PubKey.yaml
1327-
x-examples: {}
1351+
required:
1352+
- id
1353+
- key_type
13281354
responses:
13291355
payment.request.list.200:
13301356
description: OK
@@ -1807,6 +1833,14 @@ components:
18071833
pubkey:
18081834
$ref: ../models/PubKey.yaml
18091835
examples: {}
1836+
apiKeys.create.201:
1837+
description: 'OK, created'
1838+
content:
1839+
application/json:
1840+
schema:
1841+
properties:
1842+
id:
1843+
type: string
18101844
securitySchemes: {}
18111845
parameters:
18121846
merchant_id:
@@ -1885,6 +1919,7 @@ components:
18851919
schema:
18861920
type: string
18871921
description: Merchant SSP User ID
1922+
examples: {}
18881923
tags:
18891924
- name: Info
18901925
- name: Balance

0 commit comments

Comments
 (0)