search

AtlasOfLivingAustralia / biocache-service

Occurrence & mapping webservices
https://biocache-ws.ala.org.au/ws/
Other
9 stars 26 forks source link

Add additional description to API documentation #762

Closed sughics closed 8 months ago

sughics commented 1 year ago

Current API swagger docs in docs test portal include API descriptions added in the biocache-service methods themselves.

  1. TODO - Add additional descriptions as requied to methods.
  2. TOOD - Export openapi specs file from the application and add new diff(excluding deprecated APIs) to the specs which will be displayed on the docs portal (New seagger specs JSON file will be added relevant branch in the aws api gateway repo - which will deploy to the relevant S3 bucket via AWS CICD )
sughics commented 1 year ago

Relevant brach for updates: https://github.com/AtlasOfLivingAustralia/biocache-service/tree/feature/issue-762-api-descriptions

adam-collins commented 8 months ago

Further work will be done under https://github.com/AtlasOfLivingAustralia/biocache-service/issues/833