rht-labs / api-design

NO LONGER ACTIVE - Home of our Swagger / OpenAPI Specifications, System Designs and Documentation
Apache License 2.0
4 stars 5 forks source link

Use the Description Field(s) to document the API #50

Open oybed opened 8 years ago

oybed commented 8 years ago

We should leverage the Description field better to document the API, in particular any decisions made that will be hard to backtrack later on - i.e.: if a field is added that doesn't directly map to a core feature/functionality, we need to ensure it is documented for future reference. Overall, just need better documentation.