Skip to content

Commit

Permalink
protoc-gen-openapi: remove duplicate body params
Browse files Browse the repository at this point in the history
When a request has both path parameters and body = "*", the path
parameters were being repeated in the body. But according to the docs:
the special name `*` is used to define that every field not bound by the
path template should be mapped to the request body.

This commit does exactly that, when the body is `*` and there are some
path parameters, then the a new message schema is created that does not
include the path parameters. The name of the schema is the same as the
message name, with the `_Body` suffix.

fixes google#323
  • Loading branch information
jagobagascon committed Jun 12, 2024
1 parent ad271d5 commit da89488
Show file tree
Hide file tree
Showing 44 changed files with 1,754 additions and 225 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/MoveBookRequest'
$ref: '#/components/schemas/MoveBookRequest_Body'
required: true
responses:
"200":
Expand Down Expand Up @@ -374,7 +374,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/MergeShelvesRequest'
$ref: '#/components/schemas/MergeShelvesRequest_Body'
required: true
responses:
"200":
Expand Down Expand Up @@ -469,36 +469,24 @@ components:
field in the subsequent call to `ListShelves` method to retrieve the next
page of results.
description: Response message for LibraryService.ListShelves.
MergeShelvesRequest:
MergeShelvesRequest_Body:
required:
- name
- other_shelf_name
type: object
properties:
name:
type: string
description: The name of the shelf we're adding books to.
other_shelf_name:
type: string
description: The name of the shelf we're removing books from and deleting.
description: |-
Describes the shelf being removed (other_shelf_name) and updated
(name) in this merge.
MoveBookRequest:
description: The body of LibraryService_MergeShelves
MoveBookRequest_Body:
required:
- name
- other_shelf_name
type: object
properties:
name:
type: string
description: The name of the book to move.
other_shelf_name:
type: string
description: The name of the destination shelf.
description: |-
Describes what book to move (name) and what shelf we're moving it
to (other_shelf_name).
description: The body of LibraryService_MoveBook
Shelf:
required:
- name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/MoveBookRequest'
$ref: '#/components/schemas/MoveBookRequest_Body'
required: true
responses:
"200":
Expand Down Expand Up @@ -374,7 +374,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/MergeShelvesRequest'
$ref: '#/components/schemas/MergeShelvesRequest_Body'
required: true
responses:
"200":
Expand Down Expand Up @@ -469,36 +469,24 @@ components:
field in the subsequent call to `ListShelves` method to retrieve the next
page of results.
description: Response message for LibraryService.ListShelves.
MergeShelvesRequest:
MergeShelvesRequest_Body:
required:
- name
- otherShelfName
type: object
properties:
name:
type: string
description: The name of the shelf we're adding books to.
otherShelfName:
type: string
description: The name of the shelf we're removing books from and deleting.
description: |-
Describes the shelf being removed (other_shelf_name) and updated
(name) in this merge.
MoveBookRequest:
description: The body of LibraryService_MergeShelves
MoveBookRequest_Body:
required:
- name
- otherShelfName
type: object
properties:
name:
type: string
description: The name of the book to move.
otherShelfName:
type: string
description: The name of the destination shelf.
description: |-
Describes what book to move (name) and what shelf we're moving it
to (other_shelf_name).
description: The body of LibraryService_MoveBook
Shelf:
required:
- name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/google.example.library.v1.MoveBookRequest'
$ref: '#/components/schemas/google.example.library.v1.MoveBookRequest_Body'
required: true
responses:
"200":
Expand Down Expand Up @@ -374,7 +374,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/google.example.library.v1.MergeShelvesRequest'
$ref: '#/components/schemas/google.example.library.v1.MergeShelvesRequest_Body'
required: true
responses:
"200":
Expand Down Expand Up @@ -461,36 +461,24 @@ components:
field in the subsequent call to `ListShelves` method to retrieve the next
page of results.
description: Response message for LibraryService.ListShelves.
google.example.library.v1.MergeShelvesRequest:
google.example.library.v1.MergeShelvesRequest_Body:
required:
- name
- otherShelfName
type: object
properties:
name:
type: string
description: The name of the shelf we're adding books to.
otherShelfName:
type: string
description: The name of the shelf we're removing books from and deleting.
description: |-
Describes the shelf being removed (other_shelf_name) and updated
(name) in this merge.
google.example.library.v1.MoveBookRequest:
description: The body of LibraryService_MergeShelves
google.example.library.v1.MoveBookRequest_Body:
required:
- name
- otherShelfName
type: object
properties:
name:
type: string
description: The name of the book to move.
otherShelfName:
type: string
description: The name of the destination shelf.
description: |-
Describes what book to move (name) and what shelf we're moving it
to (other_shelf_name).
description: The body of LibraryService_MoveBook
google.example.library.v1.Shelf:
required:
- name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/MoveBookRequest'
$ref: '#/components/schemas/MoveBookRequest_Body'
required: true
responses:
"200":
Expand Down Expand Up @@ -374,7 +374,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/MergeShelvesRequest'
$ref: '#/components/schemas/MergeShelvesRequest_Body'
required: true
responses:
"200":
Expand Down Expand Up @@ -469,36 +469,24 @@ components:
field in the subsequent call to `ListShelves` method to retrieve the next
page of results.
description: Response message for LibraryService.ListShelves.
MergeShelvesRequest:
MergeShelvesRequest_Body:
required:
- name
- otherShelfName
type: object
properties:
name:
type: string
description: The name of the shelf we're adding books to.
otherShelfName:
type: string
description: The name of the shelf we're removing books from and deleting.
description: |-
Describes the shelf being removed (other_shelf_name) and updated
(name) in this merge.
MoveBookRequest:
description: The body of LibraryService_MergeShelves
MoveBookRequest_Body:
required:
- name
- otherShelfName
type: object
properties:
name:
type: string
description: The name of the book to move.
otherShelfName:
type: string
description: The name of the destination shelf.
description: |-
Describes what book to move (name) and what shelf we're moving it
to (other_shelf_name).
description: The body of LibraryService_MoveBook
Shelf:
required:
- name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/MoveBookRequest'
$ref: '#/components/schemas/MoveBookRequest_Body'
required: true
responses:
"200":
Expand Down Expand Up @@ -374,7 +374,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/MergeShelvesRequest'
$ref: '#/components/schemas/MergeShelvesRequest_Body'
required: true
responses:
"200":
Expand Down Expand Up @@ -469,36 +469,24 @@ components:
field in the subsequent call to `ListShelves` method to retrieve the next
page of results.
description: Response message for LibraryService.ListShelves.
MergeShelvesRequest:
MergeShelvesRequest_Body:
required:
- name
- otherShelfName
type: object
properties:
name:
type: string
description: The name of the shelf we're adding books to.
otherShelfName:
type: string
description: The name of the shelf we're removing books from and deleting.
description: |-
Describes the shelf being removed (other_shelf_name) and updated
(name) in this merge.
MoveBookRequest:
description: The body of LibraryService_MergeShelves
MoveBookRequest_Body:
required:
- name
- otherShelfName
type: object
properties:
name:
type: string
description: The name of the book to move.
otherShelfName:
type: string
description: The name of the destination shelf.
description: |-
Describes what book to move (name) and what shelf we're moving it
to (other_shelf_name).
description: The body of LibraryService_MoveBook
Shelf:
required:
- name
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi

openapi: 3.0.3
info:
title: Messaging API
version: 0.0.1
paths:
/v1/messages:
patch:
tags:
- Messaging
operationId: Messaging_UpdateMessage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
required: true
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'
/v1/messages/{messageId}:
patch:
tags:
- Messaging
operationId: Messaging_UpdateMessage
parameters:
- name: messageId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: string
required: true
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:
type: object
properties:
'@type':
type: string
description: The type of the serialized message.
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
Message:
type: object
properties:
messageId:
type: string
text:
type: string
Status:
type: object
properties:
code:
type: integer
description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
format: int32
message:
type: string
description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufAny'
description: A list of messages that carry the error details. There is a common set of message types for APIs to use.
description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
tags:
- name: Messaging
Loading

0 comments on commit da89488

Please sign in to comment.