Added __get_pydantic_json_schema__ method with format='tel'

[hasansezertasan]

No description provided.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a973b79) 100.00% compared to head (ca9fc00) 100.00%.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #106   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            9         9           
  Lines          637       642    +5     
  Branches       158       159    +1     
=========================================
+ Hits           637       642    +5     

Files	Coverage Δ
pydantic_extra_types/phone_numbers.py	100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Kludex]

Where did you get this format from?

[hasansezertasan]

Where did you get this format from?

I was playing with json-editor/json-editor and they use this format.

I wasn't sure about opening this pull request so before I checked JSON Schema but couldn't find anything and then I checked Alpaca Forms which uses phone as the format. I was confused about using tel as a format, in the end I checked the html attributes, phone number inputs uses tel, here the example: HTML input type="tel".

Edit: After you asked I checked JSON Schema again and found this page: A JSON Media Type for Describing the Structure and Meaning of JSON Documents. In the 5.19. format section I saw this line: phone - This should be a phone number (format may follow E.123). I think I should change format='tel' to format='phone'

What do you think @Kludex

[Kludex]

The document you are using to "prove" it should be "phone" is expired by 13 years already... Do you have a better source?

[hasansezertasan]

The document you are using to "prove" it should be "phone" is expired by 13 years already... Do you have a better source?

I believe not, I'll do more digging. Until then, I'm converting this one to draft.

[hasansezertasan]

@Kludex 👋 Hope you're doing well.

I was searching for a better source to implement a valid schema that includes format for PhoneNumber field.

The document you are using to "prove" it should be "phone" is expired by 13 years already... Do you have a better source?

You're right about that. But thanks to you I saw this line in the draft-04 (Expires: August 26, 2017)

"format": remove attributes "phone", "style", "color"; rename "ip-address" to "ipv4"; add references for all attributes.

Hance pydantic-extra-types uses format='color' in Color field, I think using format='phone' in the PhoneNumber field seems allright.

What do you think we should do? Remove format='color' from the Color field which is expired by 13 years already... or add format='phone' to PhoneNumber field?

[Kludex]

You're right about that. But thanks to you I saw this line in the draft-04 (Expires: August 26, 2017)

Link?

[hasansezertasan]

"format": remove attributes "phone", "style", "color"; rename "ip-address" to "ipv4"; add references for all attributes.

This line is taken from here: JSON Schema: interactive and non interactive validation

I believe you were refering this when you said:

The document you are using to "prove" it should be "phone" is expired by 13 years already... Do you have a better source?