Skip to content

Commit 341d289

Browse files
carlobeltramecarlobeltrame
authored
Merge pull request #7520 from ecamp/camp-title-documentation
Clarify camp field documentation
2 parents c2bd8e2 + d81f41e commit 341d289

File tree

2 files changed

+124
-36
lines changed

2 files changed

+124
-36
lines changed

‎api/src/Entity/Camp.php‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,8 @@ class Camp extends BaseEntity implements BelongsToCampInterface, CopyFromPrototy
192192
public bool $isPrototype = false;
193193

194194
/**
195-
* A short title for the camp.
195+
* An optional short title for the camp. Can be used in the UI where space is tight. If
196+
* not present, frontends may auto-shorten the title if the shortTitle is not set.
196197
*/
197198
#[InputFilter\Trim]
198199
#[InputFilter\CleanText]
@@ -203,7 +204,9 @@ class Camp extends BaseEntity implements BelongsToCampInterface, CopyFromPrototy
203204
public ?string $shortTitle;
204205

205206
/**
206-
* The full title of the camp.
207+
* The full title of the camp. Used for identifying the camp in lists of camps, so
208+
* this should include all necessary information to distinguish this camp from
209+
* other camps that the collaborators are part of.
207210
*/
208211
#[InputFilter\Trim]
209212
#[InputFilter\CleanText]

‎api/tests/Api/SnapshotTests/__snapshots__/ResponseSnapshotTest__testOpenApiSpecMatchesSnapshot__1.yml‎

