Skip to content

Commit

Permalink
fix: fix incorrect date ranges in existing changelog entries
Browse files Browse the repository at this point in the history
  • Loading branch information
martin-helmich committed Feb 17, 2025
1 parent 2ad5598 commit e2a9239
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 121 deletions.
44 changes: 1 addition & 43 deletions changelog/2025-01-31-api-changes-v2.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
title: Breaking (!) API changes for v2 API, January 31 to January 31
title: Breaking (!) API changes for v2 API, January 24 to January 31
authors:
- machine
tags:
- apiv2
- breaking
- Marketplace
- Domain

---

import OperationHint from "@site/src/components/OperationHint";
Expand All @@ -17,8 +16,6 @@ This week, the mittwald API introduces several updates, including optional respo

{/* truncate */}



:::caution Breaking changes

This document contains changes that can under certain circumstances be considered breaking. Please review the changes carefully.
Expand All @@ -27,11 +24,8 @@ While we generally strive to avoid breaking changes in accordance with our [API

:::



## Summary


- The response property '/items/description' has become optional for the status '200' in both the "List Contributors" and "Get a Contributor" operations. This is a breaking change.
- The optional properties '/items/deprecation/note' and '/items/deprecation/successorId' have been added to the response with the '200' status in the "List Extensions of own contributor" operation.
- The required property 'recordSet/caa' has been added to the response with the '200' status in the "Get a DNSZone" operation.
Expand All @@ -43,96 +37,60 @@ While we generally strive to avoid breaking changes in accordance with our [API

_Disclaimer: This summary is AI-generated. If you find any discrepancies, please refer to the detailed changes below._


## Detailed changes



### Changes in "List contributors"


- ⚠️ **Breaking:** the response property '/items/description' became optional for the status '200'


For details, refer to the <OperationLink operation="extension-list-contributors" apiVersion="v2" /> endpoint.



### Changes in "Get a contributor"


- ⚠️ **Breaking:** the response property 'description' became optional for the status '200'


For details, refer to the <OperationLink operation="extension-get-contributor" apiVersion="v2" /> endpoint.



### Changes in "List Extensions of own contributor"


- added the optional property '/items/deprecation/note' to the response with the '200' status

- added the optional property '/items/deprecation/successorId' to the response with the '200' status


For details, refer to the <OperationLink operation="extension-list-own-extensions" apiVersion="v2" /> endpoint.



### Changes in "Get a DNS Zone"


- added the required property 'recordSet/caa' to the response with the '200' status


For details, refer to the <OperationLink operation="dns-get-dns-zone" apiVersion="v2" /> endpoint.



### Changes in "Update a record set on a DNS Zone"


- added '#/components/schemas/de.mittwald.v1.dns.RecordCAAComponent' to the request body 'oneOf' list

- added the new enum value 'caa' to the 'path' request parameter 'recordSet'


For details, refer to the <OperationLink operation="dns-update-record-set" apiVersion="v2" /> endpoint.



### Changes in "List Extensions"


- added the optional property '/items/deprecation/note' to the response with the '200' status

- added the optional property '/items/deprecation/successorId' to the response with the '200' status


For details, refer to the <OperationLink operation="extension-list-extensions" apiVersion="v2" /> endpoint.



### Changes in "Get an Extension"


- added the optional property 'deprecation/note' to the response with the '200' status

- added the optional property 'deprecation/successorId' to the response with the '200' status


For details, refer to the <OperationLink operation="extension-get-extension" apiVersion="v2" /> endpoint.



### Changes in "List DNS Zones belonging to a Project"


- added the required property '/items/recordSet/caa' to the response with the '200' status


For details, refer to the <OperationLink operation="dns-list-dns-zones" apiVersion="v2" /> endpoint.



59 changes: 4 additions & 55 deletions changelog/2025-02-07-api-changes-v2.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
title: API changes for v2 API, February 7 to February 7
title: API changes for v2 API, January 31 to February 7
authors:
- machine
tags:
- apiv2
- Marketplace
- Conversation

---

import OperationHint from "@site/src/components/OperationHint";
Expand All @@ -16,11 +15,8 @@ This week, the mittwald API introduces several enhancements, including the addit

{/* truncate */}



## Summary


- The `GET /v2/contributors/{contributorId}/extensions` operation now includes an optional property `/items/subTitle` and a required property `/items/statistics` in the response with a `200` status.
- The `GET /v2/conversations` operation has two new optional query request parameters: `order` and `sort`.
- The following API operation IDs have been removed and replaced with new IDs:
Expand All @@ -36,147 +32,100 @@ This week, the mittwald API introduces several enhancements, including the addit

_Disclaimer: This summary is AI-generated. If you find any discrepancies, please refer to the detailed changes below._


## Detailed changes



### Changes in "List Extensions of own contributor"


- added the optional property '/items/subTitle' to the response with the '200' status

- added the required property '/items/statistics' to the response with the '200' status


For details, refer to the <OperationLink operation="extension-list-own-extensions" apiVersion="v2" /> endpoint.



### Changes in "Get all conversation the authenticated user has created or has access to"


- added the new optional 'query' request parameter 'order'

- added the new optional 'query' request parameter 'sort'


For details, refer to the <OperationLink operation="conversation-list-conversations" apiVersion="v2" /> endpoint.



### Changes in "dns-record-a-set-custom-deprecated"


- api operation id 'dns-record-a-set-custom-deprecated' removed and replaced with 'deprecated-dns-record-a-set-custom'


For details, refer to the <OperationLink operation="dns-record-a-set-custom-deprecated" apiVersion="v2" /> endpoint.



### Changes in "dns-record-a-set-managed-by-ingress-deprecated"


- api operation id 'dns-record-a-set-managed-by-ingress-deprecated' removed and replaced with 'deprecated-dns-record-a-set-managed-by-ingress'


For details, refer to the <OperationLink operation="dns-record-a-set-managed-by-ingress-deprecated" apiVersion="v2" /> endpoint.



### Changes in "dns-record-cname-set-deprecated"


- api operation id 'dns-record-cname-set-deprecated' removed and replaced with 'deprecated-dns-record-cname-set'


For details, refer to the <OperationLink operation="dns-record-cname-set-deprecated" apiVersion="v2" /> endpoint.



### Changes in "dns-record-mx-set-custom-deprecated"


- api operation id 'dns-record-mx-set-custom-deprecated' removed and replaced with 'deprecated-dns-record-mx-set-custom'


For details, refer to the <OperationLink operation="dns-record-mx-set-custom-deprecated" apiVersion="v2" /> endpoint.



### Changes in "dns-record-mx-set-managed-deprecated"


- api operation id 'dns-record-mx-set-managed-deprecated' removed and replaced with 'deprecated-dns-record-mx-set-managed'


For details, refer to the <OperationLink operation="dns-record-mx-set-managed-deprecated" apiVersion="v2" /> endpoint.



### Changes in "dns-record-srv-set-deprecated"


- api operation id 'dns-record-srv-set-deprecated' removed and replaced with 'deprecated-dns-record-srv-set'


For details, refer to the <OperationLink operation="dns-record-srv-set-deprecated" apiVersion="v2" /> endpoint.



### Changes in "dns-record-txt-set-deprecated"


- api operation id 'dns-record-txt-set-deprecated' removed and replaced with 'deprecated-dns-record-txt-set'


For details, refer to the <OperationLink operation="dns-record-txt-set-deprecated" apiVersion="v2" /> endpoint.



### Changes in "List Extensions"


- added the required property '/items/statistics' to the response with the '200' status

- added the required property '/items/subTitle' to the response with the '200' status


For details, refer to the <OperationLink operation="extension-list-extensions" apiVersion="v2" /> endpoint.



### Changes in "Get an Extension"


- added the required property 'statistics' to the response with the '200' status

- added the required property 'subTitle' to the response with the '200' status


For details, refer to the <OperationLink operation="extension-get-extension" apiVersion="v2" /> endpoint.




## Client package releases


### mittwald PHP SDK Release v2.1.103

The mittwald PHP SDK has been updated to version v2.1.103. This release introduces several enhancements and changes:

#### Added

- **ExtensionStatistics**: A new class has been introduced to represent extension statistics, which includes:

- **amountOfInstances**: An integer indicating the number of instances of an extension.

- **Statistics Field in Extensions**: The `Extension` and `OwnExtension` classes now include a `statistics` field that refers to the `ExtensionStatistics` class.

#### Changed

- The constructors for `Extension` and `OwnExtension` have been updated to accept an `ExtensionStatistics` object, ensuring proper initialization of statistics.
- New methods `getStatistics()` and `withStatistics()` have been added to the `Extension` and `OwnExtension` classes for accessing and modifying the statistics property.
- Serialization logic for these classes has been updated to incorporate statistics in the JSON output.

For more details, visit the [release page](https://github.com/mittwald/api-client-php/releases/tag/v2.1.103).

24 changes: 1 addition & 23 deletions changelog/2025-02-14-api-changes-v2.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: API changes for v2 API, February 14 to February 14
title: API changes for v2 API, February 7 to February 14
authors:
- machine
tags:
- apiv2
- Marketplace

---

import OperationHint from "@site/src/components/OperationHint";
Expand All @@ -15,11 +14,8 @@ This week, the mittwald API introduces several enhancements, including the addit

{/* truncate */}



## Summary


- The required property '/items/supportInformation' has been added to the response with the '200' status for the `GET /v2/contributors` operation (List Contributors).
- The required property 'supportInformation' has been added to the response with the '200' status for the `GET /v2/contributors/{contributorId}` operation (Get a Contributor).
- The following properties have been added to the response with the '200' status for the `GET /v2/contributors/{contributorId}/extensions` operation (List Extensions of own contributor):
Expand All @@ -31,34 +27,22 @@ Note: The addition of required properties in the last item indicates that a brea

_Disclaimer: This summary is AI-generated. If you find any discrepancies, please refer to the detailed changes below._


## Detailed changes



### Changes in "List contributors"


- added the required property '/items/supportInformation' to the response with the '200' status


For details, refer to the <OperationLink operation="extension-list-contributors" apiVersion="v2" /> endpoint.



### Changes in "Get a contributor"


- added the required property 'supportInformation' to the response with the '200' status


For details, refer to the <OperationLink operation="extension-get-contributor" apiVersion="v2" /> endpoint.



### Changes in "List Extensions of own contributor"


- added the optional property '/items/logoRefId' to the response with the '200' status

- added the optional property '/items/requestedChanges' to the response with the '200' status
Expand All @@ -71,16 +55,10 @@ For details, refer to the <OperationLink operation="extension-get-contributor" a

- added the required property '/items/verified' to the response with the '200' status


For details, refer to the <OperationLink operation="extension-list-own-extensions" apiVersion="v2" /> endpoint.




## Client package releases


### mittwald JavaScript SDK Release 4.106.0

The mittwald JavaScript SDK has been updated to version 4.106.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub [here](https://github.com/mittwald/api-client-js/releases/tag/4.106.0).

0 comments on commit e2a9239

Please sign in to comment.