grpc-ecosystem/grpc-gateway

Swagger Conformance

Open

#815 opened on Nov 17, 2018

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
help wantedopenapiquestionwaiting on reporter

Description

Go to https://editor.swagger.io/

Click File -> Import URL

Enter https://raw.githubusercontent.com/grpc-ecosystem/grpc-gateway/master/examples/proto/examplepb/a_bit_of_everything.swagger.json (current ABE example)

Find some validation errors:

Schema error at paths['/v1/example/a_bit_of_everything/echo/{value}'].get.responses['404']
should NOT have additional properties
additionalProperty: description, schema
Jump to line 63
Schema error at paths['/v1/example/a_bit_of_everything/echo/{value}'].get.responses['404'].schema
should match exactly one schema in oneOf
Jump to line 65
Schema error at paths['/v1/example/a_bit_of_everything/echo/{value}'].get.responses['404'].schema.type
should be equal to one of the allowed values
allowedValues: array, boolean, integer, null, number, object, string, file
Jump to line 66
Semantic error at paths./v1/example/a_bit_of_everything/{uuid}
Equivalent paths are not allowed.
Jump to line 422
Schema error at paths['/v2/example/echo'].get.responses['404']
should NOT have additional properties
additionalProperty: description, schema
Jump to line 689
Schema error at paths['/v2/example/echo'].get.responses['404'].schema
should match exactly one schema in oneOf
Jump to line 691
Schema error at paths['/v2/example/echo'].get.responses['404'].schema.type
should be equal to one of the allowed values
allowedValues: array, boolean, integer, null, number, object, string, file
Jump to line 692
Schema error at paths['/v2/example/echo'].post.responses['404']
should NOT have additional properties
additionalProperty: description, schema
Jump to line 724
Schema error at paths['/v2/example/echo'].post.responses['404'].schema
should match exactly one schema in oneOf
Jump to line 726
Schema error at paths['/v2/example/echo'].post.responses['404'].schema.type
should be equal to one of the allowed values
allowedValues: array, boolean, integer, null, number, object, string, file
Jump to line 727

I wonder, what does their "should" actually mean? If it's a RFC-style "SHOULD", it's not critical.. but it reads like a "real" error though.

Contributor guide

Tech stack
gorest api
Domain
api
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of OpenAPI/Swagger specFamiliarity with gRPC gateway code generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
First, reproduce the validation errors using the Swagger editor with the given URL. The errors indicate that response objects for 404 status have description and schema properties not allowed by the schema definition. This suggests the generated response object is being treated as a $ref but has extra properties. Look at the protoc gen swagger plugin code that generates the OpenAPI specification, specifically how error responses (like 404) are defined. In the example file `a bit of everything.swagger.json`, examine the response objects around the reported lines. Understand whether the generator incorrectly includes description and schema directly when using a $ref, or if the schema type is missing. Check the equivalent paths error; it may be due to path parameter definitions. Consult the OpenAPI 2.0 specification for correct response structure. Propose a fix by adjusting the generator logic to produce valid response objects.