Implement events top level resource

[domguinard]

Significant PR implementing:

• The reintroduction of the /events resource
• The removal of all .../events subresouces
• The removal of the all virtual event type
• Moving the creation of a single event to from POST eventTypes to events
• Removal of the simple event query endpoints

[dakbhavesh]

Few more review comments:

1. To update openapi.json once review comments are incorporated in openapi.yml
2. As suggested by @mgh128, I also second the thought to keep /events at the end for all the endpoints returning events e.g. have /eventTypes/{eventType}/events instead of /eventTypes/{eventType}

[dakbhavesh]

@domguinard, How about adding support of dynamic EPCIS query parameter in openapi.yaml?

Here is how we can achieve this: https://stackoverflow.com/questions/49582559/how-to-document-dynamic-query-parameter-names-in-openapi-swagger

FYI: @jmcanterafonseca-iota, @mgh128

[domguinard]

In the last commit I ensured that all creation (POST) endpoints were consistent in terms of what they return (payload + status code):

POST /queries/{queryName}

• 200 OK returning the full events matching the query. As this is not really following the usual pattern (i.e., return the created object, we used 200 following the RFC definition of the payload):

the intended meaning of the payload can be summarized as a representation of the status of, or results obtained from, the action;

POST /capture

• 202 ACCEPTED no results (as this is the async endpoint)

POST /events

• 201 CREATED with the full event as a result

POST /queries/{queryName}/subscriptions

• 201 CREATED with subscription ID only - modified to return full subscription object to be consistent with the other endpoints

[dakbhavesh]

Hi @domguinard, Based on previous calls, I assume that we decided to return subscription details instead of just subscription id for the endpoint GET /queries/{queryName}/subscriptions/{subscriptionID}.

Should we incorporate this change in the current PR itself? Possibly we may want to fix the summary and example. As per summary, it looks as if we are just going to return the subscription id.

an example may look like below:

{
    "subscriptionID": "7cec849f-72f7-4a9d-bc86-080d3c5b7c98",
    "queryName": "GetIlmdExtension",
    "callbackUrl": "http://example.com/testWebhookSubscription",
    "secret": "0435ojtojt02",
    "initialRecordTime": "2022-01-06T06:52:24.880Z",
    "reportIfEmpty": true,
    "schedule": {
        "second": "0/30"
    },
    "createdAt": "2022-01-06T06:52:24.889Z"
}

fyi: @jmcanterafonseca-iota

[jmcanterafonseca-iota]

Apart from the comments left here there are 27 additional key comments that group would need to discuss

[domguinard]

@dakbhavesh very good point on the GET /queries/{queryName}/subscriptions/{subscriptionID} it was an omission on my side, I corrected it now.