Migrate Addresses #653

RobBeck1 · 2024-09-16T14:32:38Z

Summary

Follow style guide

https://mews.atlassian.net/browse/CON-2195 Migrate Addresses

Check during review

The changelog and potentially a deprecation entries are in place.
- The changelog timestamp is date of merge to develop.
JSON example extended.
- New properties are added to the correct place in the JSON.
New properties in the table are added to the correct place.
Correct formatting:
- Spacing is consistent between titles, sections, tables, ...
- Correct JSON format - indentation.
DateTime properties should always be defined in ISO format.

VBuben · 2024-09-17T05:43:29Z

operations/addresses.md

 }
 ```

 | Property | Type | Contract | Description |
 | :-- | :-- | :-- | :-- |
-| `Addresses` | array of [Account address](#account-address) | required | The collection of Account addresses, containing address and account information. |
-| `Cursor` | string | required | Unique identifier of the last and hence oldest address item returned. This can be used in [Limitation](../guidelines/pagination.md#limitation) in a subsequent request to fetch the next batch of older Account address. |
+| `Addresses` | array of [Account address](addresses.md#account-address) | optional | The collection of Account addresses, containing address and account information. |


VBuben · 2024-09-17T05:45:09Z

operations/addresses.md

+| `City` | string | optional, max length 255 characters | The city. |
+| `PostalCode` | string | optional, max length 255 characters | Postal code. |
+| `CountryCode` | string | optional, max length 3 characters | ISO 3166-1 code of the [Country](countries.md#country). |
+| `CountrySubdivisionCode` | string | optional, max length 3 characters | ISO 3166-2 code of the administrative division, e.g. DE-BW. |


So in case of ISO 3166-2 you have 2 characters for country code, hyphen, and 3 characters for subdivision, so 6 characters in total.

However, I would consider dropping the MaxLength constraint altogether, the format of the field is defined by ISO standard and that can change.

VBuben · 2024-09-17T05:46:27Z

operations/addresses.md

+| `Line2` | string | optional, max length 255 characters | Second line of the address. |
+| `City` | string | optional, max length 255 characters | The city. |
+| `PostalCode` | string | optional, max length 255 characters | Postal code. |
+| `CountryCode` | string | optional, max length 3 characters | ISO 3166-1 code of the [Country](countries.md#country). |


Are you sure about that, @VBuben? To my knowledge ISO 3166-1 codes are up to 3 characters depending on whether you use alpha-2 or alpha-3 variant.

However, I would consider dropping the MaxLength constraint altogether, the format of the field is defined by ISO standard and that can change.

I'm no expert, but according to Wikipedia there are three variants Alpha-2, Alpha-3 and Numeric, which are 2, 3 and 3 characters respectively. We should say which one we are using. I assume it's the most common Alpha-2, because the example is "CZ".

We use alpha-2 as is described in https://mews-systems.gitbook.io/connector-api/operations/countries section. Might be good to link to it from here. One more reason to do that is that we might not support all countries that are supported by the standard. That is definitely true for country subdivisions.

ah yes @jonas-paul, either link to it or better to just use the same description.

VBuben · 2024-09-17T05:47:09Z

operations/addresses.md

 }
 ```

 | Property | Type | Contract | Description |
 | :-- | :-- | :-- | :-- |
-| `Addresses` | array of [Account address](#account-address) | required | Created addresses. |
+| `Addresses` | array of [Account address](addresses.md#account-address) | optional | The collection of Account addresses, containing address and account information. |


Suggested change

| `Addresses` | array of [Account address](addresses.md#account-address) | optional | The collection of Account addresses, containing address and account information. |

| `Addresses` | array of [Account address](addresses.md#account-address) | required | The collection of Account addresses, containing address and account information. |

I would keep required here as well because in all cases you will get the collection.

VBuben · 2024-09-17T05:48:08Z

operations/addresses.md

 }
 ```

 | Property | Type | Contract | Description |
 | :-- | :-- | :-- | :-- |
-| `Addresses` | array of [Account address](#account-address) | required | Created addresses. |
+| `Addresses` | array of [Account address](addresses.md#account-address) | optional | The collection of Account addresses, containing address and account information. |
+| `Cursor` | string | optional | Unique identifier of the last and hence oldest address item returned. This can be used in [Limitation](../guidelines/pagination.md#limitation) in a subsequent request to fetch the next batch of older Account address. |


Let's fix this, addresses/add should not have Cursor, because you don't iterate trough records, you are creating them 🚀.

VBuben · 2024-09-17T06:18:35Z

operations/addresses.md

-| `PostalCode` | [String update value](_objects.md#string-update-value) | optional | Postal code. |
-| `CountryCode` | [String update value](_objects.md#string-update-value) | optional | ISO 3166-1 code of the [Country](countries.md#country). |
-| `CountrySubdivisionCode` | [String update value](_objects.md#string-update-value) | optional | ISO 3166-2 code of the administrative division, e.g. `DE-BW`. |
+| `Line1` | [String update value](_objects.md#string-update-value) | optional, max length 255 characters | First line of the address. |


VBuben · 2024-09-17T06:25:04Z

operations/addresses.md

+| `PostalCode` | [String update value](_objects.md#string-update-value) | optional, max length 255 characters | Postal code. |
+| `CountryCode` | [String update value](_objects.md#string-update-value) | optional, max length 8 characters | ISO 3166-1 code of the Country. |
+| `CountrySubdivisionCode` | [String update value](_objects.md#string-update-value) | optional, max length 8 characters | ISO 3166-2 code of the administrative division, e.g. DE-BW. |
+| ~~`AccountId`~~ | ~~string~~ | ~~required~~ | **Deprecated!** The value is ignored.|


I don't understand why this value was not deleted, since the usage of it was removed 🤯
I think we can just remove it.

Yeah, or hide it with InternalImplementation for starters.

VBuben · 2024-09-17T06:25:25Z

operations/addresses.md

 }
 ```

 | Property | Type | Contract | Description |
 | :-- | :-- | :-- | :-- |
-| `Addresses` | array of [Account address](#account-address) | required | Updated addresses. |
+| `Addresses` | array of [Account address](addresses.md#account-address) | optional | The collection of Account addresses, containing address and account information. |


jnv · 2024-09-17T07:15:01Z

operations/addresses.md

+| `Line2` | string | optional, max length 255 characters | Second line of the address. |
+| `City` | string | optional, max length 255 characters | The city. |
+| `PostalCode` | string | optional, max length 255 characters | Postal code. |
+| `CountryCode` | string | optional, max length 3 characters | ISO 3166-1 code of the [Country](countries.md#country). |


Are you sure about that, @VBuben? To my knowledge ISO 3166-1 codes are up to 3 characters depending on whether you use alpha-2 or alpha-3 variant.

However, I would consider dropping the MaxLength constraint altogether, the format of the field is defined by ISO standard and that can change.

jnv · 2024-09-17T07:18:14Z

operations/addresses.md

+| `City` | string | optional, max length 255 characters | The city. |
+| `PostalCode` | string | optional, max length 255 characters | Postal code. |
+| `CountryCode` | string | optional, max length 3 characters | ISO 3166-1 code of the [Country](countries.md#country). |
+| `CountrySubdivisionCode` | string | optional, max length 3 characters | ISO 3166-2 code of the administrative division, e.g. DE-BW. |


So in case of ISO 3166-2 you have 2 characters for country code, hyphen, and 3 characters for subdivision, so 6 characters in total.

However, I would consider dropping the MaxLength constraint altogether, the format of the field is defined by ISO standard and that can change.

jnv · 2024-09-17T07:18:47Z

operations/addresses.md

+| `CountryCode` | string | optional, max length 8 characters | ISO 3166-1 code of the Country. |
+| `CountrySubdivisionCode` | string | optional, max length 8 characters | ISO 3166-2 code of the administrative division, e.g. DE-BW. |


Same comments as above apply here.

jnv · 2024-09-17T07:20:00Z

operations/addresses.md

+| `PostalCode` | [String update value](_objects.md#string-update-value) | optional, max length 255 characters | Postal code. |
+| `CountryCode` | [String update value](_objects.md#string-update-value) | optional, max length 8 characters | ISO 3166-1 code of the Country. |
+| `CountrySubdivisionCode` | [String update value](_objects.md#string-update-value) | optional, max length 8 characters | ISO 3166-2 code of the administrative division, e.g. DE-BW. |
+| ~~`AccountId`~~ | ~~string~~ | ~~required~~ | **Deprecated!** The value is ignored.|


Yeah, or hide it with InternalImplementation for starters.

…rameters CountryCode and CountrySubDivision, make Addressresult.Addresses required)

MikeAdamsMews · 2024-09-17T11:20:17Z

operations/addresses.md

+| `Line2` | string | optional, max length 255 characters | Second line of the address. |
+| `City` | string | optional, max length 255 characters | The city. |
+| `PostalCode` | string | optional, max length 255 characters | Postal code. |
+| `CountryCode` | string | optional, max length 3 characters | ISO 3166-1 code of the [Country](countries.md#country). |


I'm no expert, but according to Wikipedia there are three variants Alpha-2, Alpha-3 and Numeric, which are 2, 3 and 3 characters respectively. We should say which one we are using. I assume it's the most common Alpha-2, because the example is "CZ".

jonas-paul · 2024-09-18T14:12:39Z

_generator/types.yaml

-    file: _objects.md
+    file: vouchers.md


Why did this change?

This is a bug in generator, unit behaves strangely since it's a named type but doesn't have any properties, so for some reason the generator always overrides it. 🤔

…re-generating documentation.

jnv · 2024-09-20T14:24:03Z

operations/addresses.md

@@ -77,7 +77,7 @@ Note this operation uses [Pagination](../guidelines/pagination.md) and supports
 | Property | Type | Contract | Description |
 | :-- | :-- | :-- | :-- |
 | `Addresses` | array of [Account address](addresses.md#account-address) | required | The collection of Account addresses, containing address and account information. |
-| `Cursor` | string | optional | Unique identifier of the last and hence oldest address item returned. This can be used in [Limitation](../guidelines/pagination.md#limitation) in a subsequent request to fetch the next batch of older Account address. |
+| `Cursor` | string | required | Unique identifier of the last and hence oldest address item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older Account address. |


issue: Cursor should not be required, no idea how this got here. 🤔

Migrate Addresses

398c93b

RobBeck1 added Generator Pull requests related to reference documentation generator con.connectivity labels Sep 16, 2024

RobBeck1 self-assigned this Sep 16, 2024

RobBeck1 requested review from a team as code owners September 16, 2024 14:32

VBuben reviewed Sep 17, 2024

View reviewed changes

jnv reviewed Sep 17, 2024

View reviewed changes

Implementing PR change requests (remove max string limit on AddressPa…

153767b

…rameters CountryCode and CountrySubDivision, make Addressresult.Addresses required)

MikeAdamsMews approved these changes Sep 17, 2024

View reviewed changes

jonas-paul reviewed Sep 18, 2024

View reviewed changes

RobBeck1 and others added 4 commits September 20, 2024 10:43

Merge branch 'master' into CON-2195-Migrate-Addresses

ff303df

Applying changes requested in PR

73211a1

Correcting an error with new AddressResultPage class in monolith and …

5ce22f6

…re-generating documentation.

Merge branch 'master' into CON-2195-Migrate-Addresses

405a00d

jnv reviewed Sep 20, 2024

View reviewed changes

RobBeck1 and others added 2 commits September 26, 2024 10:47

Regenerated addresses.md to incorporate changes made in the monolith.

472dc1f

Merge branch 'master' into CON-2195-Migrate-Addresses

c18143d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate Addresses #653

Migrate Addresses #653

RobBeck1 commented Sep 16, 2024

VBuben Sep 17, 2024

VBuben Sep 17, 2024

jnv Sep 17, 2024

VBuben Sep 17, 2024

jnv Sep 17, 2024

MikeAdamsMews Sep 17, 2024

jonas-paul Sep 18, 2024

MikeAdamsMews Sep 20, 2024

VBuben Sep 17, 2024

VBuben Sep 17, 2024

VBuben Sep 17, 2024

VBuben Sep 17, 2024

jnv Sep 17, 2024

VBuben Sep 17, 2024

jnv Sep 17, 2024

jnv Sep 17, 2024

jnv Sep 17, 2024

jnv Sep 17, 2024

MikeAdamsMews Sep 17, 2024

jonas-paul Sep 18, 2024

jnv Sep 20, 2024

jnv Sep 20, 2024

	\| `Addresses` \| array of [Account address](addresses.md#account-address) \| optional \| The collection of Account addresses, containing address and account information. \|
	\| `Addresses` \| array of [Account address](addresses.md#account-address) \| required \| The collection of Account addresses, containing address and account information. \|

	\| `CountrySubdivisionCode` \| string \| optional, max length 3 characters \| ISO 3166-2 code of the administrative division, e.g. DE-BW. \|
	\| `CountrySubdivisionCode` \| string \| optional, max length 8 characters \| ISO 3166-2 code of the administrative division, e.g. DE-BW. \|

	\| `CountryCode` \| string \| optional, max length 3 characters \| ISO 3166-1 code of the [Country](countries.md#country). \|
	\| `CountryCode` \| string \| optional, max length 8 characters \| ISO 3166-1 code of the [Country](countries.md#country). \|

	\| `Line1` \| [String update value](_objects.md#string-update-value) \| optional, max length 255 characters \| First line of the address. \|
	\| `Line1` \| [String update value](_objects.md#string-update-value) \| optional, max length 1023 characters \| First line of the address. \|

Migrate Addresses #653

Are you sure you want to change the base?

Migrate Addresses #653

Conversation

RobBeck1 commented Sep 16, 2024

Summary

Follow style guide

Check during review

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment