Skip to content

Commit a2d3cf8

Browse files
GitLab CIexoszajzbuk
GitLab CI
authored and
exoszajzbuk
committed
chore(release): 2.0.0
1 parent 5031c0b commit a2d3cf8

2 files changed

Lines changed: 151 additions & 30 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
## [2.0.0](https://github.com/britned/empire-platform-api/compare/v1.1.0...v2.0.0) (2024-01-16)
2+
3+
4+
### ⚠ BREAKING CHANGES
5+
6+
* **auctions:** remove access for Participants to others' DA/ID allocation results
7+
* **reporting:** remove access to getFinanceAuctionResultsSettlementReport for Participants
8+
9+
### Features
10+
11+
* **auctions:** allow price to be set as 0 for LT bids
12+
* **auctions:** remove access for Participants to others' DA/ID allocation results
13+
* **reporting:** add access to getFinanceCreditCoverReport for Participants
14+
* **reporting:** add access to getFinanceCreditLimitReport for Participants
15+
* **reporting:** add uiosi hourly finance report
16+
* **reporting:** remove access to getFinanceAuctionResultsSettlementReport for Participants
17+
18+
19+
120
## [1.1.0](https://github.com/britned/empire-platform-api/compare/v1.0.5...v1.1.0) (2023-10-18)
221

322

‎openapi.yaml‎

