Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update OpenAPI 3.0 Specifications #15

Closed
wants to merge 1 commit into from
Closed

Update OpenAPI 3.0 Specifications #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
239 changes: 148 additions & 91 deletions openapi/billing_subscriptions_v1.json
View file
Open in desktop

Large diffs are not rendered by default.

210 changes: 145 additions & 65 deletions openapi/catalogs_products_v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -821,6 +821,48 @@
"issue"
]
},
"error_link_description": {
"title": "Link Description",
"description": "The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) information.",
"type": "object",
"required": [
"href",
"rel"
],
"properties": {
"href": {
"description": "The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.",
"type": "string",
"minLength": 0,
"maxLength": 20000,
"pattern": "^.*$"
},
"rel": {
"description": "The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).",
"type": "string",
"minLength": 0,
"maxLength": 100,
"pattern": "^.*$"
},
"method": {
"description": "The HTTP method required to make the related call.",
"type": "string",
"minLength": 3,
"maxLength": 7,
"pattern": "^[A-Z]*$",
"enum": [
"CONNECT",
"DELETE",
"GET",
"HEAD",
"OPTIONS",
"PATCH",
"POST",
"PUT"
]
}
}
},
"error_default": {
"description": "The default error response.",
"oneOf": [
Expand Down Expand Up @@ -855,8 +897,8 @@
},
"error_400": {
"type": "object",
"title": "400 Error",
"description": "Error response for 400",
"title": "Bad Request Error",
"description": "Request is not well-formed, syntactically incorrect, or violates schema.",
"properties": {
"name": {
"type": "string",
Expand All @@ -870,7 +912,7 @@
"Request is not well-formed, syntactically incorrect, or violates schema."
]
},
"issues": {
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error_details"
Expand All @@ -880,17 +922,21 @@
"type": "string",
"description": "The PayPal internal ID. Used for correlation purposes."
},
"information_link": {
"type": "string",
"description": "The information link, or URI, that shows detailed information about this error for the developer.",
"readOnly": true
"links": {
"description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).",
"type": "array",
"minItems": 0,
"maxItems": 10000,
"items": {
"$ref": "#/components/schemas/error_link_description"
}
}
}
},
"error_401": {
"type": "object",
"title": "401 Error",
"description": "Error response for 401",
"title": "Unauthorized Error",
"description": "Authentication failed due to missing Authorization header, or invalid authentication credentials.",
"properties": {
"name": {
"type": "string",
Expand All @@ -904,7 +950,7 @@
"Authentication failed due to missing authorization header, or invalid authentication credentials."
]
},
"issues": {
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error_details"
Expand All @@ -914,17 +960,21 @@
"type": "string",
"description": "The PayPal internal ID. Used for correlation purposes."
},
"information_link": {
"type": "string",
"description": "The information link, or URI, that shows detailed information about this error for the developer.",
"readOnly": true
"links": {
"description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).",
"type": "array",
"minItems": 0,
"maxItems": 10000,
"items": {
"$ref": "#/components/schemas/error_link_description"
}
}
}
},
"error_403": {
"type": "object",
"title": "403 Error",
"description": "Error response for 403",
"title": "Not Authorized Error",
"description": "The client is not authorized to access this resource, although it may have valid credentials. ",
"properties": {
"name": {
"type": "string",
Expand All @@ -938,7 +988,7 @@
"Authorization failed due to insufficient permissions."
]
},
"issues": {
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error_details"
Expand All @@ -948,17 +998,21 @@
"type": "string",
"description": "The PayPal internal ID. Used for correlation purposes."
},
"information_link": {
"type": "string",
"description": "The information link, or URI, that shows detailed information about this error for the developer.",
"readOnly": true
"links": {
"description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).",
"type": "array",
"minItems": 0,
"maxItems": 10000,
"items": {
"$ref": "#/components/schemas/error_link_description"
}
}
}
},
"error_404": {
"type": "object",
"title": "404 Error",
"description": "Error response for 404",
"title": "Not found Error",
"description": "The server has not found anything matching the request URI. This either means that the URI is incorrect or the resource is not available.",
"properties": {
"name": {
"type": "string",
Expand All @@ -972,7 +1026,7 @@
"The specified resource does not exist."
]
},
"issues": {
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error_details"
Expand All @@ -982,17 +1036,21 @@
"type": "string",
"description": "The PayPal internal ID. Used for correlation purposes."
},
"information_link": {
"type": "string",
"description": "The information link, or URI, that shows detailed information about this error for the developer.",
"readOnly": true
"links": {
"description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).",
"type": "array",
"minItems": 0,
"maxItems": 10000,
"items": {
"$ref": "#/components/schemas/error_link_description"
}
}
}
},
"error_409": {
"type": "object",
"title": "409 Error",
"description": "Error response for 409",
"title": "Resource Conflict Error",
"description": "The server has detected a conflict while processing this request.",
"properties": {
"name": {
"type": "string",
Expand All @@ -1006,7 +1064,7 @@
"The server has detected a conflict while processing this request."
]
},
"issues": {
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error_details"
Expand All @@ -1016,17 +1074,21 @@
"type": "string",
"description": "The PayPal internal ID. Used for correlation purposes."
},
"information_link": {
"type": "string",
"description": "The information link, or URI, that shows detailed information about this error for the developer.",
"readOnly": true
"links": {
"description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).",
"type": "array",
"minItems": 0,
"maxItems": 10000,
"items": {
"$ref": "#/components/schemas/error_link_description"
}
}
}
},
"error_415": {
"type": "object",
"title": "409 Error",
"description": "Error response for 415",
"title": "Unsupported Media Type Error",
"description": "The server does not support the request payload's media type.",
"properties": {
"name": {
"type": "string",
Expand All @@ -1040,7 +1102,7 @@
"The server does not support the request payload's media type."
]
},
"issues": {
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error_details"
Expand All @@ -1050,17 +1112,21 @@
"type": "string",
"description": "The PayPal internal ID. Used for correlation purposes."
},
"information_link": {
"type": "string",
"description": "The information link, or URI, that shows detailed information about this error for the developer.",
"readOnly": true
"links": {
"description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).",
"type": "array",
"minItems": 0,
"maxItems": 10000,
"items": {
"$ref": "#/components/schemas/error_link_description"
}
}
}
},
"error_422": {
"type": "object",
"title": "422 Error",
"description": "Error response for 422",
"title": "Unprocessable Entity Error",
"description": "The requested action cannot be performed and may require interaction with APIs or processes outside of the current request. This is distinct from a 500 response in that there are no systemic problems limiting the API from performing the request.",
"properties": {
"name": {
"type": "string",
Expand All @@ -1074,7 +1140,7 @@
"The requested action could not be performed, semantically incorrect, or failed business validation."
]
},
"issues": {
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error_details"
Expand All @@ -1084,17 +1150,21 @@
"type": "string",
"description": "The PayPal internal ID. Used for correlation purposes."
},
"information_link": {
"type": "string",
"description": "The information link, or URI, that shows detailed information about this error for the developer.",
"readOnly": true
"links": {
"description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).",
"type": "array",
"minItems": 0,
"maxItems": 10000,
"items": {
"$ref": "#/components/schemas/error_link_description"
}
}
}
},
"error_500": {
"type": "object",
"title": "500 Error",
"description": "Error response for 500",
"title": "Internal Server Error",
"description": "This is either a system or application error, and generally indicates that although the client appeared to provide a correct request, something unexpected has gone wrong on the server.",
"properties": {
"name": {
"type": "string",
Expand All @@ -1112,26 +1182,32 @@
"type": "string",
"description": "The PayPal internal ID. Used for correlation purposes."
},
"information_link": {
"type": "string",
"description": "The information link, or URI, that shows detailed information about this error for the developer.",
"enum": [
"https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR"
],
"readOnly": true
"links": {
"description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).",
"type": "array",
"minItems": 0,
"maxItems": 10000,
"items": {
"$ref": "#/components/schemas/error_link_description"
}
}
},
"example": {
"name": "INTERNAL_SERVER_ERROR",
"message": "An internal server error occurred.",
"debug_id": "90957fca61718",
"information_link": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR"
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR",
"rel": "information_link"
}
]
}
},
"error_503": {
"type": "object",
"title": "503 Error",
"description": "Error response for 503",
"title": "Service Unavailable Error",
"description": "The server is temporarily unable to handle the request, for example, because of planned maintenance or downtime.",
"properties": {
"name": {
"type": "string",
Expand All @@ -1149,10 +1225,14 @@
"type": "string",
"description": "The PayPal internal ID. Used for correlation purposes."
},
"information_link": {
"type": "string",
"description": "The information link, or URI, that shows detailed information about this error for the developer.",
"readOnly": true
"links": {
"description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).",
"type": "array",
"minItems": 0,
"maxItems": 10000,
"items": {
"$ref": "#/components/schemas/error_link_description"
}
}
},
"example": {
Expand Down
Loading