amber-electric-public-api revision history

1.0latestno API changesDocs2026-07-17 12:12

Adding operationIds. Fixing incorrect JSON5Docs a7fcf22 2024-02-19 22:36

Change detail

5 changes across 5 operations

GET/sites/{siteId}/prices/current
- info
  api operation id getCurrentPrices was added
GET/sites/{siteId}/prices
- info
  api operation id getPrices was added
GET/sites/{siteId}/usage
- info
  api operation id getUsage was added
GET/sites
- info
  api operation id getSites was added
GET/state/{state}/renewables/current
- info
  api operation id getCurrentRenewables was added

Merge pull request #191 from CarlLusty/fix-requires-in-usage192811Docs 2fc42b6 2024-02-19 22:20

Change detail

58 changes across 3 operations

GET/sites/{siteId}/prices/current
- breaking
  the ///////// response's property type changed from object to no type for status
- breaking
  the ///////// response's property type changed from object to no type for status
- breaking
  the ////// response's property type changed from object to no type for status
- breaking
  the ///////// response's property type changed from object to no type for status
- breaking
  the ////// response's property type changed from object to no type for status
- breaking
  removed the required property /////// from the response with the status
- breaking
  removed the required property /////// from the response with the status

View all changes (58)

Fix apparent typo in Usage, required. Required contained 'channel', field name in properties is 'channelIdentifier'.1148Docs fcac0a4 2024-02-19 12:02

Change detail

59 changes across 3 operations

GET/sites/{siteId}/prices/current
- breaking
  the ///////// response's property type changed from no type to object for status
- breaking
  the ///////// response's property type changed from no type to object for status
- breaking
  the ////// response's property type changed from no type to object for status
- breaking
  the ///////// response's property type changed from no type to object for status
- breaking
  the ////// response's property type changed from no type to object for status
- info
  added the optional property ////////// to the response with the status
- info
  added the optional property ////////// to the response with the status

View all changes (59)

Merge pull request #189 from CarlLusty/fix-ref-sibling-issuesno API changesDocs 957496b2024-02-19 22:18

Per the 3.0.0 standard. The a ref object can not be extended with nulllable, 'This object cannot be extended with additional properties and any properties added SHALL be ignored.'. The workaround to h192811Docs 07afbaa 2024-02-19 11:18

Change detail

58 changes across 3 operations

GET/sites/{siteId}/prices/current
- breaking
  the ///////// response's property type changed from object to no type for status
- breaking
  the ///////// response's property type changed from object to no type for status
- breaking
  the ////// response's property type changed from object to no type for status
- breaking
  the ///////// response's property type changed from object to no type for status
- breaking
  the ////// response's property type changed from object to no type for status
- breaking
  removed the required property /////// from the response with the status
- breaking
  removed the required property /////// from the response with the status

View all changes (58)

Fix examples, where the example value can be represented in JSON natively. Per OpenAPI 3.0.0, string examples should be to 'represent examples that cannot be naturally represented in JSON'.no API changesDocs 93148c32024-02-19 11:08

Remove required fields list from CurrentRenewable. The only property listed was 'estimate' and it does not exist.no API changesDocs a99f2682024-02-19 08:54

Change Renewable.duration from type:number to type:integer. Same for Interval.duration.no API changesDocs af0af9a2024-02-19 03:22

Merge pull request #181 from CarlLusty/change-anyOf-to-oneOfno API changesDocs f7d421c2024-02-18 22:56

Change use of anyOf to oneOf when returning arrays of 'sub-types', ie. Arrays containing mixes of ActualRenewable, CurrentRenewable and ForecastRenewable. The returned data types are always 'one of' t33Docs e8eb970 2024-02-16 10:46

Change detail

6 changes across 3 operations

GET/sites/{siteId}/prices/current
- breaking
  added to the response property oneOf list for the response status
- info
  removed from the response property anyOf list for the response status
GET/sites/{siteId}/prices
- breaking
  added to the response property oneOf list for the response status
- info
  removed from the response property anyOf list for the response status
GET/state/{state}/renewables/current
- breaking
  added to the response property oneOf list for the response status
- info
  removed from the response property anyOf list for the response status

Merge pull request #182 from CarlLusty/fix-security-defined-issueno API changesDocs 6cd4ea12024-02-18 22:52

Add empty security parameter to '/state/{state}/renewables/current'. This defines that it is a public call and does not require a token.no API changesDocs 76b43dc2024-02-16 12:03

Define the rate limit headers once, in the components headers field, and use ref when required to access them.no API changesDocs fa41fd12024-02-16 13:03

Merge pull request #176 from CarlLusty/fix-missing-date-type-tags523Docs d76e5dd 2024-02-16 10:25

Change both cases of endDate to be 'date', instead of 'date-time'.2Docs cad4dc1 2024-02-16 10:24

To define a date you need both format:date/-time and type:string.311Docs 08d5d99 2024-02-16 07:36

Merge pull request #175 from CarlLusty/interval-remove-extra-tags523Docs 6405c02 2024-02-16 09:59

Remove extra tags from Interval.37Docs c45cc13 2024-02-16 07:20

Merge pull request #179 from CarlLusty/fix-descriptor-names52Docs 72a034d 2024-02-16 09:58

Fix the 'requires' in Renewable to match the name in 'properties'.10Docs f73e71b 2024-02-16 08:13

Merge pull request #180 from CarlLusty/use-channelType-in-channel52Docs f162ec3 2024-02-16 09:58

Add the example from Channel.type to ChannelType.no API changesDocs 3b7f3ca2024-02-16 08:34

Use ref ChannelType in Channel7Docs a3bd9ed 2024-02-16 08:33

Re-add 'items' tag in the return of '/sites'52Docs 98292ca 2024-02-16 07:10

Using references to build extended Interval, Usage and Renewable types14Docs 4d2074e 2024-02-16 05:03

Adding more references6Docs 53ea2da 2024-02-16 04:51

Adding updated swagger.json file to allow PRs for updates, and review28Docs 4dcafc9 2024-02-16 04:18