1 | example | In addition to GET SET parameter configuration related API does not do the example, in principle, API should do the example, so that customers have a more intuitive understanding, faster to get started. If there are different scenarios and the request format is different, both the scenario and the request example are added. |
2 | example Authentication | In previous examples, the summary authentication mode is used. This document adds session authentication and summary authentication modes in Section 2.4 to guide customers to adopt the session authentication mode. The new example only needs to describe the body. |
3 | Revision History | The update log was removed and the revision log was added. API adders need to record the add-in log, add-in, and add-in date in detail |
4 | endorsement | Comments are added to facilitate future consolidation of the document and to check whether the document addition is reasonable. Do not write warnings, summary descriptions, etc., in the comments. Add these descriptions, along with business process descriptions, to the body. |
5 | Flow | For example, the IPC channel chapter and the IPC maintenance chapter have many apis stacked together. The customer has no intuitive understanding. Therefore, when multiple apis are associated, a description should be added, and a flowchart should be added if necessary. |
6 | Directory | Update the directory is prohibited except for the specified person |