search

ni / systemlink-OpenAPI-documents

MIT License
16 stars 22 forks source link

TestMonitor | Adding TestMonitor OpenAPI document for SLE #109

Closed Madhan-Reddy-ni closed 10 months ago

Madhan-Reddy-ni commented 10 months ago

What does this Pull Request accomplish?

Recently as a part of this feature - Feature 2092223: Add keywords and properties to steps, we have added new properties (keywords and properties) to steps. We want to add these new properties to OpenAPI documents which lets users to create steps with the right set of properties. While updating the old version of document we found that it hadn't been updated for a long time and updating it doesn't feel right considering SLS. So, we went ahead with creating a new folder named SLE inside test-monitor and placed the latest document from the skyline repo.

Why should this Pull Request be merged?

In this PR, we have added the latest swagger documentation of test-monitor service for SLE which will help users in making API calls to the service with the right set of properties.

What testing has been done?

Tested in Swagger Editor

MuthuRajan-S commented 10 months ago

I talked with Richard Bell about this, since these changes are SLE specific and the current documents are outdated and new SLE changes are not there, we proceed with creating a new document for SLE.

Madhan-Reddy-ni commented 10 months ago

Can you please highlight what the changes are from what is currently shipping with SLE? I don't want to re-review all of the code. In fact, it would be best to have 2 PRs. One that is just a copy of the current docs and another with the diffs.

Hi @adamarnesen

I have updated the PR just to contain current/older SLE swagger document, I will be creating one more PR adding keywords and properties inside steps. Currently, the PR is created inside the Forked Repo because of some limitations with the Forked Repo we will raise it main repo once this PR got completed.