Add pattern definition rules

[arey]

This development follows on from the Pull Request spring-petclinic/spring-petclinic-angular#142 from @Holger-Mayer. I quote:

An anomaly is defined within the openAPI validation.
We define some fields with a minimal length but we do not have a pattern validation rule defined. This enables the user of the api to define i.e. names with all blank characters. Here in the future, the openApi description should define pattern validation rules.
In the meantime, it is assumed, that any required name field with a length > 0 may not start with a character other than [A-za-z]. This is implemented in this pull request.

We could add some validation rules similar to the spring-petclinic-angular. Before starting this issue, we have to list them here.

[chetnashedame]

Hi! I’d love to work on this issue as my first contribution. May I take it up?

[arey]

Hi @chetnashedame sure you may take it 👍

[arey]

Thank you @chetnashedame for your first contribution.

Could you please continue to enhance the OAS file with constraints?
For now, I suggest listing them all in this thread. Then we can check them before implementing them.

[chetnashedame]

Thank you so much for your guidance @arey .

Here are all the current validation constraints in the Java model classes:

Person.java

• firstName: @notempty
• lastName: @notempty

Owner.java

• telephone: @notempty, @digits(integer=10, fraction=0), @pattern(regexp="^[0-9]{10}$")

also noticed some fields in the codebase that currently don't have constraints, but maybe they should:
(possibly)

Pet.java

• name: @notempty
• birthDate: @NotNull

Visit.java

• date: @NotNull
• description: @notempty

let me know if you want anything else happy to take it up

[arey]

Hi @chetnashedame. Thank you for your analyze. Here my comments:

Person.java

• firstName: @notempty
• lastName: @notempty

The last_name and first_name column of the owners table are not null.
The firstName and the lastname properties of the OwnerFields schema have both pattern, minLength and maxLength.
It looks like OK.

Owner.java

• telephone: @notempty, https://github.com/digits(integer=10, fraction=0), @pattern(regexp="^[0-9]{10}$")

The telephone column of the owners table is not null.
The telephone property of the OwnerFields schema has a pattern: '^[0-9]*$'.
It looks like OK.

also noticed some fields in the codebase that currently don't have constraints, but maybe they should:
(possibly)

Pet.java

• name: @notempty
• birthDate: @NotNull

In the H2 schema, the name and birth_date column of the pets table are not null.
In the HSQLDB, MySQLand PostgreSQLschema they are bothnullable. The birthDateproperty of thePetentity has not constraint. In thePetFieldsschema of theopenapi.yml, the nameandbirthdateproperties arerequired`.

We have to align the constraints. I propose to complete the missing schemas and add Bean Validation constraints to the Pet class.

Visit.java

• date: @NotNull
• description: @notempty

In the H2 schema, the visit_date and description column of the visits table are not null.
In the HSQLDB, MySQLand PostgreSQLschema they are bothnullable. The dateproperty of theVisitentity has not constraint. But thedescriptionis@notempty. In the VisitFieldsschema of theopenapi.yml, the descriptionproperty isrequired. The date` remains optional.

Here we have to align database schemas. We have the choice to keep or not the date nullable / optional.

[thusleenkhan]

Hai @arey , I happy to contribute in this enhancement.
I checked https://github.com/spring-petclinic/spring-petclinic-angular/pull/142
and also I compare https://github.com/spring-petclinic/spring-petclinic-rest/blob/master/src/main/resources/openapi.yml
with the models https://github.com/spring-petclinic/spring-petclinic-rest/tree/master/src/main/java/org/springframework/samples/petclinic/model

The following is my analysis. Please check it. I am waiting for reply and guide to move further. Thank you.

---

Domains-> openapi -> models(java classes)

Owner -> OwnerFields -> BaseEntity.java ,Person.java ,Owner.java
Pet -> PetFields -> BaseEntity.java ,NamedEntity.java ,Pet.java
PetType -> PetType -> BaseEntity.java ,NamedEntity.java ,PetType.java
Vet-> VetFields -> BaseEntity.java, Person.java, Vet.java
Visit -> VisitFields -> BaseEntity.java ,Visit.java
User-> User -> User.java
Role -> Role -> BaseEntity.java ,Role.java

---

Owner:

---

firstName:

-- added in Person.java --
required: yes

-- missed in Person.java --
minLength:1
maxLength:30
pattern:^[a-zA-Z]*$

lastName:

-- added in Person.java --
required: yes

--missed in Person.java--
minLength:1
maxLength:30
pattern:^[a-zA-Z]*$

address:

-- added in Owner.java --
required:yes

--missed in Owner.java---
minLength:1
maxLength:255

city:

-- added in Owner.java --
required:yes

-- missed in Owner.java--
minLength:1
maxLength:80

telephone:

-- added in Owner.java --
required:yes
pattern:^[0-9]*$

-- missed in Owner.java--
minLength:1
maxLength:20

---

Pet :

---

name:

--added in NamedEntity.java---
required:yes

--missed in NamedEntity.java---
maxLength:30

birthDate:

-- missed in Pet.java--
required: yes

---

PetType :

---

name:

--added in NamedEntity.java---
required: yes

---missed in NamedEntity.java ---
minLength:1
maxLength:80

---

Vet:

---

firstName:

-- added in Person.java --
required: yes

-- missed in Person.java --
minLength:1
maxLength:30
pattern:^[a-zA-Z]*$

lastName:

-- added in Person.java --
required: yes

--missed in Person.java--
minLength:1
maxLength:30
pattern:^[a-zA-Z]*$

specialties:
--added in NamedEntity.java---
required: yes

---

Visit:

---

date:

description:
-- added in Visit.java --
required: yes
--missed in Visit.java--
minLength:1
maxLength:255

---

User

---

username:
--missed in User.java--
required: yes
minlength:1
maxlength:80

password:
--missed in User.java--
minlength:1
maxlength:80

---

Role

---

name:
--missed in Role.java--
required: yes
minlength:1
maxlength:80