update api-docs [2d]

[pamfilos]

what we need to update:

• [x] check that all our components are there
• [x] for each component make sure that docs/description is correct and up-to-date
• [x] fix examples - there are a lot of duplicates (because of copy=paste)

[ParthS007]

CAP Components

• [x] Auth

  • [x] Connect
  • [x] Disconnect
  • [x] Authorize
  • [x] Profile

• [ ] Deposit

  • [x] Create
  • [x] Permissions
  • [x] Publish
  • [ ] Upload
    • [ ] Repositories (Add more after merging of https://github.com/cernanalysispreservation/analysispreservation.cern.ch/pull/2441)
    • [x] Upload snaphshot of repo (branch, with ref, etc)
    • [x] Upload snaphshot of specific repo file
    • [x] Create webhook (release/push)
    • [ ] Create and attach as user
    • [ ] Create and attach as a collaboration
    • [x] Disconnect Web hook
    • [x] Local File/Folders
  • [x] Clone
  • [x] Review
  • [x] Edit

• [x] Experiments

  • [x] Alice
  • [x] atlas
  • [x] cms
  • [x] lhcb

• [x] Oauth2Server

  • [x] Access Token
  • [x] Errors
  • [x] Ping
  • [x] Info
  • [x] Invalid

• [x] Records

  • [x] Create
  • [x] List all records

• [x] Repositories

  • [x] Event

• [x] Schema

  • [x] get_all_versions
  • [x] get
  • [x] post
  • [x] put
  • [x] delete

• [ ] Search

• [ ] Services

  • [x] ADL
  • [x] CDS
  • [ ] CERN
  • [x] INDICO
  • [x] LATEX
  • [x] ORCID
  • [x] ROR
  • [ ] Status checks
  • [x] Zenodo

• [x] User

  • [x] get user
  • [x] logout
  • [ ] login
  • [ ] get_identity

• [ ] Workflows

  • [ ] Add after merge of https://github.com/cernanalysispreservation/analysispreservation.cern.ch/pull/2481

• [x] CAP

  • [x] Ping
  • [x] Dashboard
  • [x] Collection

[pamfilos]

I have updated the above list with strikethrough to point on endpoints that should be hidden from user documentation, since there are irrelevant for the default user

[pamfilos]

Lets use this issue as anchor. We can open different PRs for each "module" so it is easier to handle and merge (e.g one for deposits, one for services, etc)

[ParthS007]

Okay, Sounds good.