search

camaraproject / Commonalities

Repository to describe, develop, document and test the common guidelines and assets for CAMARA APIs
Apache License 2.0
14 stars 28 forks source link

String format/pattern recommendation #330

Open rartych opened 2 weeks ago

rartych commented 2 weeks ago

What type of PR is this?

What this PR does / why we need it:

Using string format or pattern modifiers simplify implementation and clarify parameter usage. Recommendation added to section 11.5 Data Definitions.

Which issue(s) this PR fixes:

Fixes #93

Does this PR introduce a breaking change?

Special notes for reviewers:

Changelog input

String format/pattern recommendation added

Additional documentation

https://spec.openapis.org/oas/v3.0.3.html#data-types

PedroDiez commented 1 week ago

@rartych could it be also considered #137 into this PR? Think it makes sense

rartych commented 1 week ago

On general level it is covered as duration is listed in the registry: https://spec.openapis.org/registry/format/duration.html

The open question is whether it should be mandated to use strings for duration or leave the decision to subprojects (to use integers or object types).