Skip to content

feat(aepc): readOnly path params #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
toumorokoshi merged 1 commit into from
Feb 8, 2026
Merged

feat(aepc): readOnly path params #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,232 changes: 618 additions & 614 deletions example/bookstore/v1/bookstore.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

42 changes: 36 additions & 6 deletions example/bookstore/v1/bookstore.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,12 @@ message Book {
repeated Author author = 5;

// Field for path.
string path = 10018;
string path = 10018 [
(aep.api.field_info) = {
field_behavior: [FIELD_BEHAVIOR_OUTPUT_ONLY]
},
(google.api.field_behavior) = OUTPUT_ONLY
];
}

// A BookEdition.
Expand All @@ -348,7 +353,12 @@ message BookEdition {
];

// Field for path.
string path = 10018;
string path = 10018 [
(aep.api.field_info) = {
field_behavior: [FIELD_BEHAVIOR_OUTPUT_ONLY]
},
(google.api.field_behavior) = OUTPUT_ONLY
];
}

// A Isbn.
Expand All @@ -361,7 +371,12 @@ message Isbn {
};

// Field for path.
string path = 10018;
string path = 10018 [
(aep.api.field_info) = {
field_behavior: [FIELD_BEHAVIOR_OUTPUT_ONLY]
},
(google.api.field_behavior) = OUTPUT_ONLY
];
}

// A Item.
Expand Down Expand Up @@ -393,7 +408,12 @@ message Item {
];

// Field for path.
string path = 10018;
string path = 10018 [
(aep.api.field_info) = {
field_behavior: [FIELD_BEHAVIOR_OUTPUT_ONLY]
},
(google.api.field_behavior) = OUTPUT_ONLY
];
}

// A Publisher.
Expand All @@ -409,7 +429,12 @@ message Publisher {
string description = 1;

// Field for path.
string path = 10018;
string path = 10018 [
(aep.api.field_info) = {
field_behavior: [FIELD_BEHAVIOR_OUTPUT_ONLY]
},
(google.api.field_behavior) = OUTPUT_ONLY
];
}

// A Store.
Expand All @@ -433,7 +458,12 @@ message Store {
string description = 2;

// Field for path.
string path = 10018;
string path = 10018 [
(aep.api.field_info) = {
field_behavior: [FIELD_BEHAVIOR_OUTPUT_ONLY]
},
(google.api.field_behavior) = OUTPUT_ONLY
];
}

