Skip to content

feat(122): make path fields readOnly #402

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 12, 2026
Merged

feat(122): make path fields readOnly #402

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
5 changes: 5 additions & 0 deletions aep/general/0122/aep.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,15 @@ users/vhugo1802

{% sample '../example.proto', 'message Book' %}

- The `path` field for the resource **must** be annotated with `OUTPUT_ONLY`.

{% tab oas %}

{% sample '../example.oas.yaml', '$.components.schemas.book.properties.path' %}

- The `path` field for the resource **must** be annotated with
`readOnly: true`.

{% endtabs %}

**Note:** Resource paths as described here are used within the scope of a
Expand Down
6 changes: 6 additions & 0 deletions aep/general/example.oas.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ components:
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 @@ -50,6 +51,7 @@ components:
description:
The server-assigned path of the resource, which is unique within
the service.
readOnly: true
type: string
required:
- display_name
Expand All @@ -68,6 +70,7 @@ components:
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:
description:
The server-assigned path of the resource, which is unique within
the service.
readOnly: true
type: string
price:
format: double
Expand All @@ -111,6 +115,7 @@ components:
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 @@ -129,6 +134,7 @@ components:
description:
The server-assigned path of the resource, which is unique within
the service.
readOnly: true
type: string
required:
- name
Expand Down
42 changes: 36 additions & 6 deletions aep/general/example.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