OpenAPI version 3 #72

notEthan · 2019-01-24T05:11:10Z

this is a big'un.

major refactors to abstract openapi features to OpenAPI classes namespaced under OpenAPI::V2 and OpenAPI::V3
introduce Scorpio::Request and Scorpio::Response, relying on gem ur to represent requests and responses.
OpenAPI::Operation (v2 and v3) may be used to run requests without ResourceBase

…:Document

…ration and V3::Operation. lib/scorpio/openapi/operation.rb will hold all Operation code. V2 and V3 only include Scorpio::OpenAPI::Operation, triggering the OpenAPI::Operation autoload, once all the classes are defined, by moving the include to the bottom of openapi.rb

…igurable attributes of an Operation

… and V3::Document. lib/scorpio/openapi/document.rb will hold all Document code.

…gurable attributes of a Document, with V2 and V3 modules as well

…penapi/operation.rb drop attr_writer for path and http_method, these shouldn't be settable

…enapi key

…ead of listing keys not expected to be operations - rely on the openapi spec to determine this

…ses (Configurables modules), and implement for V2 and V3

…onsScope

… (Configurables)

…nse instead of Ur::Response

…ied as json; handles text/plain; and returns unhandled media type bodies as text.

… path template vs other params

…le accessors in order to see what has been overridden

… ResourceBase inheritable accessors when these have been changed from their defaults

…edia_type schema

…han faraday_response

…est#run

…n as well as v2 and rest_description

…rams

…ware and faraday_response_middleware with proc faraday_builder

also use https links

notEthan force-pushed the openapi3 branch 6 times, most recently from 4cdc5cf to 3d7c729 Compare January 30, 2019 00:41

notEthan added 24 commits January 29, 2019 16:56

ensure openapi_document is a JSI::JSON::Node inside of a OpenAPI::V2:…

94b07a4

…:Document

depend on the latest jsi

38ef983

Scorpio::OpenAPI::Operation::Configurables will contain the many conf…

d48effa

…igurable attributes of an Operation

Scorpio::OpenAPI::Document module shares methods between V2::Document…

cdcc4e7

… and V3::Document. lib/scorpio/openapi/document.rb will hold all Document code.

Scorpio::OpenAPI::Document::Configurables will contain the many confi…

9ee7d6d

…gurable attributes of a Document, with V2 and V3 modules as well

Scorpio::OpenAPI::V2::Operation dev: mv instance methods to scorpio/o…

a39ec1f

…penapi/operation.rb drop attr_writer for path and http_method, these shouldn't be settable

ResourceBase set openapi_document to v2 or v3 depending on swagger/op…

c88ec57

…enapi key

ResourceBase select which path_item keys are operations by class inst…

a2e4ca8

…ead of listing keys not expected to be operations - rely on the openapi spec to determine this

OpenAPI::Document abstract base_url from ResourceBase to OpenAPI clas…

587dadb

…ses (Configurables modules), and implement for V2 and V3

class Scorpio::OpenAPI::V3::Server

5d2dcc4

OpenAPI::Vx::Document#base_url with servers and variables for v3

368e673

Scorpio::OpenAPI::Operation#path and #http_method (from V2::Operation)

c46214f

Scorpio::OpenAPI::Document#v2? and #v3?

eaa46ed

Scorpio::OpenAPI::Document#operations using Scorpio::OpenAPI::Operati…

af8e988

…onsScope

Scorpio::Request, Scorpio::Response initial (empty)

be2fbec

Scorpio::Request dev. so far mostly relating to getting the request url.

85499d6

Scorpio::Request configurable #query_params, used in the #path

31d3345

Operation#openapi_document

bb2cedf

Scorpio::Request#openapi_document

fc2b011

Scorpio::OpenAPI::Document#user_agent and Scorpio::Request#user_agent…

b1b07e8

… (Configurables)

Scorpio::Request#base_url

cc36525

Configurable Request #body and #headers

10d5c20

OpenAPI::Operation may have multiple request schemas in V3

ea83a42

notEthan added 27 commits January 29, 2019 16:56

Scorpio::Ur

3c92a89

Scorpio::Ur overrides #class_for_schema to instantiate Scorpio::Respo…

feacaa9

…nse instead of Ur::Response

Scorpio::Request#run initial

d33b747

Request headers specified in #run incorporate user_agent and media_type

3ca4bd5

Request #run_ur returns an Ur

5e5bd8b

Scorpio::Response #response_schema

7c17813

Scorpio::Response body_object parses json; handles empty body identif…

dd657fd

…ied as json; handles text/plain; and returns unhandled media type bodies as text.

Operation#run, #run_ur, #build_request

8b7a68e

Scorpio::ResourceBase faraday accessors look to the openapi document

c9e1639

ResourceBase#call_operation relies on Scorpio::Request

b553c0c

ResourceBase#call_operation better handling of request.path_params

2520b83

ResourceBase#call_operation refactor handling of call params used for…

1ea01cf

… path template vs other params

Scorpio::ResourceBase stores the default getter methods for inheritab…

33430b8

…le accessors in order to see what has been overridden

ResourceBase #call_operation overrides request configurables from the…

0898f16

… ResourceBase inheritable accessors when these have been changed from their defaults

ResourceBase response_schema for v3 from operation response content m…

b740992

…edia_type schema

ResourceBase#call_operation response instantiation

dde1c1d

keep track of the ur on ResourceBase and HTTPError instances rather t…

9b92700

…han faraday_response

ResourceBase use options['ur'] and its helpful #response_schema

f66775b

Scorpio::Ur#raise_on_http_error moved from ResourceBase, used in Requ…

2e4ee65

…est#run

small refactor ResourceBase#call_operation, response not really needed

89a6eb9

blog openapi 3

54a3edb

tests will be run against openapi v3 version of the blog specificatio…

1c2df53

…n as well as v2 and rest_description

test fix for changed error message regarding missing or empty path_pa…

4df5072

…rams

rm scorpio/util/faraday/response_media_type - no longer used

aabd1ba

OpenAPI configurables and ResourceBase replace faraday_request_middle…

2a6c43a

…ware and faraday_response_middleware with proc faraday_builder

request_media_type considers what media types are supported by scorpio

9b8e4d1

README indicates openapi v3 is supported.

d9387a8

also use https links

notEthan force-pushed the openapi3 branch from 3d7c729 to d9387a8 Compare January 30, 2019 00:57

notEthan merged commit d9387a8 into master Jan 30, 2019

notEthan deleted the openapi3 branch January 31, 2019 03:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OpenAPI version 3 #72

OpenAPI version 3 #72

notEthan commented Jan 24, 2019

OpenAPI version 3 #72

OpenAPI version 3 #72

Conversation

notEthan commented Jan 24, 2019