Skip to content

Adding support for query parameter in Swagger UI - #1769

Merged
Abhishek Kumar (abhishekkumams) merged 32 commits into
mainfrom
dev/abhishekkuma/open-api-documentor
Nov 14, 2023
Merged

Abhishek Kumar (abhishekkumams) merged 32 commits into
mainfrom
dev/abhishekkuma/open-api-documentor

Conversation

@abhishekkumams

@abhishekkumams Abhishek Kumar (abhishekkumams) commented Oct 3, 2023 •

Copy link
Copy Markdown
Contributor

Why make this change?

What is this change?

  • Updating the OpenApi document to include the supported query parameters
  • Separate Logic for StoredProcedures and Table/Views.
  • $filter,$orderBy, $first, and $after will be available in swagger UI for GET/GET_ALL REST requests in Table/Views.
  • StoredProcedures will support input parameters for all GET requests, but for others request Body should be used.

How was this tested?

  • Integration Tests
  • Manual Tests

Screenshots

GET request will have all the query parameters

image

POST/PUT/PATCH/DELETE will not have the above query parameters

image

Input parameters for Stored procedure, depending on the stored procedure definition

image

@abhishekkumams
Abhishek Kumar (abhishekkumams) marked this pull request as ready for review October 4, 2023 16:33

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

suggestions on making tests more readable and less prone to flakiness.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Some nits, and question on providing only $select for FindById..

@abhishekkumams

Copy link
Copy Markdown
Contributor Author

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 6 pipeline(s).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM, thanks for addressing all the feedback!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

OpenAPI - Document query string

5 participants