refactor: remove swagger route and docs annotations (DEV-1335)

[mpro7]

Issue Number: DEV-1335

Pull Request Checklist

Basic Requirements

Please check if your PR fulfills the following requirements:

• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix: represents bug fixes
• Refactor: represents production code refactoring
• Feature: represents a new feature
• Documentation: documentation changes (no production code change)
• Chore: maintenance tasks (no production code change)
• Style: styles updates (no production code change)
• Test: all about tests: adding, refactoring tests (no production code change)
• Other... Please describe:

Does this PR introduce a breaking change?

• Yes
• No

Does this PR change client-test-data?

• Yes (don't forget to update the JS-LIB team about the change)
• No

Other information

[swarmia]

✅  Linked to Story DEV-1335 · DSP-API: Remove SwaggerAPI Route
➡️  Part of Epic DEV-542 · DSP-API Cleanups

[codecov]

Codecov Report

Merging #2203 (367938e) into main (71c772f) will increase coverage by 0.20%.
The diff coverage is 73.00%.

❗ Current head 367938e differs from pull request most recent head 114125a. Consider uploading reports for the commit 114125a to get more accurate results

@@            Coverage Diff             @@
##             main    #2203      +/-   ##
==========================================
+ Coverage   86.64%   86.84%   +0.20%     
==========================================
  Files         233      242       +9     
  Lines       28020    28177     +157     
==========================================
+ Hits        24277    24471     +194     
+ Misses       3743     3706      -37     

Impacted Files	Coverage Δ
...sp-shared/src/main/scala/dsp/valueobjects/V2.scala	84.05% <0.00%> (-1.45%)	⬇️
webapi/src/main/scala/org/knora/webapi/Main.scala	0.00% <0.00%> (ø)
...sponder/projectsmessages/ProjectsMessagesADM.scala	91.19% <ø> (ø)
...tore/triplestoremessages/TriplestoreMessages.scala	74.78% <ø> (-0.22%)	⬇️
...a/org/knora/webapi/messages/util/ValueUtilV1.scala	91.26% <ø> (-0.05%)	⬇️
...api/responders/admin/PermissionsResponderADM.scala	90.22% <ø> (ø)
...webapi/responders/admin/ProjectsResponderADM.scala	92.13% <ø> (ø)
...n/scala/org/knora/webapi/routing/RouteUtilV1.scala	81.81% <ø> (ø)
.../scala/org/knora/webapi/routing/VersionRoute.scala	100.00% <ø> (ø)
...org/knora/webapi/routing/admin/FilesRouteADM.scala	85.71% <ø> (ø)
... and 80 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[irinaschubert]

LGTM

[irinaschubert]

This whole structure is not up-to-date. Could you go over the whole Readme.md file if you touch it anyway?

[mpro7]

Although it's out of the scope of this PR I cleaned it up. There should be another task defined to clean the whole API documentation though.

[mpro7]

And I removed too much :)
Do we actually need this "test"?

  test-docs-build:
    name: Test docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout source
        uses: actions/checkout@v3
      - name: Install requirements (pip, npm, apt)
        run: |
          python -m pip install --upgrade pip
          pip install -r docs/requirements.txt
          npm install --global typedoc
          sudo apt-get install graphviz
      - name: Build docs
        run: make docs-build

[irinaschubert]

Yes, we need it. It's to make sure that the docs compile.