Skip to content

fix: noun declension code #464

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
flowchartsman wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: noun declension code #464

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
17 changes: 17 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 @@ -40,6 +40,13 @@ service Messaging {
body : "*"
};
}

// Test irregular plural: series/* should stay as {series}, not {serie}
rpc GetMessageSeries(GetMessageSeriesRequest) returns (MessageSeries) {
option (google.api.http) = {
get : "/v1/{name=series/*}"
};
}
}

message GetMessageRequest {
Expand All @@ -64,4 +71,14 @@ message Comment {
string comment_id = 1;
uint64 user_id = 2;
string content = 3;
}

message MessageSeries {
string name = 1;
string description = 2;
repeated Message messages = 3;
}

message GetMessageSeriesRequest {
string name = 1;
}
37 changes: 37 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 @@ -63,6 +63,32 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/series/{series}:
get:
tags:
- Messaging
description: 'Test irregular plural: series/* should stay as {series}, not {serie}'
operationId: Messaging_GetMessageSeries
parameters:
- name: series
in: path
description: The series id.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MessageSeries'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/users/{user_id}/messages/{message_id}:
get:
tags:
Expand Down Expand Up @@ -113,6 +139,17 @@ components:
type: string
maybe:
type: string
MessageSeries:
type: object
properties:
name:
type: string
description:
type: string
messages:
type: array
items:
$ref: '#/components/schemas/Message'
Status:
type: object
properties:
Expand Down
37 changes: 37 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 @@ -63,6 +63,32 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/series/{series}:
get:
tags:
- Messaging
description: 'Test irregular plural: series/* should stay as {series}, not {serie}'
operationId: Messaging_GetMessageSeries
parameters:
- name: series
in: path
description: The series id.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MessageSeries'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/users/{userId}/messages/{messageId}:
get:
tags:
Expand Down Expand Up @@ -113,6 +139,17 @@ components:
type: string
maybe:
type: string
MessageSeries:
type: object
properties:
name:
type: string
description:
type: string
messages:
type: array
items:
$ref: '#/components/schemas/Message'
Status:
type: object
properties:
Expand Down
37 changes: 37 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 @@ -63,6 +63,32 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
/v1/series/{series}:
get:
tags:
- Messaging
description: 'Test irregular plural: series/* should stay as {series}, not {serie}'
operationId: Messaging_GetMessageSeries
parameters:
- name: series
in: path
description: The series id.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/tests.pathparams.message.v1.MessageSeries'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/google.rpc.Status'
/v1/users/{userId}/messages/{messageId}:
get:
tags:
Expand Down Expand Up @@ -129,5 +155,16 @@ components:
type: string
maybe:
type: string
tests.pathparams.message.v1.MessageSeries:
type: object
properties:
name:
type: string
description:
type: string
messages:
type: array
items:
$ref: '#/components/schemas/tests.pathparams.message.v1.Message'
tags:
- name: Messaging
37 changes: 37 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 @@ -63,6 +63,32 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/series/{series}:
get:
tags:
- Messaging
description: 'Test irregular plural: series/* should stay as {series}, not {serie}'
operationId: Messaging_GetMessageSeries
parameters:
- name: series
in: path
description: The series id.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MessageSeries'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/users/{userId}/messages/{messageId}:
get:
tags:
Expand Down Expand Up @@ -113,6 +139,17 @@ components:
type: string
maybe:
type: string
MessageSeries:
type: object
properties:
name:
type: string
description:
type: string
messages:
type: array
items:
$ref: '#/components/schemas/Message'
Status:
type: object
properties:
Expand Down
37 changes: 37 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 @@ -63,6 +63,32 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/series/{series}:
get:
tags:
- Messaging
description: 'Test irregular plural: series/* should stay as {series}, not {serie}'
operationId: Messaging_GetMessageSeries
parameters:
- name: series
in: path
description: The series id.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MessageSeries'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/users/{userId}/messages/{messageId}:
get:
tags:
Expand Down Expand Up @@ -113,6 +139,17 @@ components:
type: string
maybe:
type: string
MessageSeries:
type: object
properties:
name:
type: string
description:
type: string
messages:
type: array
items:
$ref: '#/components/schemas/Message'
Status:
type: object
properties:
Expand Down
15 changes: 3 additions & 12 deletions cmd/protoc-gen-openapi/generator/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
package generator

import (
"strings"

"google.golang.org/protobuf/reflect/protoreflect"

"github.com/jinzhu/inflection"
)

// contains returns true if an array contains a specified string.
Expand All @@ -41,16 +41,7 @@ func appendUnique(s []string, e string) []string {

// singular produces the singular form of a collection name.
func singular(plural string) string {
if strings.HasSuffix(plural, "ves") {
return strings.TrimSuffix(plural, "ves") + "f"
}
if strings.HasSuffix(plural, "ies") {
return strings.TrimSuffix(plural, "ies") + "y"
}
if strings.HasSuffix(plural, "s") {
return strings.TrimSuffix(plural, "s")
}
return plural
return inflection.Singular(plural)
}

func getValueKind(message protoreflect.MessageDescriptor) string {
Expand Down
1 change: 1 addition & 0 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ require (
github.com/golang/protobuf v1.5.4
github.com/google/gnostic-models v0.7.0
github.com/google/go-cmp v0.6.0
github.com/jinzhu/inflection v1.0.0
github.com/stoewer/go-strcase v1.3.1
go.yaml.in/yaml/v3 v3.0.4
golang.org/x/tools v0.36.0
Expand Down
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 @@ -13,6 +13,8 @@ github.com/google/gnostic-models v0.7.0 h1:qwTtogB15McXDaNqTZdzPJRHvaVJlAl+HVQnL
github.com/google/gnostic-models v0.7.0/go.mod h1:whL5G0m6dmc5cPxKc5bdKdEN3UjI7OUGxBlw57miDrQ=
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E=
github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkryuEj+Srlc=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stoewer/go-strcase v1.3.1 h1:iS0MdW+kVTxgMoE1LAZyMiYJFKlOzLooE4MxjirtkAs=
Expand Down