added frameworks entities

2024-03-25 15:15:48 -07:00
parent 81e4baccb1
commit 600a8e1f61
95 changed files with 59733 additions and 0 deletions
--- a/FRAMEWORKS/APPROW/SYSENV%003ASRP_HTTP_FRAMEWORK_TEMPLATE_API_COMMENT_BLOCK.json
+++ b/FRAMEWORKS/APPROW/SYSENV%003ASRP_HTTP_FRAMEWORK_TEMPLATE_API_COMMENT_BLOCK.json
@ -0,0 +1,47 @@
+{
+    "header": {
+        "version": 1,
+        "type": "record",
+        "approw-key": "SRP_HTTP_FRAMEWORK_TEMPLATE_API_COMMENT_BLOCK"
+    },
+    "body": {
+        "record1": {
+            "<1>": "/***********************************************************************************************************************",
+            "<2>": "",
+            "<3>": "    This program is proprietary and is not to be used by or disclosed to others, nor is it to be copied without written",
+            "<4>": "    permission from SRP Computer Solutions, Inc.",
+            "<5>": "",
+            "<6>": "    Name        :   <Resource>_API",
+            "<7>": "",
+            "<8>": "    Description :   API logic for the <Resource> resource.",
+            "<9>": "",
+            "<10>": "    Notes       :   All web APIs should include the API_SETUP insert. This will provide several useful variables:",
+            "<11>": "",
+            "<12>": "                        HTTPMethod              - The HTTP Method (Verb) submitted by the client (e.g., GET, POST, etc.)",
+            "<13>": "                        APIURL                  - The URL for the API entry point (e.g., api.mysite.com/v1).",
+            "<14>": "                        FullEndpointURL         - The URL submitted by the client, including query params.",
+            "<15>": "                        FullEndpointURLNoQuery  - The URL submitted by the client, excluding query params.",
+            "<16>": "                        EndpointSegment         - The URL endpoint segment.",
+            "<17>": "                        ParentURL               - The URL path preceeding the current endpoint.",
+            "<18>": "                        CurrentAPI              - The name of this stored procedure.",
+            "<19>": "",
+            "<20>": "    Parameters  :",
+            "<21>": "        API             [in] -- Web API to process. Format is [APIPattern].[HTTPMethod]:",
+            "<22>": "                                    - APIPattern must follow this structure <Resource>[.ID.[<Property>]]",
+            "<23>": "                                    - HTTPMethod can be any valid HTTP method, e.g., GET, POST, PUT, DELETE, etc.",
+            "<24>": "                                Examples:",
+            "<25>": "                                    - <Resource>.POST",
+            "<26>": "                                    - <Resource>.ID.PUT",
+            "<27>": "                                    - <Resource>.ID.firstName.GET",
+            "<28>": "        Response       [out] -- Response to be sent back to the Controller (HTTP_MCP) or requesting procedure. Web API",
+            "<29>": "                                services do not rely upon anything being returned in the response. This is what the",
+            "<30>": "                                various services like SetResponseBody and SetResponseStatus services are for. A response",
+            "<31>": "                                value is only helpful if the developers want to use it for debug purposes.",
+            "<32>": "",
+            "<33>": "    History     :   (Date, Initials, Notes)",
+            "<34>": "        MM/DD/YY    xxx     Original programmer.",
+            "<35>": "",
+            "<36>": "***********************************************************************************************************************/"
+        }
+    }
+}