Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feat]: Create Parameters.Options.Create to be consistent with other Parameters.Shipment.Create property types #596

Open
1 task done
chadwixk opened this issue Oct 12, 2024 · 1 comment
Labels
triage Issue is being researched

Comments

@chadwixk
Copy link

Feature Request Is New

  • I have verified that the requested feature does not already exist or has not already been requested.

Description of the feature

Parameters.Shipment.Create.cs properties are other Parameter types, except Options which use a non-parameter type and instead use the Model.API type.

@chadwixk chadwixk added the triage Issue is being researched label Oct 12, 2024
@chadwixk chadwixk changed the title [Feat]: Create Parameters.ShipmentOptions.Create to be consistent with other Parameters.Shipment.Create property types [Feat]: Create Parameters.Options.Create to be consistent with other Parameters.Shipment.Create property types Oct 12, 2024
@nwithan8
Copy link
Member

Hello, thanks for reaching out!

You are correct, the Options class is one of, if not the only, response-model class that does not have a corresponding parameter class. This is largely due to the fact that a) the Options` class is quite large and could potentially fall out of sync trying to maintain two versions of it, and b) there is no difference between the request/parameter version and the response/model version, so we found it largely unnecessary to duplicate.

We are currently working on adding additional elements to the Options class, including documentation for every option, and will take your design suggestion under consideration. We apologize for the confusion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage Issue is being researched
Projects
None yet
Development

No branches or pull requests

2 participants