Review of reported errors from local run CAMARA linter to confirm conformance with API Design Guidelines for EdgeCloud_LcM.yaml

[sergiofranciscoortiz]

After running locally CAMARA linter scripts indicated in #170, although using draft spectral , along with files in lint_function_folder, following errors/warnings appear:

71:16    error  camara-parameter-casing-convention  /appInstance should be kebab-case: must be kebab case                                                     paths./appInstance
122:24    error  camara-parameter-casing-convention  /appInstance/{appId} should be kebab-case: must be kebab case                                             paths./appInstance/{appId}
180:32    error  camara-parameter-casing-convention  /appInstance/{appInstanceId} should be kebab-case: must be kebab case                                     paths./appInstance/{appInstanceId}
180:32    error  path-params                         Paths "/appInstance/{appId}" and "/appInstance/{appInstanceId}" must not be equivalent.                   paths./appInstance/{appInstanceId}
  212:8    error  camara-parameter-casing-convention  /app should be kebab-case: must be kebab case                                                             paths./app
255:16    error  camara-parameter-casing-convention  /app/{appId} should be kebab-case: must be kebab case                                                     paths./app/{appId}
331:21    error  camara-parameter-casing-convention  /edge-cloud-nodes should be kebab-case: must be kebab case                                                paths./edge-cloud-nodes
373:29  warning  camara-parameters-descriptions      Parameter description is missing or empty: "oAuth2ClientCredentials.description" property must be truthy  components.securitySchemes.oAuth2ClientCredentials
403:17  warning  camara-parameters-descriptions      Parameter description is missing or empty: "AppManifest.description" property must be truthy              components.schemas.AppManifest
411:18  warning  camara-parameters-descriptions      Parameter description is missing or empty: "virtType.description" property must be truthy                 components.schemas.AppManifest.properties.virtType
422:20  warning  camara-parameters-descriptions      Parameter description is missing or empty: "repository.description" property must be truthy               components.schemas.AppManifest.properties.repository
565:15  warning  camara-parameters-descriptions      Parameter description is missing or empty: "ErrorInfo.description" property must be truthy                components.schemas.ErrorInfo
582:26  warning  camara-parameters-descriptions      Parameter description is missing or empty: "EdgeCloudNodeDetails.description" property must be truthy     components.schemas.EdgeCloudNodeDetails
596:21  warning  camara-parameters-descriptions      Parameter description is missing or empty: "OperatingSystem.description" property must be truthy          components.schemas.OperatingSystem
604:22  warning  camara-parameters-descriptions      Parameter description is missing or empty: "architecture.description" property must be truthy             components.schemas.OperatingSystem.properties.architecture
610:16  warning  camara-parameters-descriptions      Parameter description is missing or empty: "family.description" property must be truthy                   components.schemas.OperatingSystem.properties.family
618:17  warning  camara-parameters-descriptions      Parameter description is missing or empty: "version.description" property must be truthy                  components.schemas.OperatingSystem.properties.version
625:17  warning  camara-parameters-descriptions      Parameter description is missing or empty: "license.description" property must be truthy                  components.schemas.OperatingSystem.properties.license

To be double checked if correction is needed in yaml to avoid those errors/warnings. This yaml has several open pull requests at the moment (#166 , #167 , #168 , #188 , #189) so a new run will be needed in case some of them are approved.

[sergiofranciscoortiz]

Links for linter files from commonalities are working now (updated in main branch). We have rerun it with current EdgeCloud_LcM.yaml (actually proposal in PR #208)

  70:7      hint  camara-discriminator-use        Ensure that API definition YAML files with oneOf or anyOf sections include a discriminator object for serialization, deserialization, and validation.  paths
355:11  warning  camara-parameters-descriptions  Parameter description is missing or empty: "[1].description" property must be truthy                                                                   paths./edge-cloud-zones.get.parameters[1]
383:29  warning  camara-properties-descriptions  Property description is missing or empty: "oAuth2ClientCredentials.description" property must be truthy                                                components.securitySchemes.oAuth2ClientCredentials
413:17  warning  camara-properties-descriptions  Property description is missing or empty: "AppManifest.description" property must be truthy                                                            components.schemas.AppManifest
422:21  warning  camara-properties-descriptions  Property description is missing or empty: "packageType.description" property must be truthy                                                            components.schemas.AppManifest.properties.packageType
431:17  warning  camara-properties-descriptions  Property description is missing or empty: "appRepo.description" property must be truthy                                                                components.schemas.AppManifest.properties.appRepo
554:20     hint  camara-discriminator-use        Ensure that API definition YAML files with oneOf or anyOf sections include a discriminator object for serialization, deserialization, and validation.  components.schemas.AccessEndpoint
554:20  warning  camara-properties-descriptions  Property description is missing or empty: "AccessEndpoint.description" property must be truthy                                                         components.schemas.AccessEndpoint
570:23  warning  camara-properties-descriptions  Property description is missing or empty: "ipv4Addresses.description" property must be truthy                                                          components.schemas.AccessEndpoint.properties.ipv4Addresses
575:23  warning  camara-properties-descriptions  Property description is missing or empty: "ipv6Addresses.description" property must be truthy                                                          components.schemas.AccessEndpoint.properties.ipv6Addresses
581:14  warning  camara-properties-descriptions  Property description is missing or empty: "Ipv4Addr.description" property must be truthy                                                               components.schemas.Ipv4Addr
585:14  warning  camara-properties-descriptions  Property description is missing or empty: "Ipv6Addr.description" property must be truthy                                                               components.schemas.Ipv6Addr
591:10  warning  camara-properties-descriptions  Property description is missing or empty: "Fqdn" property must be truthy                                                                               components.schemas.Fqdn
591:10  warning  camara-properties-descriptions  Property description is missing or empty: "Fqdn.description" property must be truthy                                                                   components.schemas.Fqdn
594:10  warning  camara-properties-descriptions  Property description is missing or empty: "Port" property must be truthy                                                                               components.schemas.Port
594:10  warning  camara-properties-descriptions  Property description is missing or empty: "Port.description" property must be truthy                                                                   components.schemas.Port
598:15  warning  camara-properties-descriptions  Property description is missing or empty: "ErrorInfo.description" property must be truthy                                                              components.schemas.ErrorInfo
615:26  warning  camara-properties-descriptions  Property description is missing or empty: "EdgeCloudZoneDetails.description" property must be truthy                                                   components.schemas.EdgeCloudZoneDetails
629:21  warning  camara-properties-descriptions  Property description is missing or empty: "OperatingSystem" property must be truthy                                                                    components.schemas.OperatingSystem
629:21  warning  camara-properties-descriptions  Property description is missing or empty: "OperatingSystem.description" property must be truthy                                                        components.schemas.OperatingSystem
637:22  warning  camara-properties-descriptions  Property description is missing or empty: "architecture.description" property must be truthy                                                           components.schemas.OperatingSystem.properties.architecture
643:16  warning  camara-properties-descriptions  Property description is missing or empty: "family.description" property must be truthy                                                                 components.schemas.OperatingSystem.properties.family
651:17  warning  camara-properties-descriptions  Property description is missing or empty: "version.description" property must be truthy                                                                components.schemas.OperatingSystem.properties.version
658:17  warning  camara-properties-descriptions  Property description is missing or empty: "license.description" property must be truthy                                                                components.schemas.OperatingSystem.properties.license

It just includes warnings and hints, no errors. @gunjald could you have a look to the pending warnings, most of them are about properties descriptions, although is the parameter name is descriptive enough we may skip them.