Name goes here
Note: This project follows the code null guidelines in version (version number of guideline)
Description goes here
Status
Stage: Pre-Alpha / Alpha / Beta / Released / Deprecated
Latest Stable Version:
Technical Details
| Segment | Technical ID | Public ID | Official Name | Type | Requires Accounts | Technology | Versioning |
|---|---|---|---|---|---|---|---|
| Program | true/false | Name of versioning w. version number if applicable |
Dependencies to other Devices, Server, Programs, Components
| Name | Needed for |
|---|---|
| Name with link if available |
Direct Access Databases
| Host | Type | Database Name | Used for |
|---|---|---|---|
| SQL/NOSQL/etc. |
Exposed APIs
None, description of the APIs or link to a separate documentation file. If there are more than 3 APIs or they expect/return complex data types, there always must be a separate file (apis.md)
Example for GraphQL APIs
Query/Mutation Name
Type: Query / Mutation
Expects:
GraphQL Schema here
Returns:
GraphQL Schema here
Example for REST APIs
| Endpoint | Type | Description | Expects | Returns |
|---|---|---|---|---|
| POST/GET/etc. |
Notes
Anything else that should be mentioned