-
Notifications
You must be signed in to change notification settings - Fork 29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Specify string format whenever possible #93
Comments
The living list of defined formats is in Formats Registry of OpenAPI Initiative. |
Thanks @rartych, I will reference "formats registry" in this explanatory paragraph if others agree |
Formats Registry is created for OAS 3.1 to decouple format definitions from OpenAPI specification. However, according to OAS spec:
Do we need CAMARA-specific formats? |
Formats defined in OAS 3.0:
|
@eric-murray Could add your comment about relationship between patterns and formats? |
Valid strings can be qualified by both So I would not restrict the guidance to just formats. The recommendation should be that strings should be qualified by an appropriate I would avoid CAMARA-specific formats, and stick to those recognised by JSON. |
Reactivating this discussion. The reference to the accepted values of https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#data-types Both list some formats explicitly listed by OAS by do not exclude other values. Indeed we are using already formats as |
Problem description
As in geofencing, I propose to constrain the string format whenever possible to simply implementation and clarify usage.
For example, everywhere we use notification :Geolocation, Qod, DeviceStatus and SimSwap ...
Would be
Expected action
Add paragraph in guidelinse to describe this
The text was updated successfully, but these errors were encountered: