Skip to content

Commit 21c1e66

Browse files
aferracciaferracci
authored
Update openapi_backoffice_external_ec.json
1 parent 2895638 commit 21c1e66

File tree

1 file changed

+87
-18
lines changed

1 file changed

+87
-18
lines changed

‎openapi/openapi_backoffice_external_ec.json‎

Lines changed: 87 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@
8080
"example": {
8181
"creditorInstitutions": [
8282
{
83+
"aca": true,
8384
"activationDate": "string",
8485
"applicationCode": "string",
8586
"auxDigit": "string",
@@ -97,6 +98,7 @@
9798
"primitiveVersion": 0,
9899
"pspPayment": true,
99100
"segregationCode": "string",
101+
"standIn": true,
100102
"stationId": "string",
101103
"stationState": "enabled",
102104
"taxCode": "string",
@@ -218,6 +220,51 @@
218220
}
219221
}
220222
},
223+
"/info": {
224+
"get": {
225+
"tags": [
226+
"Home"
227+
],
228+
"summary": "health check",
229+
"description": "Return OK if application is started",
230+
"operationId": "healthCheck",
231+
"parameters": [
232+
{
233+
"name": "X-Request-Id",
234+
"in": "header",
235+
"description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.",
236+
"schema": {
237+
"type": "string"
238+
}
239+
}
240+
],
241+
"responses": {
242+
"200": {
243+
"description": "OK",
244+
"headers": {
245+
"X-Request-Id": {
246+
"description": "This header identifies the call",
247+
"schema": {
248+
"type": "string"
249+
}
250+
}
251+
},
252+
"content": {
253+
"*/*": {
254+
"schema": {
255+
"$ref": "#/components/schemas/AppInfo"
256+
},
257+
"examples": {
258+
"default": {
259+
"value": null
260+
}
261+
}
262+
}
263+
}
264+
}
265+
}
266+
}
267+
},
221268
"/brokers/{brokerCode}/ibans": {
222269
"get": {
223270
"tags": [
@@ -414,6 +461,20 @@
414461
},
415462
"components": {
416463
"schemas": {
464+
"AppInfo": {
465+
"type": "object",
466+
"properties": {
467+
"environment": {
468+
"type": "string"
469+
},
470+
"name": {
471+
"type": "string"
472+
},
473+
"version": {
474+
"type": "string"
475+
}
476+
}
477+
},
417478
"BrokerInstitutionResource": {
418479
"required": [
419480
"auxDigit",
@@ -429,30 +490,34 @@
429490
],
430491
"type": "object",
431492
"properties": {
493+
"aca": {
494+
"type": "boolean",
495+
"description": "True if ACA archive will be populated"
496+
},
432497
"activationDate": {
433498
"type": "string",
434-
"description": "activation date",
499+
"description": "Activation date",
435500
"format": "date-time"
436501
},
437502
"applicationCode": {
438503
"type": "string",
439-
"description": "application code of the relation station-ec (unique per auxdigit)"
504+
"description": "Application code of the relation station-ec (unique per auxdigit)"
440505
},
441506
"auxDigit": {
442507
"type": "string",
443-
"description": "aux digit number (0,1,2,3, 0/3)"
508+
"description": "Aux digit number (0,1,2,3, 0/3)"
444509
},
445510
"broadcast": {
446511
"type": "boolean",
447-
"description": "true if the station is for broadcast"
512+
"description": "True if the station is for broadcast"
448513
},
449514
"brokerCompanyName": {
450515
"type": "string",
451-
"description": "broker name"
516+
"description": "Broker name"
452517
},
453518
"brokerTaxCode": {
454519
"type": "string",
455-
"description": "broker tax code"
520+
"description": "Broker tax code"
456521
},
457522
"cbillCode": {
458523
"type": "string",
@@ -468,23 +533,23 @@
468533
},
469534
"endpointMU": {
470535
"type": "string",
471-
"description": "endpoint for Modello Unico"
536+
"description": "Endpoint for Modello Unico"
472537
},
473538
"endpointRT": {
474539
"type": "string",
475-
"description": "endpoint for Ricevuta Telematica"
540+
"description": "Endpoint for Ricevuta Telematica"
476541
},
477542
"endpointRedirect": {
478543
"type": "string",
479-
"description": "endpoint for Redirect"
544+
"description": "Endpoint for Redirect"
480545
},
481546
"intermediated": {
482547
"type": "boolean",
483-
"description": "true if the EC has a broker"
548+
"description": "True if the EC has a broker"
484549
},
485550
"model": {
486551
"type": "integer",
487-
"description": "model of the station",
552+
"description": "Model of the station",
488553
"format": "int32"
489554
},
490555
"primitiveVersion": {
@@ -494,19 +559,23 @@
494559
},
495560
"pspPayment": {
496561
"type": "boolean",
497-
"description": "true if allows payments by the psp"
562+
"description": "True if allows payments by the psp"
498563
},
499564
"segregationCode": {
500565
"type": "string",
501-
"description": "segregation code of the relation station-ec (unique per auxdigit)"
566+
"description": "Segregation code of the relation station-ec (unique per auxdigit)"
567+
},
568+
"standIn": {
569+
"type": "boolean",
570+
"description": "True if the debt positions can be paid in Stan In"
502571
},
503572
"stationId": {
504573
"type": "string",
505-
"description": "station code"
574+
"description": "Station code"
506575
},
507576
"stationState": {
508577
"type": "string",
509-
"description": "station state",
578+
"description": "Station state",
510579
"example": "enabled"
511580
},
512581
"taxCode": {
@@ -515,7 +584,7 @@
515584
},
516585
"version": {
517586
"type": "string",
518-
"description": "station version",
587+
"description": "Station version",
519588
"example": "1"
520589
}
521590
},
@@ -624,7 +693,7 @@
624693
},
625694
"totalElements": {
626695
"type": "integer",
627-
"description": "total elements of elements",
696+
"description": "total found elements",
628697
"format": "int64"
629698
},
630699
"totalPages": {
@@ -633,7 +702,7 @@
633702
"format": "int64"
634703
}
635704
},
636-
"description": "information about the pagination"
705+
"description": "Information about the pagination"
637706
},
638707
"ProblemJson": {
639708
"type": "object",

0 commit comments

Comments
 (0)