From 5df6fbbb1c734ac28310e6c9be44ba6423c0a4e1 Mon Sep 17 00:00:00 2001 From: jvyden Date: Tue, 1 Feb 2022 14:46:24 -0500 Subject: [PATCH] [skip ci] Add api doc section to contributor's guide --- .idea/.idea.ProjectLighthouse/.idea/indexLayout.xml | 1 + CONTRIBUTING.md | 9 ++++++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/.idea/.idea.ProjectLighthouse/.idea/indexLayout.xml b/.idea/.idea.ProjectLighthouse/.idea/indexLayout.xml index 6dc843df..c41892bf 100644 --- a/.idea/.idea.ProjectLighthouse/.idea/indexLayout.xml +++ b/.idea/.idea.ProjectLighthouse/.idea/indexLayout.xml @@ -6,6 +6,7 @@ .github .gitignore .idea + CONTRIBUTING.md DatabaseMigrations ProjectLighthouse.sln.DotSettings ProjectLighthouse.sln.DotSettings.user diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58cac488..3d72edc6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,4 +90,11 @@ Keep in mind while running database tests (which most tests are) you need to hav - You can skip CI runs for a commit if you specify `[skip ci]` at the beginning of the commit name. This is useful for formatting changes, etc. - When creating your first pull request, CI will not run initially. A team member will have to approve you for use of - running CI on a pull request. This is because of GitHub policy. \ No newline at end of file + running CI on a pull request. This is because of GitHub policy. + +### API Documentation + +You can access API documentation by looking at the XMLDoc in the controllers under `ProjectLighthouse.Controllers.Api` + +You can also access an interactive version by starting Lighthouse and accessing Swagger +at `http://localhost:10060/swagger/index.html`. \ No newline at end of file