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.

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

Swagger Documentation for /v1/contenttype Endpoints #29037

Closed
Tracked by #28600
jdcmsd opened this issue Jun 27, 2024 · 4 comments · Fixed by #29187
Closed
Tracked by #28600

Swagger Documentation for /v1/contenttype Endpoints #29037

jdcmsd opened this issue Jun 27, 2024 · 4 comments · Fixed by #29187

Comments

@jdcmsd
Copy link
Contributor

jdcmsd commented Jun 27, 2024

Task

Update Content Type REST API resource with Swagger documentation.

Proposed Objective

Documentation

Proposed Priority

Priority 2 - Show Stopper

Acceptance Criteria

Content Type REST API endpoints on the API Playground should contain all necessary information to comfortably begin to use them, including:

  • Tags
  • Descriptions
  • Parameter details
  • Request body explanations
  • Sample values where appropriate
  • Return schema

image

image

image

image

@nollymar nollymar moved this from New to In Review in dotCMS - Product Planning Jun 27, 2024
@nollymar nollymar linked a pull request Jun 27, 2024 that will close this issue
@jdcmsd jdcmsd linked a pull request Jul 3, 2024 that will close this issue
@jdcmsd jdcmsd changed the title /v1/contenttype Swagger Documentation for /v1/contenttype Endpoints Jul 3, 2024
@jdcmsd jdcmsd self-assigned this Jul 3, 2024
@jdcmsd jdcmsd removed a link to a pull request Jul 10, 2024
@jdcmsd jdcmsd linked a pull request Jul 10, 2024 that will close this issue
@jdcmsd
Copy link
Contributor Author

jdcmsd commented Jul 10, 2024

Redone, new and improved! No refactoring, all swagger!

@github-project-automation github-project-automation bot moved this from In Review to Internal QA in dotCMS - Product Planning Jul 10, 2024
@nollymar nollymar reopened this Jul 11, 2024
@github-project-automation github-project-automation bot moved this from Internal QA to Current Sprint Backlog in dotCMS - Product Planning Jul 11, 2024
@nollymar nollymar moved this from Current Sprint Backlog to Internal QA in dotCMS - Product Planning Jul 11, 2024
@gavriella-dotcms
Copy link
Contributor

Looks good! All of the documentation is shown on my API playground.

@bryanboza
Copy link
Member

Hey @jdcmsd , this looks better now. However, I have a question about the responses section. I'm not sure if we should list all the possible response codes handled by the endpoint or if it should just be a basic summary of the happy path. Should we include responses like 400 or 401 as well?

Image

Image

@bryanboza
Copy link
Member

We can close this for now, a new discussion opened for the next L10 meeting

@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
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants