Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
I am creating API documentation for my REST web services. The requests and responses contain some enums, but what is a good section title to describe these. The title “Enumerations” sound to programmy, am I wrong?
Gender
Male - 1
Female - 2
Pool Team Status
All - 1
Active - 2
Active and Paid - 3
Registration Status
All - 1
Active - 2
Active and Paid - 3
Status
All - 1
Active - 2
Active and Paid - 3
You could refer to them as Options, Alternatives or any other synonym (in case that is what they are).
Nevertheless, assuming you are writing the documentation for other programmers and not just as something that management has to go through, I think Enumerations or Enums is good, as it will be clear to your audience, which is what you want to achieve.