Skip to content
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

Jump to bottom

add custom options to allow more control of swagger/openapi output #145

Merged
merged 26 commits into from
Nov 3, 2017
Merged

add custom options to allow more control of swagger/openapi output #145

merged 26 commits into from
Nov 3, 2017

Commits on Oct 27, 2017

  1. Apply additional Swagger properties using JSON. 

    Depends on PR grpc-ecosystem#134. Reverts 562956f.
    @ivucica
    ivucica committed Oct 27, 2017
    Configuration menu
    Copy the full SHA
    6ff06d8 View commit details
    Browse the repository at this point in the history

  2. Swagger: Replaced '<!-- ... -->' for raw JSON with last paragraph 'Sw… 

    …agger: '.

Per discussion in grpc-ecosystem#134.
    @ivucica
    ivucica committed Oct 27, 2017
    Configuration menu
    Copy the full SHA
    fcc2dca View commit details
    Browse the repository at this point in the history

  3. Change from 'Swagger: ' to 'OpenAPI: ' prefix.

    @ivucica
    ivucica committed Oct 27, 2017
    Configuration menu
    Copy the full SHA
    20a6d40 View commit details
    Browse the repository at this point in the history

  4. WIP: Use a proto option to describe whether a Swagger Operation is de… 

    …precated.

Issues:
- This change breaks tests, uses possibly inappropriate package names etc.
- 'deprecated' status of an operation should be determined by whether the proto
  method has been declared deprecated.
- Previous way of declaring extra values using JSON prefixed with "OpenAPI: "
  in the comments has not been removed.
- Extension for Swagger options has an arbitrary, but almost certainly wrong,
  identifier assigned to it.
- Neither global API properties nor the main useful property on a swagger
  Operation, "externalDocs", are supported with this new method.
- As a possible idea, we may want to support raw JSON in an option as well.
    @ivucica
    ivucica committed Oct 27, 2017
    Configuration menu
    Copy the full SHA
    321663d View commit details
    Browse the repository at this point in the history

  5. WIP: Setting API properties through an option.

    @ivucica
    ivucica committed Oct 27, 2017
    Configuration menu
    Copy the full SHA
    7043966 View commit details
    Browse the repository at this point in the history

  6. WIP: Correctly reserve fields. Update link. TODO: merge with commit M… 

    …on Feb 13 13:58:23 2017 +0000.
    @ivucica
    ivucica committed Oct 27, 2017
    Configuration menu
    Copy the full SHA
    cdc1094 View commit details
    Browse the repository at this point in the history

  7. WIP: Refer to the specification as OpenAPI v2, not Swagger. 

    Also, change the Go package name for options proto.
    @ivucica
    ivucica committed Oct 27, 2017
    Configuration menu
    Copy the full SHA
    41b436f View commit details
    Browse the repository at this point in the history

  8. WIP: Clean up after OpenAPIv2 options proto generation.

    @ivucica
    ivucica committed Oct 27, 2017
    Configuration menu
    Copy the full SHA
    74cd394 View commit details
    Browse the repository at this point in the history

  9. WIP: JSON is disappearing from the output protos.

    @ivucica
    ivucica committed Oct 27, 2017
    Configuration menu
    Copy the full SHA
    549ccee View commit details
    Browse the repository at this point in the history

  10. WIP: Fix typo 'want an Swagger' -> 'want a Swagger object'.

    @ivucica
    ivucica committed Oct 27, 2017
    Configuration menu
    Copy the full SHA
    6b2b321 View commit details
    Browse the repository at this point in the history

  11. WIP: Process all remaining fields of the OpenAPI v2 Swagger object.

    @ivucica
    ivucica committed Oct 27, 2017
    Configuration menu
    Copy the full SHA
    db4a056 View commit details
    Browse the repository at this point in the history

  12. WIP: ExternalDocs belongs on OpenAPIv2's Swagger object, not on the I… 

    …nfo object.
    @ivucica
    ivucica committed Oct 27, 2017
    Configuration menu
    Copy the full SHA
    7697bcf View commit details
    Browse the repository at this point in the history

