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

Part 2 of Workflow API swagger doc #29993

Merged
merged 1 commit into from
Sep 16, 2024
Merged

Part 2 of Workflow API swagger doc #29993

merged 1 commit into from
Sep 16, 2024

Conversation

jdcmsd
Copy link
Contributor

@jdcmsd jdcmsd commented Sep 13, 2024

The second vast and trunkless leg of stone arrives to stand in the desert. All that remains is the attendant shattered visage, with sneer of cold command (telling that its sculptor well those passions read!).

...By this I mean, this is the lion's share of the Workflow API — nearly 100% complete. There are several endpoints marked with an "under construction" emoji for one of two reasons:

  • Their data body is a multipart form, and I need to study up on exactly how those are structured, OR
  • Some error prevents them from firing within the playground, such as the PATCH method, which succeeds on a curl call but throws a 406 Unacceptable Status in Swagger.

I figured these two exceptions are not enough reason to delay the other endpoints' doc from entering the product.

Proposed Changes

  • Swagger annotations added to remaining WorkflowResource methods.
  • Added four new wrapper classes to assist in schema/entity reflection.

Checklist

  • Tests
  • Translations
  • Security Implications Contemplated (add notes if applicable)

This PR fixes: #29828

@jdcmsd jdcmsd linked an issue Sep 13, 2024 that may be closed by this pull request
@jdcmsd jdcmsd requested a review from nollymar September 13, 2024 11:16
@fabrizzio-dotCMS fabrizzio-dotCMS added this pull request to the merge queue Sep 13, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 14, 2024
@jdcmsd jdcmsd added this pull request to the merge queue Sep 16, 2024
Merged via the queue into master with commit cb70f7e Sep 16, 2024
31 checks passed
@jdcmsd jdcmsd deleted the 29828-workflow-api-part-2 branch September 16, 2024 15:18
@gavriella-dotcms
Copy link
Contributor

The default value for actionId did not work on my playground on some of the endpoints, not sure if this is an issue from my end or not.

@jdcmsd
Copy link
Contributor Author

jdcmsd commented Sep 17, 2024

Might warrant some research; I had thought that the System Workflow's actions' identifiers would be consistent across systems — i.e., it tests for me both on my local environment and on Demo.

If I'm wrong, though, I might need to pull some of those values and instead direct people to a method to procure the IDs.

But that can be the work of a different PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Swaggify Workflow API, part 2
4 participants