Lots of API specification updates by kendallb · Pull Request #13 · ShipEngine/shipengine-openapi

Fixed country_code, site_id and mailer_id to be common type, so it works with C# client generation

kendallb

committed

This item is nullable as the actual code can return null here (included in JSON, but null). So either we need to mark it as nullable here or the service should not be including the value.

kendallb

committed

These all need to be nullable also as the service responses actually have nulls in them

kendallb

committed

These can be null for UPS SurePost, so the spec needs to handle that

kendallb

committed

The customs_item_id is marked as required and not-nullable, but it really should be nullable so it can be left out of the request.

kendallb

committed

There is already a type for carrier code so it should be used and NOT a string!

kendallb

committed

Add support for undocumented test_labels parameters

kendallb

committed

Warehouse ID is not required for manifesting, and this will fail to parse the responses sent back if you manifest for specific labels.

kendallb

committed

Tracking numbers need to be optional to correctly parse the response when a label is a test label with USPS.

kendallb

committed

These should not be marked as obsolete as it will cause the compiler to throw and error if you use it. And it still does work.

kendallb

committed

Fixed incorrectly specified 204 responses as they are actually empty and there is no response content to parse

kendallb

committed

This must be nullable, as it comes back null for USPS manifest documents from Endicia.

kendallb

committed

Gah, this also needs to be nullable

kendallb

committed

Some countries do not have states, so this can fail if null is passed for an empty country

kendallb

committed

Added in the missing carrier information to the error responses

kendallb

committed

Add support for missing label_image_id which is not documented on the web site.

kendallb

committed

These are NULLABLE, as they can come back as NULL from the addressd validation service. I am not sure why you guys changed then to not allow null???

kendallb

committed

This must also be nullable

kendallb

committed

Add in missing error response

kendallb

committed

More fields need to be nullable

kendallb

committed

Yet more fields need to be nullable

kendallb

committed

Yet more nullable fields in the wild

kendallb

committed

Fix up broken image_content_type and revert the shipping_address_to stuff to maintain binary compatibility for now. Might put that back later.

kendallb

committed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Lots of API specification updates#13

Lots of API specification updates#13
kendallb wants to merge 23 commits into
ShipEngine:masterfrom
kendallb:feature/kendallb/api-specification-updates

Commits on Mar 27, 2024

Fixed country_code, site_id and mailer_id to be common type, so it works with C# client generation

This item is nullable as the actual code can return null here (included in JSON, but null). So either we need to mark it as nullable here or the service should not be including the value.

These all need to be nullable also as the service responses actually have nulls in them

These can be null for UPS SurePost, so the spec needs to handle that

The customs_item_id is marked as required and not-nullable, but it really should be nullable so it can be left out of the request.

There is already a type for carrier code so it should be used and NOT a string!

Add support for undocumented test_labels parameters

Warehouse ID is not required for manifesting, and this will fail to parse the responses sent back if you manifest for specific labels.

Tracking numbers need to be optional to correctly parse the response when a label is a test label with USPS.

These should not be marked as obsolete as it will cause the compiler to throw and error if you use it. And it still does work.

Fixed incorrectly specified 204 responses as they are actually empty and there is no response content to parse

This must be nullable, as it comes back null for USPS manifest documents from Endicia.

Gah, this also needs to be nullable

Some countries do not have states, so this can fail if null is passed for an empty country

Added in the missing carrier information to the error responses

Add support for missing label_image_id which is not documented on the web site.

These are NULLABLE, as they can come back as NULL from the addressd validation service. I am not sure why you guys changed then to not allow null???

This must also be nullable

Add in missing error response

More fields need to be nullable

Yet more fields need to be nullable

Yet more nullable fields in the wild

Fix up broken image_content_type and revert the shipping_address_to stuff to maintain binary compatibility for now. Might put that back later.