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

Add API Documentation for Task Assignmnets #4362

Merged
merged 4 commits into from
May 12, 2022
Merged

Conversation

sanjacornelius
Copy link
Contributor

@sanjacornelius sanjacornelius commented May 2, 2022

Issue & Reproduction Steps

TICKET: FOUR-5983
As a process architect, I want to have documentation of the task assignments API, so I can manage task assignments

Solution

  • Add missing API documentation for Task Assignments

How to Test

  1. Navigate to /api/documentation in your local instance.
  2. Authorize yourself via Bearer Token
  3. Locate the 'Task Assignment' location
  4. 'Try Out' all APIs
  5. Ensure all fields work properly
  6. Ensure all properties are listed in the example schema

Related Tickets & Packages

NONE

Code Review Checklist

  • I have pulled this code locally and tested it on my instance, along with any associated packages.
  • This code adheres to ProcessMaker Coding Guidelines.
  • This code includes a unit test or an E2E test that tests its functionality, or is covered by an existing test.
  • This solution fixes the bug reported in the original ticket.
  • This solution does not alter the expected output of a component in a way that would break existing Processes.
  • This solution does not implement any breaking changes that would invalidate documentation or cause existing Processes to fail.
  • This solution has been tested with enterprise packages that rely on its functionality and does not introduce bugs in those packages.
  • This code does not duplicate functionality that already exists in the framework or in ProcessMaker.
  • This ticket conforms to the PRD associated with this part of ProcessMaker.

# Conflicts:
#	storage/api-docs/api-docs.json
@ryancooley ryancooley merged commit a8a7cad into develop May 12, 2022
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.

3 participants