Swagger Doc annotations issue. Skip a variable
Ritwick Gupta
Ron
--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Ritwick Gupta
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
Ritwick Gupta
Ron
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
Ritwick Gupta
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsubscri...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Ron
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
Ritwick Gupta
Ron
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
Ritwick Gupta
{
"apiVersion": "1.0.0",
"swaggerVersion": "1.2",
"basePath": "https://xxxx-prod.apigee.net/v1",
"resourcePath": "/stores/{id}/orders",
"produces": ["application/json", "application/xml"],
"apis": [{
"path": "/stores/{id}/orders",
"operations": [{
"method": "GET",
"summary": "Retrieve a list of orders for the requested store ID",
"notes": "",
"type": "OrderListResponse",
"nickname": "getStoreOrders",
"authorizations": {},
"parameters": [{
"name": "id",
"description": "The ID of the store to retrieve",
"required": true,
"type": "string",
"paramType": "path",
"allowMultiple": false
}, {
"name": "apikey",
"description": "API consumer key",
"required": true,
"type": "string",
"paramType": "query",
"allowMultiple": false
}, {
"name": "fields",
"description": "Comma separated list of fields to return",
"required": false,
"type": "string",
"paramType": "query",
"allowMultiple": false
}, {
"name": "offset",
"description": "Number of records to offset before returning first record",
"defaultValue": "0",
"required": false,
"type": "string",
"paramType": "query",
"allowMultiple": false
}, {
"name": "limit",
"description": "Number of records to return",
"defaultValue": "10",
"required": false,
"type": "string",
"paramType": "query",
"allowMultiple": false
}],
"responseMessages": [{
"code": 401,
"message": "This IP address has been blocked. Please contact xxxx support at sup...@xxxx.com.",
"responseModel": "errors"
}, {
"code": 401,
"message": "The provided credentials were invalid. Please provide a valid API username and key.",
"responseModel": "errors"
}, {
"code": 401,
"message": "This IP address has not been setup to make API requests.",
"responseModel": "errors"
}, {
"code": 403,
"message": "The provided user must accept the Terms and Conditions before you are able to make API requests.",
"responseModel": "errors"
}, {
"code": 404,
"message": "The requested store ID was not found.",
"responseModel": "errors"
}]
}]
}, {
"path": "/stores/{id}/orders/{order_id}",
"operations": [{
"method": "GET",
"summary": "Retrieve an order identified by its unique ID",
"notes": "",
"type": "OrderResponse",
"nickname": "getStoreOrder",
"authorizations": {},
"parameters": [{
"name": "id",
"description": "The ID of the store to retrieve",
"required": true,
"type": "string",
"paramType": "path",
"allowMultiple": false
}, {
"name": "order_id",
"description": "The ID of the order to retrieve",
"required": true,
"type": "string",
"paramType": "path",
"allowMultiple": false
}, {
"name": "apikey",
"description": "API consumer key",
"required": true,
"type": "string",
"paramType": "query",
"allowMultiple": false
}, {
"name": "fields",
"description": "Comma separated list of fields to return",
"required": false,
"type": "string",
"paramType": "query",
"allowMultiple": false
}],
"responseMessages": [{
"code": 401,
"message": "This IP address has been blocked. Please contact xxxx support at sup...@xxxx.com.",
"responseModel": "errors"
}, {
"code": 401,
"message": "The provided credentials were invalid. Please provide a valid API username and key.",
"responseModel": "errors"
}, {
"code": 401,
"message": "This IP address has not been setup to make API requests.",
"responseModel": "errors"
}, {
"code": 403,
"message": "The provided user must accept the Terms and Conditions before you are able to make API requests.",
"responseModel": "errors"
}, {
"code": 404,
"message": "The requested store ID was not found.",
"responseModel": "errors"
}, {
"code": 404,
"message": "The requested order ID was not found.",
"responseModel": "errors"
}]
}]
}, {
"path": "/stores/{id}/orders/calculate",
"operations": [{
"method": "POST",
"summary": "Validate and calculate an order for the store identified by ID",
"notes": "Need Something Here",
"type": "OrderResponse",
"nickname": "calculateOrder",
"authorizations": {},
"parameters": [{
"name": "id",
"description": "The ID of the store to submit the order to",
"required": true,
"type": "string",
"paramType": "path",
"allowMultiple": false
}, {
"name": "check_location",
"description": "Check location to a Order type delivery",
"required": false,
"type": "boolean",
"paramType": "query",
"allowMultiple": false
}, {
"name": "apikey",
"description": "API consumer key",
"required": true,
"type": "string",
"paramType": "query",
"allowMultiple": false
}, {
"name": "body",
"description": "The Order to submit to the point of sale system.",
"required": true,
"type": "Order",
"paramType": "body",
"allowMultiple": false
}],
"responseMessages": [{
"code": 401,
"message": "This IP address has been blocked. Please contact xxxx support at sup...@xxxx.com.",
"responseModel": "errors"
}, {
"code": 401,
"message": "The provided credentials were invalid. Please provide a valid API username and key.",
"responseModel": "errors"
}, {
"code": 401,
"message": "This IP address has not been setup to make API requests.",
"responseModel": "errors"
}, {
"code": 403,
"message": "The provided user must accept the Terms and Conditions before you are able to make API requests.",
"responseModel": "errors"
}, {
"code": 404,
"message": "The requested store ID was not found.",
"responseModel": "errors"
}]
}]
}, {
"path": "/stores/{id}/orders/create",
"operations": [{
"method": "POST",
"summary": "Submit an order down the point of sale system for the store identified by ID",
"notes": "Need Something Here",
"type": "OrderResponse",
"nickname": "createOrder",
"authorizations": {},
"parameters": [{
"name": "id",
"description": "The ID of the store to submit the order to",
"required": true,
"type": "string",
"paramType": "path",
"allowMultiple": false
}, {
"name": "apikey",
"description": "API consumer key",
"required": true,
"type": "string",
"paramType": "query",
"allowMultiple": false
}, {
"name": "body",
"description": "The Order to submit to the point of sale system.",
"required": true,
"type": "Order",
"paramType": "body",
"allowMultiple": false
}],
"responseMessages": [{
"code": 401,
"message": "This IP address has been blocked. Please contact xxxx support at sup...@xxxx.com.",
"responseModel": "errors"
}, {
"code": 401,
"message": "The provided credentials were invalid. Please provide a valid API username and key.",
"responseModel": "errors"
}, {
"code": 401,
"message": "This IP address has not been setup to make API requests.",
"responseModel": "errors"
}, {
"code": 403,
"message": "The provided user must accept the Terms and Conditions before you are able to make API requests.",
"responseModel": "errors"
}, {
"code": 404,
"message": "The requested store ID was not found.",
"responseModel": "errors"
}]
}]
}],
"models": {
"order_payment": {
"id": "order_payment",
"properties": {
"payment_type": {
"type": "string"
},
"payment_tendered": {
"type": "number",
"format": "double"
},
"credit_card": {
"$ref": "CreditCard"
}
}
},
"CreditCard": {
"id": "CreditCard",
"properties": {
"card_type": {
"type": "string"
},
"card_number": {
"type": "string"
},
"expire_year": {
"type": "string"
},
"expire_month": {
"type": "string"
},
"cvv2": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"billing_address": {
"$ref": "Address"
}
}
},
"Address": {
"id": "Address",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"suite_number": {
"type": "string"
},
"street_number": {
"type": "string"
},
"street": {
"type": "string"
},
"city": {
"type": "string"
},
"province_state": {
"type": "string"
},
"postal_zip": {
"type": "string"
},
"country": {
"type": "string"
},
"nickname": {
"type": "string"
},
"notes": {
"type": "string"
},
"default": {
"type": "boolean"
}
}
},
"PhoneNumber": {
"id": "PhoneNumber",
"properties": {
"type": {
"type": "string"
},
"area_code": {
"type": "string"
},
"number": {
"type": "string"
}
}
},
"OrderResponse": {
"id": "OrderResponse",
"properties": {
"order": {
"$ref": "Order"
}
}
},
"errors": {
"id": "errors",
"properties": {
"error": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "error"
}
}
}
},
"CustomerInfo": {
"id": "CustomerInfo",
"properties": {
"customer_id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"gender": {
"type": "string"
},
"birth_date": {
"type": "string"
},
"email_address": {
"type": "string"
},
"phone_number": {
"$ref": "PhoneNumber"
},
"address": {
"$ref": "Address"
},
"guest": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"password": {
"type": "string"
},
"opt_in": {
"type": "boolean"
},
"link": {
"type": "array",
"items": {
"$ref": "Link"
}
}
}
},
"error": {
"id": "error",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"httpCode": {
"type": "string"
}
}
},
"OrderItem": {
"id": "OrderItem",
"properties": {
"menu_item_id": {
"type": "string"
},
"menu_item_name": {
"type": "string"
},
"line_number": {
"type": "integer",
"format": "int32"
},
"notes": {
"type": "string"
},
"quantity": {
"type": "string"
},
"variant_id": {
"type": "string"
},
"variant_name": {
"type": "string"
},
"total": {
"type": "number",
"format": "double"
},
"content": {
"type": "array",
"items": {
"$ref": "OrderItemContent"
}
}
}
},
"OrderAmount": {
"id": "OrderAmount",
"properties": {
"name": {
"type": "string"
},
"amount": {
"type": "number",
"format": "double"
}
}
},
"Order": {
"id": "Order",
"description": "",
"properties": {
"order_id": {
"type": "string"
},
"pos_id": {
"type": "string"
},
"external_id": {
"type": "string"
},
"order_number": {
"type": "string"
},
"order_type": {
"type": "string"
},
"order_status": {
"$ref": "OrderStatus",
"enum": ["BEING_PREPARED", "READY", "OUT_FOR_DELIVERY", "BAD_ORDER_CANCELLED", "UNPROCESSED", "PROCESSED", "ERROR"]
},
"order_date": {
"type": "string",
"format": "date-time"
},
"required_date": {
"type": "string",
"format": "date-time"
},
"quoted_time": {
"type": "string"
},
"customer": {
"$ref": "CustomerInfo"
},
"delivery_address": {
"$ref": "Address"
},
"delivery_instructions": {
"type": "string"
},
"percent_discount": {
"type": "number",
"format": "double"
},
"subtotal": {
"type": "number",
"format": "double"
},
"total_tax": {
"type": "number",
"format": "double"
},
"final_total": {
"type": "number",
"format": "double"
},
"externalPayment": {
"$ref": "ExternalPayment"
},
"order_item": {
"type": "array",
"items": {
"$ref": "OrderItem"
}
},
"order_special": {
"type": "array",
"items": {
"$ref": "SpecialOrderItem"
}
},
"order_payment": {
"type": "array",
"items": {
"$ref": "order_payment"
}
},
"order_credit": {
"type": "array",
"items": {
"$ref": "OrderAmount"
}
},
"order_charge": {
"type": "array",
"items": {
"$ref": "OrderAmount"
}
}
}
},
"SpecialOrderItem": {
"id": "SpecialOrderItem",
"properties": {
"order_item_id": {
"type": "string"
},
"quantity": {
"type": "string"
},
"total": {
"type": "number",
"format": "double"
},
"item": {
"type": "array",
"items": {
"$ref": "OrderItem"
}
}
}
},
"OrderItemContent": {
"id": "OrderItemContent",
"properties": {
"modifier_id": {
"type": "string"
},
"modifier_name": {
"type": "string"
},
"portion_id": {
"type": "string"
},
"portion_name": {
"type": "string"
},
"amount_id": {
"type": "string"
},
"amount_name": {
"type": "string"
}
}
},
"ExternalPayment": {
"id": "ExternalPayment",
"properties": {
"merchantVendor": {
"type": "string"
},
"customerName": {
"type": "string"
},
"amount": {
"type": "string"
},
"expDate": {
"type": "string"
},
"currency": {
"type": "string"
},
"authCode": {
"type": "string"
},
"authStatus": {
"type": "string"
},
"avsStatus": {
"type": "string"
},
"cvvStatus": {
"type": "string"
},
"invoice": {
"type": "string"
},
"memo": {
"type": "string"
},
"token": {
"type": "string"
},
"cardType": {
"type": "string"
},
"maskedAccount": {
"type": "string"
},
"merchantReferenceCode": {
"type": "string"
},
"acqRefData": {
"type": "string"
},
"processData": {
"type": "string"
},
"statusMessage": {
"type": "string"
}
}
},
"OrderListResponse": {
"id": "OrderListResponse",
"properties": {
"metadata": {
"$ref": "ApiListMetadata"
},
"order": {
"type": "array",
"items": {
"$ref": "Order"
}
}
}
},
"Link": {
"id": "Link",
"properties": {
"rel": {
"type": "string"
},
"href": {
"type": "string"
}
}
},
"ApiListMetadata": {
"id": "ApiListMetadata",
"properties": {
"offset": {
"type": "integer",
"format": "int32"
},
"limit": {
"type": "integer",
"format": "int32"
},
"total": {
"type": "integer",
"format": "int32"
Ron
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
Ritwick Gupta
...
tony tam
Sure
...&nbs