// A Create request for a book resource.
Expand Down
18 changes: 12 additions & 6 deletions example/bookstore/v1/bookstore.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1508,7 +1508,8 @@
},
"path": {
"type": "string",
"description": "Field for path."
"description": "Field for path.",
"readOnly": true
}
},
"description": "A Book.",
Expand All @@ -1528,7 +1529,8 @@
},
"path": {
"type": "string",
"description": "Field for path."
"description": "Field for path.",
"readOnly": true
}
},
"description": "A BookEdition.",
Expand All @@ -1541,7 +1543,8 @@
"properties": {
"path": {
"type": "string",
"description": "Field for path."
"description": "Field for path.",
"readOnly": true
}
},
"description": "A Isbn."
Expand All @@ -1564,7 +1567,8 @@
},
"path": {
"type": "string",
"description": "Field for path."
"description": "Field for path.",
"readOnly": true
}
},
"description": "A Item.",
Expand Down Expand Up @@ -1698,7 +1702,8 @@
},
"path": {
"type": "string",
"description": "Field for path."
"description": "Field for path.",
"readOnly": true
}
},
"description": "A Publisher."
Expand All @@ -1716,7 +1721,8 @@
},
"path": {
"type": "string",
"description": "Field for path."
"description": "Field for path.",
"readOnly": true
}
},
"description": "A Store.",
Expand Down
6 changes: 6 additions & 0 deletions example/bookstore/v1/bookstore_openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1374,6 +1374,7 @@
},
"path": {
"type": "string",
"readOnly": true,
"description": "The server-assigned path of the resource, which is unique within the service."
},
"price": {
Expand Down Expand Up @@ -1410,6 +1411,7 @@
},
"path": {
"type": "string",
"readOnly": true,
"description": "The server-assigned path of the resource, which is unique within the service."
}
},
Expand All @@ -1433,6 +1435,7 @@
"properties": {
"path": {
"type": "string",
"readOnly": true,
"description": "The server-assigned path of the resource, which is unique within the service."
}
},
Expand All @@ -1456,6 +1459,7 @@
},
"path": {
"type": "string",
"readOnly": true,
"description": "The server-assigned path of the resource, which is unique within the service."
},
"price": {
Expand Down Expand Up @@ -1488,6 +1492,7 @@
},
"path": {
"type": "string",
"readOnly": true,
"description": "The server-assigned path of the resource, which is unique within the service."
}
},
Expand All @@ -1511,6 +1516,7 @@
},
"path": {
"type": "string",
"readOnly": true,
"description": "The server-assigned path of the resource, which is unique within the service."
}
},
Expand Down
6 changes: 6 additions & 0 deletions example/bookstore/v1/bookstore_openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ components:
path:
description: The server-assigned path of the resource, which is unique within
the service.
readOnly: true
type: string
price:
format: int32
Expand Down Expand Up @@ -52,6 +53,7 @@ components:
path:
description: The server-assigned path of the resource, which is unique within
the service.
readOnly: true
type: string
required:
- display_name
Expand All @@ -69,6 +71,7 @@ components:
path:
description: The server-assigned path of the resource, which is unique within
the service.
readOnly: true
type: string
type: object
x-aep-resource:
Expand All @@ -86,6 +89,7 @@ components:
path:
description: The server-assigned path of the resource, which is unique within
the service.
readOnly: true
type: string
price:
format: double
Expand All @@ -110,6 +114,7 @@ components:
path:
description: The server-assigned path of the resource, which is unique within
the service.
readOnly: true
type: string
type: object
x-aep-resource:
Expand All @@ -127,6 +132,7 @@ components:
path:
description: The server-assigned path of the resource, which is unique within
the service.
readOnly: true
type: string
required:
- name
Expand Down
5 changes: 4 additions & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ toolchain go1.23.6
require (
buf.build/gen/go/aep/api/protocolbuffers/go v1.36.10-20251109183837-26a011a354ee.1
cloud.google.com/go/longrunning v0.6.6
github.com/aep-dev/aep-lib-go v0.0.0-20251111165230-98620886fcd9
github.com/aep-dev/aep-lib-go v0.0.0-20260208052831-f2a02f53a637
github.com/aep-dev/terraform-provider-aep v0.0.0-20241112052633-f48d45460768
github.com/google/cel-go v0.22.1
github.com/grpc-ecosystem/grpc-gateway/v2 v2.18.0
Expand Down Expand Up @@ -105,3 +105,6 @@ require (
golang.org/x/sys v0.31.0 // indirect
golang.org/x/text v0.23.0 // indirect
)

// uncomment for local development
// replace github.com/aep-dev/aep-lib-go => ../aep-lib-go
2 changes: 2 additions & 0 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 h1:d+Bc7a5rLufV
github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE=
github.com/aep-dev/aep-lib-go v0.0.0-20251111165230-98620886fcd9 h1:7cTm+JDlHZUaxkL8X/VJl6G+Nxn42VYDtiyM4xKgXEo=
github.com/aep-dev/aep-lib-go v0.0.0-20251111165230-98620886fcd9/go.mod h1:oPOz/8HDQAI0sR+pHSteMkiP/WHM3RNHKY4DctnwVpo=
github.com/aep-dev/aep-lib-go v0.0.0-20260208052831-f2a02f53a637 h1:7tZhVn+a3e1ITD5KC+jITawtd+kuNNC+ePFDhDw5bYQ=
github.com/aep-dev/aep-lib-go v0.0.0-20260208052831-f2a02f53a637/go.mod h1:oPOz/8HDQAI0sR+pHSteMkiP/WHM3RNHKY4DctnwVpo=
github.com/aep-dev/terraform-provider-aep v0.0.0-20241112052633-f48d45460768 h1:b5fRfpIIsOsdsT2N1MsBxr0K/fZacCUlWp0uY9/BJzM=
github.com/aep-dev/terraform-provider-aep v0.0.0-20241112052633-f48d45460768/go.mod h1:sUuUJSkWTc4GBxp8GEZXCeEI38VMyuM5msPQ9BG0kMA=
github.com/agext/levenshtein v1.2.2 h1:0S/Yg6LYmFJ5stwQeRp6EeOcCbj7xiqQSdNelsXvaqE=
Expand Down