-
Bug
-
Resolution: Done
-
Medium
-
None
-
None
Validation of the generated Swagger 2 file via tools like the swagger editor or swagger-cli reveals that there are schema violations in the file.
Violations
host String does not match the pattern of "[{}/ :\\](?::\d)?$"
host: n/a
Property example is not allowed
parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true type: string example: __PHYSICAL-LOCATION-ID__
Property also requires is not allowed
properties: model-invariant-id: type: string description: the ASDC model id for this resource or service model. also requires: model-version-id model-version-id: type: string description: the ASDC model version for this resource or service model. also requires: model-invariant-id
Other issues
- A license header is put into the description even though there already is a dedicated license field
- There is a contact block that only contains n/a values
- the description of the default response is referencing to an (internal?) AT&T wiki page that can't be reached
- When there's no description available for a parameter, a default description of n/a is added. The description key is not mandatory and it adds no value to add a meaningless placeholder for it
- relates to
-
AAI-3297 Update Swagger to not have AT&T Wiki links for Error Descriptions
- Closed