Skip to content
This repository has been archived by the owner on May 3, 2023. It is now read-only.

Handle google/protobuf/wrappers.proto types on protoc-gen-openapi #1

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

Handle google/protobuf/wrappers.proto types on protoc-gen-openapi #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
02faba9
handle wrappers type on protoc-gen-openapi
galihputera Aug 31, 2022
936e518
handle timestamp type in protoc-gen-openapi URL query parameters
idhame Sep 16, 2022
35cb67b
add more comment
idhame Sep 19, 2022
e1017b5
feat: support generate doc with additional_bindings (#367)
Adol1111 Nov 30, 2022
557cd14
Merge branch 'main' into wrappers_types
galihputera Dec 2, 2022
3751138
Update CI to run on "main" branch. (#371)
timburks Dec 2, 2022
9ddb282
chore: yaml bump and protoc move to google.golang.org (#377)
ajayk Feb 21, 2023
8c84f3c
Don't remove newlines from openapi descriptions (#370)
silas Mar 24, 2023
1ed296c
Merge branch 'main' into wrappers_types
galihputera Mar 24, 2023
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
4 changes: 2 additions & 2 deletions .github/workflows/go.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Go

on:
push:
branches: [ master ]
branches: [ main ]
pull_request:
branches: [ master ]
branches: [ main ]

jobs:

Expand Down
2 changes: 1 addition & 1 deletion COMPILE-PROTOS.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# limitations under the License.
#

go install github.com/golang/protobuf/protoc-gen-go@latest
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest

protoc -I . -I ./third_party --go_out=. --go_opt=paths=source_relative openapiv2/*.proto
protoc -I . -I ./third_party --go_out=. --go_opt=paths=source_relative openapiv3/*.proto
Expand Down
52 changes: 42 additions & 10 deletions cmd/protoc-gen-openapi/examples/google/example/library/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,19 @@ paths:
parameters:
- name: page_size
in: query
description: Requested page size. Server may return fewer shelves than requested. If unspecified, server will pick an appropriate default.
description: |-
Requested page size. Server may return fewer shelves than requested.
If unspecified, server will pick an appropriate default.
schema:
type: integer
format: int32
- name: page_token
in: query
description: A token identifying a page of results the server should return. Typically, this is the value of [ListShelvesResponse.next_page_token][google.example.library.v1.ListShelvesResponse.next_page_token] returned from the previous call to `ListShelves` method.
description: |-
A token identifying a page of results the server should return.
Typically, this is the value of
[ListShelvesResponse.next_page_token][google.example.library.v1.ListShelvesResponse.next_page_token]
returned from the previous call to `ListShelves` method.
schema:
type: string
responses:
Expand Down Expand Up @@ -141,13 +147,19 @@ paths:
type: string
- name: page_size
in: query
description: Requested page size. Server may return fewer books than requested. If unspecified, server will pick an appropriate default.
description: |-
Requested page size. Server may return fewer books than requested.
If unspecified, server will pick an appropriate default.
schema:
type: integer
format: int32
- name: page_token
in: query
description: A token identifying a page of results the server should return. Typically, this is the value of [ListBooksResponse.next_page_token][google.example.library.v1.ListBooksResponse.next_page_token]. returned from the previous call to `ListBooks` method.
description: |-
A token identifying a page of results the server should return.
Typically, this is the value of
[ListBooksResponse.next_page_token][google.example.library.v1.ListBooksResponse.next_page_token].
returned from the previous call to `ListBooks` method.
schema:
type: string
responses:
Expand Down Expand Up @@ -386,7 +398,10 @@ components:
properties:
name:
type: string
description: The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book.
description: |-
The resource name of the book.
Book names have the form `shelves/{shelf_id}/books/{book_id}`.
The name is ignored when creating a book.
author:
type: string
description: The name of the book author.
Expand Down Expand Up @@ -430,7 +445,12 @@ components:
description: The list of books.
next_page_token:
type: string
description: A token to retrieve next page of results. Pass this value in the [ListBooksRequest.page_token][google.example.library.v1.ListBooksRequest.page_token] field in the subsequent call to `ListBooks` method to retrieve the next page of results.
description: |-
A token to retrieve next page of results.
Pass this value in the
[ListBooksRequest.page_token][google.example.library.v1.ListBooksRequest.page_token]
field in the subsequent call to `ListBooks` method to retrieve the next
page of results.
description: Response message for LibraryService.ListBooks.
ListShelvesResponse:
type: object
Expand All @@ -442,7 +462,12 @@ components:
description: The list of shelves.
next_page_token:
type: string
description: A token to retrieve next page of results. Pass this value in the [ListShelvesRequest.page_token][google.example.library.v1.ListShelvesRequest.page_token] field in the subsequent call to `ListShelves` method to retrieve the next page of results.
description: |-
A token to retrieve next page of results.
Pass this value in the
[ListShelvesRequest.page_token][google.example.library.v1.ListShelvesRequest.page_token]
field in the subsequent call to `ListShelves` method to retrieve the next
page of results.
description: Response message for LibraryService.ListShelves.
MergeShelvesRequest:
required:
Expand All @@ -456,7 +481,9 @@ components:
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.
description: |-
Describes the shelf being removed (other_shelf_name) and updated
(name) in this merge.
MoveBookRequest:
required:
- name
Expand All @@ -469,15 +496,20 @@ components:
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: |-
Describes what book to move (name) and what shelf we're moving it
to (other_shelf_name).
Shelf:
required:
- name
type: object
properties:
name:
type: string
description: The resource name of the shelf. Shelf names have the form `shelves/{shelf_id}`. The name is ignored when creating a shelf.
description: |-
The resource name of the shelf.
Shelf names have the form `shelves/{shelf_id}`.
The name is ignored when creating a shelf.
theme:
type: string
description: The theme of the shelf
Expand Down
52 changes: 42 additions & 10 deletions cmd/protoc-gen-openapi/examples/google/example/library/v1/openapi_default_response.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,19 @@ paths:
parameters:
- name: pageSize
in: query
description: Requested page size. Server may return fewer shelves than requested. If unspecified, server will pick an appropriate default.
description: |-
Requested page size. Server may return fewer shelves than requested.
If unspecified, server will pick an appropriate default.
schema:
type: integer
format: int32
- name: pageToken
in: query
description: A token identifying a page of results the server should return. Typically, this is the value of [ListShelvesResponse.next_page_token][google.example.library.v1.ListShelvesResponse.next_page_token] returned from the previous call to `ListShelves` method.
description: |-
A token identifying a page of results the server should return.
Typically, this is the value of
[ListShelvesResponse.next_page_token][google.example.library.v1.ListShelvesResponse.next_page_token]
returned from the previous call to `ListShelves` method.
schema:
type: string
responses:
Expand Down Expand Up @@ -141,13 +147,19 @@ paths:
type: string
- name: pageSize
in: query
description: Requested page size. Server may return fewer books than requested. If unspecified, server will pick an appropriate default.
description: |-
Requested page size. Server may return fewer books than requested.
If unspecified, server will pick an appropriate default.
schema:
type: integer
format: int32
- name: pageToken
in: query
description: A token identifying a page of results the server should return. Typically, this is the value of [ListBooksResponse.next_page_token][google.example.library.v1.ListBooksResponse.next_page_token]. returned from the previous call to `ListBooks` method.
description: |-
A token identifying a page of results the server should return.
Typically, this is the value of
[ListBooksResponse.next_page_token][google.example.library.v1.ListBooksResponse.next_page_token].
returned from the previous call to `ListBooks` method.
schema:
type: string
responses:
Expand Down Expand Up @@ -386,7 +398,10 @@ components:
properties:
name:
type: string
description: The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book.
description: |-
The resource name of the book.
Book names have the form `shelves/{shelf_id}/books/{book_id}`.
The name is ignored when creating a book.
author:
type: string
description: The name of the book author.
Expand Down Expand Up @@ -430,7 +445,12 @@ components:
description: The list of books.
nextPageToken:
type: string
description: A token to retrieve next page of results. Pass this value in the [ListBooksRequest.page_token][google.example.library.v1.ListBooksRequest.page_token] field in the subsequent call to `ListBooks` method to retrieve the next page of results.
description: |-
A token to retrieve next page of results.
Pass this value in the
[ListBooksRequest.page_token][google.example.library.v1.ListBooksRequest.page_token]
field in the subsequent call to `ListBooks` method to retrieve the next
page of results.
description: Response message for LibraryService.ListBooks.
ListShelvesResponse:
type: object
Expand All @@ -442,7 +462,12 @@ components:
description: The list of shelves.
nextPageToken:
type: string
description: A token to retrieve next page of results. Pass this value in the [ListShelvesRequest.page_token][google.example.library.v1.ListShelvesRequest.page_token] field in the subsequent call to `ListShelves` method to retrieve the next page of results.
description: |-
A token to retrieve next page of results.
Pass this value in the
[ListShelvesRequest.page_token][google.example.library.v1.ListShelvesRequest.page_token]
field in the subsequent call to `ListShelves` method to retrieve the next
page of results.
description: Response message for LibraryService.ListShelves.
MergeShelvesRequest:
required:
Expand All @@ -456,7 +481,9 @@ components:
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.
description: |-
Describes the shelf being removed (other_shelf_name) and updated
(name) in this merge.
MoveBookRequest:
required:
- name
Expand All @@ -469,15 +496,20 @@ components:
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: |-
Describes what book to move (name) and what shelf we're moving it
to (other_shelf_name).
Shelf:
required:
- name
type: object
properties:
name:
type: string
description: The resource name of the shelf. Shelf names have the form `shelves/{shelf_id}`. The name is ignored when creating a shelf.
description: |-
The resource name of the shelf.
Shelf names have the form `shelves/{shelf_id}`.
The name is ignored when creating a shelf.
theme:
type: string
description: The theme of the shelf
Expand Down
Loading