Skip to content

Commit dfe5808

Browse files
authored
feat(aep-lib-go): update aep-lib-go, use aep.api.resource (#79)
update aep-lib-go, which updates the examples and their respective best practices (such as using aep.api.resource)
1 parent 41d9f64 commit dfe5808

8 files changed

Lines changed: 721 additions & 695 deletions

File tree

buf.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
version: v2
33
deps:
44
- name: buf.build/aep/api
5-
commit: 1454930c8f994a1980143dae475be0a2
6-
digest: b5:7c0b638065cd7705d85bdddc0c3cd22bf7b438e27e14109f811a3bd5c01d92318901b5aa63173de6e31f1cff75f912c953e72cc03487b717e72bbe1de264ee25
5+
commit: 26a011a354ee4836847fff32738f12a2
6+
digest: b5:5f32f8d8d0eaafd808d9162b0a1c1d2d3e6ed3710d20973a036788727c2a54ce2771f198a053132aa892f5986690995093c0b7538b879fc1c0c9dee4d05ac156
77
- name: buf.build/bufbuild/protovalidate
8-
commit: f05a6f4403ce4327bae4f50f281c3ed0
9-
digest: b5:f1d76430ee97c89cd2044e9ae1c510887b701ee7bca60564ebf82e3919e53cacefc830a0eb803277c2d98c5f313b4167e8914afc9f214332717a50b5e170e6f4
8+
commit: 52f32327d4b045a79293a6ad4e7e1236
9+
digest: b5:cbabc98d4b7b7b0447c9b15f68eeb8a7a44ef8516cb386ac5f66e7fd4062cd6723ed3f452ad8c384b851f79e33d26e7f8a94e2b807282b3def1cd966c7eace97
1010
- name: buf.build/googleapis/googleapis
1111
commit: 28151c0d0a1641bf938a7672c500e01d
1212
digest: b5:93b70089baa4fc05a92d3e52db91a4b7812db3b57b9664f6cb301733938cb630e377a938e8a56779388171c749c1d42a2e9a6c6230f2ff45f127a8102a6a27d0

example/bookstore/v1/bookstore.pb.go

Lines changed: 637 additions & 640 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

example/bookstore/v1/bookstore.proto

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ package example.bookstore.v1;
55

66
import "aep/api/field_info.proto";
77
import "aep/api/operation.proto";
8+
import "aep/api/resource.proto";
89
import "google/api/annotations.proto";
910
import "google/api/client.proto";
1011
import "google/api/field_behavior.proto";
11-
import "google/api/resource.proto";
1212
import "google/protobuf/empty.proto";
1313
import "google/protobuf/field_mask.proto";
1414

@@ -274,11 +274,11 @@ service Bookstore {
274274

275275
// A Book.
276276
message Book {
277-
option (google.api.resource) = {
277+
option (aep.api.resource) = {
278278
type: "bookstore.example.com/book"
279279
pattern: ["publishers/{publisher_id}/books/{book_id}"]
280-
plural: "books"
281280
singular: "book"
281+
plural: "books"
282282
};
283283

284284
// A Author.
@@ -331,11 +331,11 @@ message Book {
331331

332332
// A BookEdition.
333333
message BookEdition {
334-
option (google.api.resource) = {
334+
option (aep.api.resource) = {
335335
type: "bookstore.example.com/book-edition"
336336
pattern: ["publishers/{publisher_id}/books/{book_id}/editions/{book_edition_id}"]
337-
plural: "book-editions"
338337
singular: "book-edition"
338+
plural: "book-editions"
339339
};
340340

341341
// Field for display_name.
@@ -353,11 +353,11 @@ message BookEdition {
353353

354354
// A Isbn.
355355
message Isbn {
356-
option (google.api.resource) = {
356+
option (aep.api.resource) = {
357357
type: "bookstore.example.com/isbn"
358358
pattern: ["isbns/{isbn_id}"]
359-
plural: "isbns"
360359
singular: "isbn"
360+
plural: "isbns"
361361
};
362362

363363
// Field for path.
@@ -366,11 +366,11 @@ message Isbn {
366366

367367
// A Item.
368368
message Item {
369-
option (google.api.resource) = {
369+
option (aep.api.resource) = {
370370
type: "bookstore.example.com/item"
371371
pattern: ["stores/{store_id}/items/{item_id}"]
372-
plural: "items"
373372
singular: "item"
373+
plural: "items"
374374
};
375375

376376
// Field for book.
@@ -398,11 +398,11 @@ message Item {
398398

399399
// A Publisher.
400400
message Publisher {
401-
option (google.api.resource) = {
401+
option (aep.api.resource) = {
402402
type: "bookstore.example.com/publisher"
403403
pattern: ["publishers/{publisher_id}"]
404-
plural: "publishers"
405404
singular: "publisher"
405+
plural: "publishers"
406406
};
407407

408408
// Field for description.
@@ -414,11 +414,11 @@ message Publisher {
414414

415415
// A Store.
416416
message Store {
417-
option (google.api.resource) = {
417+
option (aep.api.resource) = {
418418
type: "bookstore.example.com/store"
419419
pattern: ["stores/{store_id}"]
420-
plural: "stores"
421420
singular: "store"
421+
plural: "stores"
422422
};
423423

424424
// Field for name.

example/bookstore/v1/bookstore.yaml

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ resources:
1313
properties:
1414
description:
1515
type: string
16-
x-aep-field-number: 1
16+
x-aep-field:
17+
field_number: 1
1718
methods:
1819
create:
1920
supports_user_settable_create: true
@@ -36,30 +37,37 @@ resources:
3637
type: array
3738
items:
3839
type: string
39-
x-aep-field-number: 1
40+
x-aep-field:
41+
field_number: 1
4042
price:
4143
type: integer
4244
format: int32
43-
x-aep-field-number: 2
45+
x-aep-field:
46+
field_number: 2
4447
published:
4548
type: boolean
46-
x-aep-field-number: 3
49+
x-aep-field:
50+
field_number: 3
4751
edition:
4852
type: integer
4953
format: int32
50-
x-aep-field-number: 4
54+
x-aep-field:
55+
field_number: 4
5156
author:
5257
type: array
53-
x-aep-field-number: 5
58+
x-aep-field:
59+
field_number: 5
5460
items:
5561
type: object
5662
properties:
5763
given_name:
5864
type: string
59-
x-aep-field-number: 1
65+
x-aep-field:
66+
field_number: 1
6067
family_name:
6168
type: string
62-
x-aep-field-number: 2
69+
x-aep-field:
70+
field_number: 2
6371
methods:
6472
create:
6573
supports_user_settable_create: true
@@ -91,7 +99,8 @@ resources:
9199
properties:
92100
display_name:
93101
type: string
94-
x-aep-field-number: 1
102+
x-aep-field:
103+
field_number: 1
95104
methods:
96105
create:
97106
supports_user_settable_create: true
@@ -117,10 +126,12 @@ resources:
117126
properties:
118127
name:
119128
type: string
120-
x-aep-field-number: 1
129+
x-aep-field:
130+
field_number: 1
121131
description:
122132
type: string
123-
x-aep-field-number: 2
133+
x-aep-field:
134+
field_number: 2
124135
methods:
125136
create:
126137
supports_user_settable_create: true
@@ -140,14 +151,17 @@ resources:
140151
properties:
141152
book:
142153
type: string
143-
x-aep-field-number: 1
154+
x-aep-field:
155+
field_number: 1
144156
condition:
145157
type: string
146-
x-aep-field-number: 2
158+
x-aep-field:
159+
field_number: 2
147160
price:
148161
type: number
149162
format: double
150-
x-aep-field-number: 3
163+
x-aep-field:
164+
field_number: 3
151165
methods:
152166
create:
153167
supports_user_settable_create: true
@@ -167,4 +181,5 @@ resources:
167181
properties:
168182
target_store:
169183
type: string
170-
x-aep-field-number: 1
184+
x-aep-field:
185+
field_number: 1

example/bookstore/v1/bookstore_openapi.json

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1349,11 +1349,15 @@
13491349
"properties": {
13501350
"family_name": {
13511351
"type": "string",
1352-
"x-aep-field-number": 2
1352+
"x-aep-field": {
1353+
"field_number": 2
1354+
}
13531355
},
13541356
"given_name": {
13551357
"type": "string",
1356-
"x-aep-field-number": 1
1358+
"x-aep-field": {
1359+
"field_number": 1
1360+
}
13571361
}
13581362
}
13591363
}
@@ -1388,7 +1392,8 @@
13881392
],
13891393
"parents": [
13901394
"publisher"
1391-
]
1395+
],
1396+
"type": "bookstore.example.com/book"
13921397
},
13931398
"required": [
13941399
"edition",
@@ -1416,7 +1421,8 @@
14161421
],
14171422
"parents": [
14181423
"book"
1419-
]
1424+
],
1425+
"type": "bookstore.example.com/book-edition"
14201426
},
14211427
"required": [
14221428
"display_name"
@@ -1435,7 +1441,8 @@
14351441
"plural": "isbns",
14361442
"patterns": [
14371443
"isbns/{isbn_id}"
1438-
]
1444+
],
1445+
"type": "bookstore.example.com/isbn"
14391446
}
14401447
},
14411448
"item": {
@@ -1464,7 +1471,8 @@
14641471
],
14651472
"parents": [
14661473
"store"
1467-
]
1474+
],
1475+
"type": "bookstore.example.com/item"
14681476
},
14691477
"required": [
14701478
"title",
@@ -1488,7 +1496,8 @@
14881496
"plural": "publishers",
14891497
"patterns": [
14901498
"publishers/{publisher_id}"
1491-
]
1499+
],
1500+
"type": "bookstore.example.com/publisher"
14921501
}
14931502
},
14941503
"store": {
@@ -1510,7 +1519,8 @@
15101519
"plural": "stores",
15111520
"patterns": [
15121521
"stores/{store_id}"
1513-
]
1522+
],
1523+
"type": "bookstore.example.com/store"
15141524
},
15151525
"required": [
15161526
"name"

example/bookstore/v1/bookstore_openapi.yaml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ components:
77
properties:
88
family_name:
99
type: string
10-
x-aep-field-number: 2
10+
x-aep-field:
11+
field_number: 2
1112
given_name:
1213
type: string
13-
x-aep-field-number: 1
14+
x-aep-field:
15+
field_number: 1
1416
type: object
1517
type: array
1618
edition:
@@ -42,6 +44,7 @@ components:
4244
- publishers/{publisher_id}/books/{book_id}
4345
plural: books
4446
singular: book
47+
type: bookstore.example.com/book
4548
book-edition:
4649
properties:
4750
display_name:
@@ -60,6 +63,7 @@ components:
6063
- publishers/{publisher_id}/books/{book_id}/editions/{book_edition_id}
6164
plural: book-editions
6265
singular: book-edition
66+
type: bookstore.example.com/book-edition
6367
isbn:
6468
properties:
6569
path:
@@ -72,6 +76,7 @@ components:
7276
- isbns/{isbn_id}
7377
plural: isbns
7478
singular: isbn
79+
type: bookstore.example.com/isbn
7580
item:
7681
properties:
7782
book:
@@ -97,6 +102,7 @@ components:
97102
- stores/{store_id}/items/{item_id}
98103
plural: items
99104
singular: item
105+
type: bookstore.example.com/item
100106
publisher:
101107
properties:
102108
description:
@@ -111,6 +117,7 @@ components:
111117
- publishers/{publisher_id}
112118
plural: publishers
113119
singular: publisher
120+
type: bookstore.example.com/publisher
114121
store:
115122
properties:
116123
description:
@@ -129,6 +136,7 @@ components:
129136
- stores/{store_id}
130137
plural: stores
131138
singular: store
139+
type: bookstore.example.com/store
132140
info:
133141
contact:
134142
email: aepsupport@aep.dev

go.mod

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ go 1.23.0
55
toolchain go1.23.6
66

77
require (
8-
buf.build/gen/go/aep/api/protocolbuffers/go v1.36.10-20251011185002-1454930c8f99.1
8+
buf.build/gen/go/aep/api/protocolbuffers/go v1.36.10-20251109183837-26a011a354ee.1
99
cloud.google.com/go/longrunning v0.6.6
10-
github.com/aep-dev/aep-lib-go v0.0.0-20251011190527-4b8a96d91310
10+
github.com/aep-dev/aep-lib-go v0.0.0-20251111165230-98620886fcd9
1111
github.com/aep-dev/terraform-provider-aep v0.0.0-20241112052633-f48d45460768
1212
github.com/google/cel-go v0.22.1
1313
github.com/grpc-ecosystem/grpc-gateway/v2 v2.18.0
@@ -21,7 +21,7 @@ require (
2121
)
2222

2323
require (
24-
buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.10-20240221180331-f05a6f4403ce.1 // indirect
24+
buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.10-20250912141014-52f32327d4b0.1 // indirect
2525
cel.dev/expr v0.19.1 // indirect
2626
github.com/DataDog/datadog-go v2.2.0+incompatible // indirect
2727
github.com/ProtonMail/go-crypto v1.1.0-alpha.2 // indirect

0 commit comments

Comments
 (0)