nspcc-dev / nspcc-dev/neofs-api

Clarify the absence of fields with nested messages

Open
#213 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement I3 S4 U4
Dominant language
Makefile
Stars
11
Forks
15
Avg merge
2d 8h
Merged PRs (30d)
9

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation for request and response fields whose types are nested messages. Review how field presence is currently described, then document whether each such field must be set unless stated otherwise; done means the presence rule is explicit throughout the relevant documentation.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.