Utilizes GORM's hooks (https://gorm.io/docs/hooks.html) to compress (before saving) & decompress (after querying) large-sized data (size threshold determined by config start-data-compression-at-bytes).

start-data-compression-at-bytes: Value in bytes at when to compress blob; default=3145728,0=compress all,-1=no compression

Used for Spec.Doc, SpecAnalysis.SpecAnalysisResult.RawResult, SpecDiff.SpecDiffResult.RawResult.

This is to avoid sort buffer oom in mysql 8.x. Please note, If you meet some issue to docker compose up this version of mysql. It probably because the old data of mysql 8.x. You need to remove them by: docker compose down --volumes

In the current report page, we can only see a list of analyzers used on a spec. However, it is not clear how much weight was applied and how the score was calculated for each analyzer.

To address this issue, the UI will need some adjustments to display these information.

increase nginix client_max_body_size so that larger specs can be uploaded successfully. Fixes: https://github.com/cisco-developer/api-insights/issues/50

Remove diff files that are temporarily created during diff execution.

These files were originally retained for testing purpose, but can now be cleaned up.

Fixed some typos, and made some enhancements for clarity & consistency.

For example, use consistent form of CI/CD, use accurate branding terms like OpenAPI instead of Open API, GitHub instead of github, Docker Compose instead of docker-compose, etc.

After deploying helm chart in Openshift platform , facing below error. Please help on resolving below error.

sed: can't create temp file '/etc/nginx/nginx.confXXXXXX': Permission denied 2022/12/12 07:00:17 [emerg] 8#8: mkdir() "/var/cache/nginx/client_temp" failed (13: Permission denied) nginx: [emerg] mkdir() "/var/cache/nginx/client_temp" failed (13: Permission denied)

For this issue, Stackoverflow suggested below mentioned solution to rebuild image. I have to build and package UI application. Please let me know UI setup details.

https://github.com/nginxinc/docker-nginx/issues/417

• cli: update analyze cmd with flag --fail-on-error-rule (defaults to exit code 0 w/o the flag)
• cli: prevents Cobra from creating a default 'completion' command
• cli: prevents Cobra from generating docs with "Auto generated by spf13/cobra..."

Scenario: When showing diff between 2 versions of the specs doc or highlighting backward compatibility breaking changes, sometimes changes are not visible in the API Path request or response object but changes are in reference objects. Reference objects are typically defined under components (OAS3) or definitions (swagger2). For enabling users to do a more meaningful analysis of spec diff, API Insights UI needs to support allowing showing diff of referred components in the context of API Path.

Proposed Solution:

1. UX should be improved to allow users to see the diff between a referenced object in the API Path context. For example in the sample case "#/definition/ListResponse" can be expanded to see the diff between ListResponse objects in 2 versions.

2. New API should be exposed by the API Insights service that will return reference object GET /v1/apiregistry/services/{id}/specs/{specID}/references

   • OpenAPI 3.0 : return 'components' that include schemas, parameters, responses etc. as child element.
   • Swagger2 : return definitions, parameters, responses and securityDefinitions section of specs.
     • Check https://swagger.io/docs/specification/components/ "Differences From OpenAPI 2.0" section for more details.

3. UI while showing diff should detect "$ref": "#/components/" in the diff JSON/YAML & enable view reference functionality as per design in step 1.

   • Note: Only local reference object details viewing will be supported. Reference pointing to components in different files or remote URLs will not be supported.

Issue: When uploading a large spec file for a service, upload failed with an error request entity too large. See below snapshot

Expected Behavior: Upload spec should work and spec should get analyzed.