Lines changed: 132 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ info:
77
---
88
99
Additional documentation available in the API's [GitHub repository](https://github.com/britned/empire-platform-api)
10-
version: 1.1.0
10+
version: 2.0.0
1111
contact:
1212
name: BritNed
1313
url: https://www.britned.com
@@ -782,7 +782,9 @@ paths:
782782
- must be a multiply of the Auction's allocation resolution
783783
- must be less than or equal to the "maximum bid capacity" in the Partcipant's Bidding Configuration for the Auction's border direction
784784
* `INVALID_BID_PRICE`
785-
- must be greater than or equal to the configured "minimum bid price" for the Auction
785+
- depending on "minimum bid price" being configured for the Auction:
786+
* if NOT set: must be greater than or equal to zero
787+
* if set: must be greater than or equal to the configured "minimum bid price"
786788
- must be less than or equal to the "maximum bid price" in the Participant's Bidding Configuration for the Auction's border direction
787789
- price value must be unique across all bids for the given Auction
788790
* `TOO_MANY_BIDS`
@@ -802,7 +804,9 @@ paths:
802804
- must be less than or equal to the "maximum bid capacity" in the Partcipant's Bidding Configuration for the Auction's border direction
803805
- code: INVALID_BID_PRICE
804806
description: |
805-
- must be greater than or equal to the configured "minimum bid price" for the Auction
807+
- depending on "minimum bid price" being configured for the Auction:
808+
* if NOT set: must be greater than or equal to zero
809+
* if set: must be greater than or equal to the configured "minimum bid price"
806810
- must be less than or equal to the "maximum bid price" in the Participant's Bidding Configuration for the Auction's border direction
807811
- price value must be unique across all bids for the given Auction
808812
- code: TOO_MANY_BIDS
@@ -5924,6 +5928,100 @@ paths:
59245928
application/json:
59255929
schema:
59265930
$ref: '#/components/schemas/ErrorResponse'
5931+
/v1/reporting/finance/credit-cover:
5932+
get:
5933+
operationId: getFinanceCreditCoverReport
5934+
description: |-
5935+
Fetch Finance Credit Cover Report
5936+
5937+
---
5938+
5939+
__Requires Permission:__ (at least one)
5940+
* `VIEW_OWN_FINANCE_REPORTS`
5941+
* `VIEW_ANY_FINANCE_REPORTS`
5942+
tags:
5943+
- reporting
5944+
security:
5945+
- ApiKey: []
5946+
- AuthToken: []
5947+
x-permissions:
5948+
- VIEW_OWN_FINANCE_REPORTS
5949+
- VIEW_ANY_FINANCE_REPORTS
5950+
parameters:
5951+
- $ref: '#/components/parameters/ParticipantIds'
5952+
- name: periodStart
5953+
in: query
5954+
required: true
5955+
schema:
5956+
$ref: '#/components/schemas/Date'
5957+
- name: periodEnd
5958+
in: query
5959+
required: true
5960+
schema:
5961+
$ref: '#/components/schemas/Date'
5962+
- name: creditType
5963+
in: query
5964+
required: true
5965+
schema:
5966+
$ref: '#/components/schemas/CreditCoverType'
5967+
responses:
5968+
'200':
5969+
description: __OK__
5970+
content:
5971+
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
5972+
schema:
5973+
$ref: '#/components/schemas/ReportFile'
5974+
'401':
5975+
$ref: '#/components/responses/Unauthorized'
5976+
'403':
5977+
$ref: '#/components/responses/Forbidden'
5978+
'422':
5979+
description: |-
5980+
__Unprocessable Entity__
5981+
5982+
* `PERIOD_MISALIGNED` - period start and end dates must come after each other
5983+
* `PERIOD_TOO_LONG` - period the maximum period length is 1 year
5984+
x-errors:
5985+
- code: PERIOD_MISALIGNED
5986+
description: period start and end dates must come after each other
5987+
- code: PERIOD_TOO_LONG
5988+
description: period the maximum period length is 1 year
5989+
content:
5990+
application/json:
5991+
schema:
5992+
$ref: '#/components/schemas/ErrorResponse'
5993+
/v1/reporting/finance/credit-limit:
5994+
get:
5995+
operationId: getFinanceCreditLimitReport
5996+
description: |-
5997+
Fetch Finance Credit Limit Report
5998+
5999+
---
6000+
6001+
__Requires Permission:__ (at least one)
6002+
* `VIEW_OWN_FINANCE_REPORTS`
6003+
* `VIEW_ANY_FINANCE_REPORTS`
6004+
tags:
6005+
- reporting
6006+
security:
6007+
- ApiKey: []
6008+
- AuthToken: []
6009+
x-permissions:
6010+
- VIEW_OWN_FINANCE_REPORTS
6011+
- VIEW_ANY_FINANCE_REPORTS
6012+
parameters:
6013+
- $ref: '#/components/parameters/ParticipantIdOptional'
6014+
responses:
6015+
'200':
6016+
description: __OK__
6017+
content:
6018+
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
6019+
schema:
6020+
$ref: '#/components/schemas/ReportFile'
6021+
'401':
6022+
$ref: '#/components/responses/Unauthorized'
6023+
'403':
6024+
$ref: '#/components/responses/Forbidden'
59276025
/v1/reporting/finance/invoice-details:
59286026
get:
59296027
operationId: getFinanceInvoiceDetailsReport
@@ -6060,11 +6158,11 @@ paths:
60606158
application/json:
60616159
schema:
60626160
$ref: '#/components/schemas/ErrorResponse'
6063-
/v1/reporting/finance/auction-results-settlement:
6161+
/v1/reporting/finance/uiosi:
60646162
get:
6065-
operationId: getFinanceAuctionResultsSettlementReport
6163+
operationId: getFinanceUiosiReport
60666164
description: |-
6067-
Fetch Finance Auction Results Settlement Report
6165+
Fetch Finance UIoSI Report
60686166
60696167
---
60706168
@@ -6091,27 +6189,27 @@ paths:
60916189
required: true
60926190
schema:
60936191
$ref: '#/components/schemas/Date'
6094-
- name: finalResultsPublishedFrom
6095-
in: query
6096-
schema:
6097-
$ref: '#/components/schemas/Date'
6098-
- name: finalResultsPublishedTo
6099-
in: query
6100-
schema:
6101-
$ref: '#/components/schemas/Date'
6102-
- name: accountingCodes
6103-
in: query
6104-
required: true
6105-
schema:
6106-
items:
6107-
$ref: '#/components/schemas/SageCode'
6192+
- $ref: '#/components/parameters/ParticipantIds'
6193+
- $ref: '#/components/parameters/Timescale'
61086194
responses:
61096195
'200':
61106196
description: __OK__
61116197
content:
61126198
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
61136199
schema:
61146200
$ref: '#/components/schemas/ReportFile'
6201+
'400':
6202+
description: |-
6203+
__Bad Request__
6204+
6205+
* `TIMESCALE_MISMATCH` - endpoint matching Auction LT/DA timescale need to be used
6206+
x-errors:
6207+
- code: TIMESCALE_MISMATCH
6208+
description: endpoint matching Auction LT/DA timescale need to be used
6209+
content:
6210+
application/json:
6211+
schema:
6212+
$ref: '#/components/schemas/ErrorResponse'
61156213
'401':
61166214
$ref: '#/components/responses/Unauthorized'
61176215
'403':
@@ -6120,25 +6218,22 @@ paths:
61206218
description: |-
61216219
__Unprocessable Entity__
61226220
6123-
* `PERIOD_MISALIGNED` - both for final resuls published period and delivery period start and end dates must come after each other
6124-
* `PERIOD_TOO_LONG` - both for final results published period and delivery period the maximum period length is 1 year
6125-
* `INVALID_ACCOUNTING_CODE` - only Auction-relevant accounting codes are acceptable. The Border direction must be the same as the accounting code's border direction
6221+
* `PERIOD_MISALIGNED` - delivery period start and end dates must come after each other
6222+
* `PERIOD_TOO_LONG` - delivery period the maximum period length is 1 year
61266223
x-errors:
61276224
- code: PERIOD_MISALIGNED
6128-
description: both for final resuls published period and delivery period start and end dates must come after each other
6225+
description: delivery period start and end dates must come after each other
61296226
- code: PERIOD_TOO_LONG
6130-
description: both for final results published period and delivery period the maximum period length is 1 year
6131-
- code: INVALID_ACCOUNTING_CODE
6132-
description: only Auction-relevant accounting codes are acceptable. The Border direction must be the same as the accounting code's border direction
6227+
description: delivery period the maximum period length is 1 year
61336228
content:
61346229
application/json:
61356230
schema:
61366231
$ref: '#/components/schemas/ErrorResponse'
6137-
/v1/reporting/finance/uiosi:
6232+
/v1/reporting/finance/uiosi-hourly:
61386233
get:
6139-
operationId: getFinanceUiosiReport
6234+
operationId: getFinanceUiosiHourlyReport
61406235
description: |-
6141-
Fetch Finance UIoSI Report
6236+
Fetch Finance UIoSI Hourly Report
61426237
61436238
---
61446239
@@ -9405,6 +9500,12 @@ components:
94059500
properties:
94069501
id:
94079502
$ref: '#/components/schemas/Identifier'
9503+
CreditCoverType:
9504+
type: string
9505+
enum:
9506+
- BOTH
9507+
- BANK_DEPOSIT
9508+
- LETTER_OF_CREDIT
94089509
Currency:
94099510
type: number
94109511
description: Currency value in Euros (€), accepted with a precision of maximum 2 decimal places
@@ -9682,6 +9783,7 @@ components:
96829783
* `requestedCapacity` - Sum of ALL bids for the given MTU and Participant in kilowatts
96839784
* `allocatedTrs` - The SUM AC for the given MTU and Participant for the Auction in kilowatts
96849785
required:
9786+
- requestedCapacity
96859787
- allocatedTrs
96869788
properties:
96879789
requestedCapacity:

0 commit comments

Comments
 (0)