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

Authentication API Swagger Documentation #29616

Closed
7 tasks
Tracked by #28600
gavriella-dotcms opened this issue Aug 16, 2024 · 1 comment · Fixed by #29617
Closed
7 tasks
Tracked by #28600

Authentication API Swagger Documentation #29616

gavriella-dotcms opened this issue Aug 16, 2024 · 1 comment · Fixed by #29617
Labels
LTS : Next Ticket that will be added to LTS Merged QA : Approved QA : Passed Internal Release : 24.08.27 Custom templates and loggin fixes Team : Scout Type : Task

Comments

@gavriella-dotcms
Copy link
Contributor

gavriella-dotcms commented Aug 16, 2024 •
edited
Loading

Parent Issue

#28600

Task

Create missing Swagger documentation for the Authentication endpoint. Endpoint path is v1/authentication

Proposed Objective

Documentation

Proposed Priority

Priority 3 - Average

Acceptance Criteria

  • General description for endpoints
  • Document all input parameters
  • Describe all the possible responses
  • Test with secure authentication methods

Provide examples that work on demo site if possible.

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

Authentication Endpoints:

  • /v1/authentication
  • /v1/authentication/api-token
  • /v1/authentication/logInUser
@gavriella-dotcms gavriella-dotcms self-assigned this Aug 16, 2024
@gavriella-dotcms gavriella-dotcms mentioned this issue Aug 16, 2024
Open
94 tasks
@gavriella-dotcms gavriella-dotcms linked a pull request Aug 16, 2024 that will close this issue
issue-29616-authentication-endpoint-documentation #29617
Merged
3 tasks
@nollymar nollymar moved this from New to In Review in dotCMS - Product Planning Aug 24, 2024
@nollymar nollymar removed the Triage label Aug 24, 2024
@github-project-automation github-project-automation bot moved this from In Review to Internal QA in dotCMS - Product Planning Aug 24, 2024
@github-actions github-actions bot mentioned this issue Aug 24, 2024
Merged
3 tasks
@nollymar nollymar reopened this Aug 25, 2024
@github-project-automation github-project-automation bot moved this from Internal QA to Current Sprint Backlog in dotCMS - Product Planning Aug 25, 2024
@nollymar nollymar moved this from Current Sprint Backlog to Internal QA in dotCMS - Product Planning Aug 25, 2024
@jgambarios jgambarios self-assigned this Aug 26, 2024
@jgambarios jgambarios moved this from Internal QA to QA - Backlog in dotCMS - Product Planning Aug 26, 2024
@github-project-automation github-project-automation bot moved this from QA - Backlog to Internal QA in dotCMS - Product Planning Aug 26, 2024
@jgambarios jgambarios moved this from Internal QA to QA - Backlog in dotCMS - Product Planning Aug 26, 2024
@jgambarios jgambarios removed their assignment Aug 26, 2024
@bryanboza
Copy link
Member

Fixed.

@bryanboza bryanboza added QA : Approved Release : 24.08.27 Custom templates and loggin fixes labels Aug 26, 2024
@jdcmsd jdcmsd added the LTS : Next Ticket that will be added to LTS label Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
LTS : Next Ticket that will be added to LTS Merged QA : Approved QA : Passed Internal Release : 24.08.27 Custom templates and loggin fixes Team : Scout Type : Task
Projects
dotCMS - Product Planning
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

issue-29616-authentication-endpoint-documentation dotCMS/core
5 participants
@jgambarios @bryanboza @nollymar @jdcmsd @gavriella-dotcms