add links for swagger UI and docs to API docs

[rachel-labri-tipton]

Pull Request

Description

Adds a brief description to the PV Site API docs that will better communicate to users how to test out the API. The links I've added should just add /docs or /swagger to the page's base url.

Fixes # issue that came up in the Full Stack Chat this morning

How Has This Been Tested?

Ran the api locally to view the changes.

Checklist:

• My code follows OCF's coding style guidelines
• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works
• I have checked my code and corrected any misspellings

[peterdudfield]

Is it worth doing swagger hyperlink? I understand then the dev site would connect to production though

[rachel-labri-tipton]

yeah, dev would connect to production. but that might be the best way to point users to correct url.

[peterdudfield]

yeah, dev would connect to production. but that might be the best way to point users to correct url.

Yea, do you mind doing that?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (72eacd9) 95.20% compared to head (1980020) 95.20%.
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #130   +/-   ##
=======================================
  Coverage   95.20%   95.20%           
=======================================
  Files          11       11           
  Lines         625      625           
=======================================
  Hits          595      595           
  Misses         30       30           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.