Don't put .
at the end of the header:
# goodHeader# badHeader.
Keep original case of abbreviations:
# goodFHIR, API, JSON, SaaS# badfhir, Api, json, saas
Use capitalized and consistent names for products:
# goodAidbox, Aidbox.Dev, Aidbox.Cloud, Aidbox.One, Fhirbase# badaidbox, devbox, cloud version of aidbox, enterprise aidbox, fhirebase
[ ]
some name, which should be substituted with something meaningful
{ }
mean optional
POST /PatientresourceType: Patientname:- given: [Max]family: Turikovgender: malebirthDate: '1990-10-10'address:- line:- 123 Oxygen Stcity: Hellodistrict: Worldstate: NYpostalCode: '3212'telecom:- use: home- system: phonevalue: "(32) 8934 1234"use: workrank: 1
200 OK
inside text
200
OK - as options for responses
'Button' names should be single-quoted.
Placeholders <YOUR-BOX>
should be in SCREAMING-CAMEL-CASE.