Skip to content

Commit 6250ed4

Browse files
committed
Week of Apr 7
- Add some samples to the 'core' dir - Run tooling on more md/json files - make it clear that ancestor ordering is case-insensitive w.r.t vIDs - while "strongly recommended", it's no required to detect circular references w.r.t. version's ancestor attribute - make it clear the changing 'ancestor' means epoch/modifiedat are also changed - in model, an attr with a default value MUST also be tagged as 'required' - fix some models - add text to primer to make it clear the not all required fields are required in all requests - e.g. map keys->IDs Signed-off-by: Doug Davis <[email protected]>
1 parent 0c7a869 commit 6250ed4

File tree

9 files changed

+905
-184
lines changed

9 files changed

+905
-184
lines changed

cloudevents/schemas/document-schema.json

Lines changed: 177 additions & 36 deletions
Large diffs are not rendered by default.

cloudevents/schemas/openapi.json

Lines changed: 136 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4256,7 +4256,10 @@
42564256
"type": "boolean",
42574257
"description": "CloudEvents specversion is always required"
42584258
}
4259-
}
4259+
},
4260+
"required": [
4261+
"required"
4262+
]
42604263
},
42614264
"id": {
42624265
"type": "object",
@@ -4276,7 +4279,11 @@
42764279
"type": "boolean",
42774280
"description": "CloudEvents id is always required"
42784281
}
4279-
}
4282+
},
4283+
"required": [
4284+
"type",
4285+
"required"
4286+
]
42804287
},
42814288
"type": {
42824289
"type": "object",
@@ -4296,7 +4303,11 @@
42964303
"type": "boolean",
42974304
"description": "CloudEvents type is always required"
42984305
}
4299-
}
4306+
},
4307+
"required": [
4308+
"type",
4309+
"required"
4310+
]
43004311
},
43014312
"source": {
43024313
"type": "object",
@@ -4318,6 +4329,7 @@
43184329
}
43194330
},
43204331
"required": [
4332+
"type",
43214333
"required"
43224334
]
43234335
},
@@ -4339,7 +4351,11 @@
43394351
"type": "boolean",
43404352
"description": "CloudEvents subject required"
43414353
}
4342-
}
4354+
},
4355+
"required": [
4356+
"type",
4357+
"required"
4358+
]
43434359
},
43444360
"time": {
43454361
"type": "object",
@@ -4358,7 +4374,11 @@
43584374
"required": {
43594375
"type": "boolean"
43604376
}
4361-
}
4377+
},
4378+
"required": [
4379+
"type",
4380+
"required"
4381+
]
43624382
},
43634383
"dataschema": {
43644384
"type": "object",
@@ -4378,7 +4398,11 @@
43784398
"required": {
43794399
"type": "boolean"
43804400
}
4381-
}
4401+
},
4402+
"required": [
4403+
"type",
4404+
"required"
4405+
]
43824406
},
43834407
"datacontenttype": {
43844408
"type": "object",
@@ -4397,7 +4421,11 @@
43974421
"required": {
43984422
"type": "boolean"
43994423
}
4400-
}
4424+
},
4425+
"required": [
4426+
"type",
4427+
"required"
4428+
]
44014429
}
44024430
},
44034431
"additionalProperties": {
@@ -4419,7 +4447,11 @@
44194447
"type": "boolean",
44204448
"description": "Whether the extension is required"
44214449
}
4422-
}
4450+
},
4451+
"required": [
4452+
"type",
4453+
"required"
4454+
]
44234455
}
44244456
},
44254457
"envelopeoptions": {
@@ -4477,7 +4509,10 @@
44774509
"type": "boolean",
44784510
"description": "AMQP properties.message-id required"
44794511
}
4480-
}
4512+
},
4513+
"required": [
4514+
"required"
4515+
]
44814516
},
44824517
"user-id": {
44834518
"type": "object",
@@ -4498,7 +4533,11 @@
44984533
"type": "boolean",
44994534
"description": "AMQP properties.user-id required"
45004535
}
4501-
}
4536+
},
4537+
"required": [
4538+
"type",
4539+
"required"
4540+
]
45024541
},
45034542
"to": {
45044543
"type": "object",
@@ -4519,7 +4558,11 @@
45194558
"type": "boolean",
45204559
"description": "AMQP properties.to required"
45214560
}
4522-
}
4561+
},
4562+
"required": [
4563+
"type",
4564+
"required"
4565+
]
45234566
},
45244567
"subject": {
45254568
"type": "object",
@@ -4564,7 +4607,11 @@
45644607
"type": "boolean",
45654608
"description": "AMQP properties.reply-to required"
45664609
}
4567-
}
4610+
},
4611+
"required": [
4612+
"type",
4613+
"required"
4614+
]
45684615
},
45694616
"correlation-id": {
45704617
"type": "object",
@@ -4585,7 +4632,11 @@
45854632
"type": "boolean",
45864633
"description": "AMQP correlation-id required"
45874634
}
4588-
}
4635+
},
4636+
"required": [
4637+
"type",
4638+
"required"
4639+
]
45894640
},
45904641
"content-type": {
45914642
"type": "object",
@@ -4606,7 +4657,11 @@
46064657
"type": "boolean",
46074658
"description": "AMQP properties.content-type required"
46084659
}
4609-
}
4660+
},
4661+
"required": [
4662+
"type",
4663+
"required"
4664+
]
46104665
},
46114666
"content-encoding": {
46124667
"type": "object",
@@ -4627,7 +4682,11 @@
46274682
"type": "boolean",
46284683
"description": "AMQP properties.content-encoding required"
46294684
}
4630-
}
4685+
},
4686+
"required": [
4687+
"type",
4688+
"required"
4689+
]
46314690
},
46324691
"absolute-expiry-time": {
46334692
"type": "object",
@@ -4648,7 +4707,11 @@
46484707
"type": "boolean",
46494708
"description": "AMQP properties.absolute-expiry-time required"
46504709
}
4651-
}
4710+
},
4711+
"required": [
4712+
"type",
4713+
"required"
4714+
]
46524715
},
46534716
"creation-time": {
46544717
"type": "object",
@@ -4669,7 +4732,11 @@
46694732
"type": "boolean",
46704733
"description": "AMQP properties.creation-time required"
46714734
}
4672-
}
4735+
},
4736+
"required": [
4737+
"type",
4738+
"required"
4739+
]
46734740
},
46744741
"group-id": {
46754742
"type": "object",
@@ -4690,7 +4757,11 @@
46904757
"type": "boolean",
46914758
"description": "AMQP properties.group-id required"
46924759
}
4693-
}
4760+
},
4761+
"required": [
4762+
"type",
4763+
"required"
4764+
]
46944765
},
46954766
"group-sequence": {
46964767
"type": "object",
@@ -4711,7 +4782,11 @@
47114782
"type": "boolean",
47124783
"description": "AMQP group-sequence required"
47134784
}
4714-
}
4785+
},
4786+
"required": [
4787+
"type",
4788+
"required"
4789+
]
47154790
},
47164791
"reply-to-group-id": {
47174792
"type": "object",
@@ -4732,7 +4807,11 @@
47324807
"type": "boolean",
47334808
"description": "AMQP properties.reply-to-group-id required"
47344809
}
4735-
}
4810+
},
4811+
"required": [
4812+
"type",
4813+
"required"
4814+
]
47364815
}
47374816
}
47384817
},
@@ -4757,7 +4836,11 @@
47574836
"type": "boolean",
47584837
"description": "Application property required"
47594838
}
4760-
}
4839+
},
4840+
"required": [
4841+
"type",
4842+
"required"
4843+
]
47614844
}
47624845
},
47634846
"message-annotations": {
@@ -4781,7 +4864,11 @@
47814864
"type": "boolean",
47824865
"description": "Annotation required"
47834866
}
4784-
}
4867+
},
4868+
"required": [
4869+
"type",
4870+
"required"
4871+
]
47854872
}
47864873
},
47874874
"delivery-annotations": {
@@ -4805,7 +4892,11 @@
48054892
"type": "boolean",
48064893
"description": "Annotation required"
48074894
}
4808-
}
4895+
},
4896+
"required": [
4897+
"type",
4898+
"required"
4899+
]
48094900
}
48104901
},
48114902
"header": {
@@ -4832,7 +4923,13 @@
48324923
"type": "integer",
48334924
"description": "AMQP delivery-count"
48344925
}
4835-
}
4926+
},
4927+
"required": [
4928+
"durable",
4929+
"priority",
4930+
"first-acquirer",
4931+
"delivery-count"
4932+
]
48364933
},
48374934
"footer": {
48384935
"type": "object",
@@ -4855,7 +4952,11 @@
48554952
"type": "boolean",
48564953
"description": "Footer required"
48574954
}
4858-
}
4955+
},
4956+
"required": [
4957+
"type",
4958+
"required"
4959+
]
48594960
}
48604961
}
48614962
}
@@ -5031,7 +5132,8 @@
50315132
}
50325133
},
50335134
"required": [
5034-
"name"
5135+
"name",
5136+
"required"
50355137
]
50365138
}
50375139
}
@@ -5078,7 +5180,8 @@
50785180
}
50795181
},
50805182
"required": [
5081-
"name"
5183+
"name",
5184+
"required"
50825185
]
50835186
}
50845187
},
@@ -5105,7 +5208,8 @@
51055208
}
51065209
},
51075210
"required": [
5108-
"name"
5211+
"name",
5212+
"required"
51095213
]
51105214
}
51115215
},
@@ -5169,7 +5273,10 @@
51695273
"type": "boolean",
51705274
"description": "The NATS header required"
51715275
}
5172-
}
5276+
},
5277+
"required": [
5278+
"required"
5279+
]
51735280
}
51745281
}
51755282
}

0 commit comments

Comments
 (0)