core icon indicating copy to clipboard operation
core copied to clipboard

Swagger Documentation for `/v1/api-token` Endpoints

Open gavriella-dotcms opened this issue 6 months ago • 0 comments

Parent Issue

28600

Task

Add Swagger documentation to api-token endpoints.

Proposed Objective

Documentation

Proposed Priority

Priority 3 - Average

Acceptance Criteria

Add endpoints should contain the following information in playground:

  • Tags
  • Descriptions
  • Parameters
  • Request bodies
  • Example values if necessary
  • Return schema

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

Endpoints being documented:

  • /v1/apitoken
  • /v1/apitoken/{tokenId}
  • /v1/apitoken/{tokenId}/jwt
  • /v1/apitoken/{tokenId}/revoke
  • /v1/apitoken/{userId}/tokens
  • /v1/apitoken/remote
  • /v1/apitoken/users/{userid}/revoke
  • /v1/apitoken/users/revoke

gavriella-dotcms avatar Aug 23 '24 18:08 gavriella-dotcms