Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update api-docs [2d] #17

Open
3 tasks done
pamfilos opened this issue Apr 13, 2022 · 4 comments · May be fixed by #18
Open
3 tasks done

update api-docs [2d] #17

pamfilos opened this issue Apr 13, 2022 · 4 comments · May be fixed by #18
Assignees
@ParthS007

Comments

@pamfilos
Copy link
Collaborator

pamfilos commented Apr 13, 2022 •
edited by ParthS007
Loading

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)
@pamfilos pamfilos changed the title update api-docs update api-docs [2d] Apr 13, 2022
@ParthS007
Copy link

ParthS007 commented Apr 13, 2022 •
edited
Loading

CAP Components

  • Auth

    • Connect
    • Disconnect
    • Authorize
    • Profile

  • Deposit

  • 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

  • CAP

    • Ping
    • Dashboard
    • Collection

@pamfilos
Copy link
Collaborator Author

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
Copy link
Collaborator Author

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
Copy link

Okay, Sounds good.

@ParthS007 ParthS007 linked a pull request Apr 13, 2022 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ParthS007 ParthS007

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

deposit: update open api docs cernanalysispreservation/cap-api-docs
2 participants
@pamfilos @ParthS007