Skip to content

Commit 3cd643a

Browse files
committed
Fix incorrect casing in documentation
1 parent 02f654c commit 3cd643a

File tree

8 files changed

+34
-34
lines changed

8 files changed

+34
-34
lines changed

docs/usage/extensibility/services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Then on your model, pass in the set of endpoints to expose (the ones that you've
140140
```c#
141141
[Resource(GenerateControllerEndpoints =
142142
JsonApiEndpoints.Create | JsonApiEndpoints.Delete)]
143-
public class Article : identifiable<long>
143+
public class Article : Identifiable<long>
144144
{
145145
// ...
146146
}

docs/usage/options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ options.ValidateModelState = true;
137137
```c#
138138
#nullable enable
139139

140-
public class Person : identifiable<long>
140+
public class Person : Identifiable<long>
141141
{
142142
[Attr]
143143
[MinLength(3)]

docs/usage/resource-graph.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,15 +73,15 @@ builder.Services.AddJsonApi(resources: resourceGraphBuilder =>
7373
2. The `PublicName` property when a model is decorated with a `ResourceAttribute`.
7474
```c#
7575
[Resource(PublicName = "individuals")]
76-
public class Person : identifiable<long>
76+
public class Person : Identifiable<long>
7777
{
7878
}
7979
```
8080

8181
3. The configured naming convention (by default this is camel-case), after pluralization.
8282
```c#
8383
// this will be registered as "people"
84-
public class Person : identifiable<long>
84+
public class Person : Identifiable<long>
8585
{
8686
}
8787
```

docs/usage/resources/attributes.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ If you want an attribute on your model to be publicly available, add the `AttrAt
55
```c#
66
#nullable enable
77

8-
public class Person : identifiable<long>
8+
public class Person : Identifiable<long>
99
{
1010
[Attr]
1111
public string? FirstName { get; set; }
@@ -24,7 +24,7 @@ There are two ways the exposed attribute name is determined:
2424
2. Individually using the attribute's constructor.
2525
```c#
2626
#nullable enable
27-
public class Person : identifiable<long>
27+
public class Person : Identifiable<long>
2828
{
2929
[Attr(PublicName = "first-name")]
3030
public string? FirstName { get; set; }
@@ -51,7 +51,7 @@ Otherwise, the attribute is silently omitted.
5151
```c#
5252
#nullable enable
5353

54-
public class User : identifiable<long>
54+
public class User : Identifiable<long>
5555
{
5656
[Attr(Capabilities = ~AttrCapabilities.AllowView)]
5757
public string Password { get; set; } = null!;
@@ -65,7 +65,7 @@ Indicates whether the attribute can be filtered on. When not allowed and used in
6565
```c#
6666
#nullable enable
6767

68-
public class Person : identifiable<long>
68+
public class Person : Identifiable<long>
6969
{
7070
[Attr(Capabilities = AttrCapabilities.AllowFilter)]
7171
public string? FirstName { get; set; }
@@ -79,7 +79,7 @@ Indicates whether the attribute can be sorted on. When not allowed and used in `
7979
```c#
8080
#nullable enable
8181

82-
public class Person : identifiable<long>
82+
public class Person : Identifiable<long>
8383
{
8484
[Attr(Capabilities = ~AttrCapabilities.AllowSort)]
8585
public string? FirstName { get; set; }
@@ -93,7 +93,7 @@ Indicates whether POST requests can assign the attribute value. When sent but no
9393
```c#
9494
#nullable enable
9595

96-
public class Person : identifiable<long>
96+
public class Person : Identifiable<long>
9797
{
9898
[Attr(Capabilities = AttrCapabilities.AllowCreate)]
9999
public string? CreatorName { get; set; }
@@ -107,7 +107,7 @@ Indicates whether PATCH requests can update the attribute value. When sent but n
107107
```c#
108108
#nullable enable
109109

110-
public class Person : identifiable<long>
110+
public class Person : Identifiable<long>
111111
{
112112
[Attr(Capabilities = AttrCapabilities.AllowChange)]
113113
public string? FirstName { get; set; };
@@ -124,7 +124,7 @@ You can also use [global options](~/usage/options.md#customize-serializer-option
124124
```c#
125125
#nullable enable
126126

127-
public class Foo : identifiable<long>
127+
public class Foo : Identifiable<long>
128128
{
129129
[Attr]
130130
public Bar? Bar { get; set; }
@@ -146,7 +146,7 @@ and retrieval.
146146
```c#
147147
#nullable enable
148148

149-
public class Foo : identifiable<long>
149+
public class Foo : Identifiable<long>
150150
{
151151
[Attr]
152152
[NotMapped]

docs/usage/resources/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public class Person : Identifiable<Guid>
1414
If you need to attach annotations or attributes on the `Id` property, you can override the virtual property.
1515

1616
```c#
17-
public class Person : identifiable<long>
17+
public class Person : Identifiable<long>
1818
{
1919
[Key]
2020
[Column("PersonID")]

docs/usage/resources/nullability.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To make JsonApiDotNetCore return an error when such a property is missing on res
1212
Example:
1313

1414
```c#
15-
public sealed class User : identifiable<long>
15+
public sealed class User : Identifiable<long>
1616
{
1717
[Attr]
1818
[Required]
@@ -35,7 +35,7 @@ Example:
3535
```c#
3636
#nullable disable
3737

38-
public sealed class Label : identifiable<long>
38+
public sealed class Label : Identifiable<long>
3939
{
4040
[Attr]
4141
[Required]
@@ -69,7 +69,7 @@ Example:
6969
```c#
7070
#nullable enable
7171

72-
public sealed class Label : identifiable<long>
72+
public sealed class Label : Identifiable<long>
7373
{
7474
[Attr]
7575
public string Name { get; set; } = null!;

docs/usage/resources/relationships.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This exposes a to-one relationship.
1313
```c#
1414
#nullable enable
1515

16-
public class TodoItem : identifiable<long>
16+
public class TodoItem : Identifiable<long>
1717
{
1818
[HasOne]
1919
public Person? Owner { get; set; }
@@ -36,13 +36,13 @@ The next example defines that each car requires an engine, while an engine is op
3636
```c#
3737
#nullable enable
3838

39-
public sealed class Car : identifiable<long>
39+
public sealed class Car : Identifiable<long>
4040
{
4141
[HasOne]
4242
public Engine Engine { get; set; } = null!;
4343
}
4444

45-
public sealed class Engine : identifiable<long>
45+
public sealed class Engine : Identifiable<long>
4646
{
4747
[HasOne]
4848
public Car? Car { get; set; }
@@ -123,13 +123,13 @@ The next example defines that each car optionally has an engine, while an engine
123123
```c#
124124
#nullable enable
125125

126-
public sealed class Car : identifiable<long>
126+
public sealed class Car : Identifiable<long>
127127
{
128128
[HasOne]
129129
public Engine? Engine { get; set; }
130130
}
131131

132-
public sealed class Engine : identifiable<long>
132+
public sealed class Engine : Identifiable<long>
133133
{
134134
[HasOne]
135135
public Car? Car { get; set; }
@@ -204,7 +204,7 @@ CREATE UNIQUE INDEX "IX_Cars_EngineId" ON "Cars" ("EngineId");
204204
This exposes a to-many relationship.
205205

206206
```c#
207-
public class Person : identifiable<long>
207+
public class Person : Identifiable<long>
208208
{
209209
[HasMany]
210210
public ICollection<TodoItem> TodoItems { get; set; } = new HashSet<TodoItem>();
@@ -236,7 +236,7 @@ However, under the covers it would use the join type and Entity Framework Core's
236236
```c#
237237
#nullable disable
238238

239-
public class Article : identifiable<long>
239+
public class Article : Identifiable<long>
240240
{
241241
// tells Entity Framework Core to ignore this property
242242
[NotMapped]
@@ -261,7 +261,7 @@ There are two ways the exposed relationship name is determined:
261261
2. Individually using the attribute's constructor.
262262
```c#
263263
#nullable enable
264-
public class TodoItem : identifiable<long>
264+
public class TodoItem : Identifiable<long>
265265
{
266266
[HasOne(PublicName = "item-owner")]
267267
public Person Owner { get; set; } = null!;
@@ -294,7 +294,7 @@ Otherwise, the relationship (and its related resources, when included) are silen
294294
```c#
295295
#nullable enable
296296

297-
public class User : identifiable<long>
297+
public class User : Identifiable<long>
298298
{
299299
[HasOne(Capabilities = ~HasOneCapabilities.AllowView)]
300300
public LoginAccount Account { get; set; } = null!;
@@ -308,7 +308,7 @@ Indicates whether the relationship can be included. When not allowed and used in
308308
```c#
309309
#nullable enable
310310

311-
public class User : identifiable<long>
311+
public class User : Identifiable<long>
312312
{
313313
[HasMany(Capabilities = ~HasManyCapabilities.AllowInclude)]
314314
public ISet<Group> Groups { get; set; } = new HashSet<Group>();
@@ -322,7 +322,7 @@ For to-many relationships only. Indicates whether it can be used in the `count()
322322
```c#
323323
#nullable enable
324324

325-
public class User : identifiable<long>
325+
public class User : Identifiable<long>
326326
{
327327
[HasMany(Capabilities = HasManyCapabilities.AllowFilter)]
328328
public ISet<Group> Groups { get; set; } = new HashSet<Group>();
@@ -336,7 +336,7 @@ Indicates whether POST and PATCH requests can replace the relationship. When sen
336336
```c#
337337
#nullable enable
338338

339-
public class User : identifiable<long>
339+
public class User : Identifiable<long>
340340
{
341341
[HasOne(Capabilities = ~HasOneCapabilities.AllowSet)]
342342
public LoginAccount Account { get; set; } = null!;
@@ -350,7 +350,7 @@ For to-many relationships only. Indicates whether POST requests can add resource
350350
```c#
351351
#nullable enable
352352

353-
public class User : identifiable<long>
353+
public class User : Identifiable<long>
354354
{
355355
[HasMany(Capabilities = ~HasManyCapabilities.AllowAdd)]
356356
public ISet<Group> Groups { get; set; } = new HashSet<Group>();
@@ -364,7 +364,7 @@ For to-many relationships only. Indicates whether DELETE requests can remove res
364364
```c#
365365
#nullable enable
366366

367-
public class User : identifiable<long>
367+
public class User : Identifiable<long>
368368
{
369369
[HasMany(Capabilities = ~HasManyCapabilities.AllowRemove)]
370370
public ISet<Group> Groups { get; set; } = new HashSet<Group>();
@@ -380,7 +380,7 @@ Relationships can be marked to disallow including them using the `?include=` que
380380
```c#
381381
#nullable enable
382382

383-
public class TodoItem : identifiable<long>
383+
public class TodoItem : Identifiable<long>
384384
{
385385
[HasOne(CanInclude: false)]
386386
public Person? Owner { get; set; }
@@ -397,7 +397,7 @@ So for the calculated property to be evaluated correctly, the related entity mus
397397
```c#
398398
#nullable enable
399399

400-
public class ShippingAddress : identifiable<long>
400+
public class ShippingAddress : Identifiable<long>
401401
{
402402
[Attr]
403403
public string Street { get; set; } = null!;

docs/usage/routing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The library will configure routes for all auto-generated and hand-written contro
2323
```c#
2424
// Auto-generated
2525
[Resource]
26-
public class OrderSummary : identifiable<long>
26+
public class OrderSummary : Identifiable<long>
2727
{
2828
}
2929

0 commit comments

Comments
 (0)