update api-docs [2d]

[pamfilos]

what we need to update:

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

[ParthS007]

CAP Components

• Auth

  • Connect
  • Disconnect
  • Authorize
  • Profile

• Deposit

  • Create
  • Permissions
  • Publish
  • Upload
    • Repositories (Add more after merging of repos: allow creation of repos in gitlab/github analysispreservation.cern.ch#2441)
      • Upload snaphshot of repo (branch, with ref, etc)
      • Upload snaphshot of specific repo file
      • Create webhook (release/push)
      • Create and attach as user
      • Create and attach as a collaboration
      • Disconnect Web hook
    • Local File/Folders
  • Clone
  • Review
  • Edit

• Experiments

  • Alice
  • atlas
  • cms
  • lhcb

• Oauth2Server

  • Access Token
  • Errors
  • Ping
  • Info
  • Invalid

• Records

  • Create
  • List all records

• Repositories

  • Event

• Schema

  • get_all_versions
  • get
  • post
  • put
  • delete

• Search

• Services

  • ADL
  • CDS
  • CERN
  • INDICO
  • LATEX
  • ORCID
  • ROR
  • Status checks
  • Zenodo

• User

  • get user
  • logout
  • login
  • get_identity

• Workflows

  • Add after merge of workflows: update reana api for 0.8.0 analysispreservation.cern.ch#2481

• CAP

  • Ping
  • Dashboard
  • 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.