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

Implement Swagger Docs, Login UI Update #205

Merged
merged 12 commits into from
May 9, 2024
Merged

Conversation

wcgunter
Copy link
Collaborator

@wcgunter wcgunter commented Apr 9, 2024

Purpose

  • Add easy to access API documentation to CWS.
  • On the Documentation tab, two new links have been added: API Documentation (links to Swagger Docs), Camunda API Documentation (links to Camunda Swagger Docs)
image
  • Swagger docs are now available at /cws-ui/api-docs
image
  • Swagger docs includes "Try it out" feature. Once the user puts their cwsToken in the authentication tool at the top of the page, they can test out API calls directly on the webpage.
  • Updated login page so that the text boxes no longer shift after a couple of seconds. (Test Console is the CWS_BRAND_HEADER variable that gets set on startup
image

@wcgunter wcgunter self-assigned this Apr 9, 2024
@wcgunter wcgunter marked this pull request as draft April 9, 2024 22:49
@jamesfwood
Copy link
Collaborator

Still working on this?

@wcgunter wcgunter marked this pull request as ready for review April 12, 2024 17:13
@wcgunter
Copy link
Collaborator Author

@jamesfwood Yep! I just pushed the changes to fix the curl command. It will grab the cookie if the user entered it in the authentication box at the top of the page. Otherwise, it will leave a spot and instruct the user to put the cookie there.

Copy link
Collaborator

@jamesfwood jamesfwood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, awesome work!

@jamesfwood jamesfwood merged commit f1b3195 into develop May 9, 2024
4 checks passed
@jamesfwood jamesfwood deleted the wg-swagger-docs branch May 9, 2024 19:05
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.

2 participants