updating stored-procedure design doc

[abhishekkumams]

Why make this change?

• It contains updating the design doc to understand the changes that are required for implementing stored-procedure for graphql
• It also helps understand the rationale for certain assumptions that were made.

What is this change?

• Updating the doc file to add high level change required in different classes/methods to support stored-procedure for graphQL.
  • Links to relevant documentation:
  • • [GraphQL] Stored Procedure support for Engine #869
  • • https://github.com/Azure/data-api-builder/blob/a9a56dbcc3778bbe227dabdb64e7b61b3d25672f/docs/StoredProcedureDesignDoc.md

NOTE:

the doc contains images that might not be shown correctly on the Files changed tab. To view the images correctly head over to the branch file: https://github.com/Azure/data-api-builder/blob/dev/abhishekkuma/graphql-support-for-stored-procedure-doc/docs/internals/StoredProcedureDesignDoc.md

[seantleonard]

Some changes requested to be clearer in explanations.
One general comment: why is much of this markdown document formatted as quotes using the ">" character?

[Aniruddh25]

LGTM, thanks for keeping our documentation up to date!

[seantleonard]

There's a thread about JsonDocument -> JsonElement that wasn't changed. Can you also note why many sections of this markdown document are quoted with the > character?

[abhishekkumams]

There's a thread about JsonDocument -> JsonElement that wasn't changed. Can you also note why many sections of this markdown document are quoted with the > character?

Updated to JsonElement.

most part of the document is quoted as '>' because this document was initially designed in that way to show every subsection to appear differently. I also think it makes it easier to follow each section.

[seantleonard]

Only reason I bring > up is because it is markdown block quote syntax and those sections are not quotes. I understand that they may be more readable, but I wonder if there is a better way to make it more readable.
Quotes make me think "this content is being quoted from somewhere... where is that?"

[abhishekkumams]

Only reason I bring > up is because it is markdown block quote syntax and those sections are not quotes. I understand that they may be more readable, but I wonder if there is a better way to make it more readable. Quotes make me think "this content is being quoted from somewhere... where is that?"

okay, I see your point now.