Lines changed: 119 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2452,14 +2452,19 @@ components:
24522452
readOnly: true
24532453
type: string
24542454
shortTitle:
2455-
description: 'A short title for the camp.'
2455+
description: |-
2456+
An optional short title for the camp. Can be used in the UI where space is tight. If
2457+
not present, frontends may auto-shorten the title if the shortTitle is not set.
24562458
example: 'SoLa 2022'
24572459
maxLength: 32
24582460
type:
24592461
- 'null'
24602462
- string
24612463
title:
2462-
description: 'The full title of the camp.'
2464+
description: |-
2465+
The full title of the camp. Used for identifying the camp in lists of camps, so
2466+
this should include all necessary information to distinguish this camp from
2467+
other camps that the collaborators are part of.
24632468
example: 'Abteilungs-Sommerlager 2022'
24642469
maxLength: 32
24652470
type: string
@@ -2640,14 +2645,19 @@ components:
26402645
readOnly: true
26412646
type: string
26422647
shortTitle:
2643-
description: 'A short title for the camp.'
2648+
description: |-
2649+
An optional short title for the camp. Can be used in the UI where space is tight. If
2650+
not present, frontends may auto-shorten the title if the shortTitle is not set.
26442651
example: 'SoLa 2022'
26452652
maxLength: 32
26462653
type:
26472654
- 'null'
26482655
- string
26492656
title:
2650-
description: 'The full title of the camp.'
2657+
description: |-
2658+
The full title of the camp. Used for identifying the camp in lists of camps, so
2659+
this should include all necessary information to distinguish this camp from
2660+
other camps that the collaborators are part of.
26512661
example: 'Abteilungs-Sommerlager 2022'
26522662
maxLength: 32
26532663
type: string
@@ -2831,14 +2841,19 @@ components:
28312841
readOnly: true
28322842
type: string
28332843
shortTitle:
2834-
description: 'A short title for the camp.'
2844+
description: |-
2845+
An optional short title for the camp. Can be used in the UI where space is tight. If
2846+
not present, frontends may auto-shorten the title if the shortTitle is not set.
28352847
example: 'SoLa 2022'
28362848
maxLength: 32
28372849
type:
28382850
- 'null'
28392851
- string
28402852
title:
2841-
description: 'The full title of the camp.'
2853+
description: |-
2854+
The full title of the camp. Used for identifying the camp in lists of camps, so
2855+
this should include all necessary information to distinguish this camp from
2856+
other camps that the collaborators are part of.
28422857
example: 'Abteilungs-Sommerlager 2022'
28432858
maxLength: 32
28442859
type: string
@@ -3022,14 +3037,19 @@ components:
30223037
readOnly: true
30233038
type: string
30243039
shortTitle:
3025-
description: 'A short title for the camp.'
3040+
description: |-
3041+
An optional short title for the camp. Can be used in the UI where space is tight. If
3042+
not present, frontends may auto-shorten the title if the shortTitle is not set.
30263043
example: 'SoLa 2022'
30273044
maxLength: 32
30283045
type:
30293046
- 'null'
30303047
- string
30313048
title:
3032-
description: 'The full title of the camp.'
3049+
description: |-
3050+
The full title of the camp. Used for identifying the camp in lists of camps, so
3051+
this should include all necessary information to distinguish this camp from
3052+
other camps that the collaborators are part of.
30333053
example: 'Abteilungs-Sommerlager 2022'
30343054
maxLength: 32
30353055
type: string
@@ -3151,14 +3171,19 @@ components:
31513171
example: true
31523172
type: boolean
31533173
shortTitle:
3154-
description: 'A short title for the camp.'
3174+
description: |-
3175+
An optional short title for the camp. Can be used in the UI where space is tight. If
3176+
not present, frontends may auto-shorten the title if the shortTitle is not set.
31553177
example: 'SoLa 2022'
31563178
maxLength: 32
31573179
type:
31583180
- 'null'
31593181
- string
31603182
title:
3161-
description: 'The full title of the camp.'
3183+
description: |-
3184+
The full title of the camp. Used for identifying the camp in lists of camps, so
3185+
this should include all necessary information to distinguish this camp from
3186+
other camps that the collaborators are part of.
31623187
example: 'Abteilungs-Sommerlager 2022'
31633188
maxLength: 32
31643189
type: string
@@ -3255,14 +3280,19 @@ components:
32553280
example: true
32563281
type: boolean
32573282
shortTitle:
3258-
description: 'A short title for the camp.'
3283+
description: |-
3284+
An optional short title for the camp. Can be used in the UI where space is tight. If
3285+
not present, frontends may auto-shorten the title if the shortTitle is not set.
32593286
example: 'SoLa 2022'
32603287
maxLength: 32
32613288
type:
32623289
- 'null'
32633290
- string
32643291
title:
3265-
description: 'The full title of the camp.'
3292+
description: |-
3293+
The full title of the camp. Used for identifying the camp in lists of camps, so
3294+
this should include all necessary information to distinguish this camp from
3295+
other camps that the collaborators are part of.
32663296
example: 'Abteilungs-Sommerlager 2022'
32673297
maxLength: 32
32683298
type: string
@@ -3361,12 +3391,17 @@ components:
33613391
example: true
33623392
type: boolean
33633393
shortTitle:
3364-
description: 'A short title for the camp.'
3394+
description: |-
3395+
An optional short title for the camp. Can be used in the UI where space is tight. If
3396+
not present, frontends may auto-shorten the title if the shortTitle is not set.
33653397
example: 'SoLa 2022'
33663398
maxLength: 32
33673399
type: ['null', string]
33683400
title:
3369-
description: 'The full title of the camp.'
3401+
description: |-
3402+
The full title of the camp. Used for identifying the camp in lists of camps, so
3403+
this should include all necessary information to distinguish this camp from
3404+
other camps that the collaborators are part of.
33703405
example: 'Abteilungs-Sommerlager 2022'
33713406
maxLength: 32
33723407
type: string
@@ -3626,14 +3661,19 @@ components:
36263661
readOnly: true
36273662
type: string
36283663
shortTitle:
3629-
description: 'A short title for the camp.'
3664+
description: |-
3665+
An optional short title for the camp. Can be used in the UI where space is tight. If
3666+
not present, frontends may auto-shorten the title if the shortTitle is not set.
36303667
example: 'SoLa 2022'
36313668
maxLength: 32
36323669
type:
36333670
- 'null'
36343671
- string
36353672
title:
3636-
description: 'The full title of the camp.'
3673+
description: |-
3674+
The full title of the camp. Used for identifying the camp in lists of camps, so
3675+
this should include all necessary information to distinguish this camp from
3676+
other camps that the collaborators are part of.
36373677
example: 'Abteilungs-Sommerlager 2022'
36383678
maxLength: 32
36393679
type: string
@@ -3823,14 +3863,19 @@ components:
38233863
readOnly: true
38243864
type: string
38253865
shortTitle:
3826-
description: 'A short title for the camp.'
3866+
description: |-
3867+
An optional short title for the camp. Can be used in the UI where space is tight. If
3868+
not present, frontends may auto-shorten the title if the shortTitle is not set.
38273869
example: 'SoLa 2022'
38283870
maxLength: 32
38293871
type:
38303872
- 'null'
38313873
- string
38323874
title:
3833-
description: 'The full title of the camp.'
3875+
description: |-
3876+
The full title of the camp. Used for identifying the camp in lists of camps, so
3877+
this should include all necessary information to distinguish this camp from
3878+
other camps that the collaborators are part of.
38343879
example: 'Abteilungs-Sommerlager 2022'
38353880
maxLength: 32
38363881
type: string
@@ -4023,14 +4068,19 @@ components:
40234068
readOnly: true
40244069
type: string
40254070
shortTitle:
4026-
description: 'A short title for the camp.'
4071+
description: |-
4072+
An optional short title for the camp. Can be used in the UI where space is tight. If
4073+
not present, frontends may auto-shorten the title if the shortTitle is not set.
40274074
example: 'SoLa 2022'
40284075
maxLength: 32
40294076
type:
40304077
- 'null'
40314078
- string
40324079
title:
4033-
description: 'The full title of the camp.'
4080+
description: |-
4081+
The full title of the camp. Used for identifying the camp in lists of camps, so
4082+
this should include all necessary information to distinguish this camp from
4083+
other camps that the collaborators are part of.
40344084
example: 'Abteilungs-Sommerlager 2022'
40354085
maxLength: 32
40364086
type: string
@@ -4223,14 +4273,19 @@ components:
42234273
readOnly: true
42244274
type: string
42254275
shortTitle:
4226-
description: 'A short title for the camp.'
4276+
description: |-
4277+
An optional short title for the camp. Can be used in the UI where space is tight. If
4278+
not present, frontends may auto-shorten the title if the shortTitle is not set.
42274279
example: 'SoLa 2022'
42284280
maxLength: 32
42294281
type:
42304282
- 'null'
42314283
- string
42324284
title:
4233-
description: 'The full title of the camp.'
4285+
description: |-
4286+
The full title of the camp. Used for identifying the camp in lists of camps, so
4287+
this should include all necessary information to distinguish this camp from
4288+
other camps that the collaborators are part of.
42344289
example: 'Abteilungs-Sommerlager 2022'
42354290
maxLength: 32
42364291
type: string
@@ -4361,14 +4416,19 @@ components:
43614416
example: true
43624417
type: boolean
43634418
shortTitle:
4364-
description: 'A short title for the camp.'
4419+
description: |-
4420+
An optional short title for the camp. Can be used in the UI where space is tight. If
4421+
not present, frontends may auto-shorten the title if the shortTitle is not set.
43654422
example: 'SoLa 2022'
43664423
maxLength: 32
43674424
type:
43684425
- 'null'
43694426
- string
43704427
title:
4371-
description: 'The full title of the camp.'
4428+
description: |-
4429+
The full title of the camp. Used for identifying the camp in lists of camps, so
4430+
this should include all necessary information to distinguish this camp from
4431+
other camps that the collaborators are part of.
43724432
example: 'Abteilungs-Sommerlager 2022'
43734433
maxLength: 32
43744434
type: string
@@ -4571,14 +4631,19 @@ components:
45714631
readOnly: true
45724632
type: string
45734633
shortTitle:
4574-
description: 'A short title for the camp.'
4634+
description: |-
4635+
An optional short title for the camp. Can be used in the UI where space is tight. If
4636+
not present, frontends may auto-shorten the title if the shortTitle is not set.
45754637
example: 'SoLa 2022'
45764638
maxLength: 32
45774639
type:
45784640
- 'null'
45794641
- string
45804642
title:
4581-
description: 'The full title of the camp.'
4643+
description: |-
4644+
The full title of the camp. Used for identifying the camp in lists of camps, so
4645+
this should include all necessary information to distinguish this camp from
4646+
other camps that the collaborators are part of.
45824647
example: 'Abteilungs-Sommerlager 2022'
45834648
maxLength: 32
45844649
type: string
@@ -4782,14 +4847,19 @@ components:
47824847
readOnly: true
47834848
type: string
47844849
shortTitle:
4785-
description: 'A short title for the camp.'
4850+
description: |-
4851+
An optional short title for the camp. Can be used in the UI where space is tight. If
4852+
not present, frontends may auto-shorten the title if the shortTitle is not set.
47864853
example: 'SoLa 2022'
47874854
maxLength: 32
47884855
type:
47894856
- 'null'
47904857
- string
47914858
title:
4792-
description: 'The full title of the camp.'
4859+
description: |-
4860+
The full title of the camp. Used for identifying the camp in lists of camps, so
4861+
this should include all necessary information to distinguish this camp from
4862+
other camps that the collaborators are part of.
47934863
example: 'Abteilungs-Sommerlager 2022'
47944864
maxLength: 32
47954865
type: string
@@ -4996,14 +5066,19 @@ components:
49965066
readOnly: true
49975067
type: string
49985068
shortTitle:
4999-
description: 'A short title for the camp.'
5069+
description: |-
5070+
An optional short title for the camp. Can be used in the UI where space is tight. If
5071+
not present, frontends may auto-shorten the title if the shortTitle is not set.
50005072
example: 'SoLa 2022'
50015073
maxLength: 32
50025074
type:
50035075
- 'null'
50045076
- string
50055077
title:
5006-
description: 'The full title of the camp.'
5078+
description: |-
5079+
The full title of the camp. Used for identifying the camp in lists of camps, so
5080+
this should include all necessary information to distinguish this camp from
5081+
other camps that the collaborators are part of.
50075082
example: 'Abteilungs-Sommerlager 2022'
50085083
maxLength: 32
50095084
type: string
@@ -5210,14 +5285,19 @@ components:
52105285
readOnly: true
52115286
type: string
52125287
shortTitle:
5213-
description: 'A short title for the camp.'
5288+
description: |-
5289+
An optional short title for the camp. Can be used in the UI where space is tight. If
5290+
not present, frontends may auto-shorten the title if the shortTitle is not set.
52145291
example: 'SoLa 2022'
52155292
maxLength: 32
52165293
type:
52175294
- 'null'
52185295
- string
52195296
title:
5220-
description: 'The full title of the camp.'
5297+
description: |-
5298+
The full title of the camp. Used for identifying the camp in lists of camps, so
5299+
this should include all necessary information to distinguish this camp from
5300+
other camps that the collaborators are part of.
52215301
example: 'Abteilungs-Sommerlager 2022'
52225302
maxLength: 32
52235303
type: string
@@ -5339,14 +5419,19 @@ components:
53395419
example: true
53405420
type: boolean
53415421
shortTitle:
5342-
description: 'A short title for the camp.'
5422+
description: |-
5423+
An optional short title for the camp. Can be used in the UI where space is tight. If
5424+
not present, frontends may auto-shorten the title if the shortTitle is not set.
53435425
example: 'SoLa 2022'
53445426
maxLength: 32
53455427
type:
53465428
- 'null'
53475429
- string
53485430
title:
5349-
description: 'The full title of the camp.'
5431+
description: |-
5432+
The full title of the camp. Used for identifying the camp in lists of camps, so
5433+
this should include all necessary information to distinguish this camp from
5434+
other camps that the collaborators are part of.
53505435
example: 'Abteilungs-Sommerlager 2022'
53515436
maxLength: 32
53525437
type: string

0 commit comments

Comments
 (0)