bcgov / invasivesbc

Inventory and database repository for the creation, treatment, and report on BC Invasive plants and animals.

Apache License 2.0

13 stars 4 forks source link

:zap: OpenAPI Documents #3668

Open LocalNewsTV opened 1 week ago

LocalNewsTV commented 1 week ago

Describe the task

If the task will only make sense to a dev, add a :zap: to the title.

Rewrite the OpenAPI Docs in our endpoints to be less boilerplate / general, and more tuned to our application to shed more context on the application

Value Add

More Usable Docs
Living Documentation in the Repo
Helps internal and external developers understand the application

Acceptance Criteria

[ ] Rewrite OpenAPI Docs to be less general and more specific to their use cases
[ ] second
[ ] third

Additional Context

-