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

Clarify the absence of fields with nested messages #213

Open
cthulhu-rider opened this issue Apr 12, 2022 · 1 comment
Open

Clarify the absence of fields with nested messages #213

cthulhu-rider opened this issue Apr 12, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement Improving existing functionality I3 Minimal impact S4 Routine U4 Nothing urgent

Comments

@cthulhu-rider
Copy link
Contributor

cthulhu-rider commented Apr 12, 2022

There are plenty of fields of message type. I propose to explicitly write in docs whether the field MUST be set.

Where it is not written otherwise, I suggest to require field presence. Later we can relax the requirement, which would be a backwards compatible change.

These requirements will reduce the number of uncertainties when writing software.

Note: this only applies to fields in requests/responses.

@cthulhu-rider cthulhu-rider added documentation Improvements or additions to documentation enhancement Improving existing functionality discussion Open discussion of some problem triage labels Apr 12, 2022
@cthulhu-rider
Copy link
Contributor Author

We decided to consider all nested fields mandatory by default (where would you explicitly write about this?), and if an empty field is allowed, explicitly state this in the containing message.

@roman-khimov roman-khimov added U4 Nothing urgent S4 Routine I3 Minimal impact and removed triage discussion Open discussion of some problem labels Dec 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement Improving existing functionality I3 Minimal impact S4 Routine U4 Nothing urgent
Projects
None yet
Development

No branches or pull requests

2 participants