Split QoD in Quality-On-Demand and QoS Profiles APIs

[jlurien]

What type of PR is this?

• enhancement/feature

What this PR does / why we need it:

QoD v0.10.x API is split in 2:

• Quality-On-Demand, version WIP, with /sessions operations

  • PR suggests "Quality-On-Demand" and /quality-on-demand, as API Title and basePath

• QoS Profiles, version WIP, with /qos-profiles operations

  • PR suggests "QoS Profiles" and /qos-profiles, as API Title and basePath

The discussion about the names is not closed, so they may change.

Considerations:

• yaml files in /code folder. We may consider a different organization, e.g. a subfolder per API.
• All schemas moved to the spec where they are referred. Only the schema QosProfileName is used in both.
• securitySchemas is only kept in Quality-On-Demand. TBD which securityScheme to be applied to QoS Profiles, if any.
• Old info.description is kept mostly within Quality-On-Demand. A basic one is included for QoS Profiles, but may be enhanced. A cross reference between both APIs could be added.
• versions are "wip", and version in basePaths are /v-wip

Which issue(s) this PR fixes:

Fixes #265
Discussion is not closed. It was decided in last meeting that "we will discuss final names based on the PR."

Special notes for reviewers:

README and other files in documentation will likely need to be adapted

Changelog input

- QoD API is split in 2: one for operations on sessions, and other for operations on qos-profiles

[jlurien]

This error requires some fixing in the CI, as now is dependent on the spec filename:

Run `npm audit` for details.
Run cd /home/runner/work/_actions/char0n/swagger-editor-validate/v1.3.2 && SWAGGER_EDITOR_URL=https://editor.swagger.io/ DEFINITION_FILE=code/API_definitions/qod-api.yaml IGNORE_ERROR= node src/index.js
Error: Error while validating in Swagger Editor
Error: Error: ENOENT: no such file or directory, open '/home/runner/work/QualityOnDemand/QualityOnDemand/code/API_definitions/qod-api.yaml'
Error: Process completed with exit code 1.

[hdamker]

From QoD meeting on May 3rd:

• Naming will be accepted as proposed for this PR ... can be discussed separately and changed if needed
• One week of review ... will be merged on next Friday (May 10th) if no open comments.

[hdamker]

@camaraproject/quality-on-demand_maintainers - I just learned that a team will be removed from the reviewer list as soon as one member of the team has reviewed "on behalf" (here @RandyLevensalor). But I suppose that all team members have at least got the review request ones?

Anyway, this PR is important to get reviewed and merged, so that we continue with other issues. Please be aware of the deadline of March 10th for your reviews.

[RandyLevensalor]

This error requires some fixing in the CI, as now is dependent on the spec filename:

Run `npm audit` for details.
Run cd /home/runner/work/_actions/char0n/swagger-editor-validate/v1.3.2 && SWAGGER_EDITOR_URL=https://editor.swagger.io/ DEFINITION_FILE=code/API_definitions/qod-api.yaml IGNORE_ERROR= node src/index.js
Error: Error while validating in Swagger Editor
Error: Error: ENOENT: no such file or directory, open '/home/runner/work/QualityOnDemand/QualityOnDemand/code/API_definitions/qod-api.yaml'
Error: Process completed with exit code 1.

This fix has been merged. When the branch is rebased it should resolve this issue. @hdamker thanks for the quick fix.

[RandyLevensalor]

Can the README.md also be updated to reflect these changes?

The links to the redoc and swagger views of these files will be missing along with some of the other descriptions.

[hdamker]

Can the README.md also be updated to reflect these changes?

The links to the redoc and swagger views of these files will be missing along with some of the other descriptions.

@RandyLevensalor that will be done when we create a (public) release. Currently they are pointing correctly to the latest released version.

[hdamker]

Hi, as we have todo the QoD Call I kindly ask @camaraproject/quality-on-demand_maintainers for their review. Hopefully we can discuss today the outstanding comments and get the PR done.

[sfnuser]

Thanks.

[jlurien]

@hdamker @eric-murray @RandyLevensalor Suggestions merged