Skip to content

JSON File Reference documentation improvements #1468

@mfilipan

Description

@mfilipan

Summary

We have several documentation improvements requests, that arose during migration projects on the following documentation page: JSON File Reference

Why do we need this ?

For migration purposes, it would be beneficial to have more complete documentation, in order to make the migration smoother.

What is already there? What do you see now?

The documentation is there, we need to improve it as below.

What is missing? What do you want to see?

  1. In the "JSON End Device Format" table, columns "Name", "Required", "Example" and "Description" are cut off and values are not fully visible.
  2. "supports_join" field is listed as Always required. However, customer removed it from the import file and the import finished successfully, albeit, the device got converted to ABP device (undesired and unexpected).
  3. "session_key_id" should be also present during the import. Absence of this field stopped the device from being imported via console.

How do you propose to document this?

  1. We see correct behaviour on CSV File Reference page. Ideally, the columns should be wider or scrollable, so that the whole strings can be seen.
  2. We need to clarify if this field is indeed mandatory or not (it is not listed as mandatory on the CSV File Reference document.
  3. If the value is not present in the input file, we could state it can be randomly generated as 16 byte string, and then encoded with base64 encoding (or recommend other adequate solution)

Can you do this yourself and submit a Pull Request?

In the future perhaps.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions