Skip to content

Handle path patterns like /v1/{name=user/messages/*} #458

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

Open
asavageiv wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Handle path patterns like /v1/{name=user/messages/*} #458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9fe5e70
Factor out buildPathParameter
asavageiv Sep 12, 2025
61dcf88
Handle path patterns like /v1/{name=user/messages/*}
asavageiv Sep 12, 2025
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
21 changes: 21 additions & 0 deletions cmd/protoc-gen-openapi/examples/tests/pathparams/message.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,18 @@ service Messaging {
};
}

rpc GetMessage2(GetMessage2Request) returns (Message) {
option (google.api.http) = {
get : "/v2/messages/{message_id=*}"
};
}

rpc GetMessage3(GetMessage3Request) returns (Message) {
option (google.api.http) = {
get : "/v3/{name=user/messages/*}"
};
}

rpc GetUserMessage(GetMessageRequest) returns (Message) {
option (google.api.http) = {
get : "/v1/users/{user_id}/messages/{message_id}"
Expand All @@ -47,6 +59,15 @@ message GetMessageRequest {
uint64 user_id = 2;
}

message GetMessage2Request {
string message_id = 1;
uint64 user_id = 2;
}

message GetMessage3Request {
string name = 1;
}

message Meta {
string message_id = 1;
uint64 user_id = 2;
Expand Down
53 changes: 53 additions & 0 deletions cmd/protoc-gen-openapi/examples/tests/pathparams/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,59 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v2/messages/{message_id}:
get:
tags:
- Messaging
operationId: Messaging_GetMessage2
parameters:
- name: message_id
in: path
required: true
schema:
type: string
- name: user_id
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v3/user/messages/{message}:
get:
tags:
- Messaging
operationId: Messaging_GetMessage3
parameters:
- name: message
in: path
description: The message id.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
GoogleProtobufAny:
Expand Down
53 changes: 53 additions & 0 deletions cmd/protoc-gen-openapi/examples/tests/pathparams/openapi_default_response.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,59 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v2/messages/{messageId}:
get:
tags:
- Messaging
operationId: Messaging_GetMessage2
parameters:
- name: messageId
in: path
required: true
schema:
type: string
- name: userId
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v3/user/messages/{message}:
get:
tags:
- Messaging
operationId: Messaging_GetMessage3
parameters:
- name: message
in: path
description: The message id.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
GoogleProtobufAny:
Expand Down
53 changes: 53 additions & 0 deletions cmd/protoc-gen-openapi/examples/tests/pathparams/openapi_fq_schema_naming.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,59 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
/v2/messages/{messageId}:
get:
tags:
- Messaging
operationId: Messaging_GetMessage2
parameters:
- name: messageId
in: path
required: true
schema:
type: string
- name: userId
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/tests.pathparams.message.v1.Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
/v3/user/messages/{message}:
get:
tags:
- Messaging
operationId: Messaging_GetMessage3
parameters:
- name: message
in: path
description: The message id.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/tests.pathparams.message.v1.Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
components:
schemas:
google.protobuf.Any:
Expand Down
53 changes: 53 additions & 0 deletions cmd/protoc-gen-openapi/examples/tests/pathparams/openapi_json.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,59 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v2/messages/{messageId}:
get:
tags:
- Messaging
operationId: Messaging_GetMessage2
parameters:
- name: messageId
in: path
required: true
schema:
type: string
- name: userId
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v3/user/messages/{message}:
get:
tags:
- Messaging
operationId: Messaging_GetMessage3
parameters:
- name: message
in: path
description: The message id.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
GoogleProtobufAny:
Expand Down
53 changes: 53 additions & 0 deletions cmd/protoc-gen-openapi/examples/tests/pathparams/openapi_string_enum.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,59 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v2/messages/{messageId}:
get:
tags:
- Messaging
operationId: Messaging_GetMessage2
parameters:
- name: messageId
in: path
required: true
schema:
type: string
- name: userId
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v3/user/messages/{message}:
get:
tags:
- Messaging
operationId: Messaging_GetMessage3
parameters:
- name: message
in: path
description: The message id.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
GoogleProtobufAny:
Expand Down
Loading