This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-kamelets-examples.git
commit 90fcc1e458fba59076a707a7341ca8e7a5275c3d
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Wed Mar 27 17:51:00 2024 +0100
CAMEL-20557: Rest DSL to use openapi spec directly
---
jbang/open-api-contract-first/README.md | 45 +
.../camel-mock/pet/123.json | 3 +
jbang/open-api-contract-first/petstore-v3.json | 1240 ++++++++++++++++++++
jbang/open-api-contract-first/petstore.camel.yaml | 3 +
4 files changed, 1291 insertions(+)
diff --git a/jbang/open-api-contract-first/README.md
b/jbang/open-api-contract-first/README.md
new file mode 100644
index 0000000..4017ab7
--- /dev/null
+++ b/jbang/open-api-contract-first/README.md
@@ -0,0 +1,45 @@
+# Open API contract-first example
+
+This example shows how to do _contrat first_ with Camel and OpenAPI.
+
+The `petstore-v3.json` is the OpenAPI contract which we want to implement with
Camel.
+
+## Petstore example
+
+Run the examples running
+
+```
+camel run petstore-v3.json pet.camel.yaml
+```
+
+Or run via:
+
+```
+camel run *
+```
+
+
+Then you can test by calling to get pet with id 123:
+
+```
+$ curl -i http://localhost:8080/api/v3/pet/123
+HTTP/1.1 200 OK
+Accept: */*
+User-Agent: curl/8.1.2
+transfer-encoding: chunked
+Content-Type: application/json
+
+{
+ "pet": "donald the dock"
+}
+```
+
+## Dummy data
+
+The example will return an empty response if you request non implemented API
endpoints.
+The petstore has 18 apis, and this example has none implemented.
+
+The returned response is loaded from disk in the `camel-mock` folder, as you
can see it has pet/123.json as a file,
+that will be returned when you call `/api/v3/pet/123`.
+
+
diff --git a/jbang/open-api-contract-first/camel-mock/pet/123.json
b/jbang/open-api-contract-first/camel-mock/pet/123.json
new file mode 100644
index 0000000..9c7739d
--- /dev/null
+++ b/jbang/open-api-contract-first/camel-mock/pet/123.json
@@ -0,0 +1,3 @@
+{
+ "pet": "donald the dock"
+}
\ No newline at end of file
diff --git a/jbang/open-api-contract-first/petstore-v3.json
b/jbang/open-api-contract-first/petstore-v3.json
new file mode 100644
index 0000000..b03f018
--- /dev/null
+++ b/jbang/open-api-contract-first/petstore-v3.json
@@ -0,0 +1,1240 @@
+{
+ "openapi": "3.0.2",
+ "info": {
+ "title": "Swagger Petstore - OpenAPI 3.0",
+ "description": "This is a sample Pet Store Server based on the
OpenAPI 3.0 specification. You can find out more about\nSwagger at
[http://swagger.io](http://swagger.io). In the third iteration of the pet
store, we've switched to the design first approach!\nYou can now help us
improve the API whether it's by making changes to the definition itself or to
the code.\nThat way, with time, we can improve the API in general, and expose
some of the new features in OAS3.\n\nSome useful links:\ [...]
+ "termsOfService": "http://swagger.io/terms/";,
+ "contact": {
+ "email": "apit...@swagger.io"
+ },
+ "license": {
+ "name": "Apache 2.0",
+ "url": "http://www.apache.org/licenses/LICENSE-2.0.html";
+ },
+ "version": "1.0.4"
+ },
+ "externalDocs": {
+ "description": "Find out more about Swagger",
+ "url": "http://swagger.io";
+ },
+ "servers": [
+ {
+ "url": "{scheme}://{host}/{basePath}",
+ "variables": {
+ "scheme": {
+ "enum": [
+ "https",
+ "http"
+ ],
+ "default": "https"
+ },
+ "host": {
+ "default": "petstore3.swagger.io"
+ },
+ "basePath": {
+ "default": "/api/v3"
+ }
+ }
+ }
+ ],
+ "tags": [
+ {
+ "name": "pet",
+ "description": "Everything about your Pets",
+ "externalDocs": {
+ "description": "Find out more",
+ "url": "http://swagger.io";
+ }
+ },
+ {
+ "name": "store",
+ "description": "Operations about user"
+ },
+ {
+ "name": "user",
+ "description": "Access to Petstore orders",
+ "externalDocs": {
+ "description": "Find out more about our store",
+ "url": "http://swagger.io";
+ }
+ }
+ ],
+ "paths": {
+ "/pet": {
+ "put": {
+ "tags": [
+ "pet"
+ ],
+ "summary": "Update an existing pet",
+ "description": "Update an existing pet by Id",
+ "operationId": "updatePet",
+ "requestBody": {
+ "description": "Update an existent pet
in the store",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ },
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ },
+
"application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successful
operation",
+ "content": {
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid ID
supplied"
+ },
+ "404": {
+ "description": "Pet not found"
+ },
+ "405": {
+ "description": "Validation
exception"
+ }
+ },
+ "security": [
+ {
+ "petstore_auth": [
+ "write:pets",
+ "read:pets"
+ ]
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "pet"
+ ],
+ "summary": "Add a new pet to the store",
+ "description": "Add a new pet to the store",
+ "operationId": "addPet",
+ "requestBody": {
+ "description": "Create a new pet in the
store",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ },
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ },
+
"application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Successful
operation",
+ "content": {
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Invalid input"
+ }
+ },
+ "security": [
+ {
+ "petstore_auth": [
+ "write:pets",
+ "read:pets"
+ ]
+ }
+ ]
+ }
+ },
+ "/pet/findByStatus": {
+ "get": {
+ "tags": [
+ "pet"
+ ],
+ "summary": "Finds Pets by status",
+ "description": "Multiple status values can be
provided with comma separated strings",
+ "operationId": "findPetsByStatus",
+ "parameters": [
+ {
+ "name": "status",
+ "in": "query",
+ "description": "Status values
that need to be considered for filter",
+ "required": false,
+ "explode": true,
+ "schema": {
+ "type": "string",
+ "default": "available",
+ "enum": [
+ "available",
+ "pending",
+ "sold"
+ ]
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "successful
operation",
+ "content": {
+ "application/xml": {
+ "schema": {
+ "type":
"array",
+
"items": {
+
"$ref": "#/components/schemas/Pet"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type":
"array",
+
"items": {
+
"$ref": "#/components/schemas/Pet"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid status
value"
+ }
+ },
+ "security": [
+ {
+ "petstore_auth": [
+ "write:pets",
+ "read:pets"
+ ]
+ }
+ ]
+ }
+ },
+ "/pet/findByTags": {
+ "get": {
+ "tags": [
+ "pet"
+ ],
+ "summary": "Finds Pets by tags",
+ "description": "Multiple tags can be provided
with comma separated strings. Use tag1, tag2, tag3 for testing.",
+ "operationId": "findPetsByTags",
+ "parameters": [
+ {
+ "name": "tags",
+ "in": "query",
+ "description": "Tags to filter
by",
+ "required": false,
+ "explode": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "successful
operation",
+ "content": {
+ "application/xml": {
+ "schema": {
+ "type":
"array",
+
"items": {
+
"$ref": "#/components/schemas/Pet"
+ }
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type":
"array",
+
"items": {
+
"$ref": "#/components/schemas/Pet"
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid tag
value"
+ }
+ },
+ "security": [
+ {
+ "petstore_auth": [
+ "write:pets",
+ "read:pets"
+ ]
+ }
+ ]
+ }
+ },
+ "/pet/{petId}": {
+ "get": {
+ "tags": [
+ "pet"
+ ],
+ "summary": "Find pet by ID",
+ "description": "Returns a single pet",
+ "operationId": "getPetById",
+ "parameters": [
+ {
+ "name": "petId",
+ "in": "path",
+ "description": "ID of pet to
return",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "successful
operation",
+ "content": {
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid ID
supplied"
+ },
+ "404": {
+ "description": "Pet not found"
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ },
+ {
+ "petstore_auth": [
+ "write:pets",
+ "read:pets"
+ ]
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "pet"
+ ],
+ "summary": "Updates a pet in the store with
form data",
+ "description": "",
+ "operationId": "updatePetWithForm",
+ "parameters": [
+ {
+ "name": "petId",
+ "in": "path",
+ "description": "ID of pet that
needs to be updated",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "name",
+ "in": "query",
+ "description": "Name of pet
that needs to be updated",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "status",
+ "in": "query",
+ "description": "Status of pet
that needs to be updated",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "405": {
+ "description": "Invalid input"
+ }
+ },
+ "security": [
+ {
+ "petstore_auth": [
+ "write:pets",
+ "read:pets"
+ ]
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "pet"
+ ],
+ "summary": "Deletes a pet",
+ "description": "",
+ "operationId": "deletePet",
+ "parameters": [
+ {
+ "name": "api_key",
+ "in": "header",
+ "description": "",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "petId",
+ "in": "path",
+ "description": "Pet id to
delete",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "400": {
+ "description": "Invalid pet
value"
+ }
+ },
+ "security": [
+ {
+ "petstore_auth": [
+ "write:pets",
+ "read:pets"
+ ]
+ }
+ ]
+ }
+ },
+ "/pet/{petId}/uploadImage": {
+ "post": {
+ "tags": [
+ "pet"
+ ],
+ "summary": "uploads an image",
+ "description": "",
+ "operationId": "uploadFile",
+ "parameters": [
+ {
+ "name": "petId",
+ "in": "path",
+ "description": "ID of pet to
update",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "additionalMetadata",
+ "in": "query",
+ "description": "Additional
Metadata",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/octet-stream": {
+ "schema": {
+ "type":
"string",
+ "format":
"binary"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "successful
operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/ApiResponse"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "petstore_auth": [
+ "write:pets",
+ "read:pets"
+ ]
+ }
+ ]
+ }
+ },
+ "/store/inventory": {
+ "get": {
+ "tags": [
+ "store"
+ ],
+ "summary": "Returns pet inventories by status",
+ "description": "Returns a map of status codes
to quantities",
+ "operationId": "getInventory",
+ "responses": {
+ "200": {
+ "description": "successful
operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type":
"object",
+
"additionalProperties": {
+
"type": "integer",
+
"format": "int32"
+ }
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_key": []
+ }
+ ]
+ }
+ },
+ "/store/order": {
+ "post": {
+ "tags": [
+ "store"
+ ],
+ "summary": "Place an order for a pet",
+ "description": "Place a new order in the store",
+ "operationId": "placeOrder",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/Order"
+ }
+ },
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/Order"
+ }
+ },
+
"application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref":
"#/components/schemas/Order"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "successful
operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/Order"
+ }
+ }
+ }
+ },
+ "405": {
+ "description": "Invalid input"
+ }
+ }
+ }
+ },
+ "/store/order/{orderId}": {
+ "get": {
+ "tags": [
+ "store"
+ ],
+ "summary": "Find purchase order by ID",
+ "description": "For valid response try integer
IDs with value <= 5 or > 10. Other values will generated exceptions",
+ "operationId": "getOrderById",
+ "parameters": [
+ {
+ "name": "orderId",
+ "in": "path",
+ "description": "ID of order
that needs to be fetched",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "successful
operation",
+ "content": {
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/Order"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/Order"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid ID
supplied"
+ },
+ "404": {
+ "description": "Order not found"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "store"
+ ],
+ "summary": "Delete purchase order by ID",
+ "description": "For valid response try integer
IDs with value < 1000. Anything above 1000 or nonintegers will generate API
errors",
+ "operationId": "deleteOrder",
+ "parameters": [
+ {
+ "name": "orderId",
+ "in": "path",
+ "description": "ID of the order
that needs to be deleted",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ ],
+ "responses": {
+ "400": {
+ "description": "Invalid ID
supplied"
+ },
+ "404": {
+ "description": "Order not found"
+ }
+ }
+ }
+ },
+ "/user": {
+ "post": {
+ "tags": [
+ "user"
+ ],
+ "summary": "Create user",
+ "description": "This can only be done by the
logged in user.",
+ "operationId": "createUser",
+ "requestBody": {
+ "description": "Created user object",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/User"
+ }
+ },
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/User"
+ }
+ },
+
"application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref":
"#/components/schemas/User"
+ }
+ }
+ }
+ },
+ "responses": {
+ "default": {
+ "description": "successful
operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/User"
+ }
+ },
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/User"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/user/createWithList": {
+ "post": {
+ "tags": [
+ "user"
+ ],
+ "summary": "Creates list of users with given
input array",
+ "description": "Creates list of users with
given input array",
+ "operationId": "createUsersWithListInput",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref":
"#/components/schemas/User"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful
operation",
+ "content": {
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/User"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/User"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "successful
operation"
+ }
+ }
+ }
+ },
+ "/user/login": {
+ "get": {
+ "tags": [
+ "user"
+ ],
+ "summary": "Logs user into the system",
+ "description": "",
+ "operationId": "loginUser",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "query",
+ "description": "The user name
for login",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "password",
+ "in": "query",
+ "description": "The password
for login in clear text",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "successful
operation",
+ "headers": {
+ "X-Rate-Limit": {
+ "description":
"calls per hour allowed by the user",
+ "schema": {
+ "type":
"integer",
+
"format": "int32"
+ }
+ },
+ "X-Expires-After": {
+ "description":
"date in UTC when toekn expires",
+ "schema": {
+ "type":
"string",
+
"format": "date-time"
+ }
+ }
+ },
+ "content": {
+ "application/xml": {
+ "schema": {
+ "type":
"string"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "type":
"string"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid
username/password supplied"
+ }
+ }
+ }
+ },
+ "/user/logout": {
+ "get": {
+ "tags": [
+ "user"
+ ],
+ "summary": "Logs out current logged in user
session",
+ "description": "",
+ "operationId": "logoutUser",
+ "parameters": [],
+ "responses": {
+ "default": {
+ "description": "successful
operation"
+ }
+ }
+ }
+ },
+ "/user/{username}": {
+ "get": {
+ "tags": [
+ "user"
+ ],
+ "summary": "Get user by user name",
+ "description": "",
+ "operationId": "getUserByName",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "description": "The name that
needs to be fetched. Use user1 for testing. ",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "successful
operation",
+ "content": {
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/User"
+ }
+ },
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/User"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid
username supplied"
+ },
+ "404": {
+ "description": "User not found"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "user"
+ ],
+ "summary": "Update user",
+ "description": "This can only be done by the
logged in user.",
+ "operationId": "updateUser",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "description": "name that need
to be deleted",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Update an existent user
in the store",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/User"
+ }
+ },
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/User"
+ }
+ },
+
"application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref":
"#/components/schemas/User"
+ }
+ }
+ }
+ },
+ "responses": {
+ "default": {
+ "description": "successful
operation"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "user"
+ ],
+ "summary": "Delete user",
+ "description": "This can only be done by the
logged in user.",
+ "operationId": "deleteUser",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "path",
+ "description": "The name that
needs to be deleted",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "400": {
+ "description": "Invalid
username supplied"
+ },
+ "404": {
+ "description": "User not found"
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Order": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 10
+ },
+ "petId": {
+ "type": "integer",
+ "format": "int64",
+ "example": 198772
+ },
+ "quantity": {
+ "type": "integer",
+ "format": "int32",
+ "example": 7
+ },
+ "shipDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "description": "Order Status",
+ "example": "approved",
+ "enum": [
+ "placed",
+ "approved",
+ "delivered"
+ ]
+ },
+ "complete": {
+ "type": "boolean"
+ }
+ },
+ "xml": {
+ "name": "order"
+ }
+ },
+ "Customer": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 100000
+ },
+ "username": {
+ "type": "string",
+ "example": "fehguy"
+ },
+ "address": {
+ "type": "array",
+ "xml": {
+ "name": "addresses",
+ "wrapped": true
+ },
+ "items": {
+ "$ref":
"#/components/schemas/Address"
+ }
+ }
+ },
+ "xml": {
+ "name": "customer"
+ }
+ },
+ "Address": {
+ "type": "object",
+ "properties": {
+ "street": {
+ "type": "string",
+ "example": "437 Lytton"
+ },
+ "city": {
+ "type": "string",
+ "example": "Palo Alto"
+ },
+ "state": {
+ "type": "string",
+ "example": "CA"
+ },
+ "zip": {
+ "type": "string",
+ "example": "94301"
+ }
+ },
+ "xml": {
+ "name": "address"
+ }
+ },
+ "Category": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1
+ },
+ "name": {
+ "type": "string",
+ "example": "Dogs"
+ }
+ },
+ "xml": {
+ "name": "category"
+ }
+ },
+ "User": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 10
+ },
+ "username": {
+ "type": "string",
+ "example": "theUser"
+ },
+ "firstName": {
+ "type": "string",
+ "example": "John"
+ },
+ "lastName": {
+ "type": "string",
+ "example": "James"
+ },
+ "email": {
+ "type": "string",
+ "example": "j...@email.com"
+ },
+ "password": {
+ "type": "string",
+ "example": "12345"
+ },
+ "phone": {
+ "type": "string",
+ "example": "12345"
+ },
+ "userStatus": {
+ "type": "integer",
+ "description": "User Status",
+ "format": "int32",
+ "example": 1
+ }
+ },
+ "xml": {
+ "name": "user"
+ }
+ },
+ "Tag": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "xml": {
+ "name": "tag"
+ }
+ },
+ "Pet": {
+ "required": [
+ "name",
+ "photoUrls"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "example": 10
+ },
+ "name": {
+ "type": "string",
+ "example": "doggie"
+ },
+ "category": {
+ "$ref":
"#/components/schemas/Category"
+ },
+ "photoUrls": {
+ "type": "array",
+ "xml": {
+ "wrapped": true
+ },
+ "items": {
+ "type": "string",
+ "xml": {
+ "name":
"photoUrl"
+ }
+ }
+ },
+ "tags": {
+ "type": "array",
+ "xml": {
+ "wrapped": true
+ },
+ "items": {
+ "$ref":
"#/components/schemas/Tag"
+ }
+ },
+ "status": {
+ "type": "string",
+ "description": "pet status in
the store",
+ "enum": [
+ "available",
+ "pending",
+ "sold"
+ ]
+ }
+ },
+ "xml": {
+ "name": "pet"
+ }
+ },
+ "ApiResponse": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "type": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "xml": {
+ "name": "##default"
+ }
+ }
+ },
+ "requestBodies": {
+ "Pet": {
+ "description": "Pet object that needs to be
added to the store",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ },
+ "application/xml": {
+ "schema": {
+ "$ref":
"#/components/schemas/Pet"
+ }
+ }
+ }
+ },
+ "UserArray": {
+ "description": "List of user object",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref":
"#/components/schemas/User"
+ }
+ }
+ }
+ }
+ }
+ },
+ "securitySchemes": {
+ "petstore_auth": {
+ "type": "oauth2",
+ "flows": {
+ "implicit": {
+ "authorizationUrl":
"https://petstore3.swagger.io/oauth/authorize";,
+ "scopes": {
+ "write:pets": "modify
pets in your account",
+ "read:pets": "read your
pets"
+ }
+ }
+ }
+ },
+ "api_key": {
+ "type": "apiKey",
+ "name": "api_key",
+ "in": "header"
+ }
+ }
+ }
+}
diff --git a/jbang/open-api-contract-first/petstore.camel.yaml
b/jbang/open-api-contract-first/petstore.camel.yaml
new file mode 100644
index 0000000..fbd1fc3
--- /dev/null
+++ b/jbang/open-api-contract-first/petstore.camel.yaml
@@ -0,0 +1,3 @@
+- rest:
+ openApi:
+ specification: petstore-v3.json
