feat(openapi): Support OpenAPI 3.2. Deprecate Swagger 2.0

Author: asyrjasalo

README.md

@@ -4,14 +4,17 @@
 
 [Keyword Documentation](https://asyrjasalo.github.io/RESTinstance)
 
+Note: Since 1.7.0, Swagger (OpenAPI 2.0) support is deprecated,
+and will likely be removed in the future.
+
 ## Advantages
 
 1.  **RESTinstance relies on Robot Framework's language-agnostic, clean
     and minimal syntax, for API tests.** It is neither tied to any
     particular programming language nor development framework. Using
     RESTinstance requires little, if any, programming knowledge. It
     builts on long-term technologies with well established communities,
-    such as HTTP, JSON (Schema), Swagger/OpenAPI and Robot Framework.
+    such as HTTP, JSON (Schema), OpenAPI and Robot Framework.
 2.  **It validates JSON using JSON Schema, guiding you to write API
     tests to base on properties** rather than on specific values (e.g.
     "email must be valid" vs "email is foo@bar.com"). This approach
@@ -24,10 +27,9 @@
     and the schema gets more accurate by your tests.** Output the schema
     to a file and reuse it as expectations to test the other methods, as
     most of them respond similarly with only minor differences. Or
-    extend the schema further to a full Swagger spec (version 2.0 and
-    OpenAPI 3.0), which RESTinstance can test requests and
-    responses against. All this leads to reusability, getting great test
-    coverage with minimum number of keystrokes and very clean tests.
+    extend the schema further to a full OpenAPI spec, which RESTinstance can
+    test requests and responses against. All this leads to reusability, getting
+    great test coverage with minimum number of keystrokes and very clean tests.
 
 ## Installation
 
@@ -58,7 +60,7 @@ Documentation   Test data can be read from variables and files.
 ...             Using (enum) values in tests optional. Only type is required.
 ...             All the JSON Schema validation keywords are also supported.
 ...             Thus, there is no need to write any own validation logic.
-...             Not a long path from schemas to full Swagger/OpenAPI specs.
+...             Not a long path from schemas to full OpenAPI specs.
 ...             The persistence of the created instances is the test suite.
 ...             Use keyword `Rest instances` to output the created instances.
 
@@ -163,17 +165,15 @@ Contributors:
 
 We use following Python excellence under the hood:
 
-- [Flex](https://github.com/pipermerriam/flex), by Piper Merriam, for
-Swagger 2.0 validation
 - [GenSON](https://github.com/wolverdude/GenSON), by Jon "wolverdude"
 Wolverton, for JSON Schema generator
 - [jsonpath-ng](https://github.com/h2non/jsonpath-ng), by Tomas
 Aparicio and Kenneth Knowles, for handling JSONPath queries
 - [jsonschema](https://github.com/Julian/jsonschema), by Julian
 Berman, for JSON Schema validator
+- [openapi-core](https://github.com/python-openapi/openapi-core), by Artur Maciag
+et al., for OpenAPI validation
 - [pygments](http://pygments.org), by Georg Brandl et al., for JSON
 syntax coloring
 - [requests](https://github.com/requests/requests), by Kenneth Reitz
 et al., for making HTTP requests
-- [openapi-core](https://github.com/python-openapi/openapi-core), by Artur Maciag
-et al., for OpenAPI 3 validation

atest/spec_31_json.robot

@@ -0,0 +1,66 @@
+*** Settings ***
+Library           REST    localhost:8273/
+...               spec=${CURDIR}/swagger/spec_31.json
+
+*** Test Cases ***
+GET to existing
+    GET    /users/1    allow_redirects=${None}
+
+GET to non-existing
+    GET    /users/404    allow_redirects=true
+
+GET many
+    GET    /users    allow_redirects=false
+
+GET many with query "_limit"
+    GET    /users?_limit=10    allow_redirects=${False}
+
+GET many with invalid query
+    GET    /users?_invalid=query    timeout=2.0
+
+POST with invalid params
+    POST    /users    { "name": "Alexander James Murphy" }
+
+POST with valid params
+    POST    /users    { "id": 100, "name": "Alexander James Murphy" }
+
+POST with missing params
+    POST    /users
+
+PUT to non-existing
+    PUT    /users/2043
+
+PUT with invalid params
+    PUT    /users/100    { "id": 1801 }
+
+PUT with valid params
+    PUT    /users/100    { "address": { "city": "Delta City" } }
+
+PUT with missing params
+    PUT    /users/100
+
+PATCH to non-existing
+    PATCH    /users/2043
+
+PATCH with invalid params
+    PATCH    /users/100    { "nickname": "murph" }
+
+PATCH with valid params
+    PATCH    /users/100    { "username": "murph" }
+
+PATCH with missing params
+    PATCH    /users/100
+
+DELETE to non-existing
+    DELETE    /users/2043
+
+DELETE to existing
+    DELETE    /users/100
+
+DELETE to invalid, but with no validations
+    DELETE    /invalid    validate=false
+
+GET non-documented endpoint
+    Run Keyword And Expect Error
+    ...    Path not found for http://localhost:8273/nope
+    ...    GET    /nope

atest/spec_31_yaml.robot

@@ -0,0 +1,66 @@
+*** Settings ***
+Library           REST    localhost:8273/
+...               spec=${CURDIR}/swagger/spec_31.yaml
+
+*** Test Cases ***
+GET to existing
+    GET    /users/1    allow_redirects=${None}
+
+GET to non-existing
+    GET    /users/404    allow_redirects=true
+
+GET many
+    GET    /users    allow_redirects=false
+
+GET many with query "_limit"
+    GET    /users?_limit=10    allow_redirects=${False}
+
+GET many with invalid query
+    GET    /users?_invalid=query    timeout=2.0
+
+POST with invalid params
+    POST    /users    { "name": "Alexander James Murphy" }
+
+POST with valid params
+    POST    /users    { "id": 100, "name": "Alexander James Murphy" }
+
+POST with missing params
+    POST    /users
+
+PUT to non-existing
+    PUT    /users/2043
+
+PUT with invalid params
+    PUT    /users/100    { "id": 1801 }
+
+PUT with valid params
+    PUT    /users/100    { "address": { "city": "Delta City" } }
+
+PUT with missing params
+    PUT    /users/100
+
+PATCH to non-existing
+    PATCH    /users/2043
+
+PATCH with invalid params
+    PATCH    /users/100    { "nickname": "murph" }
+
+PATCH with valid params
+    PATCH    /users/100    { "username": "murph" }
+
+PATCH with missing params
+    PATCH    /users/100
+
+DELETE to non-existing
+    DELETE    /users/2043
+
+DELETE to existing
+    DELETE    /users/100
+
+DELETE to invalid, but with no validations
+    DELETE    /invalid    validate=false
+
+GET non-documented endpoint
+    Run Keyword And Expect Error
+    ...    Path not found for http://localhost:8273/nope
+    ...    GET    /nope

atest/spec_32_yaml.robot

@@ -0,0 +1,66 @@
+*** Settings ***
+Library           REST    localhost:8273/
+...               spec=${CURDIR}/swagger/spec_32.yaml
+
+*** Test Cases ***
+GET to existing
+    GET    /users/1    allow_redirects=${None}
+
+GET to non-existing
+    GET    /users/404    allow_redirects=true
+
+GET many
+    GET    /users    allow_redirects=false
+
+GET many with query "_limit"
+    GET    /users?_limit=10    allow_redirects=${False}
+
+GET many with invalid query
+    GET    /users?_invalid=query    timeout=2.0
+
+POST with invalid params
+    POST    /users    { "name": "Alexander James Murphy" }
+
+POST with valid params
+    POST    /users    { "id": 100, "name": "Alexander James Murphy" }
+
+POST with missing params
+    POST    /users
+
+PUT to non-existing
+    PUT    /users/2043
+
+PUT with invalid params
+    PUT    /users/100    { "id": 1801 }
+
+PUT with valid params
+    PUT    /users/100    { "address": { "city": "Delta City" } }
+
+PUT with missing params
+    PUT    /users/100
+
+PATCH to non-existing
+    PATCH    /users/2043
+
+PATCH with invalid params
+    PATCH    /users/100    { "nickname": "murph" }
+
+PATCH with valid params
+    PATCH    /users/100    { "username": "murph" }
+
+PATCH with missing params
+    PATCH    /users/100
+
+DELETE to non-existing
+    DELETE    /users/2043
+
+DELETE to existing
+    DELETE    /users/100
+
+DELETE to invalid, but with no validations
+    DELETE    /invalid    validate=false
+
+GET non-documented endpoint
+    Run Keyword And Expect Error
+    ...    Path not found for http://localhost:8273/nope
+    ...    GET    /nope