chore: Optimize Api definition

[tyyzqmf]

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Summary

1. Standardization API path to make the consistent API style, and clarify the meaning of the API by name.
   Standardization API path to make the consistent API style #215
   for example:

 POST /api/pipeline ---> POST /api/pipeline/CreatePipeline
 GET /api/pipeline ---> GET /api/pipeline/ListPipelines
 GET /api/pipeline/<id> ---> GET /api/pipeline/GetPipeline?id=xxx

2. Interface parameters, for example:

• The GET method only uses query to pass parameters
• The POST/PUT/DELETE method only uses body to pass parameters

3. Define Request and Response objects for all API, shared by front-end and back-end services

4. Distinguish between the Response object returned by the API and the DDB raw object, avoid to exposing the internal data structure.
   response event name in api #338

Implementation highlights

(describe how the merge request does for feature changes, share the RFC link if it has)

Test checklist

• add new test cases
• all code changes are covered by unit tests
• end-to-end tests
  • deploy web console with CloudFront + S3 + API gateway
  • deploy web console within VPC
  • deploy ingestion server
    • with MSK sink
    • with KDS sink
    • with S3 sink
  • deploy data processing
  • deploy data modeling
    • new Redshift Serverless
    • provisioned Redshift
    • Athena
  • deploy with reporting

Is it a breaking change

• add parameters without default value in stack
• introduce new service permission in stack
• introduce new top level stack module

Miscellaneous

• introduce new symbol link source file(s) to be shared among infra code, web console frontend, and web console backend

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	96.84%	🍏

There is no coverage information present for the Files changed

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	96.84%	🍏

There is no coverage information present for the Files changed

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	96.84%	🍏

There is no coverage information present for the Files changed

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	96.84%	🍏

There is no coverage information present for the Files changed

[jingnanl]

Here is RESTful API naming convention: https://restfulapi.net/resource-naming/

We should not use URIs to indicate a CRUD function. URIs should only be used to identify the resources and not any action upon them uniquely. We should use HTTP request methods to indicate which CRUD function is performed.

It is not correct to put the verbs in REST URIs. REST uses nouns to represent resources, and HTTP methods (GET, POST, PUT, DELETE, etc.) are then used to perform actions on those resources, effectively acting as verbs.

[tyyzqmf]

Here is RESTful API naming convention: https://restfulapi.net/resource-naming/

We should not use URIs to indicate a CRUD function. URIs should only be used to identify the resources and not any action upon them uniquely. We should use HTTP request methods to indicate which CRUD function is performed.

It is not correct to put the verbs in REST URIs. REST uses nouns to represent resources, and HTTP methods (GET, POST, PUT, DELETE, etc.) are then used to perform actions on those resources, effectively acting as verbs.

Great suggestion! I will refactor according to this rule.

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	97.12%	🍏

There is no coverage information present for the Files changed

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	97.12%	🍏

There is no coverage information present for the Files changed

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	96.25%	🍏

There is no coverage information present for the Files changed

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	96.52%	🍏

There is no coverage information present for the Files changed

[github-actions]

Data Pipeline spark application's test coverage

Overall Project	96.52%	🍏

There is no coverage information present for the Files changed