Commits on Oct 28, 2017

  1. WIP: Remove use of JSON. Introduce schema and tag object. Support ext… 

    …ernalDocs on exported schema object. Replace (protocol) scheme strings with enum.
    @ivucica
    ivucica committed Oct 28, 2017
    Configuration menu
    Copy the full SHA
    162c375 View commit details
    Browse the repository at this point in the history

  2. WIP: Add built annotations.pb.go and openapiv2.pb.go.

    @ivucica
    ivucica committed Oct 28, 2017
    Configuration menu
    Copy the full SHA
    b53579c View commit details
    Browse the repository at this point in the history

  3. WIP: go fmt on protoc-gen-swagger.

    @ivucica
    ivucica committed Oct 28, 2017
    Configuration menu
    Copy the full SHA
    60d116f View commit details
    Browse the repository at this point in the history

  4. WIP: Provide a more unique operation ID in case of additional bindings. 

    This doesn't resolve the problem of multiple services having same operation IDs.

That can be dealt with sometime in the future, however.
    @ivucica
    ivucica committed Oct 28, 2017
    Configuration menu
    Copy the full SHA
    d509096 View commit details
    Browse the repository at this point in the history

  5. WIP: Try to fix integration test by removing 'host' from the Swagger … 

    …object.
    @ivucica
    ivucica committed Oct 28, 2017
    Configuration menu
    Copy the full SHA
    3949620 View commit details
    Browse the repository at this point in the history

Commits on Oct 29, 2017

  1. WIP: Remove swaggerExtrasRegexp.

    @ivucica
    ivucica committed Oct 29, 2017
    Configuration menu
    Copy the full SHA
    a386e97 View commit details
    Browse the repository at this point in the history

  2. WIP: Move error checking for extractSchemaOptionFromMessageDescriptor… 

    … out of check for opts != nil.
    @ivucica
    ivucica committed Oct 29, 2017
    Configuration menu
    Copy the full SHA
    290f777 View commit details
    Browse the repository at this point in the history

  3. WIP: Fix typo: 'want a Schema'.

    @ivucica
    ivucica committed Oct 29, 2017
    Configuration menu
    Copy the full SHA
    97ee19b View commit details
    Browse the repository at this point in the history

Commits on Nov 1, 2017

  1. Assign IDs for proto options extensions.

    @ivucica
    ivucica committed Nov 1, 2017
    Configuration menu
    Copy the full SHA
    ceb4c4e View commit details
    Browse the repository at this point in the history

  2. Move test definitions for options-based extension to Swagger output f… 

    …ile from echo service to a bit of everything service.
    @ivucica
    ivucica committed Nov 1, 2017
    Configuration menu
    Copy the full SHA
    099fda5 View commit details
    Browse the repository at this point in the history

Commits on Nov 2, 2017

  1. Undo commenting out dependency on EXAMPLE_CLIENT_SRCS. 

    I do not have swagger-codegen installed, so that was broken for me while developing.
    @ivucica
    ivucica committed Nov 2, 2017
    Configuration menu
    Copy the full SHA
    d7b0ba4 View commit details
    Browse the repository at this point in the history

  2. Change the proto package to start with 'grpc.gateway', as seems to be… 

    … the approach elsewhere.
    @ivucica
    ivucica committed Nov 2, 2017
    Configuration menu
    Copy the full SHA
    d7a9a69 View commit details
    Browse the repository at this point in the history

  3. Add a comment about all IDs being ok to be the same.

    @ivucica
    ivucica committed Nov 2, 2017
    Configuration menu
    Copy the full SHA
    84c3046 View commit details
    Browse the repository at this point in the history

  4. Regenerated Swagger-generated clients.

    @ivucica
    ivucica committed Nov 2, 2017
    Configuration menu
    Copy the full SHA
    a543b9e View commit details
    Browse the repository at this point in the history