Wala shell

Advanced PHP File Manager

Server IP: 127.0.0.1 | PHP Version: 8.3.30 | Domains Hosted: 54

Name	Size	Last Modified
📁 ..	-	2025-05-25 12:27
📄 bitbucket.json { "info": { "termsOfService": "https://www.atlassian.com/end-user-agreement", "version": "2.0", "contact": { "url": "https://bitbucket.org/support", "name": "Bitbucket Support", "email": "support@bitbucket.org" }, "description": "Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework.", "title": "Bitbucket API" }, "paths": { "/repositories/{username}/{repo_slug}/refs/branches/{name}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "name", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "refs" ] } }, "/teams/{username}/following": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" } ], "get": { "security": [ { "oauth2": [ "account" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the list of accounts this team is following.", "responses": { "200": { "description": "A paginated list of user objects.", "schema": { "$ref": "#/definitions/paginated_users" } }, "404": { "description": "If no team exists for the specified name, or if the specified account is a personal account, not a team account.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The team's username", "name": "username", "in": "path" } ], "tags": [ "teams" ] } }, "/repositories/{username}/{repo_slug}/commit/{sha}/comments/{comment_id}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "sha", "in": "path" }, { "required": true, "type": "string", "name": "comment_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the specified commit comment.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "commits" ] } }, "/repositories/{username}/{repo_slug}/hooks": { "post": { "security": [ { "oauth2": [ "webhook" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Creates a new webhook on the specified repository.", "responses": { "201": { "description": "If the webhook was registered successfully.", "schema": { "$ref": "#/definitions/webhook_subscription" } }, "403": { "description": "If the authenticated user does not have permission to install webhooks on the specified repository.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the repository does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "webhooks" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "webhook" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns a paginated list of webhooks installed on this repository.", "responses": { "200": { "description": "The paginated list of installed webhooks.", "schema": { "$ref": "#/definitions/paginated_webhook_subscriptions" } }, "403": { "description": "If the authenticated user does not have permission to access the webhooks.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the repository does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "webhooks" ] } }, "/repositories/{username}/{repo_slug}/issues/{issue_id}/attachments/{path}": { "delete": { "security": [ { "oauth2": [ "issue:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Deletes an attachment.", "responses": { "401": { "description": "If the issue tracker is private and the request was not authenticated." }, "404": { "description": "If the specified repository, issue, or attachment does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } }, "204": { "description": "Indicates that the deletion was successful" } }, "parameters": [], "tags": [ "issue_tracker" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "issue_id", "in": "path" }, { "required": true, "type": "string", "name": "path", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the contents of the specified file attachment.\n\nNote that this endpoint does not return a JSON response, but instead\nreturns a redirect pointing to the actual file that in turn will return\nthe raw contents.\n\nThe redirect URL contains a one-time token that has a limited lifetime.\nAs a result, the link should not be persisted, stored, or shared.", "responses": { "401": { "description": "If the issue tracker is private and the request was not authenticated." }, "404": { "description": "If the specified repository or issue does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } }, "302": { "headers": { "Location": { "type": "string" } }, "description": "A redirect to the file's contents" } }, "parameters": [], "tags": [ "issue_tracker" ] } }, "/repositories/{username}/{repo_slug}/versions/{version_id}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "version_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the specified issue tracker version object.", "responses": { "200": { "description": "The specified version object.", "schema": { "$ref": "#/definitions/version" } }, "404": { "description": "If the specified repository or version does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "integer", "description": "The version's id", "name": "version_id", "in": "path" } ], "tags": [ "issue_tracker" ] } }, "/repositories/{username}/{repo_slug}/issues/{issue_id}/vote": { "put": { "security": [ { "oauth2": [ "issue", "account:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Vote for this issue.\n\nTo cast your vote, do an empty PUT. The 204 status code indicates that\nthe operation was successful.", "responses": { "401": { "description": "When the request wasn't authenticated.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "When the issue does not exist, the repo does not exist, or when the repos does not have an issue tracker.", "schema": { "$ref": "#/definitions/error" } }, "204": { "description": "Indicating the authenticated user has cast their vote successfully.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "integer", "description": "The issue's id", "name": "issue_id", "in": "path" } ], "tags": [ "issue_tracker" ] }, "delete": { "security": [ { "oauth2": [ "issue:write", "account:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Retract your vote.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "integer", "description": "The issue's id", "name": "issue_id", "in": "path" } ], "tags": [ "issue_tracker" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "issue_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue", "account" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Check whether the authenticated user has voted for this issue.\nA 204 status code indicates that the user has voted, while a 404\nimplies they haven't.", "responses": { "401": { "description": "When the request wasn't authenticated.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the authenticated user has not voted for this issue, or when the repo does not exist, or does not have an issue tracker.", "schema": { "$ref": "#/definitions/error" } }, "204": { "description": "If the authenticated user has not voted for this issue.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "integer", "description": "The issue's id", "name": "issue_id", "in": "path" } ], "tags": [ "issue_tracker" ] } }, "/repositories/{username}/{repo_slug}/milestones": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the milestones that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.", "responses": { "200": { "description": "The milestones that have been defined in the issue tracker.", "schema": { "$ref": "#/definitions/paginated_milestones" } }, "404": { "description": "If the specified repository does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "issue_tracker" ] } }, "/repositories/{username}/{repo_slug}/components": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the components that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.", "responses": { "200": { "description": "The components that have been defined in the issue tracker.", "schema": { "$ref": "#/definitions/paginated_components" } }, "404": { "description": "If the specified repository does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "issue_tracker" ] } }, "/account/{username}/addons/{encoded_context_id}/refresh": { "put": { "security": [ { "oauth2": [ "account:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_context_id", "in": "path" } ] }, "/addon/linkers/{linker_key}/values": { "put": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] }, "post": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] }, "delete": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] }, "parameters": [ { "required": true, "type": "string", "name": "linker_key", "in": "path" } ], "get": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] } }, "/repositories/{username}/{repo_slug}/refs/branches": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "refs" ] } }, "/hook_events/{subject_type}": { "parameters": [ { "required": true, "type": "string", "name": "subject_type", "in": "path" } ], "get": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns a paginated list of all valid webhook events for the\nspecified entity.\n\nThis is public data that does not require any scopes or authentication.", "responses": { "200": { "description": "A paginated list of webhook types available to subscribe on.", "schema": { "$ref": "#/definitions/paginated_hook_events" } }, "404": { "description": "If an invalid `{subject_type}` value was specified.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "enum": [ "user", "repository", "team" ], "name": "subject_type", "required": true, "in": "path", "type": "string", "description": "A resource or subject type." } ], "tags": [ "webhooks" ] } }, "/users/{username}/followers": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" } ], "get": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the list of accounts that are following this team.", "responses": { "200": { "description": "A paginated list of user objects.", "schema": { "$ref": "#/definitions/paginated_users" } }, "404": { "description": "If no account exists for the specified name, or if the specified account is a team account, not a personal account.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The account's username", "name": "username", "in": "path" } ], "tags": [ "users" ] } }, "/repositories/{username}/{repo_slug}/default-reviewers": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository:admin" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the repository's default reviewers.\n\nThese are the users that are automatically added as reviewers on every\nnew pull request that is created.", "responses": { "200": { "description": "The paginated list of default reviewers" } }, "parameters": [], "tags": [ "pullrequests" ] } }, "/repositories/{username}/{repo_slug}/downloads/{filename}": { "delete": { "security": [ { "oauth2": [ "repository:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Deletes the specified download artifact from the repository.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "downloads" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "filename", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Return a redirect to the contents of a download artifact.\n\nThis endpoint returns the actual file contents and not the artifact's\nmetadata.\n\n $ curl -s -L https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads/hello.txt\n Hello World", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "downloads" ] } }, "/repositories/{username}/{repo_slug}/commit/{node}/statuses/build/{key}": { "put": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "node", "in": "path" }, { "required": true, "type": "string", "name": "key", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [] } }, "/repositories/{username}/{repo_slug}/watchers": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns a paginated list of all the watchers on the specified\nrepository.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "repositories" ] } }, "/snippets/{username}/{encoded_id}/commits": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the changes (commits) made on this snippet.", "responses": { "200": { "description": "The paginated list of snippet commits.", "schema": { "$ref": "#/definitions/paginated_snippet_commit" } }, "403": { "description": "If the authenticated user does not have access to the snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "snippets" ] } }, "/users/{username}/repositories": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "All repositories owned by a user/team. This includes private\nrepositories, but filtered down to the ones that the calling user has\naccess to.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "users", "teams" ] } }, "/repositories/{username}/{repo_slug}/pullrequests/activity": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "pullrequest" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the pull request's activity log. This includes comments that\nwere made by the reviewers, updates and approvals.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] } }, "/snippets/{username}/{encoded_id}/comments/{comment_id}": { "put": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Updates a comment.\n\nComments can only be updated by their author.", "responses": { "200": { "description": "The updated comment object." }, "403": { "description": "If the authenticated user does not have access to the snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the comment or snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "snippets" ] }, "delete": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Deletes a snippet comment.\n\nComments can only be removed by their author.", "responses": { "204": { "description": "Indicates the comment was deleted successfully." }, "403": { "description": "If the authenticated user is not the author of the comment.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the comment or the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "snippets" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_id", "in": "path" }, { "required": true, "type": "string", "name": "comment_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the specific snippet comment.", "responses": { "200": { "description": "The specified comment.", "schema": { "$ref": "#/definitions/snippet_comment" } }, "403": { "description": "If the authenticated user does not have access to the snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the comment or snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "snippets" ] } }, "/repositories/{username}/{repo_slug}/diff/{spec}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "spec", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "commits" ] } }, "/repositories/{username}/{repo_slug}/branch-restrictions": { "post": { "security": [ { "oauth2": [ "repository:admin" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "branch_restrictions" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository:admin" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "branch_restrictions" ] } }, "/repositories/{username}/{repo_slug}/issues/{issue_id}/comments/{comment_id}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "issue_id", "in": "path" }, { "required": true, "type": "string", "name": "comment_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the specified issue comment object.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "issue_tracker" ] } }, "/repositories/{username}/{repo_slug}/hooks/{uid}": { "put": { "security": [ { "oauth2": [ "webhook" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Updates the specified webhook subscription.\n\nThe following properties can be mutated:\n\n* `description`\n* `url`\n* `active`\n* `events`", "responses": { "200": { "description": "The webhook subscription object.", "schema": { "$ref": "#/definitions/webhook_subscription" } }, "403": { "description": "If the authenticated user does not have permission to update the webhook.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the webhook or repository does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The installed webhook's id", "name": "uid", "in": "path" } ], "tags": [ "webhooks" ] }, "delete": { "security": [ { "oauth2": [ "webhook" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Deletes the specified webhook subscription.", "responses": { "204": { "description": "When the webhook was deleted successfully", "schema": { "$ref": "#/definitions/webhook_subscription" } }, "403": { "description": "If the authenticated user does not have permission to delete the webhook.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the webhook or repository does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The installed webhook's id", "name": "uid", "in": "path" } ], "tags": [ "webhooks" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "uid", "in": "path" } ], "get": { "security": [ { "oauth2": [ "webhook" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the webhook installed on the specified repository.", "responses": { "200": { "description": "The webhook subscription object.", "schema": { "$ref": "#/definitions/webhook_subscription" } }, "404": { "description": "If the webhook or repository does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The installed webhook's id.", "name": "uid", "in": "path" } ], "tags": [ "webhooks" ] } }, "/users/{username}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" } ], "get": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "Gets the public information associated with a user account.\n\nIf the user's profile is private, `location`, `website` and\n`created_on` elements are omitted.", "responses": { "200": { "description": "The user object", "schema": { "$ref": "#/definitions/team" } }, "404": { "description": "If no user exists for the specified name or UUID, or if the specified account is a team account, not a personal account.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The account's username or UUID.", "name": "username", "in": "path" } ], "tags": [ "users" ] } }, "/snippets/{username}/{encoded_id}": { "put": { "responses": { "200": { "description": "The updated snippet object.", "schema": { "$ref": "#/definitions/snippet" } }, "401": { "description": "If the snippet is private and the request was not authenticated.", "schema": { "$ref": "#/definitions/error" } }, "403": { "description": "If authenticated user does not have permission to update the private snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The snippet's id.", "name": "encoded_id", "in": "path" } ], "tags": [ "snippets" ], "produces": [ "application/json", "multipart/related", "multipart/form-data" ], "security": [ { "oauth2": [ "snippet:write" ] }, { "basic": [] }, { "api_key": [] } ], "consumes": [ "application/json", "multipart/related", "multipart/form-data" ], "description": "Used to update a snippet. Use this to add and delete files and to\nchange a snippet's title.\n\nTo update a snippet, one can either PUT a full snapshot, or only the\nparts that need to be changed.\n\nThe contract for PUT on this API is that properties missing from the\nrequest remain untouched so that snippets can be efficiently\nmanipulated with differential payloads.\n\nTo delete a property (e.g. the title, or a file), include its name in\nthe request, but omit its value (use `null`).\n\nAs in Git, explicit renaming of files is not supported. Instead, to\nrename a file, delete it and add it again under another name. This can\nbe done atomically in a single request. Rename detection is left to\nthe SCM.\n\nPUT supports three different content types for both request and\nresponse bodies:\n\n* `application/json`\n* `multipart/related`\n* `multipart/form-data`\n\nThe content type used for the request body can be different than that\nused for the response. Content types are specified using standard HTTP\nheaders.\n\nUse the `Content-Type` and `Accept` headers to select the desired\nrequest and response format.\n\n\napplication/json\n----------------\n\nAs with creation and retrieval, the content type determines what\nproperties can be manipulated. `application/json` does not support\nfile contents and is therefore limited to a snippet's meta data.\n\nTo update the title, without changing any of its files:\n\n $ curl -X POST -H \"Content-Type: application/json\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj -d '{\"title\": \"Updated title\"}'\n\n\nTo delete the title:\n\n $ curl -X POST -H \"Content-Type: application/json\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj -d '{\"title\": null}'\n\nNot all parts of a snippet can be manipulated. The owner and creator\nfor instance are immutable.\n\n\nmultipart/related\n-----------------\n\n`multipart/related` can be used to manipulate all of a snippet's\nproperties. The body is identical to a POST. properties omitted from\nthe request are left unchanged. Since the `start` part contains JSON,\nthe mechanism for manipulating the snippet's meta data is identical\nto `application/json` requests.\n\nTo update one of a snippet's file contents, while also changing its\ntitle:\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 288\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"title\": \"My updated snippet\",\n \"files\": {\n \"foo.txt\": {}\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"foo.txt\"\n Content-Disposition: attachment; filename=\"foo.txt\"\n\n Updated file contents.\n\n --===============1438169132528273974==--\n\nHere only the parts that are changed are included in the body. The\nother files remain untouched.\n\nNote the use of the `files` list in the JSON part. This list contains\nthe files that are being manipulated. This list should have\ncorresponding multiparts in the request that contain the new contents\nof these files.\n\nIf a filename in the `files` list does not have a corresponding part,\nit will be deleted from the snippet, as shown below:\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 188\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"files\": {\n \"image.png\": {}\n }\n }\n\n --===============1438169132528273974==--\n\nTo simulate a rename, delete a file and add the same file under\nanother name:\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 212\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"files\": {\n \"foo.txt\": {},\n \"bar.txt\": {}\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"bar.txt\"\n Content-Disposition: attachment; filename=\"bar.txt\"\n\n foo\n\n --===============1438169132528273974==--\n\n\nmultipart/form-data\n-----------------\n\nAgain, one can also use `multipart/form-data` to manipulate file\ncontents and meta data atomically.\n\n $ curl -X PUT http://localhost:12345/2.0/snippets/evzijst/kypj -F title=\"My updated snippet\" -F file=@foo.txt\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 351\n Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"file\"; filename=\"foo.txt\"\n Content-Type: text/plain\n\n foo\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"title\"\n\n My updated snippet\n ------------------------------63a4b224c59f\n\nTo delete a file, omit its contents while including its name in the\n`files` field:\n\n $ curl -X PUT https://api.bitbucket.org/2.0/snippets/evzijst/kypj -F files=image.png\n\n PUT /2.0/snippets/evzijst/kypj HTTP/1.1\n Content-Length: 149\n Content-Type: multipart/form-data; boundary=----------------------------ef8871065a86\n\n ------------------------------ef8871065a86\n Content-Disposition: form-data; name=\"files\"\n\n image.png\n ------------------------------ef8871065a86--\n\nThe explicit use of the `files` element in `multipart/related` and\n`multipart/form-data` is only required when deleting files.\nThe default mode of operation is for file parts to be processed,\nregardless of whether or not they are listed in `files`, as a\nconvenience to the client." }, "delete": { "security": [ { "oauth2": [ "snippet:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Deletes a snippet and returns an empty response.", "responses": { "401": { "description": "If the snippet is private and the request was not authenticated.", "schema": { "$ref": "#/definitions/error" } }, "403": { "description": "If authenticated user does not have permission to delete the private snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } }, "204": { "description": "If the snippet was deleted successfully." } }, "parameters": [ { "required": true, "type": "string", "description": "The snippet's id.", "name": "encoded_id", "in": "path" } ], "tags": [ "snippets" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_id", "in": "path" } ], "get": { "responses": { "200": { "description": "The snippet object.", "schema": { "$ref": "#/definitions/snippet" } }, "401": { "description": "If the snippet is private and the request was not authenticated.", "schema": { "$ref": "#/definitions/error" } }, "403": { "description": "If authenticated user does not have access to the private snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The snippet's id.", "name": "encoded_id", "in": "path" } ], "produces": [ "application/json", "multipart/related", "multipart/form-data" ], "tags": [ "snippets" ], "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Retrieves a single snippet.\n\nSnippets support multiple content types:\n\n* application/json\n* multipart/related\n* multipart/form-data\n\n\napplication/json\n----------------\n\nThe default content type of the response is `application/json`.\nSince JSON is always `utf-8`, it cannot reliably contain file contents\nfor files that are not text. Therefore, JSON snippet documents only\ncontain the filename and links to the file contents.\n\nThis means that in order to retrieve all parts of a snippet, N+1\nrequests need to be made (where N is the number of files in the\nsnippet).\n\n\nmultipart/related\n-----------------\n\nTo retrieve an entire snippet in a single response, use the\n`Accept: multipart/related` HTTP request header.\n\n $ curl -H \"Accept: multipart/related\" https://api.bitbucket.org/2.0/snippets/evzijst/1\n\nResponse:\n\n HTTP/1.1 200 OK\n Content-Length: 2214\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/snippets/evzijst/kypj\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/comments\"\n },\n \"watchers\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/watchers\"\n },\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/commits\"\n }\n },\n \"id\": kypj,\n \"title\": \"My snippet\",\n \"created_on\": \"2014-12-29T22:22:04.790331+00:00\",\n \"updated_on\": \"2014-12-29T22:22:04.790331+00:00\",\n \"is_private\": false,\n \"files\": {\n \"foo.txt\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/foo.txt\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/snippets/evzijst/kypj#foo.txt\"\n }\n }\n },\n \"image.png\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/snippets/evzijst/kypj/files/367ab19/image.png\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/snippets/evzijst/kypj#image.png\"\n }\n }\n }\n ],\n \"owner\": {\n \"username\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png\"\n }\n }\n },\n \"creator\": {\n \"username\": \"evzijst\",\n \"display_name\": \"Erik van Zijst\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Jul/31/erik-avatar-725122544-0_avatar.png\"\n }\n }\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"foo.txt\"\n Content-Disposition: attachment; filename=\"foo.txt\"\n\n foo\n\n --===============1438169132528273974==\n Content-Type: image/png\n MIME-Version: 1.0\n Content-Transfer-Encoding: base64\n Content-ID: \"image.png\"\n Content-Disposition: attachment; filename=\"image.png\"\n\n iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m\n TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB\n cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5\n EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ\n 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN\n AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==\n --===============1438169132528273974==--\n\nmultipart/form-data\n-------------------\n\nAs with creating new snippets, `multipart/form-data` can be used as an\nalternative to `multipart/related`. However, the inherently flat\nstructure of form-data means that only basic, root-level properties\ncan be returned, while nested elements like `links` are omitted:\n\n $ curl -H \"Accept: multipart/form-data\" https://api.bitbucket.org/2.0/snippets/evzijst/kypj\n\nResponse:\n\n HTTP/1.1 200 OK\n Content-Length: 951\n Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"title\"\n Content-Type: text/plain; charset=\"utf-8\"\n\n My snippet\n ------------------------------63a4b224c59f--\n Content-Disposition: attachment; name=\"file\"; filename=\"foo.txt\"\n Content-Type: text/plain\n\n foo\n\n ------------------------------63a4b224c59f\n Content-Disposition: attachment; name=\"file\"; filename=\"image.png\"\n Content-Transfer-Encoding: base64\n Content-Type: application/octet-stream\n\n iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m\n TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB\n cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5\n EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ\n 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN\n AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==\n ------------------------------5957323a6b76--" } }, "/addon/linkers": { "parameters": [], "get": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] } }, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "pull_request_id", "in": "path" }, { "required": true, "type": "string", "name": "comment_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "pullrequest" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns a specific pull request comment.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] } }, "/repositories/{username}/{repo_slug}/components/{component_id}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "component_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the specified issue tracker component object.", "responses": { "200": { "description": "The specified component object.", "schema": { "$ref": "#/definitions/component" } }, "404": { "description": "If the specified repository or component does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "integer", "description": "The component's id", "name": "component_id", "in": "path" } ], "tags": [ "issue_tracker" ] } }, "/addon": { "put": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] }, "parameters": [], "delete": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] } }, "/users/{username}/following": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" } ], "get": { "security": [ { "oauth2": [ "account" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the list of accounts this user is following.", "responses": { "200": { "description": "A paginated list of user objects.", "schema": { "$ref": "#/definitions/paginated_users" } }, "404": { "description": "If no user exists for the specified name, or if the specified account is a team account, not a personal account.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The user's username", "name": "username", "in": "path" } ], "tags": [ "users" ] } }, "/repositories/{username}/{repo_slug}/issues/{issue_id}": { "delete": { "security": [ { "oauth2": [ "issue:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Deletes the specified issue. This requires write access to the\nrepository.", "responses": { "200": { "description": "The issue object.", "schema": { "$ref": "#/definitions/issue" } }, "403": { "description": "When the authenticated user lacks isn't authorized to delete the issue tracker.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the specified repository or issue does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "issue_tracker" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "issue_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the specified issue.", "responses": { "200": { "description": "The issue object.", "schema": { "$ref": "#/definitions/issue" } }, "403": { "description": "When the authenticated user lacks isn't authorized to access the issue tracker.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the specified repository or issue does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "issue_tracker" ] } }, "/teams/{username}/repositories": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "All repositories owned by a user/team. This includes private\nrepositories, but filtered down to the ones that the calling user has\naccess to.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "users", "teams" ] } }, "/repositories/{username}/{repo_slug}/downloads": { "post": { "security": [ { "oauth2": [ "repository:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Upload new download artifacts.\n\nTo upload files, perform a `multipart/form-data` POST containing one\nor more `files` fields:\n\n $ echo Hello World > hello.txt\n $ curl -s -u evzijst -X POST https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads -F files=@hello.txt\n\nWhen a file is uploaded with the same name as an existing artifact,\nthen the existing file will be replaced.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "downloads" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns a list of download links associated with the repository.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "downloads" ] } }, "/repositories/{username}/{repo_slug}/refs": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "refs" ] } }, "/hook_events": { "parameters": [], "get": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the webhook resource or subject types on which webhooks can\nbe registered.\n\nEach resource/subject type contains an `event` link that returns the\npaginated list of specific events each individual subject type can\nemit.\n\nThis endpoint is publicly accessible and does not require\nauthentication or scopes.", "responses": { "200": { "description": "A mapping of resource/subject types pointing to their individual event types.", "schema": { "$ref": "#/definitions/subject_types" } } }, "parameters": [], "tags": [ "webhooks" ] } }, "/teams/{username}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" } ], "get": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "Gets the public information associated with a team.\n\nIf the team's profile is private, `location`, `website` and\n`created_on` elements are omitted.", "responses": { "200": { "description": "The team object", "schema": { "$ref": "#/definitions/team" } }, "404": { "description": "If no team exists for the specified name or UUID, or if the specified account is a personal account, not a team account.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The team's username or UUID.", "name": "username", "in": "path" } ], "tags": [ "teams" ] } }, "/user/emails/{email}": { "parameters": [ { "required": true, "type": "string", "name": "email", "in": "path" } ], "get": { "security": [ { "oauth2": [ "email" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns details about a specific one of the authenticated user's\nemail addresses.\n\nDetails describe whether the address has been confirmed by the user and\nwhether it is the user's primary address or not.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "users" ] } }, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/approve": { "post": { "security": [ { "oauth2": [ "pullrequest:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Approve the specified pull request as the authenticated user.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "pull_request_id", "in": "path" } ], "delete": { "security": [ { "oauth2": [ "pullrequest:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Redact the authenticated user's approval of the specified pull\nrequest.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] } }, "/repositories/{username}/{repo_slug}/patch/{spec}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "spec", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "commits" ] } }, "/snippets/{username}/{encoded_id}/{node_id}/diff": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_id", "in": "path" }, { "required": true, "type": "string", "name": "node_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the diff of the specified commit against its first parent.\n\nNote that this resource is different in functionality from the `patch`\nresource.\n\nThe differences between a diff and a patch are:\n\n* patches have a commit header with the username, message, etc\n* diffs support the optional `path=foo/bar.py` query param to filter the\n diff to just that one file diff (not supported for patches)\n* for a merge, the diff will show the diff between the merge commit and\n its first parent (identical to how PRs work), while patch returns a\n response containing separate patches for each commit on the second\n parent's ancestry, up to the oldest common ancestor (identical to\n its reachability).\n\nNote that the character encoding of the contents of the diff is\nunspecified as Git and Mercurial do not track this, making it hard for\nBitbucket to reliably determine this.", "responses": { "200": { "description": "The raw diff contents." }, "403": { "description": "If the authenticated user does not have access to the snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "type": "string", "description": "When used, only one the diff of the specified file will be returned.", "name": "path", "in": "query" }, { "required": true, "type": "string", "description": "The snippet id.", "name": "encoded_id", "in": "path" } ], "tags": [ "snippets" ] } }, "/repositories/{username}/{repo_slug}/forks": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns a paginated list of all the forks of the specified\nrepository.", "responses": { "200": { "description": "All forks.", "schema": { "$ref": "#/definitions/paginated_repositories" } } }, "parameters": [], "tags": [ "repositories" ] } }, "/repositories/{username}/{repo_slug}/issues": { "post": { "security": [ { "oauth2": [ "issue:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Creates a new issue.\n\nThis call requires authentication. Private repositories or private\nissue trackers require the caller to authenticate with an account that\nhas appropriate authorisation.\n\nThe authenticated user is used for the issue's `reporter` field.", "responses": { "201": { "headers": { "Location": { "type": "string", "description": "The (absolute) URL of the newly created issue." } }, "description": "The newly created issue.", "schema": { "$ref": "#/definitions/issue" } }, "403": { "description": "When the authenticated user lacks the privilege to create issues in the issue tracker.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the specified repository or version does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } }, "401": { "description": "When the request wasn't authenticated.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "schema": { "$ref": "#/definitions/issue" }, "required": true, "description": "The new issue. Note that the only required element is `title`. All other elements can be omitted from the body.", "name": "_body", "in": "body" } ], "tags": [ "issue_tracker" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the issues in the issue tracker.", "responses": { "200": { "description": "A paginated list of the issues matching any filter criteria that were provided.", "schema": { "$ref": "#/definitions/paginated_issues" } }, "404": { "description": "If the specified repository or version does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "issue_tracker" ] } }, "/repositories/{username}/{repo_slug}/issues/{issue_id}/attachments": { "post": { "security": [ { "oauth2": [ "issue:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Upload new issue attachments.\n\nTo upload files, perform a `multipart/form-data` POST containing one\nor more file fields.\n\nWhen a file is uploaded with the same name as an existing attachment,\nthen the existing file will be replaced.", "responses": { "400": { "description": "If no files were uploaded, or if the wrong `Content-Type` was used." }, "201": { "headers": { "Location": { "type": "string", "description": "The URL to the issue's collection of attachments." } }, "description": "An empty response document." }, "404": { "description": "If the specified repository or issue does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } }, "401": { "description": "If the issue tracker is private and the request was not authenticated." } }, "parameters": [ { "required": true, "type": "integer", "description": "The issue's id", "name": "issue_id", "in": "path" } ], "tags": [ "issue_tracker" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "issue_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns all attachments for this issue.\n\nThis returns the files' meta data. This does not return the files'\nactual contents.\n\nThe files are always ordered by their upload date.", "responses": { "200": { "description": "A paginated list of all attachments for this issue.", "schema": { "$ref": "#/definitions/paginated_issue_attachments" } }, "401": { "description": "If the issue tracker is private and the request was not authenticated." }, "404": { "description": "If the specified repository or version does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "integer", "description": "The issue's id", "name": "issue_id", "in": "path" } ], "tags": [ "issue_tracker" ] } }, "/repositories/{username}/{repo_slug}/versions": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the versions that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled.", "responses": { "200": { "description": "The versions that have been defined in the issue tracker.", "schema": { "$ref": "#/definitions/paginated_versions" } }, "404": { "description": "If the specified repository does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "issue_tracker" ] } }, "/repositories/{username}/{repo_slug}/refs/tags/{name}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "name", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "refs" ] } }, "/snippets/{username}/{encoded_id}/watch": { "put": { "security": [ { "oauth2": [ "snippet:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Used to start watching a specific snippet. Returns 204 (No Content).", "responses": { "401": { "description": "If the request was not authenticated.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } }, "204": { "description": "Indicates the authenticated user is now watching the snippet.", "schema": { "$ref": "#/definitions/paginated_users" } } }, "parameters": [ { "required": true, "type": "string", "description": "The snippet id.", "name": "encoded_id", "in": "path" } ], "tags": [ "snippets" ] }, "delete": { "security": [ { "oauth2": [ "snippet:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Used to stop watching a specific snippet. Returns 204 (No Content)\nto indicate success.", "responses": { "401": { "description": "If the request was not authenticated.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } }, "204": { "description": "Indicates the user stopped watching the snippet successfully.", "schema": { "$ref": "#/definitions/paginated_users" } } }, "parameters": [ { "required": true, "type": "string", "description": "The snippet id.", "name": "encoded_id", "in": "path" } ], "tags": [ "snippets" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Used to check if the current user is watching a specific snippet.\n\nReturns 204 (No Content) if the user is watching the snippet and 404 if\nnot.\n\nHitting this endpoint anonymously always returns a 404.", "responses": { "204": { "description": "If the authenticated user is watching the snippet.", "schema": { "$ref": "#/definitions/paginated_users" } }, "404": { "description": "If the snippet does not exist, or if the authenticated user is not watching the snippet.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The snippet id.", "name": "encoded_id", "in": "path" } ], "tags": [ "snippets" ] } }, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/diff": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "pull_request_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "pullrequest" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] } }, "/snippets": { "post": { "security": [ { "oauth2": [ "snippet:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Creates a new snippet under the authenticated user's account.\n\nSnippets can contain multiple files. Both text and binary files are\nsupported.\n\nThe simplest way to create a new snippet from a local file:\n\n $ curl -u username:password -X POST https://api.bitbucket.org/2.0/snippets -F file=@image.png\n\nCreating snippets through curl has a few limitations and so let's look\nat a more complicated scenario.\n\nSnippets are created with a multipart POST. Both `multipart/form-data`\nand `multipart/related` are supported. Both allow the creation of\nsnippets with both meta data (title, etc), as well as multiple text\nand binary files.\n\nThe main difference is that `multipart/related` can use rich encoding\nfor the meta data (currently JSON).\n\n\nmultipart/related (RFC-2387)\n----------------------------\n\nThis is the most advanced and efficient way to create a paste.\n\n POST /2.0/snippets/evzijst HTTP/1.1\n Content-Length: 1188\n Content-Type: multipart/related; start=\"snippet\"; boundary=\"===============1438169132528273974==\"\n MIME-Version: 1.0\n\n --===============1438169132528273974==\n Content-Type: application/json; charset=\"utf-8\"\n MIME-Version: 1.0\n Content-ID: snippet\n\n {\n \"title\": \"My snippet\",\n \"is_private\": true,\n \"scm\": \"hg\",\n \"files\": {\n \"foo.txt\": {},\n \"image.png\": {}\n }\n }\n\n --===============1438169132528273974==\n Content-Type: text/plain; charset=\"us-ascii\"\n MIME-Version: 1.0\n Content-Transfer-Encoding: 7bit\n Content-ID: \"foo.txt\"\n Content-Disposition: attachment; filename=\"foo.txt\"\n\n foo\n\n --===============1438169132528273974==\n Content-Type: image/png\n MIME-Version: 1.0\n Content-Transfer-Encoding: base64\n Content-ID: \"image.png\"\n Content-Disposition: attachment; filename=\"image.png\"\n\n iVBORw0KGgoAAAANSUhEUgAAABQAAAAoCAYAAAD+MdrbAAABD0lEQVR4Ae3VMUoDQRTG8ccUaW2m\n TKONFxArJYJamCvkCnZTaa+VnQdJSBFl2SMsLFrEWNjZBZs0JgiL/+KrhhVmJRbCLPx4O+/DT2TB\n cbblJxf+UWFVVRNsEGAtgvJxnLm2H+A5RQ93uIl+3632PZyl/skjfOn9Gvdwmlcw5aPUwimG+NT5\n EnNN036IaZePUuIcK533NVfal7/5yjWeot2z9ta1cAczHEf7I+3J0ws9Cgx0fsOFpmlfwKcWPuBQ\n 73Oc4FHzBaZ8llq4q1mr5B2mOUCt815qYR8eB1hG2VJ7j35q4RofaH7IG+Xrf/PfJhfmwtfFYoIN\n AqxFUD6OMxcvkO+UfKfkOyXfKdsv/AYCHMLVkHAFWgAAAABJRU5ErkJggg==\n --===============1438169132528273974==--\n\nThe request contains multiple parts and is structured as follows.\n\nThe first part is the JSON document that describes the snippet's\nproperties or meta data. It either has to be the first part, or the\nrequest's `Content-Type` header must contain the `start` parameter to\npoint to it.\n\nThe remaining parts are the files of which there can be zero or more.\nEach file part should contain the `Content-ID` MIME header through\nwhich the JSON meta data's `files` element addresses it. The value\nshould be the name of the file.\n\n`Content-Disposition` is an optional MIME header. The header's\noptional `filename` parameter can be used to specify the file name\nthat Bitbucket should use when writing the file to disk. When present,\n`filename` takes precedence over the value of `Content-ID`.\n\nWhen the JSON body omits the `files` element, the remaining parts are\nnot ignored. Instead, each file is added to the new snippet as if its\nname was explicitly linked (the use of the `files` elements is\nmandatory for some operations like deleting or renaming files).\n\n\nmultipart/form-data\n-------------------\n\nThe use of JSON for the snippet's meta data is optional. Meta data can\nalso be supplied as regular form fields in a more conventional\n`multipart/form-data` request:\n\n $ curl -X POST -u credentials https://api.bitbucket.org/2.0/snippets -F title=\"My snippet\" -F file=@foo.txt -F file=@image.png\n\n POST /2.0/snippets HTTP/1.1\n Content-Length: 951\n Content-Type: multipart/form-data; boundary=----------------------------63a4b224c59f\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"file\"; filename=\"foo.txt\"\n Content-Type: text/plain\n\n foo\n\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"file\"; filename=\"image.png\"\n Content-Type: application/octet-stream\n\n ?PNG\n\n IHDR?1??I.....\n ------------------------------63a4b224c59f\n Content-Disposition: form-data; name=\"title\"\n\n My snippet\n ------------------------------63a4b224c59f--\n\nHere the meta data properties are included as flat, top-level form\nfields. The file attachments use the `file` field name. To attach\nmultiple files, simply repeat the field.\n\nThe advantage of `multipart/form-data` over `multipart/related` is\nthat it can be easier to build clients.\n\nEssentially all properties are optional, `title` and `files` included.\n\n\nSharing and Visibility\n----------------------\n\nSnippets can be either public (visible to anyone on Bitbucket, as well\nas anonymous users), or private (visible only to the owner, creator\nand members of the team in case the snippet is owned by a team). This\nis controlled through the snippet's `is_private` element:\n\n* is_private=false -- everyone, including anonymous users can view\n the snippet\n* is_private=true -- only the owner and team members (for team\n snippets) can view it\n\nTo create the snippet under a team account, just append the team name\nto the URL (see `/2.0/snippets/{username}`).", "responses": { "201": { "headers": { "Location": { "type": "string", "description": "The URL of the newly created snippet." } }, "description": "The newly created snippet object.", "schema": { "$ref": "#/definitions/snippet" } }, "401": { "description": "If the request was not authenticated", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "schema": { "$ref": "#/definitions/snippet" }, "required": true, "description": "The new snippet object.", "name": "_body", "in": "body" } ], "tags": [ "snippets" ] }, "parameters": [], "get": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns all snippets. Like pull requests, repositories and teams, the\nfull set of snippets is defined by what the current user has access to.\n\nThis includes all snippets owned by the current user, but also all snippets\nowned by any of the teams the user is a member of, or snippets by other\nusers that the current user is either watching or has collaborated on (for\ninstance by commenting on it).\n\nTo limit the set of returned snippets, apply the\n`?role=[owner\|contributor\|member]` query parameter where the roles are\ndefined as follows:\n\n* `owner`: all snippets owned by the current user\n* `contributor`: all snippets owned by, or watched by the current user\n* `member`: owned by the user, their teams, or watched by the current user\n\nWhen no role is specified, all public snippets are returned, as well as all\nprivately owned snippets watched or commented on.\n\nThe returned response is a normal paginated JSON list. This endpoint\nonly supports `application/json` responses and no\n`multipart/form-data` or `multipart/related`. As a result, it is not\npossible to include the file contents.", "responses": { "200": { "description": "A paginated list of snippets.", "schema": { "$ref": "#/definitions/paginated_snippets" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "enum": [ "owner", "contributor", "member" ], "name": "role", "required": false, "in": "query", "type": "string", "description": "Filter down the result based on the authenticated user's role (`owner`, `contributor`, or `member`)." } ], "tags": [ "snippets" ] } }, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}": { "put": { "security": [ { "oauth2": [ "pullrequest:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Mutates the specified pull request.\n\nThis can be used to change the pull request's branches or description.\n\nOnly open pull requests can be mutated.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "pull_request_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "pullrequest" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the specified pull request.", "responses": { "200": { "description": "The pull request object", "schema": { "$ref": "#/definitions/pullrequest" } } }, "parameters": [], "tags": [ "pullrequests" ] } }, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/comments": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "pull_request_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "pullrequest" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns all the pull request's comments.\n\nThis includes both global, inline comments and replies.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] } }, "/account/{username}/addons/{encoded_context_id}": { "put": { "security": [ { "oauth2": [ "account:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] }, "delete": { "security": [ { "oauth2": [ "account:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_context_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "account:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] } }, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/decline": { "post": { "security": [ { "oauth2": [ "pullrequest:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "pull_request_id", "in": "path" } ] }, "/user/emails": { "parameters": [], "get": { "security": [ { "oauth2": [ "email" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns all the authenticated user's email addresses. Both\nconfirmed and unconfirmed.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "users" ] } }, "/repositories/{username}/{repo_slug}/pullrequests": { "post": { "security": [ { "oauth2": [ "pullrequest:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Creates a new pull request.", "responses": { "201": { "headers": { "Location": { "type": "string", "description": "The URL of new newly created pull request." } }, "description": "The newly created pull request.", "schema": { "$ref": "#/definitions/pullrequest" } } }, "parameters": [ { "schema": { "$ref": "#/definitions/pullrequest" }, "required": false, "description": "The new pull request.\n\nThe request URL you POST to becomes the destination repository URL. For this reason, you must specify an explicit source repository in the request object if you want to pull from a different repository (fork).\n\nSince not all elements are required or even mutable, you only need to include the elements you want to initialize, such as the source branch and the title.", "name": "_body", "in": "body" } ], "tags": [ "pullrequests" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "pullrequest" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns all pull requests on the specified repository.\n\nBy default only open pull requests are returned. This can be controlled\nusing the `state` query parameter. To retrieve pull requests that are\nin one of multiple states, repeat the `state` parameter for each\nindividual state.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "enum": [ "MERGED", "SUPERSEDED", "OPEN", "DECLINED" ], "type": "string", "description": "Only return pull requests that in this state. This parameter can be repeated.", "name": "state", "in": "query" } ], "tags": [ "pullrequests" ] } }, "/repositories/{username}/{repo_slug}/commits": { "post": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Identical to `GET /repositories/{username}/{repo_slug}/commits`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n\nNote that this resource does NOT support new commit creation.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "commits" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log` and\n`hg log`. Like these tools, the DAG can be filtered.\n\n## GET /repositories/{username}/{repo_slug}/commits/\n\nReturns all commits in the repo in topological order (newest commit\nfirst). All branches and tags are included (similar to\n`git log --all` and `hg log`).\n\n## GET /repositories/{username}/{repo_slug}/commits/master\n\nReturns all commits on rev `master` (similar to `git log master`,\n`hg log master`).\n\n## GET /repositories/{username}/{repo_slug}/commits/dev?exclude=master\n\nReturns all commits on ref `dev`, except those that are reachable on\n`master` (similar to `git log dev ^master`).\n\n## GET /repositories/{username}/{repo_slug}/commits/?exclude=master\n\nReturns all commits in the repo that are not on master\n(similar to `git log --all ^master`).\n\n## GET /repositories/{username}/{repo_slug}/commits/?include=foo&include=bar&exclude=fu&exclude=fubar\n\nReturns all commits that are on refs `foo` or `bar`, but not on `fu` or\n`fubar` (similar to `git log foo bar ^fu ^fubar`).\n\nBecause the response could include a very large number of commits, it\nis paginated. Follow the 'next' link in the response to navigate to the\nnext page of commits. As with other paginated resources, do not\nconstruct your own links.\n\nWhen the include and exclude parameters are more than ca fit in a\nquery string, clients can use a `x-www-form-urlencoded` POST instead.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "commits" ] } }, "/repositories/{username}/{repo_slug}/commit/{sha}/comments": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "sha", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the commit's comments.\n\nThis includes both global and inline comments.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "commits" ] } }, "/repositories/{username}/{repo_slug}/commit/{revision}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "revision", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the specified commit.", "responses": { "200": { "description": "The commit object", "schema": { "$ref": "#/definitions/commit" } }, "404": { "description": "If the specified commit or repository does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The commit's SHA1.", "name": "revision", "in": "path" } ], "tags": [ "commits" ] } }, "/snippets/{username}": { "post": { "security": [ { "oauth2": [ "snippet:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Identical to `/snippets`, except that the new snippet will be\ncreated under the account specified in the path parameter `{username}`.", "responses": { "201": { "headers": { "Location": { "type": "string", "description": "The URL of the newly created snippet." } }, "description": "The newly created snippet object.", "schema": { "$ref": "#/definitions/snippet" } }, "403": { "description": "If the authenticated user does not have permission to create snippets under the specified account.", "schema": { "$ref": "#/definitions/error" } }, "401": { "description": "If the request was not authenticated", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "schema": { "$ref": "#/definitions/snippet" }, "required": true, "description": "The new snippet object.", "name": "_body", "in": "body" } ], "tags": [ "snippets" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" } ], "get": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Identical to `/snippets`, except that the result is further filtered\nby the snippet owner and only those that are owned by `{username}` are\nreturned.", "responses": { "200": { "description": "A paginated list of snippets.", "schema": { "$ref": "#/definitions/paginated_snippets" } }, "404": { "description": "If the user does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "enum": [ "owner", "contributor", "member" ], "name": "role", "required": false, "in": "query", "type": "string", "description": "Filter down the result based on the authenticated user's role (`owner`, `contributor`, or `member`)." }, { "required": true, "type": "string", "description": "Limits the result to snippets owned by this user.", "name": "username", "in": "path" } ], "tags": [ "snippets" ] } }, "/repositories/{username}/{repo_slug}/issues/{issue_id}/watch": { "put": { "security": [ { "oauth2": [ "issue", "account:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Start watching this issue.\n\nTo start watching this issue, do an empty PUT. The 204 status code\nindicates that the operation was successful.", "responses": { "401": { "description": "When the request wasn't authenticated.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the authenticated user is not watching this issue, or when the repo does not exist, or does not have an issue tracker.", "schema": { "$ref": "#/definitions/error" } }, "204": { "description": "Indicates that the authenticated user successfully started watching this issue.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "integer", "description": "The issue's id", "name": "issue_id", "in": "path" } ], "tags": [ "issue_tracker" ] }, "delete": { "security": [ { "oauth2": [ "issue:write", "account:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Stop watching this issue.", "responses": { "401": { "description": "When the request wasn't authenticated.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the issue or the repo does not exist, or the repository does not have an issue tracker.", "schema": { "$ref": "#/definitions/error" } }, "204": { "description": "Indicates that the authenticated user successfully stopped watching this issue.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "integer", "description": "The issue's id", "name": "issue_id", "in": "path" } ], "tags": [ "issue_tracker" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "issue_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue", "account" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Indicated whether or not the authenticated user is watching this\nissue.", "responses": { "401": { "description": "When the request wasn't authenticated.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the authenticated user is not watching this issue, or when the repo does not exist, or does not have an issue tracker.", "schema": { "$ref": "#/definitions/error" } }, "204": { "description": "If the authenticated user is watching this issue.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "integer", "description": "The issue's id", "name": "issue_id", "in": "path" } ], "tags": [ "issue_tracker" ] } }, "/repositories/{username}/{repo_slug}/milestones/{milestone_id}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "milestone_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the specified issue tracker milestone object.", "responses": { "200": { "description": "The specified milestone object.", "schema": { "$ref": "#/definitions/milestone" } }, "404": { "description": "If the specified repository or milestone does not exist, or if the repository doesn't have the issue tracker enabled.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "integer", "description": "The milestone's id", "name": "milestone_id", "in": "path" } ], "tags": [ "issue_tracker" ] } }, "/teams": { "parameters": [], "get": { "security": [ { "oauth2": [ "team" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns all the teams that the authenticated user is associated\nwith.", "responses": { "200": { "description": "A paginated list of teams.", "schema": { "$ref": "#/definitions/paginated_teams" } }, "401": { "description": "When the request wasn't authenticated.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "enum": [ "admin", "contributor", "member" ], "name": "role", "required": false, "in": "query", "type": "string", "description": "\nFilters the teams based on the authenticated user's role on each team.\n\n* member: returns a list of all the teams which the caller is a member of\n at least one team group or repository owned by the team\n* contributor: returns a list of teams which the caller has write access\n to at least one repository owned by the team\n* admin: returns a list teams which the caller has team administrator access\n" } ], "tags": [ "teams" ] } }, "/user": { "parameters": [], "get": { "security": [ { "oauth2": [ "account" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the currently logged in user.", "responses": { "200": { "description": "The current user.", "schema": { "$ref": "#/definitions/user" } }, "401": { "description": "When the request wasn't authenticated.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "users" ] } }, "/repositories/{username}/{repo_slug}/commits/{revision}": { "post": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Identical to `GET /repositories/{username}/{repo_slug}/commits`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n\nNote that this resource does NOT support new commit creation.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "commits" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "revision", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log` and\n`hg log`. Like these tools, the DAG can be filtered.\n\n## GET /repositories/{username}/{repo_slug}/commits/\n\nReturns all commits in the repo in topological order (newest commit\nfirst). All branches and tags are included (similar to\n`git log --all` and `hg log`).\n\n## GET /repositories/{username}/{repo_slug}/commits/master\n\nReturns all commits on rev `master` (similar to `git log master`,\n`hg log master`).\n\n## GET /repositories/{username}/{repo_slug}/commits/dev?exclude=master\n\nReturns all commits on ref `dev`, except those that are reachable on\n`master` (similar to `git log dev ^master`).\n\n## GET /repositories/{username}/{repo_slug}/commits/?exclude=master\n\nReturns all commits in the repo that are not on master\n(similar to `git log --all ^master`).\n\n## GET /repositories/{username}/{repo_slug}/commits/?include=foo&include=bar&exclude=fu&exclude=fubar\n\nReturns all commits that are on refs `foo` or `bar`, but not on `fu` or\n`fubar` (similar to `git log foo bar ^fu ^fubar`).\n\nBecause the response could include a very large number of commits, it\nis paginated. Follow the 'next' link in the response to navigate to the\nnext page of commits. As with other paginated resources, do not\nconstruct your own links.\n\nWhen the include and exclude parameters are more than ca fit in a\nquery string, clients can use a `x-www-form-urlencoded` POST instead.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "commits" ] } }, "/snippets/{username}/{encoded_id}/comments": { "post": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Creates a new comment.\n\nThe only required field in the body is `content.raw`.\n\nTo create a threaded reply to an existing comment, include `parent.id`.", "responses": { "201": { "headers": { "Location": { "type": "string", "description": "The URL of the new comment" } }, "description": "The newly created comment.", "schema": { "$ref": "#/definitions/snippet" } }, "403": { "description": "If the authenticated user does not have access to the snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "schema": { "$ref": "#/definitions/snippet" }, "required": true, "description": "The contents of the new comment.", "name": "_body", "in": "body" } ], "tags": [ "snippets" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Used to retrieve a paginated list of all comments for a specific\nsnippet.\n\nThis resource works identical to commit and pull request comments.", "responses": { "200": { "description": "A paginated list of snippet comments, ordered by creation date.", "schema": { "$ref": "#/definitions/paginated_snippet_comments" } }, "403": { "description": "If the authenticated user does not have access to the snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "snippets" ] } }, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/activity": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "pull_request_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "pullrequest" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the pull request's activity log. This includes comments that\nwere made by the reviewers, updates and approvals.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] } }, "/repositories/{username}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns all repositories owned by the specified account.\n\nThe result can be narrowed down based on the authenticated user's role.\n\nE.g. with `?role=contributor`, only those repositories that the\nauthenticated user has write access to are returned (this includes any\nrepo the user is an admin on, as that implies write access).", "responses": { "200": { "description": "The repositories owned by the specified account.", "schema": { "$ref": "#/definitions/paginated_repositories" } }, "404": { "description": "If the specified account does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "enum": [ "admin", "contributor", "member", "owner" ], "name": "role", "required": false, "in": "query", "type": "string", "description": "\nFilters the result based on the authenticated user's role on each repository.\n\n* member: returns repositories to which the user has explicit read access\n* contributor: returns repositories to which the user has explicit write access\n* admin: returns repositories to which the user has explicit administrator access\n* owner: returns all repositories owned by the current user\n" } ], "tags": [ "repositories" ] } }, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/merge": { "post": { "security": [ { "oauth2": [ "pullrequest:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "pull_request_id", "in": "path" } ] }, "/snippets/{username}/{encoded_id}/commits/": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "200": { "description": "The specified snippet commit.", "schema": { "$ref": "#/definitions/snippet_commit" } }, "403": { "description": "If the authenticated user does not have access to the snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the commit or the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "snippets" ] } }, "/snippets/{username}/{encoded_id}/{node_id}/patch": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_id", "in": "path" }, { "required": true, "type": "string", "name": "node_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the patch of the specified commit against its first\nparent.\n\nNote that this resource is different in functionality from the `diff`\nresource.\n\nThe differences between a diff and a patch are:\n\n* patches have a commit header with the username, message, etc\n* diffs support the optional `path=foo/bar.py` query param to filter the\n diff to just that one file diff (not supported for patches)\n* for a merge, the diff will show the diff between the merge commit and\n its first parent (identical to how PRs work), while patch returns a\n response containing separate patches for each commit on the second\n parent's ancestry, up to the oldest common ancestor (identical to\n its reachability).\n\nNote that the character encoding of the contents of the patch is\nunspecified as Git and Mercurial do not track this, making it hard for\nBitbucket to reliably determine this.", "responses": { "200": { "description": "The raw patch contents." }, "403": { "description": "If the authenticated user does not have access to the snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The snippet id.", "name": "encoded_id", "in": "path" } ], "tags": [ "snippets" ] } }, "/teams/{username}/followers": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" } ], "get": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the list of accounts that are following this team.", "responses": { "200": { "description": "A paginated list of user objects.", "schema": { "$ref": "#/definitions/paginated_users" } }, "404": { "description": "If no team exists for the specified name, or if the specified account is a personal account, not a team account.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The team's username", "name": "username", "in": "path" } ], "tags": [ "teams" ] } }, "/snippets/{username}/{encoded_id}/{node_id}/files/{path}": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_id", "in": "path" }, { "required": true, "type": "string", "name": "node_id", "in": "path" }, { "required": true, "type": "string", "name": "path", "in": "path" } ], "get": { "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Retrieves the raw contents of a specific file in the snippet. The\n`Content-Disposition` header will be \"attachment\" to avoid issues with\nmalevolent executable files.\n\nThe file's mime type is derived from its filename and returned in the\n`Content-Type` header.\n\nNote that for text files, no character encoding is included as part of\nthe content type.", "responses": { "200": { "headers": { "Content-Type": { "type": "string", "description": "The mime type as derived from the filename" }, "Content-Disposition": { "type": "string", "description": "attachment" } }, "description": "Returns the contents of the specified file." }, "403": { "description": "If the authenticated user does not have access to the snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the file or snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "snippets" ] } }, "/addon/linkers/{linker_key}": { "parameters": [ { "required": true, "type": "string", "name": "linker_key", "in": "path" } ], "get": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] } }, "/repositories/{username}/{repo_slug}/refs/tags": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "refs" ] } }, "/repositories/{username}/{repo_slug}/commit/{node}/approve": { "post": { "security": [ { "oauth2": [ "repository:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Approve the specified commit as the authenticated user.\n\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits.", "responses": { "200": { "description": "The `participant` object recording that the authenticated user approved the commit.", "schema": { "$ref": "#/definitions/participant" } }, "404": { "description": "If the specified commit, or the repository does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The commit's SHA1.", "name": "node", "in": "path" } ], "tags": [ "commits" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "node", "in": "path" } ], "delete": { "security": [ { "oauth2": [ "repository:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Redact the authenticated user's approval of the specified commit.\n\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits.", "responses": { "204": { "description": "An empty response indicating the authenticated user's approval has been withdrawn." }, "404": { "description": "If the specified commit, or the repository does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The commit's SHA1.", "name": "node", "in": "path" } ], "tags": [ "commits" ] } }, "/account/{username}/addons": { "post": { "security": [ { "oauth2": [ "account:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" } ], "get": { "security": [ { "oauth2": [ "account:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] } }, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/commits": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "pull_request_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "pullrequest" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the pull request's commits.\n\nThese are the commits that are being merged into the destination\nbranch when the pull requests gets accepted.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] } }, "/snippets/{username}/{encoded_id}/watchers": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_id", "in": "path" } ], "get": { "responses": { "200": { "description": "The paginated list of users watching this snippet", "schema": { "$ref": "#/definitions/paginated_users" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The snippet id.", "name": "encoded_id", "in": "path" } ], "tags": [ "snippets" ], "deprecated": true, "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns a paginated list of all users watching a specific snippet." } }, "/repositories/{username}/{repo_slug}/branch-restrictions/{id}": { "put": { "security": [ { "oauth2": [ "repository:admin" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "branch_restrictions" ] }, "delete": { "security": [ { "oauth2": [ "repository:admin" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "branch_restrictions" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository:admin" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "branch_restrictions" ] } }, "/repositories/{username}/{repo_slug}/commit/{node}/statuses/build": { "post": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "node", "in": "path" } ] }, "/repositories/{username}/{repo_slug}": { "post": { "security": [ { "oauth2": [ "repository:admin" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Creates a new repository.", "responses": { "200": { "description": "The newly created repository.", "schema": { "$ref": "#/definitions/repository" } }, "401": { "description": "If the request was not authenticated.", "schema": { "$ref": "#/definitions/error" } }, "400": { "description": "If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "schema": { "$ref": "#/definitions/repository" }, "required": false, "description": "The repository that is to be created. Note that most object elements are optional. Elements \"owner\" and \"full_name\" are ignored as the URL implies them.", "name": "_body", "in": "body" } ], "tags": [ "repositories" ] }, "delete": { "security": [ { "oauth2": [ "repository:admin" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Deletes the repository. This is an irreversible operation.\n\nThis does not affect its forks.", "responses": { "204": { "description": "Indicates successful deletion." }, "403": { "description": "If the caller either does not have admin access to the repository, or the repository is set to read-only.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the repository does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "repositories" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the object describing this repository.", "responses": { "200": { "description": "The repository object.", "schema": { "$ref": "#/definitions/repository" } }, "403": { "description": "If the repository is private and the authenticated user does not have access to it.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If no repository exists at this location.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "repositories" ] } }, "/repositories/{username}/{repo_slug}/default-reviewers/{target_username}": { "put": { "security": [ { "oauth2": [ "repository:admin" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Adds the specified user to the repository's list of default\nreviewers.\n\nThis method is idempotent. Adding a user a second time has no effect.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] }, "delete": { "security": [ { "oauth2": [ "repository:admin" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Removes a default reviewer from the repository.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "target_username", "in": "path" } ], "get": { "security": [ { "oauth2": [ "repository:admin" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns the specified reviewer.\n\nThis can be used to test whether a user is among the repository's\ndefault reviewers list. A 404 indicates that that specified user is not\na default reviewer.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] } }, "/repositories/{username}/{repo_slug}/issues/{issue_id}/comments": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "issue_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "issue" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns all comments that were made on the specified issue.", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "issue_tracker" ] } }, "/snippets/{username}/{encoded_id}/{node_id}": { "put": { "responses": { "200": { "description": "The updated snippet object.", "schema": { "$ref": "#/definitions/snippet" } }, "401": { "description": "If the snippet is private and the request was not authenticated.", "schema": { "$ref": "#/definitions/error" } }, "403": { "description": "If authenticated user does not have permission to update the private snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet or the revision does not exist.", "schema": { "$ref": "#/definitions/error" } }, "405": { "description": "If `{node_id}` is not the latest revision.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The snippet's id.", "name": "encoded_id", "in": "path" }, { "required": true, "type": "string", "description": "A commit revision (SHA1).", "name": "node_id", "in": "path" } ], "tags": [ "snippets" ], "produces": [ "application/json", "multipart/related", "multipart/form-data" ], "security": [ { "oauth2": [ "snippet:write" ] }, { "basic": [] }, { "api_key": [] } ], "consumes": [ "application/json", "multipart/related", "multipart/form-data" ], "description": "Identical to `UPDATE /snippets/encoded_id`, except that this endpoint\ntakes an explicit commit revision. Only the snippet's \"HEAD\"/\"tip\"\n(most recent) version can be updated and requests on all other,\nolder revisions fail by returning a 405 status.\n\nUsage of this endpoint over the unrestricted `/snippets/encoded_id`\ncould be desired if the caller wants to be sure no concurrent\nmodifications have taken place between the moment of the UPDATE\nrequest and the original GET.\n\nThis can be considered a so-called \"Compare And Swap\", or CAS\noperation.\n\nOther than that, the two endpoints are identical in behavior." }, "delete": { "security": [ { "oauth2": [ "snippet:write" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Deletes the snippet.\n\nNote that this only works for versioned URLs that point to the latest\ncommit of the snippet. Pointing to an older commit results in a 405\nstatus code.\n\nTo delete a snippet, regardless of whether or not concurrent changes\nare being made to it, use `DELETE /snippets/{encoded_id}` instead.", "responses": { "401": { "description": "If the snippet is private and the request was not authenticated.", "schema": { "$ref": "#/definitions/error" } }, "403": { "description": "If authenticated user does not have permission to delete the private snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet does not exist.", "schema": { "$ref": "#/definitions/error" } }, "204": { "description": "If the snippet was deleted successfully." }, "405": { "description": "If `{node_id}` is not the latest revision.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The snippet's id.", "name": "encoded_id", "in": "path" } ], "tags": [ "snippets" ] }, "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "encoded_id", "in": "path" }, { "required": true, "type": "string", "name": "node_id", "in": "path" } ], "get": { "responses": { "200": { "description": "The snippet object.", "schema": { "$ref": "#/definitions/snippet" } }, "401": { "description": "If the snippet is private and the request was not authenticated.", "schema": { "$ref": "#/definitions/error" } }, "403": { "description": "If authenticated user does not have access to the private snippet.", "schema": { "$ref": "#/definitions/error" } }, "404": { "description": "If the snippet, or the revision does not exist.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [ { "required": true, "type": "string", "description": "The snippet's id.", "name": "encoded_id", "in": "path" }, { "required": true, "type": "string", "description": "A commit revision (SHA1).", "name": "node_id", "in": "path" } ], "produces": [ "application/json", "multipart/related", "multipart/form-data" ], "tags": [ "snippets" ], "security": [ { "oauth2": [ "snippet" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Identical to `GET /snippets/encoded_id`, except that this endpoint\ncan be used to retrieve the contents of the snippet as it was at an\nolder revision, while `/snippets/encoded_id` always returns the\nsnippet's current revision.\n\nNote that only the snippet's file contents are versioned, not its\nmeta data properties like the title.\n\nOther than that, the two endpoints are identical in behavior." } }, "/repositories/{username}/{repo_slug}/pullrequests/{pull_request_id}/patch": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" }, { "required": true, "type": "string", "name": "repo_slug", "in": "path" }, { "required": true, "type": "string", "name": "pull_request_id", "in": "path" } ], "get": { "security": [ { "oauth2": [ "pullrequest" ] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "pullrequests" ] } }, "/addon/linkers/{linker_key}/values/": { "delete": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] }, "parameters": [ { "required": true, "type": "string", "name": "linker_key", "in": "path" } ], "get": { "security": [ { "oauth2": [] }, { "basic": [] }, { "api_key": [] } ], "description": "", "responses": { "default": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "addon" ] } }, "/repositories": { "parameters": [], "get": { "security": [ { "oauth2": [ "repository" ] }, { "basic": [] }, { "api_key": [] } ], "description": "Returns all public repositories.", "responses": { "200": { "description": "All public repositories.", "schema": { "$ref": "#/definitions/paginated_repositories" } } }, "parameters": [], "tags": [ "repositories" ] } }, "/teams/{username}/members": { "parameters": [ { "required": true, "type": "string", "name": "username", "in": "path" } ], "get": { "security": [ { "oauth2": [ "account" ] }, { "basic": [] }, { "api_key": [] } ], "description": "All members of a team.\n\nReturns all members of the specified team. Any member of any of the\nteam's groups is considered a member of the team. This includes users\nin groups that may not actually have access to any of the team's\nrepositories.\n\nNote that members using the \"private profile\" feature are not included.", "responses": { "200": { "description": "All members", "schema": { "$ref": "#/definitions/user" } }, "404": { "description": "When the team does not exist, or multiple teams with the same name exist that differ only in casing and the URL did not match the exact casing of a particular one.", "schema": { "$ref": "#/definitions/error" } } }, "parameters": [], "tags": [ "teams" ] } } }, "schemes": [ "https" ], "tags": [ { "name": "users", "description": "" }, { "name": "teams", "description": "" }, { "name": "repositories", "description": "" }, { "name": "refs", "description": "" }, { "name": "commits", "description": "" }, { "name": "pullrequests", "description": "" }, { "name": "issue_tracker", "description": "The issues resource provides functionality for getting information on\nissues in an issue tracker, creating new issues, updating them and deleting\nthem.\n\nYou can access public issues without authentication, but you can't gain access\nto private repositories' issues. By authenticating, you will get the ability\nto create issues, as well as access to updating data or deleting issues you\nhave access to." }, { "name": "wiki", "description": "" }, { "name": "downloads", "description": "" }, { "name": "snippets", "description": "" }, { "name": "webhooks", "description": "Webhooks provide a way to configure Bitbucket Cloud to make requests to\nyour server (or another external service) whenever certain events occur in\nBitbucket Cloud.\n\nA webhook consists of:\n\n* A subject -- The resource that generates the events. Currently, this resource\n is the repository, user account, or team where you create the webhook.\n* One or more event -- The default event is a repository push, but you can\n select multiple events that can trigger the webhook.\n* A URL -- The endpoint where you want Bitbucket to send the event payloads\n when a matching event happens.\n\nThere are two parts to getting a webhook to work: creating the webhook and\ntriggering the webhook. After you create a webhook for an event, every time\nthat event occurs, Bitbucket sends a payload request that describes the event\nto the specified URL. Thus, you can think of webhooks as a kind of\nnotification system.\n\nUse webhooks to integrate applications with Bitbucket Cloud. The following\nuse cases provides examples of when you would want to use webhooks:\n\n* Every time a user pushes commits in a repository, you may want to notify\n your CI server to start a build.\n* Every time a user pushes commits or creates a pull request, you may want to\n display a notification in your application.\n" } ], "basePath": "/2.0", "produces": [ "application/json" ], "securityDefinitions": { "oauth2": { "scopes": { "wiki": "Read and write to your repositories' wikis", "snippet": "Read your snippets", "account": "Read your account information", "repository:admin": "Administer your repositories", "repository": "Read your repositories", "snippet:write": "Read and write to your snippets", "issue:write": "Read and write to your repositories' issues", "pullrequest": "Read your repositories and their pull requests", "webhook": "Read and write to your repositories' webhooks", "pullrequest:write": "Read and write to your repositories and their pull requests", "project": "Read your team's projects", "project:write": "Read and write to your team's projects and move repositories between them", "team": "Read your team membership information", "repository:write": "Read and write to your repositories", "team:write": "Read and write to your team membership information", "account:write": "Read and write to your account information", "issue": "Read your repositories' issues", "email": "Read your account's primary email address" }, "tokenUrl": "http://dev.bitbucket.org:8000/site/oauth2/access_token", "description": "OAuth 2 as per [RFC-6749](https://tools.ietf.org/html/rfc6749).", "flow": "accessCode", "type": "oauth2", "authorizationUrl": "http://dev.bitbucket.org:8000/site/oauth2/authorize" }, "api_key": { "in": "header", "type": "apiKey", "description": "API Keys can be used as Basic HTTP Authentication credentials and provide a substitute for the account's actual username and password. API Keys are only available to team accounts and there is only 1 key per account. API Keys do not support scopes and have therefore access to all contents of the account.", "name": "Authorization" }, "basic": { "type": "basic", "description": "Basic HTTP Authentication as per [RFC-2617](https://tools.ietf.org/html/rfc2617) (Digest not supported). Note that Basic Auth with username and password as credentials is only available on accounts that have 2-factor-auth / 2-step-verification disabled. If you use 2fa, you should authenticate using OAuth2 instead." } }, "x-revision": "dev-1452122794", "host": "api.dev.bitbucket.org:8000", "definitions": { "paginated_repositories": { "allOf": [ { "$ref": "#/definitions/page" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of repositories.", "properties": { "values": { "minItems": 0, "items": { "$ref": "#/definitions/repository" }, "uniqueItems": true, "type": "array" } } } ] }, "subject_types": { "additionalProperties": false, "type": "object", "description": "The mapping of resource/subject types pointing to their individual event types.", "properties": { "user": { "additionalProperties": false, "type": "object", "properties": { "events": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } }, "repository": { "additionalProperties": false, "type": "object", "properties": { "events": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } }, "team": { "additionalProperties": false, "type": "object", "properties": { "events": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } } } }, "paginated_hook_events": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of webhook types available to subscribe on.", "properties": { "next": { "type": "string", "description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" }, "values": { "minItems": 0, "items": { "$ref": "#/definitions/hook_event" }, "uniqueItems": true, "type": "array" }, "pagelen": { "minimum": 1, "type": "integer", "description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values." }, "size": { "minimum": 0, "type": "integer", "description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute." }, "page": { "minimum": 1, "type": "integer", "description": "Page number of the current results. This is an optional element that is not provided in all responses." }, "previous": { "type": "string", "description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" } } } ] }, "base_commit": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "The common base type for both repository and snippet commits.", "properties": { "date": { "type": "string", "format": "date-time" }, "parents": { "minItems": 0, "items": { "$ref": "#/definitions/base_commit" }, "type": "array" }, "message": { "type": "string" }, "hash": { "pattern": "[0-9a-f]{7,}?", "type": "string" }, "author": { "$ref": "#/definitions/account" } } } ] }, "error": { "additionalProperties": false, "type": "object", "properties": { "error": { "additionalProperties": false, "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string" }, "detail": { "type": "string" } } } } }, "participant": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "Object describing a user's role on resources like commits or pull requests.", "properties": { "role": { "enum": [ "PARTICIPANT", "REVIEWER" ], "type": "string" }, "user": { "$ref": "#/definitions/user" }, "approved": { "type": "boolean" } } } ] }, "paginated_versions": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of issue tracker versions.", "properties": { "next": { "type": "string", "description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" }, "values": { "minItems": 0, "items": { "$ref": "#/definitions/version" }, "uniqueItems": true, "type": "array" }, "pagelen": { "minimum": 1, "type": "integer", "description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values." }, "size": { "minimum": 0, "type": "integer", "description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute." }, "page": { "minimum": 1, "type": "integer", "description": "Page number of the current results. This is an optional element that is not provided in all responses." }, "previous": { "type": "string", "description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" } } } ] }, "paginated_users": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of users.", "properties": { "next": { "type": "string", "description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" }, "values": { "minItems": 0, "items": { "$ref": "#/definitions/user" }, "uniqueItems": true, "type": "array" }, "pagelen": { "minimum": 1, "type": "integer", "description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values." }, "size": { "minimum": 0, "type": "integer", "description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute." }, "page": { "minimum": 1, "type": "integer", "description": "Page number of the current results. This is an optional element that is not provided in all responses." }, "previous": { "type": "string", "description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" } } } ] }, "snippet": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A snippet object.", "properties": { "scm": { "enum": [ "hg", "git" ], "type": "string", "description": "The DVCS used to store the snippet." }, "title": { "type": "string" }, "creator": { "$ref": "#/definitions/account" }, "created_on": { "type": "string", "format": "date-time" }, "owner": { "$ref": "#/definitions/account" }, "updated_on": { "type": "string", "format": "date-time" }, "id": { "minimum": 0, "type": "integer" }, "is_private": { "type": "boolean" } } } ] }, "hook_event": { "additionalProperties": false, "type": "object", "description": "An event, associated with a resource or subject type.", "properties": { "category": { "type": "string", "description": "The category this event belongs to." }, "event": { "enum": [ "pullrequest:updated", "repo:commit_status_created", "repo:fork", "issue:comment_created", "pullrequest:rejected", "pullrequest:fulfilled", "pullrequest:comment_created", "pullrequest:comment_deleted", "issue:created", "repo:commit_comment_created", "pullrequest:approved", "repo:commit_status_updated", "pullrequest:comment_updated", "issue:updated", "pullrequest:unapproved", "pullrequest:created", "repo:push" ], "type": "string", "description": "The event identifier." }, "description": { "type": "string", "description": "More detailed description of the webhook event type." }, "label": { "type": "string", "description": "Summary of the webhook event type." } } }, "version": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A version as defined in a repository's issue tracker.", "properties": { "name": { "type": "string" }, "links": { "additionalProperties": false, "type": "object", "properties": { "self": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } }, "id": { "type": "integer" } } } ] }, "issue": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "An issue.", "properties": { "content": { "additionalProperties": false, "type": "object", "properties": { "raw": { "type": "string", "description": "The text as it was typed by a user." }, "markup": { "enum": [ "markdown", "creole" ], "type": "string", "description": "The type of markup language the content is to be interpreted in." }, "html": { "type": "string", "description": "The user's markup rendered as HTML." } } }, "kind": { "enum": [ "bug", "enhancement", "proposal", "task" ], "type": "string" }, "repository": { "$ref": "#/definitions/repository" }, "links": { "additionalProperties": false, "type": "object", "properties": { "attachments": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "self": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "watch": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "comments": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "html": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "vote": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } }, "title": { "type": "string" }, "reporter": { "$ref": "#/definitions/user" }, "component": { "$ref": "#/definitions/component" }, "votes": { "type": "integer" }, "priority": { "enum": [ "trivial", "minor", "major", "critical", "blocker" ], "type": "string" }, "assignee": { "$ref": "#/definitions/user" }, "state": { "enum": [ "new", "open", "resolved", "on hold", "invalid", "duplicate", "wontfix", "closed" ], "type": "string" }, "version": { "$ref": "#/definitions/version" }, "edited_on": { "type": "string", "format": "date-time" }, "created_on": { "type": "string", "format": "date-time" }, "milestone": { "$ref": "#/definitions/milestone" }, "updated_on": { "type": "string", "format": "date-time" }, "id": { "type": "integer" } } } ] }, "webhook_subscription": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A Webhook subscription.", "properties": { "subject_type": { "enum": [ "user", "repository", "team" ], "type": "string", "description": "The type of entity, which is `repository` in the case of webhook subscriptions on repositories." }, "uuid": { "type": "string", "description": "The webhook's id" }, "url": { "type": "string", "description": "The URL events get delivered to.", "format": "uri" }, "created_at": { "type": "string", "format": "date-time" }, "description": { "type": "string", "description": "A user-defined description of the webhook." }, "active": { "type": "boolean" }, "events": { "minItems": 1, "items": { "enum": [ "pullrequest:updated", "repo:commit_status_created", "repo:fork", "issue:comment_created", "pullrequest:rejected", "pullrequest:fulfilled", "pullrequest:comment_created", "pullrequest:comment_deleted", "issue:created", "repo:commit_comment_created", "pullrequest:approved", "repo:commit_status_updated", "pullrequest:comment_updated", "issue:updated", "pullrequest:unapproved", "pullrequest:created", "repo:push" ], "type": "string" }, "uniqueItems": true, "description": "The events this webhook is subscribed to.", "type": "array" }, "subject": { "$ref": "#/definitions/object" } } } ] }, "repository": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A Bitbucket repository.", "properties": { "scm": { "enum": [ "hg", "git" ], "type": "string" }, "has_wiki": { "type": "boolean" }, "uuid": { "type": "string", "description": "The repository's immutable id. This can be used as a substitute for the slug segment in URLs. Doing this guarantees your URLs will survive renaming of the repository by its owner, or even transfer of the repository to a different user." }, "links": { "additionalProperties": false, "type": "object", "properties": { "watchers": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "commits": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "downloads": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "self": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "html": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "avatar": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "hooks": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "forks": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "clone": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "pullrequests": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } }, "fork_policy": { "enum": [ "allow_forks", "no_public_forks", "no_forks" ], "type": "string", "description": "\nControls the rules for forking this repository.\n\n* allow_forks: unrestricted forking\n* no_public_forks: restrict forking to private forks (forks cannot\n be made public later)\n* no_forks: deny all forking\n" }, "description": { "type": "string" }, "language": { "type": "string" }, "created_on": { "type": "string", "format": "date-time" }, "parent": { "$ref": "#/definitions/repository" }, "full_name": { "type": "string", "description": "The concatenation of the repository owner's username and the slugified name, e.g. \"evzijst/interruptingcow\". This is the same string used in Bitbucket URLs." }, "has_issues": { "type": "boolean" }, "owner": { "$ref": "#/definitions/account" }, "updated_on": { "type": "string", "format": "date-time" }, "size": { "type": "integer" }, "is_private": { "type": "boolean" }, "name": { "type": "string" } } } ] }, "snippet_commit": { "allOf": [ { "$ref": "#/definitions/base_commit" }, { "additionalProperties": true, "type": "object", "description": "", "properties": { "snippet": { "$ref": "#/definitions/snippet" }, "links": { "additionalProperties": false, "type": "object", "properties": { "diff": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "self": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "html": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } } } } ] }, "object": { "description": "Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`.", "required": [ "type" ], "additionalProperties": true, "discriminator": "type", "type": "object", "properties": { "type": { "type": "string" } } }, "component": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A component as defined in a repository's issue tracker.", "properties": { "name": { "type": "string" }, "links": { "additionalProperties": false, "type": "object", "properties": { "self": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } }, "id": { "type": "integer" } } } ] }, "paginated_issues": { "allOf": [ { "$ref": "#/definitions/page" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of issues.", "properties": { "values": { "minItems": 0, "items": { "$ref": "#/definitions/issue" }, "uniqueItems": true, "type": "array" } } } ] }, "user": { "allOf": [ { "$ref": "#/definitions/account" }, { "additionalProperties": true, "type": "object", "description": "A user object.", "properties": {} } ] }, "milestone": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A milestone as defined in a repository's issue tracker.", "properties": { "name": { "type": "string" }, "links": { "additionalProperties": false, "type": "object", "properties": { "self": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } }, "id": { "type": "integer" } } } ] }, "paginated_issue_attachments": { "allOf": [ { "$ref": "#/definitions/page" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of issue attachments.", "properties": { "values": { "minItems": 0, "items": { "$ref": "#/definitions/issue_attachment" }, "type": "array" } } } ] }, "paginated_webhook_subscriptions": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of webhook subscriptions", "properties": { "next": { "type": "string", "description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" }, "values": { "minItems": 0, "items": { "$ref": "#/definitions/webhook_subscription" }, "uniqueItems": true, "type": "array" }, "pagelen": { "minimum": 1, "type": "integer", "description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values." }, "size": { "minimum": 0, "type": "integer", "description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute." }, "page": { "minimum": 1, "type": "integer", "description": "Page number of the current results. This is an optional element that is not provided in all responses." }, "previous": { "type": "string", "description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" } } } ] }, "snippet_comment": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A comment on a snippet.", "properties": { "snippet": { "$ref": "#/definitions/snippet" }, "links": { "additionalProperties": false, "type": "object", "properties": { "self": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "html": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } } } } ] }, "paginated_milestones": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of issue tracker milestones.", "properties": { "next": { "type": "string", "description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" }, "values": { "minItems": 0, "items": { "$ref": "#/definitions/milestone" }, "uniqueItems": true, "type": "array" }, "pagelen": { "minimum": 1, "type": "integer", "description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values." }, "size": { "minimum": 0, "type": "integer", "description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute." }, "page": { "minimum": 1, "type": "integer", "description": "Page number of the current results. This is an optional element that is not provided in all responses." }, "previous": { "type": "string", "description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" } } } ] }, "paginated_components": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of issue tracker components.", "properties": { "next": { "type": "string", "description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" }, "values": { "minItems": 0, "items": { "$ref": "#/definitions/component" }, "uniqueItems": true, "type": "array" }, "pagelen": { "minimum": 1, "type": "integer", "description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values." }, "size": { "minimum": 0, "type": "integer", "description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute." }, "page": { "minimum": 1, "type": "integer", "description": "Page number of the current results. This is an optional element that is not provided in all responses." }, "previous": { "type": "string", "description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" } } } ] }, "account": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "An account object.", "properties": { "username": { "pattern": "^[a-zA-Z0-9_\\-]+$", "type": "string" }, "website": { "type": "string" }, "display_name": { "type": "string" }, "uuid": { "type": "string" }, "links": { "additionalProperties": false, "type": "object", "properties": { "self": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "repositories": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "html": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "followers": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "avatar": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "following": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } }, "created_on": { "type": "string", "format": "date-time" } } } ] }, "issue_attachment": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "An issue file attachment's meta data. Note this does not contain the file's actual contents.", "properties": { "name": { "type": "string" }, "links": { "additionalProperties": false, "type": "object", "properties": { "self": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } } } } ] }, "paginated_snippet_commit": { "allOf": [ { "$ref": "#/definitions/page" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of snippet commits.", "properties": { "values": { "minItems": 0, "items": { "$ref": "#/definitions/snippet_commit" }, "type": "array" } } } ] }, "pullrequest": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A pull request object.", "properties": { "state": { "enum": [ "MERGED", "SUPERSEDED", "OPEN", "DECLINED" ], "type": "string" }, "author": { "$ref": "#/definitions/account" }, "id": { "type": "integer" }, "links": { "additionalProperties": false, "type": "object", "properties": { "decline": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "commits": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "self": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "comments": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "merge": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "html": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "activity": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "diff": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "approve": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } }, "title": { "type": "string" } } } ] }, "paginated_teams": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of teams.", "properties": { "next": { "type": "string", "description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" }, "values": { "minItems": 0, "items": { "$ref": "#/definitions/team" }, "uniqueItems": true, "type": "array" }, "pagelen": { "minimum": 1, "type": "integer", "description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values." }, "size": { "minimum": 0, "type": "integer", "description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute." }, "page": { "minimum": 1, "type": "integer", "description": "Page number of the current results. This is an optional element that is not provided in all responses." }, "previous": { "type": "string", "description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" } } } ] }, "paginated_snippet_comments": { "allOf": [ { "$ref": "#/definitions/page" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of snippet comments.", "properties": { "values": { "minItems": 0, "items": { "$ref": "#/definitions/snippet_comment" }, "uniqueItems": true, "type": "array" } } } ] }, "team": { "allOf": [ { "$ref": "#/definitions/account" }, { "additionalProperties": true, "type": "object", "description": "A team object.", "properties": {} } ] }, "commit": { "allOf": [ { "$ref": "#/definitions/base_commit" }, { "additionalProperties": true, "type": "object", "description": "A repository commit object.", "properties": { "participants": { "minItems": 0, "items": { "$ref": "#/definitions/participant" }, "type": "array" }, "repository": { "$ref": "#/definitions/repository" }, "links": { "additionalProperties": false, "type": "object", "properties": { "self": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "comments": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "patch": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "html": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "diff": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } }, "approve": { "additionalProperties": false, "type": "object", "properties": { "href": { "type": "string", "format": "uri" } } } } } } } ] }, "paginated_snippets": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "A paginated list of snippets.", "properties": { "next": { "type": "string", "description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" }, "values": { "minItems": 0, "items": { "$ref": "#/definitions/snippet" }, "uniqueItems": true, "type": "array" }, "pagelen": { "minimum": 1, "type": "integer", "description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values." }, "size": { "minimum": 0, "type": "integer", "description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute." }, "page": { "minimum": 1, "type": "integer", "description": "Page number of the current results. This is an optional element that is not provided in all responses." }, "previous": { "type": "string", "description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" } } } ] }, "page": { "allOf": [ { "$ref": "#/definitions/object" }, { "additionalProperties": true, "type": "object", "description": "Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`.", "properties": { "previous": { "type": "string", "description": "Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" }, "pagelen": { "minimum": 1, "type": "integer", "description": "Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values." }, "next": { "type": "string", "description": "Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.", "format": "uri" }, "page": { "minimum": 1, "type": "integer", "description": "Page number of the current results. This is an optional element that is not provided in all responses." }, "size": { "minimum": 0, "type": "integer", "description": "Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute." } } } ] } }, "swagger": "2.0", "consumes": [ "application/json" ] }	241.15 KB	2025-05-25 12:27
📁 default	-	2025-05-25 12:27
📄 direct-circular-ancestor.json { "swagger": "2.0", "info": { "description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n", "version": "1.0.0", "title": "Swagger Petstore", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/pets": { "get": { "tags": ["pet"], "summary": "list the pets", "operationId": "getPets", "responses": { "default": { "description": "Generic Error" }, "200": { "description": "Pets list", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pet" } } } } } } }, "definitions": { "Parent": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Circular1": { "allOf": [{ "$ref": "#/definitions/Circular2" }, { "properties": { "age": { "type": "integer", "format": "int32" } } }] }, "Circular2": { "allOf": [{ "$ref": "#/definitions/Circular1" }, { "properties": { "createdAt": { "type": "string", "format": "date-time" } } }] }, "Category": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Pet": { "required": [ "name", "photoUrls" ], "properties": { "id": { "type": "integer", "format": "int64" }, "category": { "$ref": "#/definitions/Category" }, "name": { "type": "string", "example": "doggie" }, "photoUrls": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "status": { "type": "string", "description": "pet status in the store" } } }, "Tag": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } }	3.65 KB	2025-05-25 12:27
📄 duplicateprops.json { "swagger": "2.0", "info": { "description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n", "version": "1.0.0", "title": "Swagger Petstore", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/pets": { "get": { "tags": ["pet"], "summary": "list the pets", "operationId": "getPets", "responses": { "default": { "description": "Generic Error" }, "200": { "description": "Pets list", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pet" } } } } } } }, "definitions": { "Parent": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "ValidChild": { "allOf": [{ "$ref": "#/definitions/Parent" }, { "properties": { "age": { "type": "integer", "format": "int32" } } }] }, "InvalidChild": { "allOf": [{ "$ref": "#/definitions/Parent" }, { "properties": { "name": { "type": "string" } } }] }, "Category": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Pet": { "required": [ "name", "photoUrls" ], "properties": { "id": { "type": "integer", "format": "int64" }, "category": { "$ref": "#/definitions/Category" }, "name": { "type": "string", "example": "doggie" }, "photoUrls": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "status": { "type": "string", "description": "pet status in the store" } } }, "Tag": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } }	3.6 KB	2025-05-25 12:27
📄 empty-path-param-name.json { "swagger": "2.0", "info": { "description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n", "version": "1.0.0", "title": "Swagger Petstore", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/pets/{}": { "get": { "tags": ["pet"], "summary": "list the pets", "operationId": "getPets", "parameters": [{ "name": "limit", "in": "query", "description": "number of items to return in the result", "type": "array", "collectionFormat": "csv", "items": { "type": "integer", "format": "int32", "default": "20" } }], "responses": { "default": { "description": "Generic Error" }, "200": { "description": "Pets list", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pet" } } } } } } }, "definitions": { "Parent": { "$ref": "#/definitions/Category" }, "Category": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Pet": { "required": [ "name", "photoUrls" ], "properties": { "id": { "type": "integer", "format": "int64" }, "category": { "$ref": "#/definitions/Category" }, "name": { "type": "string", "example": "doggie" }, "photoUrls": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "status": { "type": "string", "description": "pet status in the store" } } }, "Tag": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } }	3.34 KB	2025-05-25 12:27
📁 example	-	2025-05-25 12:27
📄 expected_messages.yaml # # This document specifies messages expecations on tested fixtures (errors and warnings) # Messages may be either a plain string (assert.Contains) or a simple regexp (assert.True(regexp.MatchString()) fixture-items-items.yaml: comment: how to get through item.Items in simple schemas todo: expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: - message: 'soSimple in path has a default value and is required as parameter' withContinueOnErrors: false isRegexp: false valid-referenced.yml: comment: todo: expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: [] valid-referenced-variants.yaml: comment: additional scenarios with failures on additionalProperties and required properties todo: expectedLoadError: false expectedValid: false expectedMessages: - message: 'definitions.lotOfErrors.patternProperties in body is a forbidden property' withContinueOnErrors: false isRegexp: false - message: '"definitions.lotOfErrors.additionalProperties" must validate at least one schema (anyOf)' withContinueOnErrors: false isRegexp: false - message: 'definitions.lotOfErrors.additionalProperties.patternProperties in body is a forbidden property' withContinueOnErrors: false isRegexp: false - message: 'definitions.lotOfErrors2.patternProperties in body is a forbidden property' withContinueOnErrors: false isRegexp: false - message: 'pattern "^)b-InvalidRegexp1.($" is invalid in lotOfErrors' withContinueOnErrors: true isRegexp: false - message: '"bug" is present in required but not defined as property in definition "lotOfErrors"' withContinueOnErrors: true isRegexp: false - message: 'pattern "^)b-InvalidRegexp2.($" is invalid in lotOfErrors2' withContinueOnErrors: true isRegexp: false expectedWarnings: - message: 'Required property a in "lotOfErrors" should not be marked as both required and readOnly' withContinueOnErrors: true isRegexp: false - message: 'Required property z-1 in "lotOfErrors" should not be marked as both required and readOnly' withContinueOnErrors: true isRegexp: false - message: 'Required property b-8 in "lotOfErrors2" should not be marked as both required and readOnly' withContinueOnErrors: true isRegexp: false fixture-additional-items.yaml: comment: todo: unsupported keyword such as additionnalItems should be better reported expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: [] fixture-additional-items-2.yaml: comment: todo: unsupported keyword such as additionnalItems should be better reported expectedLoadError: false expectedValid: false expectedMessages: - message: '"paths./servers/getGood.get.parameters" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'paths./servers/getGood.get.parameters.schema.additionalItems in body is a forbidden property' withContinueOnErrors: false isRegexp: false expectedWarnings: [] fixture-additional-items-3.yaml: comment: todo: unsupported keyword such as additionnalItems should be better reported expectedLoadError: false expectedValid: false expectedMessages: - message: '"paths./servers/edgeCase.get.responses.200" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: '"paths./servers/edgeCase.get.responses.200.schema" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'paths./servers/edgeCase.get.responses.200.schema.additionalItems in body is a forbidden property' withContinueOnErrors: false isRegexp: false - message: '"paths./servers/edgeCase.get.responses.200.schema.items" must validate at least one schema (anyOf)' withContinueOnErrors: false isRegexp: false - message: 'paths./servers/edgeCase.get.responses.200.schema.items.additionalItems in body is a forbidden property' withContinueOnErrors: false isRegexp: false - message: '"paths./servers/getGood.get.responses.200" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: '"paths./servers/getGood.get.responses.200.schema" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'paths./servers/getGood.get.responses.200.schema.additionalItems in body is a forbidden property' withContinueOnErrors: false isRegexp: false expectedWarnings: - message: 'definition "#/definitions/itemsSchema0" is not used anywhere' withContinueOnErrors: true isRegexp: false - message: 'definition "#/definitions/itemsSchema1" is not used anywhere' withContinueOnErrors: true isRegexp: false - message: 'definition "#/definitions/itemsSchema2" is not used anywhere' withContinueOnErrors: true isRegexp: false - message: 'definition "#/definitions/itemsSchema3" is not used anywhere' withContinueOnErrors: true isRegexp: false fixture-no-json-example.yaml: comment: a response example for a mime type other than application/json todo: not supported. atm, this is just a warning expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: - message: 'No validation attempt for examples for media types other than application/json, in operation "getGoodOp", default response' withContinueOnErrors: false isRegexp: false - message: 'Examples provided without schema in operation "getGoodOp", response 200' withContinueOnErrors: false isRegexp: false fixture-additional-items-invalid-values.yaml: comment: additional testing scenario for default and example values todo: expectedLoadError: false expectedValid: false expectedMessages: - message: '"paths./servers/getBad1.get.responses.default" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'paths./servers/getBad1.get.responses.default.description in body is required' withContinueOnErrors: false isRegexp: false - message: 'default value for addItems in body does not validate its schema' withContinueOnErrors: true isRegexp: false - message: 'addItems.default.0.first in body must be of type string: "array"' withContinueOnErrors: true isRegexp: false - message: 'addItems.default.2.c in body must be of type number: "string"' withContinueOnErrors: true isRegexp: false - message: 'addItems.default.2.x in body must be of type string: "number"' withContinueOnErrors: true isRegexp: false - message: 'addItems.default.2.x in body should be one of [a b c]' withContinueOnErrors: true isRegexp: false - message: 'addItems.default.3.z in body must be of type number: "string"' withContinueOnErrors: true isRegexp: false - message: 'in operation "getGoodOp", default value in default response does not validate its schema' withContinueOnErrors: true isRegexp: false - message: 'default.default.0.first in body must be of type string: "array"' withContinueOnErrors: true isRegexp: false - message: 'default.default.2.x in body must be of type string: "number"' withContinueOnErrors: true isRegexp: false - message: 'default.default.2.x in body should be one of [a b c]' withContinueOnErrors: true isRegexp: false - message: 'default.default.2.c in body must be of type number: "string"' withContinueOnErrors: true isRegexp: false - message: 'default.default.3.z in body must be of type number: "string"' withContinueOnErrors: true isRegexp: false - message: 'in operation "getGoodOp", default value in response 200 does not validate its schema' withContinueOnErrors: true isRegexp: false - message: '200.default.0.first in body must be of type string: "array"' withContinueOnErrors: true isRegexp: false - message: '200.default.2.c in body must be of type number: "string"' withContinueOnErrors: true isRegexp: false - message: '200.default.2.x in body must be of type string: "number"' withContinueOnErrors: true isRegexp: false - message: '200.default.2.x in body should be one of [a b c]' withContinueOnErrors: true isRegexp: false - message: '200.default.3.z in body must be of type number: "string"' withContinueOnErrors: true isRegexp: false expectedWarnings: - message: 'in operation "getGoodOp", example value in response 200 does not validate its schema' withContinueOnErrors: true isRegexp: false - message: '/servers/getBad1.examples.0.first in body must be of type string: "number"' withContinueOnErrors: true isRegexp: false - message: '/servers/getBad1.examples.3.z in body must be of type number: "boolean"' withContinueOnErrors: true isRegexp: false - message: '200.example.0.first in body must be of type string: "number"' withContinueOnErrors: true isRegexp: false - message: '200.example.3.z in body must be of type number: "boolean"' withContinueOnErrors: true isRegexp: false - message: 'example value for addItems in body does not validate its schema' withContinueOnErrors: true isRegexp: false - message: 'addItems.example.0.first in body must be of type string: "number"' withContinueOnErrors: true isRegexp: false - message: 'addItems.example.3.z in body must be of type number: "boolean"' withContinueOnErrors: true isRegexp: false - message: 'in operation "getGoodOp", example value in default response does not validate its schema' withContinueOnErrors: true isRegexp: false - message: 'default.example.0.first in body must be of type string: "number"' withContinueOnErrors: true isRegexp: false - message: 'default.example.3.z in body must be of type number: "boolean"' withContinueOnErrors: true isRegexp: false fixture-no-response.yaml: comment: todo: expectedLoadError: false expectedValid: false expectedMessages: - message: 'operation "ListBackendSets" has no valid response' withContinueOnErrors: true isRegexp: false - message: 'paths./loadBalancers/{loadBalancerId}/backendSets.get.responses in body must be of type object: "null"' withContinueOnErrors: false isRegexp: false expectedWarnings: [] fixture-empty-paths.json: comment: todo: expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: - message: spec has no valid path defined withContinueOnErrors: false isRegexp: false fixture-patternProperties.json: comment: Exercise pattern properties (for default values), with an invalid pattern todo: expectedLoadError: false expectedValid: false expectedMessages: - message: definitions.Tag.patternProperties in body is a forbidden property withContinueOnErrors: false isRegexp: false - message: definitions.TagInvalidDefault.patternProperties in body is a forbidden property withContinueOnErrors: false isRegexp: false - message: definitions.TagWrong.patternProperties in body is a forbidden property withContinueOnErrors: false isRegeexp: false - message: 'definitions.TagInvalidDefault.default.id in body must be of type integer: "string"' withContinueOnErrors: true isRegexp: false - message: 'definitions.TagInvalidDefault.default.nb-1 in body must be of type integer: "string"' withContinueOnErrors: true isRegexp: false - message: 'definitions.TagInvalidDefault.default.nb-2 in body must be of type integer: "string"' withContinueOnErrors: true isRegexp: false # with systematic response expansion we get more messages - message: '200.items.default.invalidDefault.default.id in body must be of type integer: "string"' withContinueOnErrors: true isRegexp: false - message: '200.items.default.invalidDefault.default.nb-1 in body must be of type integer: "string"' withContinueOnErrors: true isRegexp: false - message: '200.items.default.invalidDefault.default.nb-2 in body must be of type integer: "string"' withContinueOnErrors: true isRegexp: false - message: 'in operation "getPets", default value in response 200 does not validate its schema' withContinueOnErrors: true isRegexp: false expectedWarnings: - message: 'definition "#/definitions/Parent" is not used anywhere' withContinueOnErrors: true isRegexp: false bitbucket.json: comment: Path differing by only a trailing "/" are not considered duplicates todo: expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: [] fixture-161-2.json: comment: \| Variant of Issue#161: this is a partially fixed spec. In this version, the name param type is fixed, but the default value remains wrongly typed' todo: expectedLoadError: false expectedValid: false expectedMessages: - message: default value for requestBody in body does not validate its schema withContinueOnErrors: false isRegexp: false - message: 'requestBody.default in body must be of type object: "string"' withContinueOnErrors: false isRegexp: false expectedWarnings: - message: 'example value for requestBody in body does not validate its schema' withContinueOnErrors: false isRegexp: false - message: 'requestBody.example.parent.id in body must be of type number: "string"' withContinueOnErrors: false isRegexp: false fixture-161-good.json: comment: 'Issue#161: this is the corresponding corrected spec which should be valid. Ah! But now examples are invalid...' todo: expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: - message: 'example value for requestBody in body does not validate its schema' withContinueOnErrors: false isRegexp: false - message: 'requestBody.example.parent.id in body must be of type number: "string"' withContinueOnErrors: false isRegexp: false fixture-161.json: comment: 'Issue#161: default value as object' todo: expectedLoadError: false expectedValid: false expectedMessages: - message: 'default value for requestBody in body does not validate its schema' withContinueOnErrors: false isRegexp: false - message: 'requestBody.default in body must be of type object: "string"' withContinueOnErrors: false isRegexp: false expectedWarnings: - message: 'requestBody.example.name in body must be of type object: "string"' withContinueOnErrors: false isRegexp: false - message: 'example value for requestBody in body does not validate its schema' withContinueOnErrors: false isRegexp: false - message: 'requestBody.example.parent.id in body must be of type number: "string"' withContinueOnErrors: false isRegexp: false fixture-342-2.yaml: comment: Botched correction attempt for fixture-342 todo: expectedLoadError: true expectedValid: false expectedMessages: # This one is a regexp to avoid being too stringent on expectations from another package (loads or analysis) - message: '.cannot unmarshal.' withContinueOnErrors: false isRegexp: true expectedWarnings: [] fixture-342.yaml: comment: 'Panic on interface conversion: early stop on error prevents the panic, but continuing it goes in, it goes down' todo: $ref have no sibling should be more general expectedLoadError: false expectedValid: false expectedMessages: - message: 'paths./get_main_object.get.parameters.$ref in body is a forbidden property' withContinueOnErrors: false isRegexp: false - message: 'invalid definition for parameter sid in body in operation ""' withContinueOnErrors: true isRegexp: false - message: 'paths./get_main_object.get.parameters.in in body should be one of [header]' withContinueOnErrors: false isRegexp: false - message: 'paths./get_main_object.get.parameters.type in body is required' withContinueOnErrors: false isRegexp: false - message: '"paths./get_main_object.get.parameters" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'invalid ref "nowhere.yaml#/definitions/sample_info/properties/sid"' withContinueOnErrors: true isRegexp: false - message: 'invalid definition as Schema for parameter in in operation ""' withContinueOnErrors: true isRegexp: false - message: 'invalid definition for parameter in in operation ""' withContinueOnErrors: true isRegexp: false - message: '"parameters.wrong" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'parameters.wrong.theName in body is a forbidden property' withContinueOnErrors: false isRegexp: false - message: 'parameters.wrong.theType in body is a forbidden property' withContinueOnErrors: false isRegexp: false - message: 'parameters.wrong.name in body is required' withContinueOnErrors: false isRegexp: false - message: 'parameters.wrong.in in body is required' withContinueOnErrors: false isRegexp: false - message: 'parameters.wrong.type in body is required' withContinueOnErrors: false isRegexp: false - message: '"parameters.notbetter" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'parameters.notbetter.properties in body is a forbidden property' withContinueOnErrors: false isRegexp: false - message: 'parameters.notbetter.type in body should be one of [string number boolean integer array]' withContinueOnErrors: false isRegexp: false - message: 'parameters.notbetter.name in body is required' withContinueOnErrors: false isRegexp: false - message: 'parameters.notbetter.in in body is required' withContinueOnErrors: false isRegexp: false - message: '"parameters.stillnogood" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'parameters.stillnogood.name in body is required' withContinueOnErrors: false isRegexp: false - message: 'parameters.stillnogood.in in body is required' withContinueOnErrors: false isRegexp: false - message: 'could not resolve reference in "\/get_main_object"\.GET to \$ref nowhere\.yaml#\/definitions\/sample_info\/properties\/sid: open .+nowhere\.yaml:\s.' withContinueOnErrors: true isRegexp: true expectedWarnings: - message: 'definition "#/definitions/sample_info" is not used anywhere' withContinueOnErrors: true isRegexp: false - message: $ref property should have no sibling in "".sid withContinueOnErrors: true isRegexp: false - message: $ref property should have no sibling in "". withContinueOnErrors: true isRegexp: false fixture-581-good-numbers.yaml: comment: todo: expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: [] fixture-581-good.yaml: comment: todo: expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: [] fixture-581-inline-param-format.yaml: comment: a collection of error messages raised by format validation todo: expectedLoadError: false expectedValid: false expectedMessages: - message: 'paths./fixture.get.parameters.in in body should be one of [body]' withContinueOnErrors: false isRegexp: false - message: 'paths./fixture.get.parameters.in in body should be one of [header]' withContinueOnErrors: false isRegexp: false - message: 'paths./fixture.get.parameters.multipleOf in body should be greater than 0' withContinueOnErrors: false isRegexp: false - message: '"paths./fixture.get.parameters" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: default value for inlineInfiniteInt in query does not validate its schema withContinueOnErrors: true isRegexp: false - message: default value for inlineInfiniteInt2 in query does not validate its schema withContinueOnErrors: true isRegexp: false - message: default value for inlineMaxInt in query does not validate its schema withContinueOnErrors: true isRegexp: false - message: default value for inlineMinInt in query does not validate its schema withContinueOnErrors: true isRegexp: false - message: default value for negFactor in query does not validate its schema withContinueOnErrors: true isRegexp: false - message: default value for negFactor2 in query does not validate its schema withContinueOnErrors: true isRegexp: false - message: default value for negFactor3 in query does not validate its schema withContinueOnErrors: true isRegexp: false - message: Checked value must be of type integer with format uint32 in inlineInfiniteInt withContinueOnErrors: true isRegexp: false - message: inlineInfiniteInt in query should be greater than or equal to 0 withContinueOnErrors: true isRegexp: false - message: Checked value must be of type integer with format uint32 in negFactor3 withContinueOnErrors: true isRegexp: false - message: 'factor MultipleOf declared for negFactor must be positive: -300' withContinueOnErrors: true isRegexp: false - message: negFactor2 in query should be a multiple of 3 withContinueOnErrors: true isRegexp: false - message: Minimum boundary value must be of type integer with format uint64 in inlineMaxInt withContinueOnErrors: true isRegexp: false - message: Maximum boundary value must be of type integer with format uint64 in inlineMaxInt withContinueOnErrors: true isRegexp: false - message: Minimum boundary value must be of type integer with format uint32 in inlineMinInt withContinueOnErrors: true isRegexp: false - message: Maximum boundary value must be of type integer with format uint32 in inlineMinInt withContinueOnErrors: true isRegexp: false - message: definitions.myId.uint64.default in body should be less than or equal to 0 withContinueOnErrors: true isRegexp: false - message: definitions.myId.uint8.default in body should be less than or equal to 255 withContinueOnErrors: true isRegexp: false - message: Checked value must be of type integer with format uint32 in inlineInfiniteInt2 withContinueOnErrors: true isRegexp: false - message: inlineInfiniteInt2 in query should be greater than or equal to 0 withContinueOnErrors: true isRegexp: false - message: 'default value for myid in query does not validate its schema' withContinueOnErrors: true isRegexp: false - message: 'invalid definition as Schema for parameter myid in query in operation "op1"' withContinueOnErrors: true isRegexp: false - message: myid.uint64.default in body should be less than or equal to 0 withContinueOnErrors: true isRegexp: false - message: myid.uint8.default in body should be less than or equal to 255 withContinueOnErrors: true isRegexp: false expectedWarnings: - message: definition "#/definitions/myId" is not used anywhere withContinueOnErrors: true isRegexp: false fixture-581-inline-param.yaml: comment: A variation on the theme of number constraints, inspired by isssue#581. Focuses on inline params. todo: Still limited by support of default/examples values check expectedLoadError: false expectedValid: false expectedMessages: - message: '"paths./fixture.get.parameters" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'paths./fixture.get.parameters.in in body should be one of [body]' withContinueOnErrors: false isRegexp: false - message: 'paths./fixture.get.parameters.in in body should be one of [header]' withContinueOnErrors: false isRegexp: false - message: 'paths./fixture.get.parameters.multipleOf in body should be greater than 0' withContinueOnErrors: false isRegexp: false - message: default value for inlineInfiniteInt in query does not validate its schema withContinueOnErrors: true isRegexp: false - message: default value for inlineMaxInt in query does not validate its schema withContinueOnErrors: true isRegexp: false - message: default value for inlineMinInt in query does not validate its schema withContinueOnErrors: true isRegexp: false - message: default value for negFactor in query does not validate its schema withContinueOnErrors: true isRegexp: false - message: Maximum boundary value must be of type integer (default format) in inlineMaxInt withContinueOnErrors: true isRegexp: false - message: Minimum boundary value must be of type integer (default format) in inlineMinInt withContinueOnErrors: true isRegexp: false - message: Minimum boundary value must be of type integer (default format) in inlineInfiniteInt withContinueOnErrors: true isRegexp: false - message: Maximum boundary value must be of type integer (default format) in inlineInfiniteInt withContinueOnErrors: true isRegexp: false - message: 'factor MultipleOf declared for negFactor must be positive: -300' withContinueOnErrors: true isRegexp: false - message: inlineMinInt in query should be less than or equal to 1 withContinueOnErrors: true isRegexp: false - message: definitions.myId.uint64.default in body should be less than or equal to 0 withContinueOnErrors: true isRegexp: false - message: definitions.myId.uint8.default in body should be less than or equal to 255 withContinueOnErrors: true isRegexp: false - message: default value for myid in query does not validate its schema withContinueOnErrors: true isRegexp: false - message: 'invalid definition as Schema for parameter myid in query in operation "op1"' withContinueOnErrors: true isRegexp: false - message: myid.uint64.default in body should be less than or equal to 0 withContinueOnErrors: true isRegexp: false - message: myid.uint8.default in body should be less than or equal to 255 withContinueOnErrors: true isRegexp: false expectedWarnings: - message: definition "#/definitions/myId" is not used anywhere withContinueOnErrors: true isRegexp: false fixture-581.yaml: comment: 'Issue#581 : value and type checking in constraints' todo: 'issue#581 error reporting solved: not only inline params are subject to this validation' expectedLoadError: false expectedValid: false expectedMessages: - message: 'paths./fixture.get.parameters.in in body should be one of [body]' withContinueOnErrors: false isRegexp: false - message: '"paths./fixture.get.parameters" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'definitions.myId.uint8.default in body should be less than or equal to 255' withContinueOnErrors: true isRegexp: false - message: 'default value for myid in query does not validate its schema' withContinueOnErrors: true isRegexp: false - message: 'invalid definition as Schema for parameter myid in query in operation "op1"' withContinueOnErrors: true isRegexp: false - message: 'myid.uint8.default in body should be less than or equal to 255' withContinueOnErrors: true isRegexp: false expectedWarnings: - message: 'definition "#/definitions/myId" is not used anywhere' withContinueOnErrors: true isRegexp: false fixture-859-2.yaml: comment: 'Issue#859: clear message on unresolved $ref. Additional scenario with items' todo: expectedLoadError: false expectedValid: false expectedMessages: # This one is a regexp since we cannot predict which $ref will fail first - message: 'some references could not be resolved in spec\. First found: object has no key "."' withContinueOnErrors: false isRegexp: true - message: 'could not resolve reference in / to $ref : object has no key "myitem"' withContinueOnErrors: true isRegexp: false expectedWarnings: - message: definition "#/definitions/myoutput" is not used anywhere withContinueOnErrors: true isRegexp: false fixture-859-good.yaml: comment: 'Issue#859: clear message on unresolved $ref. Valid spec baseline for further scenarios' todo: "" expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: - message: definition "#/definitions/myoutput" is not used anywhere withContinueOnErrors: false isRegexp: false fixture-859.yaml: comment: 'Issue#859: clear message on unresolved $ref. First scenario for messages Supplement for items, arrays and other nested structures in fixture-859-2.yaml' todo: would love to have all missing references in one shot. expectedLoadError: false expectedValid: false expectedMessages: - message: 'paths./.get.parameters.in in body should be one of [body]' withContinueOnErrors: false isRegexp: false - message: '"paths./.get.parameters" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'some references could not be resolved in spec\. First found: object has no key "."' withContinueOnErrors: true isRegexp: true #- message: 'invalid reference: "#/parameters/rateLimit"' #withContinueOnErrors: true #isRegexp: true - message: 'could not resolve reference in "/".GET to $ref #/parameters/rateLimit: object has no key "rateLimit"' withContinueOnErrors: true isRegexp: false - message: 'could not resolve reference in / to $ref : object has no key "record"' withContinueOnErrors: true isRegexp: false #- message: some parameters definitions are broken in "/".POST. Cannot carry on full checks on parameters for operation #withContinueOnErrors: true #isRegexp: false #- message: some parameters definitions are broken in "/".GET. Cannot carry on full checks on parameters for operation #withContinueOnErrors: true #isRegexp: false - message: 'could not resolve reference in "/".POST to $ref #/parameters/rateLimit: object has no key "rateLimit"' withContinueOnErrors: true isRegexp: false - message: 'could not resolve reference in "/".GET to $ref : object has no key "myparam"' withContinueOnErrors: true isRegexp: false expectedWarnings: - message: definition "#/definitions/myoutputs" is not used anywhere withContinueOnErrors: true isRegexp: false - message: parameter "#/parameters/rateLimits" is not used anywhere withContinueOnErrors: true isRegexp: false - message: definition "#/definitions/records" is not used anywhere withContinueOnErrors: true isRegexp: false - message: definition "#/definitions/myparams" is not used anywhere withContinueOnErrors: true isRegexp: false fixture-1050.yaml: comment: 'Valid spec: fix issue#1050 (dot separated path params)' todo: "" expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: [] fixture-1171.yaml: comment: An invalid array definition todo: Missing check on $ref sibling expectedLoadError: false expectedValid: false expectedMessages: - message: 'invalid definition as Schema for parameter other_server_id in path in operation "listZones"' withContinueOnErrors: true isRegexp: false - message: 'invalid definition for parameter in body in operation "getBody"' withContinueOnErrors: true isRegexp: false - message: '"paths./servers/{server_id}/zones.get.parameters" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: '"paths./server/getBody.get.parameters" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: '"paths./server/getBody.get.responses.200" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: '"paths./server/getBody.get.responses.200.schema" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'paths./server/getBody.get.responses.200.schema.properties.name in body must be of type object: "string"' withContinueOnErrors: false isRegexp: false - message: 'paths./server/getBody.get.responses.200.schema.properties.$ref in body must be of type object: "string"' withContinueOnErrors: false isRegexp: false - message: paths./server/getBody.get.responses.200.description in body is required withContinueOnErrors: false isRegexp: false - message: items in definitions.Zones is required withContinueOnErrors: false isRegexp: false - message: '"definitions.InvalidZone.items" must validate at least one schema (anyOf)' withContinueOnErrors: false isRegexp: false - message: definitions.InvalidZone.items.name in body is a forbidden property withContinueOnErrors: false isRegexp: false - message: path param "other_server_id" is not present in path "/servers/{server_id}/zones" withContinueOnErrors: true isRegexp: false - message: 'operation "getBody" has more than 1 body param: ["" "yet_other_server_id"]' withContinueOnErrors: true isRegexp: false - message: body param "yet_other_server_id" for "getBody" is a collection without an element type (array requires items definition) withContinueOnErrors: true isRegexp: false - message: in operation "listZones",path param "other_server_id" must be declared as required withContinueOnErrors: true isRegexp: false # TODO name missing in path - message: 'items in paths./server/getBody.get.parameters.schema is required' withContinueOnErrors: false isRegexp: false # TODO name missing in path - message: 'items in paths./servers/{server_id}/zones.get.parameters.schema is required' withContinueOnErrors: false isRegexp: false # TODO name missing in path - message: 'paths./server/getBody.get.parameters.in in body should be one of [header]' withContinueOnErrors: false isRegexp: false - message: 'paths./server/getBody.get.parameters.name in body is required' withContinueOnErrors: false isRegexp: false - message: 'paths./server/getBody.get.parameters.thestreetwithnoname in body is a forbidden property' withContinueOnErrors: false isRegexp: false - message: 'paths./servers/{server_id}/zones.get.parameters.in in body should be one of [body]' withContinueOnErrors: false isRegexp: false expectedWarnings: [] fixture-1231.yaml: comment: "" todo: "" expectedLoadError: false expectedValid: false expectedMessages: - message: '"parameters.customerIdParam" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'parameters.customerIdParam.example in body is a forbidden property' withContinueOnErrors: false isRegexp: false - message: 'parameters.customerIdParam.in in body should be one of [header]' withContinueOnErrors: false isRegexp: false expectedWarnings: - message: 'definitions.customer.create_date.example in body must be of type date-time: "float64"' withContinueOnErrors: true isRegexp: false - message: 'definitions.customer.email.example in body must be of type email: "float64"' withContinueOnErrors: true isRegexp: false - message: 'definitions.customer.id.example in body must be of type uuid: "float64"' withContinueOnErrors: true isRegexp: false - message: 'definitions.customer2.example.create_date in body must be of type date-time: "bad-date"' withContinueOnErrors: true isRegexp: false - message: 'definitions.customer2.example.id in body must be of type uuid: "mycustomer"' withContinueOnErrors: true isRegexp: false - message: 'example value for customer_id in path does not validate its schema' withContinueOnErrors: true isRegexp: false - message: '/v1/broker/{customer_id}.examples.id in body must be of type uuid: "mycustomer"' withContinueOnErrors: true isRegexp: false - message: '/v1/broker/{customer_id}.examples.create_date in body must be of type date-time: "bad-date"' withContinueOnErrors: true isRegexp: false - message: 'customer_id in path must be of type uuid: "xyz"' withContinueOnErrors: true isRegexp: false - message: '200.email.example in body must be of type email: "float64"' withContinueOnErrors: true isRegexp: false - message: '200.example.create_date in body must be of type date-time: "bad-date"' withContinueOnErrors: true isRegexp: false - message: '200.example.id in body must be of type uuid: "mycustomer"' withContinueOnErrors: true isRegexp: false - message: '200.create_date.example in body must be of type date-time: "float64"' withContinueOnErrors: true isRegexp: false - message: '200.id.example in body must be of type uuid: "float64"' withContinueOnErrors: true isRegexp: false - message: 'in operation "", example value in response 200 does not validate its schema' withContinueOnErrors: true isRegexp: false fixture-1238.yaml: comment: "" todo: "" expectedLoadError: false expectedValid: false expectedMessages: - message: definitions.RRSets in body must be of type array withContinueOnErrors: false isRegexp: false expectedWarnings: [] fixture-1243-2.yaml: comment: "" todo: "" expectedLoadError: false expectedValid: false expectedMessages: - message: path param "{loadBalancerId}" has no parameter definition withContinueOnErrors: false isRegexp: false expectedWarnings: [] fixture-1243-3.yaml: comment: "" todo: "" expectedLoadError: false expectedValid: false expectedMessages: - message: '"paths./loadBalancers/{loadBalancerId}/backendSets.get.parameters" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'in operation "ListBackendSets",path param "loadBalancerId" must be declared as required' withContinueOnErrors: true isRegexp: false - message: 'paths./loadBalancers/{loadBalancerId}/backendSets.get.parameters.in in body should be one of [header]' withContinueOnErrors: false isRegexp: false expectedWarnings: [] fixture-1243-4.yaml: comment: Check garbled path strings todo: "" expectedLoadError: false expectedValid: false expectedMessages: - message: '"paths./loadBalancers/{aLotOfLoadBalancerIds}/backendSets.get.parameters" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: 'paths./loadBalancers/{aLotOfLoadBalancerIds}/backendSets.get.parameters.in in body is required' withContinueOnErrors: false isRegexp: false - message: 'paths./loadBalancers/{aLotOfLoadBalancerIds}/backendSets.get.parameters.schema in body is required' withContinueOnErrors: false isRegexp: false - message: 'paths./loadBalancers/{aLotOfLoadBalancerIds}/backendSets.get.parameters.type in body is a forbidden property' withContinueOnErrors: false isRegexp: false - message: path param "{aLotOfLoadBalancerIds}" has no parameter definition withContinueOnErrors: true isRegexp: false - message: path /loadBalancers/{aLotOfLoadBalancerIds}/backendSets overlaps with /loadBalancers/{loadBalancerId}/backendSets withContinueOnErrors: true isRegexp: false - message: path param "{sid }" has no parameter definition withContinueOnErrors: true isRegexp: false - message: path param "sid" is not present in path "/othercheck/{si/d}warnMe" withContinueOnErrors: true isRegexp: false - message: path param "sid" is not present in path "/othercheck/{sid }/warnMe" withContinueOnErrors: true isRegexp: false expectedWarnings: - message: in path "/othercheck/{sid }/warnMe", param "{sid }" contains {,} or white space. Albeit not stricly illegal, this is probably no what you want withContinueOnErrors: true isRegexp: false - message: path stripped from path parameters /othercheck/{X/warnMe contains {,} or white space. This is probably no what you want. withContinueOnErrors: true isRegexp: false - message: path stripped from path parameters /othercheck/{si/d}warnMe contains {,} or white space. This is probably no what you want. withContinueOnErrors: true isRegexp: false fixture-1243-5.json: comment: "" todo: "" expectedLoadError: false expectedValid: false expectedMessages: - message: path param "{sid}" has no parameter definition withContinueOnErrors: false isRegexp: false - message: path param "{sid" is not present in path "/othercheck/{{sid}/warnMe" withContinueOnErrors: false isRegexp: false - message: path param "sid" is not present in path "/othercheck/{si/d}warnMe" withContinueOnErrors: false isRegexp: false - message: path /loadBalancers/{aLotOfLoadBalancerIds}/backendSets overlaps with /loadBalancers/{loadBalancerId}/backendSets withContinueOnErrors: false isRegexp: false expectedWarnings: - message: in path "/othercheck/{sid }/warnMe", param "{sid }" contains {,} or white space. Albeit not stricly illegal, this is probably no what you want withContinueOnErrors: false isRegexp: false - message: path stripped from path parameters /othercheck/{X/warnMe contains {,} or white space. This is probably no what you want. withContinueOnErrors: false isRegexp: false - message: path stripped from path parameters /othercheck/{si/d}warnMe contains {,} or white space. This is probably no what you want. withContinueOnErrors: false isRegexp: false fixture-1243-5.yaml: comment: "" todo: "" expectedLoadError: false expectedValid: false expectedMessages: #- message: '"paths./loadBalancers/{aLotOfLoadBalancerIds}/backendSets.get.parameters" # must validate one and only one schema (oneOf). Found none valid' # withContinueOnErrors: false # isRegexp: false #- message: '"paths./othercheck/{{sid}/warnMe.get.parameters" must validate one and # only one schema (oneOf). Found none valid' # withContinueOnErrors: false # isRegexp: false #- message: '"paths./othercheck/{sid }/warnMe.get.parameters" must validate one and # only one schema (oneOf). Found none valid' # withContinueOnErrors: false # isRegexp: false #- message: '"paths./othercheck/{si/d}warnMe.get.parameters" must validate one and # only one schema (oneOf). Found none valid' # withContinueOnErrors: false # isRegexp: false - message: 'path param "sid" is not present in path "/othercheck/{si/d}warnMe"' withContinueOnErrors: false isRegexp: false - message: 'path param "{sid" is not present in path "/othercheck/{{sid}/warnMe"' withContinueOnErrors: false isRegexp: false #- message: path param "{aLotOfLoadBalancerIds}" has no parameter definition # withContinueOnErrors: true # isRegexp: false - message: path param "{sid}" has no parameter definition withContinueOnErrors: false isRegexp: false #- message: path param "{sid }" has no parameter definition # withContinueOnErrors: true # isRegexp: false - message: path /loadBalancers/{aLotOfLoadBalancerIds}/backendSets overlaps with /loadBalancers/{loadBalancerId}/backendSets withContinueOnErrors: false isRegexp: false expectedWarnings: - message: in path "/othercheck/{sid }/warnMe", param "{sid }" contains {,} or white space. Albeit not stricly illegal, this is probably no what you want withContinueOnErrors: false isRegexp: false - message: path stripped from path parameters /othercheck/{X/warnMe contains {,} or white space. This is probably no what you want. withContinueOnErrors: false isRegexp: false - message: path stripped from path parameters /othercheck/{si/d}warnMe contains {,} or white space. This is probably no what you want. withContinueOnErrors: false isRegexp: false fixture-1243-good.yaml: comment: "" todo: "" expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: [] fixture-1243.yaml: comment: "" todo: "" expectedLoadError: false expectedValid: false expectedMessages: - message: '"paths./loadBalancers/{loadBalancerId}/backendSets.get.responses.200" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: paths./loadBalancers/{loadBalancerId}/backendSets.get.responses.200.headers.opc-response-id.$ref in body is a forbidden property withContinueOnErrors: false isRegexp: false - message: paths./loadBalancers/{loadBalancerId}/backendSets.get.responses.200.headers.opc-response-id.type in body is required withContinueOnErrors: false isRegexp: false - message: path param "{loadBalancerId}" has no parameter definition withContinueOnErrors: true isRegexp: false - message: 'in "paths./loadBalancers/{loadBalancerId}/backendSets.get.responses.200": $ref are not allowed in headers. In context for header "opc-response-id", one may not use $ref=":#/x-descriptions/opc-response-id"' withContinueOnErrors: false isRegexp: false expectedWarnings: [] fixture-1289-donotload.json: comment: "" todo: "" expectedLoadError: true expectedValid: false expectedMessages: - message: .yaml:.+ withContinueOnErrors: false isRegexp: true expectedWarnings: [] fixture-1289-donotload.yaml: comment: "" todo: "" expectedLoadError: true expectedValid: false expectedMessages: - message: .yaml:.+ withContinueOnErrors: false isRegexp: true expectedWarnings: [] fixture-1289-good.yaml: comment: "" todo: "" expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: [] fixture-1289.yaml: comment: "" todo: "" expectedLoadError: false expectedValid: false expectedMessages: - message: items in definitions.getSomeIds.properties.someIds is required withContinueOnErrors: false isRegexp: false expectedWarnings: [] fixture-collisions.yaml: comment: A supplement scenario for uniqueness tests in paths, operations, parameters todo: "" expectedLoadError: false expectedValid: false expectedMessages: - message: '"paths./bigbody/get.get.parameters" must validate one and only one schema (oneOf). Found none valid' withContinueOnErrors: false isRegexp: false - message: paths./dupparam/get.get.parameters in body shouldn't contain duplicates withContinueOnErrors: false isRegexp: false - message: paths./bigbody/get.get.parameters.in in body should be one of [header] withContinueOnErrors: false isRegexp: false - message: 'operation "ope2" has more than 1 body param: ["loadBalancerId2" "loadBalancerId3"]' withContinueOnErrors: true isRegexp: false - message: '"ope6" is defined 2 times' withContinueOnErrors: true isRegexp: false - message: '"ope5" is defined 2 times' withContinueOnErrors: true isRegexp: false - message: path /duplpath/{id1}/get overlaps with /duplpath/{id2}/get withContinueOnErrors: true isRegexp: false - message: duplicate parameter name "id2" for "query" in operation "ope7" withContinueOnErrors: true isRegexp: false - message: 'params in path "/loadBalancers/{loadBalancerId}/backendSets/{loadBalancerId}/get" must be unique: "{loadBalancerId}" conflicts with "{loadBalancerId}"' withContinueOnErrors: true isRegexp: false # with systematic param resolution, we get more errors like this one (body and type: string) - message: 'invalid definition for parameter loadBalancerId2 in body in operation "ope2"' withContinueOnErrors: true isRegexp: false - message: 'invalid definition for parameter loadBalancerId3 in body in operation "ope2"' withContinueOnErrors: true isRegexp: false expectedWarnings: [] fixture-constraints-on-numbers.yaml: comment: A supplement scenario for native vs float-based constraint verifications on integers (multipleOf,maximum, minimum). todo: This scenario supports current checks, that is for constraints on schemas with a default value only. It should be generalized (issue#581) and also for example values (issue#1231) expectedLoadError: false expectedValid: false expectedMessages: - message: default value for param1 in query does not validate its schema withContinueOnErrors: false isRegexp: false - message: default value for param2 in query does not validate its schema withContinueOnErrors: false isRegexp: false - message: default value for param3 in query does not validate its schema withContinueOnErrors: false isRegexp: false - message: default value for param4 in query does not validate its schema withContinueOnErrors: false isRegexp: false - message: default value for param5 in query does not validate its schema withContinueOnErrors: false isRegexp: false - message: default value for param6 in query does not validate its schema withContinueOnErrors: false isRegexp: false - message: default value for param7 in query does not validate its schema withContinueOnErrors: false isRegexp: false - message: default value for param8 in query does not validate its schema withContinueOnErrors: false isRegexp: false # Note how value has been implicitely converted to fload64 - message: param1 in query should be a multiple of 2.147483648e+09 withContinueOnErrors: false isRegexp: false - message: MultipleOf value must be of type integer with format int32 in param1 withContinueOnErrors: false isRegexp: false - message: MultipleOf value must be of type integer with format int32 in param2 withContinueOnErrors: false isRegexp: false - message: Checked value must be of type integer with format int32 in param2 withContinueOnErrors: false isRegexp: false - message: Checked value must be of type integer with format int32 in param3 withContinueOnErrors: false isRegexp: false - message: param3 in query should be a multiple of 10 withContinueOnErrors: false isRegexp: false - message: Checked value must be of type integer with format int32 in param4 withContinueOnErrors: false isRegexp: false - message: Checked value must be of type integer with format int32 in param5 withContinueOnErrors: false isRegexp: false # Note how value has been implicitely converted to fload64 - message: param5 in query should be less than or equal to 2.147483647e+09 withContinueOnErrors: false isRegexp: false - message: Checked value must be of type integer with format uint32 in param6 withContinueOnErrors: false isRegexp: false - message: Checked value must be of type integer with format int32 in param7 withContinueOnErrors: false isRegexp: false - message: Checked value must be of type integer with format uint32 in param8 withContinueOnErrors: false isRegexp: false # Note how value has been implicitely converted to fload64 - message: param8 in query should be greater than or equal to 2.147483647e+09 withContinueOnErrors: false isRegexp: false expectedWarnings: #- message: param8 in query has a default but no valid schema # withContinueOnErrors: false # isRegexp: false fixture-invalid-example-property.yaml: comment: todo: expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: - message: example value for getSomeIds in body does not validate its schema withContinueOnErrors: false isRegexp: false - message: 'getSomeIds.id.example in body must be of type number: "string"' withContinueOnErrors: false isRegexp: false fixture-valid-example-property.yaml: comment: todo: expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: [] petstore-expanded.json: comment: Fail Ref expansion in ContinueOnErrors mode panics todo: expectedLoadError: false expectedValid: false expectedMessages: - message: invalid ref "pet" withContinueOnErrors: false isRegexp: false # this one is a regexp since the full absolute path of the ref is reported - message: 'could not resolve reference in newPet to \$ref pet: open .[\/\\]pet:\s.+' withContinueOnErrors: true isRegexp: true # with systematic response expansion, get more errors - message: 'could not resolve reference in "\/pets".POST to \$ref .: open .:\s.+' withContinueOnErrors: true isRegexp: true expectedWarnings: [] gentest.yaml: comment: many parameters situations todo: expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: - message: deepNested1 in query has a default value and is required as parameter withContinueOnErrors: false isRegexp: false - message: queryParam2 in query has a default value and is required as parameter withContinueOnErrors: false isRegexp: false gentest2.yaml: comment: many parameters situations with default values todo: expectedLoadError: false expectedValid: true expectedMessages: [] expectedWarnings: - message: deepNested1 in query has a default value and is required as parameter withContinueOnErrors: false isRegexp: false - message: queryParam2 in query has a default value and is required as parameter withContinueOnErrors: false isRegexp: false gentest3.yaml: comment: default format in headers todo: expectedLoadError: false expectedValid: false expectedMessages: - message: 'in operation "gimmeLottaHeaders", default value in header sanity-check-header-2 for response 201 does not validate its schema' withContinueOnErrors: false isRegexp: false - message: 'sanity-check-header-2 in response must be of type date: "x1972-01-01"' withContinueOnErrors: false isRegexp: false expectedWarnings: [] fixture-all-formats.yaml: comment: all custom formats as default values todo: expectedLoadError: false expectedValid: false expectedMessages: # On parameters: - message: 'default value for n01 in query does not validate its schema' - message: 'default value for n03 in query does not validate its schema' - message: 'default value for n04 in query does not validate its schema' - message: 'default value for n05 in query does not validate its schema' - message: 'default value for n06 in query does not validate its schema' - message: 'default value for p01 in query does not validate its schema' - message: 'default value for p02 in query does not validate its schema' - message: 'default value for p03 in query does not validate its schema' - message: 'default value for p04 in query does not validate its schema' - message: 'default value for p05 in query does not validate its schema' - message: 'default value for p06 in query does not validate its schema' - message: 'default value for p07 in query does not validate its schema' - message: 'default value for p08 in query does not validate its schema' - message: 'default value for p09 in query does not validate its schema' - message: 'default value for p10 in query does not validate its schema' - message: 'default value for p11 in query does not validate its schema' - message: 'default value for p12 in query does not validate its schema' - message: 'default value for p13 in query does not validate its schema' - message: 'default value for p14 in query does not validate its schema' - message: 'default value for p15 in query does not validate its schema' - message: 'default value for p16 in query does not validate its schema' - message: 'default value for p17 in query does not validate its schema' - message: 'default value for p18 in query does not validate its schema' - message: 'default value for p20 in query does not validate its schema' - message: 'default value for p21 in query does not validate its schema' - message: 'default value for p22 in query does not validate its schema' - message: 'default value for p23 in query does not validate its schema' - message: 'n01 in query must be of type number: "string"' - message: 'n03 in query must be of type int32: "float64"' - message: 'n04 in query must be of type int64: "float64"' - message: 'Checked value must be of type integer with format uint32 in n05' - message: 'Checked value must be of type integer with format uint64 in n06' - message: 'p01 in query must be of type byte: "ZWxpemFiZXRocG9zZXk"' - message: 'p02 in query must be of type creditcard: "4111-1X11-1111-1111"' - message: 'p03 in query must be of type date: "1970-13-01"' - message: 'p04 in query must be of type date-time: "1963-13-19T08:30:06.283185Z"' - message: 'p05 in query must be of type duration: "three weeks"' - message: 'p06 in query must be of type email: "joe.bloggs-example.com"' - message: 'p07 in query must be of type hexcolor: "xFFFFFF"' - message: 'p08 in query must be of type hostname: "not_a_valid_hostname"' - message: 'p09 in query must be of type ipv4: "192.168.0.256"' - message: 'p10 in query must be of type ipv6: "o::1"' - message: 'p11 in query must be of type isbn: "abc-0321751043"' - message: 'p12 in query must be of type isbn10: "abc-0321751043"' - message: 'p13 in query must be of type isbn13: "978\|3401013190"' - message: 'p14 in query must be of type mac: "01:02:03:04:05:06:07"' - message: 'p15 in query must be of type bsonobjectid: "x07f1f77bcf86cd799439011"' - message: 'p16 in query must be of type password: "float64"' - message: 'p17 in query must be of type rgbcolor: "rgb(100,100)"' - message: 'p18 in query must be of type ssn: "111-11111"' - message: 'p20 in query must be of type uuid: "a8098c1a+f86e+11da+bd1a+00112444be1e"' - message: 'p21 in query must be of type uuid3: "bcd02e22+68f0+3046+a512+327cca9def8f"' - message: 'p22 in query must be of type uuid4: "025b0d74+00a2+4048+bf57+227c5111bb34"' - message: 'p23 in query must be of type uuid5: "886313e1+3b8a+5372+9b90+0c9aee199e5d"' # On schema: - message: 'definitions.allformats-bad.prop01.default in body must be of type byte: "ZWxpemFiZXRocG9zZXk"' - message: 'definitions.allformats-bad.prop02.default in body must be of type creditcard: "4111-1111-1111-111K"' - message: 'definitions.allformats-bad.prop03.default in body must be of type date: "1970-01-32"' - message: 'definitions.allformats-bad.prop04.default in body must be of type date-time: "1963-06-19T99:30:06.283185Z"' - message: 'definitions.allformats-bad.prop05.default in body must be of type duration: "weeks"' - message: 'definitions.allformats-bad.prop06.default in body must be of type email: "joe.bloggs-example.com"' - message: 'definitions.allformats-bad.prop07.default in body must be of type hexcolor: "float64"' - message: 'definitions.allformats-bad.prop08.default in body must be of type hostname: "---invalid-hostname---"' - message: 'definitions.allformats-bad.prop09.default in body must be of type ipv4: "192.2.0.1.45"' - message: 'definitions.allformats-bad.prop10.default in body must be of type ipv6: "x::1"' - message: 'definitions.allformats-bad.prop11.default in body must be of type isbn: "X0321751043"' - message: 'definitions.allformats-bad.prop12.default in body must be of type isbn10: "X0321751043"' - message: 'definitions.allformats-bad.prop13.default in body must be of type isbn13: "X978 3401013190"' - message: 'definitions.allformats-bad.prop14.default in body must be of type mac: "X1:02:03:04:05:06"' - message: 'definitions.allformats-bad.prop15.default in body must be of type bsonobjectid: "X507f1f77bcf86cd799439011"' - message: 'definitions.allformats-bad.prop16.default in body must be of type password: "float64"' - message: 'definitions.allformats-bad.prop17.default in body must be of type rgbcolor: "gb(100,100,100)"' - message: 'definitions.allformats-bad.prop18.default in body must be of type ssn: "Z111-11-1111"' - message: 'definitions.allformats-bad.prop20.default in body must be of type uuid: "a8098c1a+f86e+11da+bd1a+00112444be1e"' - message: 'definitions.allformats-bad.prop21.default in body must be of type uuid3: "bcd02e22+68f0+3046+a512+327cca9def8f"' - message: 'definitions.allformats-bad.prop22.default in body must be of type uuid4: "025b0d74+00a2+4048+bf57+227c5111bb34"' - message: 'definitions.allformats-bad.prop23.default in body must be of type uuid5: "886313e1+3b8a+5372+9b90+0c9aee199e5d"' - message: 'definitions.allformats-bad.propn01.default in body must be of type number: "string"' - message: 'definitions.allformats-bad.propn02.default in body must be of type number: "string"' - message: 'definitions.allformats-bad.propn03.default in body must be of type int32: "float64"' - message: 'definitions.allformats-bad.propn04.default in body must be of type int64: "float64"' - message: 'definitions.allformats-bad.propn05.default in body must be of type uint32: "float64"' - message: 'definitions.allformats-bad.propn06.default in body must be of type uint64: "float64"' # More messages with systematic response expansion - message: '200.prop01.default in body must be of type byte: "ZWxpemFiZXRocG9zZXk"' - message: '200.prop02.default in body must be of type creditcard: "4111-1111-1111-111K"' - message: '200.prop03.default in body must be of type date: "1970-01-32"' - message: '200.prop04.default in body must be of type date-time: "1963-06-19T99:30:06.283185Z"' - message: '200.prop05.default in body must be of type duration: "weeks"' - message: '200.prop06.default in body must be of type email: "joe.bloggs-example.com"' - message: '200.prop07.default in body must be of type hexcolor: "float64"' - message: '200.prop08.default in body must be of type hostname: "---invalid-hostname---"' - message: '200.prop09.default in body must be of type ipv4: "192.2.0.1.45"' - message: '200.prop10.default in body must be of type ipv6: "x::1"' - message: '200.prop11.default in body must be of type isbn: "X0321751043"' - message: '200.prop12.default in body must be of type isbn10: "X0321751043"' - message: '200.prop13.default in body must be of type isbn13: "X978 3401013190"' - message: '200.prop14.default in body must be of type mac: "X1:02:03:04:05:06"' - message: '200.prop15.default in body must be of type bsonobjectid: "X507f1f77bcf86cd799439011"' - message: '200.prop16.default in body must be of type password: "float64"' - message: '200.prop17.default in body must be of type rgbcolor: "gb(100,100,100)"' - message: '200.prop18.default in body must be of type ssn: "Z111-11-1111"' - message: '200.prop20.default in body must be of type uuid: "a8098c1a+f86e+11da+bd1a+00112444be1e"' - message: '200.prop21.default in body must be of type uuid3: "bcd02e22+68f0+3046+a512+327cca9def8f"' - message: '200.prop22.default in body must be of type uuid4: "025b0d74+00a2+4048+bf57+227c5111bb34"' - message: '200.prop23.default in body must be of type uuid5: "886313e1+3b8a+5372+9b90+0c9aee199e5d"' - message: '200.propn01.default in body must be of type number: "string"' - message: '200.propn02.default in body must be of type number: "string"' - message: '200.propn03.default in body must be of type int32: "float64"' - message: '200.propn04.default in body must be of type int64: "float64"' - message: '200.propn05.default in body must be of type uint32: "float64"' - message: '200.propn06.default in body must be of type uint64: "float64"' - message: 'in operation "op2", default value in response 200 does not validate its schema' expectedWarnings: [] fixture-bad-response.yaml: comment: $ref sibling in response todo: expectedLoadError: false expectedValid: false expectedMessages: - message: '"paths./fixture.get.responses.200" must validate one and only one schema (oneOf). Found none valid' - message: 'paths./fixture.get.responses.200.$ref in body is a forbidden property' expectedWarnings: - message: 'definition "#/definitions/someIds" is not used anywhere' withContinueOnErrors: true	63.4 KB	2025-05-25 12:27
📄 fixture-1050.yaml swagger: '2.0' info: description: >- Minimal swagger file to demonstrate a dot-in-th-path problem version: 0.0.1 title: test tags: - name: test description: test the go-swagger generator bug paths: /{fileName}.{fileExt}: get: tags: - test operationId: test parameters: - name: fileName in: path required: true type: string - name: fileExt in: path required: true type: string responses: '204': description: successful operation '500': description: Operation error	629 B	2025-05-25 12:27
📄 fixture-1171.yaml # In this one we make sure arrays without items are detected by validation # Conversely, objects with items are detected with fixture for issue #1238 swagger: '2.0' info: title: issue-1171 version: 0.0.1 license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: '/servers/{server_id}/zones': get: operationId: listZones tags: - zones parameters: - name: server_id in: path required: true type: string - name: other_server_id in: path schema: # Invalid array definition type: array properties: other: type: string responses: '200': description: An array of Zones schema: $ref: '#/definitions/Zones' '/server/getBody': get: operationId: getBody parameters: - name: yet_other_server_id in: body schema: # Invalid array definition type: array properties: other: type: string # param should be named? - thestreetwithnoname: storyOfTheStreetsAreMine in: body type: integer responses: '200': schema: $ref: '#/definitions/Zones' '/servers/{server_id}/zones/{zone_id}': get: operationId: listZone tags: - zones parameters: - name: server_id in: path required: true type: string - name: zone_id type: string in: path required: true responses: '200': description: A Zone schema: $ref: '#/definitions/Zone' '201': description: An invalid Zone schema: $ref: '#/definitions/InvalidZone' '203': description: An empty Zone schema: $ref: '#/definitions/EmptyZone' definitions: # An array must have an items definition Zones: type: array properties: name: type: string Zone: type: array items: type: string InvalidZone: type: array items: # This is a forbidden property name: type: string EmptyZone: type: array # Empty description: no error items:	2.39 KB	2025-05-25 12:27
📄 fixture-1231.yaml swagger: '2.0' info: title: test example version: "1.0.0" produces: - application/json paths: /v1/broker/{customer_id}: get: #operationId: a parameters: - $ref: "#/parameters/customerIdParam" responses: 200: # in line example description: Customer schema: type: object properties: id: type: string format: uuid email: type: string format: email create_date: type: string format: date-time examples: application/json: id: mycustomer email: mycustomer@ripoffpark.com create_date: bad-date /v1/vendor/{customer_id}: get: #operationId: b parameters: - $ref: "#/parameters/customerIdParam" responses: 200: description: Customer schema: $ref: '#/definitions/customer2' /v1/customer/{customer_id}: get: #operationId: c parameters: - $ref: "#/parameters/customerIdParam" responses: 200: description: Customer schema: $ref: '#/definitions/customer' parameters: customerIdParam: name: customer_id description: The ID of the customer in: path required: true type: string format: uuid example: xyz #<---- example not allowed here definitions: # example property by property customer: type: object required: - id properties: id: type: string format: uuid description: The unique ID of the customer example: 123 email: type: string format: email description: The email address of the customer example: 123 create_date: type: string format: date-time description: The date and time when the customer was created example: 123 # example at object level customer2: type: object required: - id properties: id: type: string format: uuid description: The unique ID of the customer email: type: string format: email description: The email address of the customer create_date: type: string format: date-time description: The date and time when the customer was created example: id: 'mycustomer' email: 'mycustomer@ripoffpark.com' create_date: bad-date	2.53 KB	2025-05-25 12:27
📄 fixture-1238.yaml # This spec should be correctly detected as invalid swagger: '2.0' info: title: issue-1238 version: 0.0.1 license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: '/servers/{server_id}/zones': get: operationId: listZones tags: - zones parameters: - name: server_id in: path required: true type: string responses: '200': description: An array of Zones schema: $ref: '#/definitions/Zones' '/servers/{server_id}/zones/{zone_id}': get: operationId: listZone tags: - zones parameters: - name: server_id in: path required: true type: string - name: zone_id type: string in: path required: true responses: '200': description: A Zone schema: $ref: '#/definitions/Zone' definitions: Zones: type: array items: $ref: '#/definitions/Zone' Zone: type: object properties: name: type: string RR: $ref: '#/definitions/RRSets' RRSets: # Declaring items for an object should be correctly assessed as invalid and not trigger a panic (issue#1238) type: object items: $ref: '#/definitions/RRSet' RRSet: properties: name: type: string	1.45 KB	2025-05-25 12:27
📄 fixture-1243-2.yaml --- swagger: "2.0" info: title: "Load Balancing Service API" description: API for the Load Balancing Service version: "20170115" basePath: /20170115 paths: /loadBalancers/{loadBalancerId}/backendSets: get: summary: "ListBackendSets" tags: ['loadBalancer'] description: Lists all backend sets associated with a given load balancer. operationId: "ListBackendSets" # Missing parameter in path produces: - "application/json" responses: 200: description: The list is being retrieved. # fixed that: $ref is forbidden in headers headers: opc-response-id: description: \| Unique identifier for the response. type: string	768 B	2025-05-25 12:27
📄 fixture-1243-3.yaml --- swagger: "2.0" info: title: "Load Balancing Service API" description: API for the Load Balancing Service version: "20170115" basePath: /20170115 paths: /loadBalancers/{loadBalancerId}/backendSets: get: summary: "ListBackendSets" tags: ['loadBalancer'] description: Lists all backend sets associated with a given load balancer. operationId: "ListBackendSets" # fixed that: Missing parameter in path parameters: - name: loadBalancerId in: path type: string # Ah: should be required produces: - "application/json" responses: 200: description: The list is being retrieved. # fix that: $ref is forbidden in headers headers: opc-response-id: description: \| Unique identifier for the response. type: string	904 B	2025-05-25 12:27
📄 fixture-1243-4.yaml --- swagger: "2.0" info: title: "Load Balancing Service API" description: Play with path parameters and checks version: "20170115" basePath: /20170115 paths: /loadBalancers/{loadBalancerId}/backendSets: get: summary: "ListBackendSets" tags: ['loadBalancer'] description: Lists all backend sets associated with a given load balancer. operationId: "ListBackendSets" # fixed that: Missing parameter in path parameters: - name: loadBalancerId # fixed that: specified in in: path type: string # fixed that: should be required required: true produces: - "application/json" responses: 200: description: The list is being retrieved. # fixed that: $ref is forbidden in headers headers: opc-response-id: description: \| Unique identifier for the response. type: string /loadBalancers/{aLotOfLoadBalancerIds}/backendSets: get: summary: "ERROR" tags: ['loadBalancer'] description: Triggers an invalid spec check operationId: "ListALotOfBackendSets" # fixed that: Missing parameter in path parameters: # Error here: parameter don't match - name: aLotOfLoadBalancerId type: string # fixed that: should be required required: true produces: - "application/json" responses: 200: description: The list is being retrieved. # fixed that: $ref is forbidden in headers headers: opc-response-id: description: \| Unique identifier for the response. type: string # This one should give a warning /othercheck/{{sid}/warnMe: get: parameters: - name: sid type: string in: path required: true produces: - "application/json" responses: 200: # This one also /othercheck/{sid }/warnMe: get: parameters: - name: sid type: string in: path required: true produces: - "application/json" responses: 200: # This one fails /othercheck/{si/d}warnMe: get: parameters: - name: sid # fixed this in: path type: string required: true produces: - "application/json" responses: 200:	2.44 KB	2025-05-25 12:27
📄 fixture-1243-5.json { "swagger":"2.0", "info":{"title":"Load Balancing Service API","description":"Play with path parameters and checks","version":"20170115"}, "basePath":"/20170115", "paths":{ "/loadBalancers/{loadBalancerId}/backendSets":{ "get":{ "summary":"ListBackendSets", "tags":["loadBalancer"], "description":"Lists all backend sets associated with a given load balancer.", "operationId":"ListBackendSets", "parameters":[ { "name":"loadBalancerId", "type":"string", "in":"path", "required":true } ], "produces":["application/json"], "responses":{ "200":{ "description":"The list is being retrieved.", "headers":{ "opc-response-id":{ "description":"Unique identifier for the response.\n", "type":"string" } } } } } }, "/loadBalancers/{aLotOfLoadBalancerIds}/backendSets":{ "get":{ "summary":"ERROR", "tags":["loadBalancer"], "description":"Triggers an invalid spec check", "operationId":"ListALotOfBackendSets", "parameters":[ { "name":"aLotOfLoadBalancerIds", "type":"string", "in":"path", "required":true } ], "produces":[ "application/json" ], "responses":{ "200":{ "description":"The list is being retrieved.", "headers":{ "opc-response-id":{ "description":"Unique identifier for the response.\n", "type":"string" } } } } } }, "/othercheck/{{sid}/warnMe":{ "get":{ "parameters":[ { "name":"{sid", "type":"string", "in":"path", "required":true } ], "produces":[ "application/json" ], "responses":{ "200":null } } }, "/othercheck/{sid }/warnMe":{ "get":{ "parameters":[ { "name":"sid ", "in":"path", "type":"string", "required":true } ], "produces":["application/json"], "responses":{ "200":null } } }, "/othercheck/{si/d}warnMe":{ "get":{ "parameters":[ { "name":"sid", "type":"string", "in":"path", "required":true } ], "produces":["application/json"], "responses":{ "200":null } } } } }	2.32 KB	2025-05-25 12:27
📄 fixture-1243-5.yaml --- swagger: "2.0" info: title: "Load Balancing Service API" description: Play with path parameters and checks version: "20170115" basePath: /20170115 paths: /loadBalancers/{loadBalancerId}/backendSets: get: summary: "ListBackendSets" tags: ['loadBalancer'] description: Lists all backend sets associated with a given load balancer. operationId: "ListBackendSets" # fixed that: Missing parameter in path parameters: - name: loadBalancerId type: string in: path # fixed that: should be required required: true produces: - "application/json" responses: 200: description: The list is being retrieved. # fixed that: $ref is forbidden in headers headers: opc-response-id: description: \| Unique identifier for the response. type: string /loadBalancers/{aLotOfLoadBalancerIds}/backendSets: get: summary: "ERROR" tags: ['loadBalancer'] description: Triggers an invalid spec check operationId: "ListALotOfBackendSets" # fixed that: Missing parameter in path parameters: # Fixed that error here: parameter don't match - name: aLotOfLoadBalancerIds in: path type: string # fixed that: should be required required: true produces: - "application/json" responses: 200: description: The list is being retrieved. # fixed that: $ref is forbidden in headers headers: opc-response-id: description: \| Unique identifier for the response. type: string # This one should give a warning /othercheck/{{sid}/warnMe: get: parameters: # Fixed this: stupid, but what if I explictly want a { in name... # Still an error since we add " in the name string - name: '{sid' in: path type: string required: true produces: - "application/json" responses: 200: # This one also /othercheck/{sid }/warnMe: get: parameters: # Fixed this: stupid, but what if I explictly want a space in name... # Still an error since we add " in the name string - name: 'sid ' in: path type: string required: true produces: - "application/json" responses: 200: # This one fails /othercheck/{si/d}warnMe: get: parameters: - name: sid in: path type: string required: true produces: - "application/json" responses: 200:	2.68 KB	2025-05-25 12:27
📄 fixture-1243-good.yaml --- swagger: "2.0" info: title: "Load Balancing Service API" description: API for the Load Balancing Service version: "20170115" basePath: /20170115 paths: /loadBalancers/{loadBalancerId}/backendSets: get: summary: "ListBackendSets" tags: ['loadBalancer'] description: Lists all backend sets associated with a given load balancer. operationId: "ListBackendSets" # fixed that: Missing parameter in path parameters: - name: loadBalancerId in: path type: string # fixed that: should be required required: true produces: - "application/json" responses: 200: description: The list is being retrieved. # fixed that: $ref is forbidden in headers headers: opc-response-id: description: \| Unique identifier for the response. type: string	939 B	2025-05-25 12:27
📄 fixture-1243.yaml --- swagger: "2.0" info: title: "Load Balancing Service API" description: API for the Load Balancing Service version: "20170115" basePath: /20170115 paths: /loadBalancers/{loadBalancerId}/backendSets: get: summary: "ListBackendSets" tags: ['loadBalancer'] description: Lists all backend sets associated with a given load balancer. operationId: "ListBackendSets" # error no param defined produces: - "application/json" responses: 200: # we should not have a forbidden property message here: instead description: The list is being retrieved. # $ref is forbidden in headers headers: opc-response-id: $ref: '#/x-descriptions/opc-response-id' x-descriptions: opc-response-id: description: \| Unique identifier for the response. type: string	887 B	2025-05-25 12:27
📄 fixture-1289-donotload.json "someIds": { "type": "array", "example": [ 413, 231, 777 ], "default": [ 413, 231, 777 ], "items": { "type": "number" } }, "getSomeIds": { "type": "object", "properties": { "someIds": { "$ref": "#/definitions/someIds", "type": "array" } } },	378 B	2025-05-25 12:27
📄 fixture-1289-donotload.yaml "someIds": { "type": "array", "example": [ 413, 231, 777 ], "default": [ 413, 231, 777 ], "items": { "type": "number" } }, "getSomeIds": { "type": "object", "properties": { "someIds": { "$ref": "#/definitions/someIds", "type": "array" } } },	378 B	2025-05-25 12:27
📄 fixture-1289-good.yaml --- swagger: '2.0' info: title: 'fixture 1289' version: '1.0' produces: - application/json paths: '/fixture': get: operationId: op1 responses: '200': description: 'erroneous response' schema: # Expect clean $ref: '#/definitions/someIds' definitions: someIds: type: string	355 B	2025-05-25 12:27
📄 fixture-1289.yaml --- swagger: '2.0' info: title: 'fixture 1289' version: '1.0' produces: - application/json paths: '/fixture': get: operationId: op1 responses: '200': description: 'erroneous response' schema: $ref: '#/definitions/getSomeIds' definitions: getSomeIds: type: object properties: # Expect a clear message about $ref siblings someIds: $ref: '#/definitions/someIds' type: array someIds: type: string	503 B	2025-05-25 12:27
📄 fixture-161-2.json { "swagger": "2.0", "info": { "description": "", "version": "1.0.0", "title": "issue#161", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/folders": { "post": { "parameters": [{ "name": "requestBody", "in": "body", "description": "body parameter", "required": true, "schema": { "type": "object", "title": "body of creating folder", "description": "body parameter of creating folder", "default": "{\"name\":\"new\",\"parent\":{\"id\":\"0\"}}", "required": ["name", "parent"], "properties": { "name": { "type": "string" }, "parent": { "type": "object", "properties": { "id": { "type": "number" } } } }, "readOnly": false, "externalDocs": { "description": "create a new folder.", "url": "https://box-content.readme.io/#create-a-new-folder" }, "example": { "name": "newname.jpg", "parent": { "id": "0" } } } }], "responses": { "200": { "description": "Some response" } } } } } }	2.04 KB	2025-05-25 12:27
📄 fixture-161-good.json { "swagger": "2.0", "info": { "description": "", "version": "1.0.0", "title": "issue#161", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/folders": { "post": { "parameters": [{ "name": "requestBody", "in": "body", "description": "body parameter", "required": true, "schema": { "type": "object", "title": "body of creating folder", "description": "body parameter of creating folder", "default": { "name": "new", "parent":{ "id": 0 } }, "required": ["name", "parent"], "properties": { "name": { "type": "string" }, "parent": { "type": "object", "properties": { "id": { "type": "number" } } } }, "readOnly": false, "externalDocs": { "description": "create a new folder.", "url": "https://box-content.readme.io/#create-a-new-folder" }, "example": { "name": "newname.jpg", "parent": { "id": "0" } } } }], "responses": { "200": { "description": "Some response" } } } } } }	2.06 KB	2025-05-25 12:27
📄 fixture-161.json { "swagger": "2.0", "info": { "description": "", "version": "1.0.0", "title": "issue#161", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/folders": { "post": { "parameters": [{ "name": "requestBody", "in": "body", "description": "body parameter", "required": true, "schema": { "type": "object", "title": "body of creating folder", "description": "body parameter of creating folder", "default": "{\"name\":\"new\",\"parent\":{\"id\":\"0\"}}", "required": ["name", "parent"], "properties": { "name": { "type": "object" }, "parent": { "type": "object", "properties": { "id": { "type": "number" } } } }, "readOnly": false, "externalDocs": { "description": "create a new folder.", "url": "https://box-content.readme.io/#create-a-new-folder" }, "example": { "name": "newname.jpg", "parent": { "id": "0" } } } }], "responses": { "200": { "description": "Some response" } } } } } }	2.04 KB	2025-05-25 12:27
📄 fixture-342-2.yaml swagger: '2.0' info: title: issue-342 description: A variant on issue-342 with an incorrect attempt to fix the $ref sibling issue version: 0.0.1 license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: /get_main_object: get: tags: - maindata parameters: # Here, declared as a property and not an item: cannot marshall $ref: "#/parameters/sid" responses: '200': parameters: sid: #name: mysid in: body required: true type: integer format: int64	627 B	2025-05-25 12:27
📄 fixture-342.yaml swagger: '2.0' info: title: issue-342 description: \| Original issue: a spec which triggers a panic because of invalid type assertion on parameters. Specifically, this tests how validation carries on when references returns an unexpected object. This may happen for parameters and responses and should be accurately reported. version: 0.0.1 license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: /get_main_object: get: tags: - maindata parameters: - name: pquery1 in: query required: true $ref: "#/definitions/sample_info/properties/sid" # <-- error: a whole schema replaces the parameter - $ref: "#/parameters/wrong" # <-- error: wrong param props - $ref: "#/parameters/notbetter" # <-- error: wrong param schema - $ref: "#/parameters/stillnogood" # <-- error: wrong param schema - name: pquery2 in: query required: true $ref: "nowhere.yaml#/definitions/sample_info/properties/sid" # <-- error: expand ref error - name: sid in: body required: true $ref: "#/definitions/sample_info/properties/sid" # <-- error: a whole schema replaces the parameter responses: '200': parameters: wrong: theName: wrongNameProperty theType: wrongTypePropery notbetter: type: object properties: whenDidThatHappen: type: string format: date stillnogood: schema: type: object properties: aintnogood: type: integer definitions: sample_info: type: object properties: sid: type: string format: uuid	1.74 KB	2025-05-25 12:27
📄 fixture-43-2.json { "swagger": "2.0", "info": { "title": "Test", "description": "Tests issue with examples and nested objects with items properties", "version": "1.0" }, "host": "FooBar", "basePath": "/latest", "schemes": [ "https" ], "produces": [ "application/json" ], "paths": { "/foo/": { "get": { "description": "Tests issue with nested items object properties and examples", "summary": "Tests issue with nested items object properties and examples", "responses": { "200": { "description": "Example should match spec", "schema": { "type": "array", "items": { "type": "object", "properties": { "items": { "type": "array", "maxItems": 255, "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" } } } } } } } } } } } } }	1.74 KB	2025-05-25 12:27
📄 fixture-43.json { "swagger": "2.0", "info": { "title": "Test", "description": "Tests issue with examples and nested objects with items properties", "version": "1.0" }, "host": "FooBar", "basePath": "/latest", "schemes": [ "https" ], "produces": [ "application/json" ], "paths": { "/foo/": { "get": { "description": "Tests issue with nested items object properties and examples", "summary": "Tests issue with nested items object properties and examples", "responses": { "200": { "description": "Example should match spec", "examples": { "application/json": [ { "item": [ { "id": 1 } ] } ] }, "schema": { "type": "array", "items": { "type": "object", "properties": { "item": { "type": "array", "maxItems": 255, "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" } } } } } } } } } } } } }	2.17 KB	2025-05-25 12:27
📄 fixture-581-good-numbers.yaml --- swagger: '2.0' info: title: 'fixture for issue #581' version: '1.0' description: \| This one just to set a minimum/maximum valid case for non regression. It exersises, for numbers: - inline parameters - schema parameters - schema parameters through $ref - schema for response - schema object for response, with object and array - schema for response through $ref produces: - application/json paths: /fixture: get: operationId: op1 parameters: - name: myid in: body schema: $ref: '#/definitions/myId' responses: 200: description: 'response exercising number boundaries' schema: $ref: '#/definitions/someIds' 201: description: 'response exercising number boundaries' schema: type: number minimum: 0 maximum: 100 default: 0 401: description: 'response exercising number boundaries' schema: type: object properties: shortInt: type: number minimum: 0 maximum: 100 default: 0 shortIntList: type: array items: type: number minimum: 0 maximum: 100 default: 0 definitions: myId: type: object properties: smallId: type: number minimum: 0 maximum: 12 default: 10 format: uint64 someIds: type: object properties: smallId: type: number minimum: 0 maximum: 12 default: 10 format: uint64 smallIdList: type: array items: type: number minimum: 0 maximum: 100 default: 0	1.87 KB	2025-05-25 12:27
📄 fixture-581-good.yaml --- swagger: '2.0' info: title: 'fixture for issue #581' version: '1.0' description: \| This one just to set a minimum/maximum valid case for non regression. It exersises, for integers: - inline parameters - schema parameters - schema parameters through $ref - schema for response - schema object for response, with object and array - schema for response through $ref produces: - application/json paths: /fixture: get: operationId: op1 parameters: - name: myid in: body schema: $ref: '#/definitions/myId' responses: 200: description: 'response exercising integer boundaries' schema: $ref: '#/definitions/someIds' 201: description: 'response exercising integer boundaries' schema: type: integer minimum: 0 maximum: 100 default: 0 401: description: 'response exercising integer boundaries' schema: type: object properties: shortInt: type: integer minimum: 0 maximum: 100 default: 0 shortIntList: type: array items: type: integer minimum: 0 maximum: 100 default: 0 definitions: myId: type: object properties: smallId: type: integer minimum: 0 maximum: 12 default: 10 format: uint64 someIds: type: object properties: smallId: type: integer minimum: 0 maximum: 12 default: 10 format: uint64 smallIdList: type: array items: type: integer minimum: 0 maximum: 100 default: 0	1.88 KB	2025-05-25 12:27
📄 fixture-581-inline-param-format.yaml --- swagger: '2.0' info: title: 'fixture for issue #581' version: '1.0' description: \| Exercise boundary checks for minimum, maximum and multipleOf For integer parameters with formats int32, uint32 or uint64 - inline - schema objects, with nested array - via $refs produces: - application/json paths: /fixture: get: operationId: op1 parameters: - name: myid in: query schema: $ref: '#/definitions/myId' - name: inlineMaxInt in: query type: integer format: uint64 # Error: boundary inconsistent with format minimum: -100 # Error: Out of bound maximum maximum: 922337203685477580700000000000000000 default: 99 - name: inlineMinInt in: query type: integer format: uint32 # Error: Out of bound minimum minimum: -1 # Error: Out of bound maximum maximum: 4294967296 default: 99 - name: inlineInfiniteInt in: query type: integer format: uint32 minimum: 0 maximum: 2000000 # Errors: invalid default #default: -10000000000000000000000000000000000000000000000000 default: -922 # TODO: not validated since no default value!!! - name: inlineInfiniteInt2 in: query type: integer format: uint32 minimum: 0 maximum: 2000000 # Errors: invalid default default: -4294967296 # TODO: not validated since no default value!!! - name: bigInt in: query type: integer format: int32 # Error: Out of bound factor multipleOf: 4294967296 - name: negFactor in: query type: integer # Allows signed format format: int32 # Error: negative factor (consistent with format) multipleOf: -300 default: -600 - name: negFactor2 in: query type: integer # Allows signed format format: uint32 # Error: consistent with format multipleOf: 3 # Error: fails constraint, but consistent with format default: 2 - name: negFactor3 in: query type: integer # Allows signed format format: uint32 # Error: consistent with format multipleOf: 3 # Error: successful constraint, but inconsistent with format default: -6 responses: 200: responses: 200: description: 'response exercising integer boundaries' schema: $ref: '#/definitions/someIds' definitions: myId: type: object properties: uint8: type: integer minimum: 0 maximum: 255 # Error: default does not validate against boundaries default: 256 int64: type: integer minimum: -9223372036854775808 maximum: 9223372036854775807000 uint64: type: integer minimum: -9223372036854775807000 maximum: 0 # See if detected? default: 1 uint64-wrong: type: integer minimum: 0 maximum: 18446744073709551616 someIds: type: object properties: smallId: type: integer minimum: 0 maximum: 12	3.42 KB	2025-05-25 12:27
📄 fixture-581-inline-param.yaml --- swagger: '2.0' info: title: 'fixture for issue #581' version: '1.0' description: \| Exercise boundary checks for minimum, maximum and multipleOf For integer parameters (as default int64): - inline - schema objects, with nested array - via $refs produces: - application/json paths: /fixture: get: operationId: op1 parameters: - name: myid in: query schema: $ref: '#/definitions/myId' - name: inlineMaxInt in: query type: integer minimum: 0 #maximum: 100 # Error: Out of bound maximum maximum: 922337203685477580700000000000000000 default: 99 - name: inlineMinInt in: query type: integer minimum: -9223372036854775807000000000000000 # Error: Out of bound minimum maximum: 1 default: 99 - name: inlineInfiniteInt in: query type: integer # Errors: Out of bound minimum and maximum minimum: -92233720368547758070000000000000000000000 maximum: 92233720368547758070000000000000000 default: 99 - name: bigInt in: query type: integer # TODO: not validated since no default value!!! # Error: Out of bound factor multipleOf: 3922337203685477580700000000000000000000000 # ISSUE: does use native method => use number - name: negFactor in: query type: integer # Error: negative factor multipleOf: -300 default: -600 responses: 200: responses: 200: description: 'response exercising integer boundaries' schema: # TODO: should validate here too $ref: '#/definitions/someIds' # TODO: should validate here too definitions: myId: type: object properties: uint8: type: integer minimum: 0 maximum: 255 # Error: default does not validate against boundaries default: 256 int64: type: integer minimum: -9223372036854775808 maximum: 9223372036854775807000 uint64: type: integer minimum: -9223372036854775807000 maximum: 0 # See if detected? default: 1 uint64-wrong: type: integer minimum: 0 maximum: 18446744073709551616 someIds: type: object properties: smallId: type: integer minimum: 0 maximum: 12	2.53 KB	2025-05-25 12:27
📄 fixture-581.yaml --- swagger: '2.0' info: title: 'fixture for issue #581' version: '1.0' description: \| test verification of overflow on min/max boundary reproduces the initial reported case,with schema and $refs produces: - application/json paths: /fixture: get: operationId: op1 parameters: - name: myid in: query schema: $ref: '#/definitions/myId' responses: 200: description: 'response exercising integer boundaries' schema: $ref: '#/definitions/someIds' definitions: myId: type: object properties: uint8: type: integer minimum: 0 maximum: 255 # Error: default does not validate against boundaries default: 256 int64: type: integer minimum: -9223372036854775808 # Error: maximum is not an int64 maximum: 9223372036854775807000 uint64: type: integer minimum: -9223372036854775807000 maximum: 18446744073709551615 uint64-wrong: type: integer minimum: 0 maximum: 18446744073709551616 someIds: type: object properties: smallId: type: integer minimum: 0 maximum: 12	1.23 KB	2025-05-25 12:27
📄 fixture-859-2.yaml --- swagger: "2.0" info: version: "0.1.0" title: issue#859. Reference validation description: more exercising on $ref recursion,default response,items paths: /: post: parameters: - $ref: "#/parameters/rateLimit" responses: 200: description: "Success" get: parameters: - name: myparam in: body schema: $ref: '#/definitions/myparam' responses: default: description: the record schema: $ref: "#/definitions/record" 404: $ref: "#/responses/notFound" 200: description: "Success" schema: $ref: "#definitions/myoutput" 201: description: "Success" schema: $ref: "#definitions/myoutput" parameters: rateLimit: name: X-Rate-Limit in: header type: integer format: int32 responses: notFound: description: Not found schema: $ref: "#/definitions/record" definitions: record: type: object properties: createdAt: type: string format: date-time myparam: type: array items: $ref: "#/definitions/myitems" myoutput: type: array items: # Error: unresolved $ref: "#/definitions/myitem" myitems: type: object properties: ident: type: string	1.36 KB	2025-05-25 12:27
📄 fixture-859-good.yaml --- swagger: "2.0" info: version: "0.1.0" title: issue#859. Reference validation paths: /: post: parameters: - $ref: "#/parameters/rateLimit" responses: 200: description: "Success" get: parameters: - name: myparam in: body schema: $ref: '#/definitions/myparam' responses: default: description: the record schema: $ref: "#/definitions/record" 404: $ref: "#/responses/notFound" 200: description: "Success" schema: $ref: "#definitions/myoutput" parameters: rateLimit: name: X-Rate-Limit in: header type: integer format: int32 responses: notFound: description: Not found schema: $ref: "#/definitions/record" definitions: record: type: object properties: createdAt: type: string format: date-time myparam: type: string myoutput: type: string	1020 B	2025-05-25 12:27
📄 fixture-859.yaml --- swagger: "2.0" info: version: "0.1.0" title: issue#859. Reference validation paths: /: post: parameters: # error - $ref: "#/parameters/rateLimit" - name: myparam in: query type: string responses: 200: description: "Success" get: parameters: - $ref: "#/parameters/rateLimit" # <-- error: mispelled reference cannot resolve - name: myparam in: query schema: $ref: '#/definitions/myparam' # <- error : mispelled reference cannot resolve responses: default: description: the record schema: $ref: "#/definitions/record" # <- error : mispelled reference cannot resolve 404: $ref: "#/responses/notFound" 200: description: "Success" schema: $ref: "#definitions/myoutput" # <- error : mispelled reference cannot resolve parameters: rateLimits: name: X-Rate-Limit in: header type: integer format: int32 responses: notFound: description: Not found schema: $ref: "#/definitions/record" # <- error : mispelled reference cannot resolve definitions: records: type: object properties: createdAt: type: string format: date-time myparams: type: string myoutputs: type: string	1.37 KB	2025-05-25 12:27
📄 fixture-additional-items-2.yaml swagger: '2.0' info: title: additionalItems-2 version: '1.0' description: 'this spec exercise the additionalItems property on params and responses, with default and example values. This one is invalid.' license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: /servers/getGood: get: operationId: getGoodOp parameters: - name: addItems in: body schema: type: array # Unsupported keyword additionalItems: false items: # inline schema - type: object properties: first: type: string # ref simple schema - $ref: '#/definitions/itemsSchema0' # ref multiple complex schemas - $ref: '#/definitions/itemsSchema1' - $ref: '#/definitions/itemsSchema2' - $ref: '#/definitions/itemsSchema3' default: - first: 'Default string' #<-- validates inline schema - 'Default string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 #<-- validate schema2 example: - first: 'Default string' #<-- validates inline schema - 'A string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 responses: 200: description: 'ok' definitions: itemsSchema0: type: string itemsSchema1: type: object required: - x - c properties: x: type: string enum: - 'a' - 'b' - 'c' default: 'a' example: 'b' c: type: number default: 1 example: 9 example: x: 'c' c: 12 itemsSchema2: type: object required: - z properties: z: type: number default: 1 example: 9 example: z: 12 itemsSchema3: type: array items: type: array items: type: object properties: a: type: string default: 'a' example: 'A' b: type: string default: 'b' example: 'B' required: [ a, b ] default: a: 'x' b: 'y' example: a: 'u' b: 'v' default: - a: 'u' b: 'v' example: - a: 'u' b: 'v' default: - - a: 'a' - b: 'b' - - a: 'c' - b: 'd' example: - - a: 'a' - b: 'b' - - a: 'c' - b: 'd'	2.87 KB	2025-05-25 12:27
📄 fixture-additional-items-3.yaml swagger: '2.0' info: title: additionalItems-3 version: '1.0' description: 'this spec exercise the additionalItems property on params and responses, with default and example values. This one is invalid.' license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: /servers/getGood: get: operationId: getGoodOp parameters: - name: addItems in: query type: string responses: 200: description: 'ok' schema: type: array # Unsupported keyword additionalItems: type: object properties: v: string items: # inline schema - type: object properties: first: type: string # ref simple schema - $ref: '#/definitions/itemsSchema0' # ref multiple complex schemas - $ref: '#/definitions/itemsSchema1' - $ref: '#/definitions/itemsSchema2' - $ref: '#/definitions/itemsSchema3' default: - first: 'Default string' #<-- validates inline schema - 'Default string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 #<-- validate schema2 example: - first: 'Default string' #<-- validates inline schema - 'A string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 examples: application/json: - first: 'Default string' #<-- validates inline schema - 'A string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 - - - a: 'a' - b: 'b' - - a: 'c' - b: 'd' /servers/edgeCase: get: operationId: getEdgeOp parameters: - name: addItems in: query type: string responses: 200: description: 'ok' schema: type: array # unsupported additionalItems: type: array items: type: array items: type: string items: - type: array additionalItems: type: string items: - type: integer format: int32 - type: string - type: integer default: - 1 - 'ABC' - 32 - 'ABC' example: - 1 - 'ABC' - 32 - 'ABC' - 'DEF' default: - - 1 - 'ABC' - 32 - 'ABC' - - - 'ABC' - - 'ABCD' - - 'ABCDE' example: - - 1 - 'ABC' - 32 - - - 'ABC' - - 'ABCD' - - 'ABCDE' examples: application/json: - - 1 - 'ABC' - 32 - 'XYZ' - - - 'ABC' - - 'ABCD' - - 'ABCDE' definitions: itemsSchema0: type: string itemsSchema1: type: object required: - x - c properties: x: type: string enum: - 'a' - 'b' - 'c' default: 'a' example: 'b' c: type: number default: 1 example: 9 example: x: 'c' c: 12 itemsSchema2: type: object required: - z properties: z: type: number default: 1 example: 9 example: z: 12 itemsSchema3: type: array items: type: array items: type: object properties: a: type: string default: 'a' example: 'A' b: type: string default: 'b' example: 'B' required: [ a, b ] default: a: 'x' b: 'y' example: a: 'u' b: 'v' default: - a: 'u' b: 'v' example: - a: 'u' b: 'v' default: - - a: 'a' - b: 'b' - - a: 'c' - b: 'd' example: - - a: 'a' - b: 'b' - - a: 'c' - b: 'd'	5.07 KB	2025-05-25 12:27
📄 fixture-additional-items-invalid-values.yaml swagger: '2.0' info: title: additionalItems version: '1.0' description: 'this spec exercise the additionalItems property on params and responses, with default and example values. This one is valid.' license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: /servers/getBad1: get: operationId: getGoodOp parameters: - name: addItems in: body schema: type: array # Unsupported keyword #additionalItems: false items: # inline schema - type: object properties: first: type: string # ref simple schema - $ref: '#/definitions/itemsSchema0' # ref multiple complex schemas - $ref: '#/definitions/itemsSchema1' - $ref: '#/definitions/itemsSchema2' - $ref: '#/definitions/itemsSchema3' default: - first: [ 'A' , 'B' ] #<-- error - 'Default string' #<-- validates scheme0 - x: 1 #<-- error c: 'ABC' #<-- error - z: x #<-- error example: - first: 2 #<-- error - 'A string' #<-- validates scheme0 - c: 1 #x: 'a' #<-- error - z: true #<-- error responses: default: schema: type: array # Unsupported keyword #additionalItems: false items: # inline schema - type: object properties: first: type: string # ref simple schema - $ref: '#/definitions/itemsSchema0' # ref multiple complex schemas - $ref: '#/definitions/itemsSchema1' - $ref: '#/definitions/itemsSchema2' - $ref: '#/definitions/itemsSchema3' default: - first: [ 'A' , 'B' ] #<-- error - 'Default string' #<-- validates scheme0 - x: 1 #<-- error c: 'ABC' #<-- error - z: x #<-- error example: - first: 2 #<-- error - 'A string' #<-- validates scheme0 - c: 1 #x: 'a' #<-- error - z: true #<-- error examples: application/json: - first: 2 #<-- error - 'A string' #<-- validates scheme0 - c: 1 #x: 'a' #<-- error - z: true #<-- error 200: description: 'ok' schema: type: array # Unsupported keyword #additionalItems: false items: # inline schema - type: object properties: first: type: string # ref simple schema - $ref: '#/definitions/itemsSchema0' # ref multiple complex schemas - $ref: '#/definitions/itemsSchema1' - $ref: '#/definitions/itemsSchema2' - $ref: '#/definitions/itemsSchema3' default: - first: [ 'A' , 'B' ] #<-- error - 'Default string' #<-- validates scheme0 - x: 1 #<-- error c: 'ABC' #<-- error - z: x #<-- error example: - first: 2 #<-- error - 'A string' #<-- validates scheme0 - c: 1 #x: 'a' #<-- error - z: true #<-- error examples: application/json: - first: 2 #<-- error - 'A string' #<-- validates scheme0 - c: 1 #x: 'a' #<-- error - z: true #<-- error /servers/getBad2: get: operationId: getGoodOp2 parameters: - name: addItems in: body schema: type: array # Unsupported keyword #additionalItems: false items: # inline schema - type: object properties: first: type: string # ref simple schema - $ref: '#/definitions/itemsSchema0' # ref multiple complex schemas - $ref: '#/definitions/itemsSchema1' - $ref: '#/definitions/itemsSchema2' - $ref: '#/definitions/itemsSchema3' default: - first: 'Default string' #<-- validates inline schema - 'Default string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 #<-- validate schema2 example: - first: 'Default string' #<-- validates inline schema - 'A string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 responses: 200: description: 'ok' /servers/getBad3: get: operationId: getGoodOp3 parameters: - name: addItems in: body schema: type: array # Unsupported keyword #additionalItems: false items: # inline schema - type: object properties: first: type: string # ref simple schema - $ref: '#/definitions/itemsSchema0' # ref multiple complex schemas - $ref: '#/definitions/itemsSchema1' - $ref: '#/definitions/itemsSchema2' - $ref: '#/definitions/itemsSchema3' default: - first: 'Default string' #<-- validates inline schema - 'Default string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 #<-- validate schema2 example: - first: 'Default string' #<-- validates inline schema - 'A string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 responses: 200: description: 'ok' definitions: itemsSchema0: type: string itemsSchema1: type: object required: - x - c properties: x: type: string enum: - 'a' - 'b' - 'c' default: 'a' example: 'b' c: type: number default: 1 example: 9 example: x: 'c' c: 12 itemsSchema2: type: object required: - z properties: z: type: number default: 1 example: 9 example: z: 12 itemsSchema3: type: array items: type: array items: type: object properties: a: type: string default: 'a' example: 'A' b: type: string default: 'b' example: 'B' required: [ a, b ] default: a: 'x' b: 'y' example: a: 'u' b: 'v' default: - a: 'u' #b: 'v' #<-- error example: - a: 'u' b: 'v' default: - - a: 'a' - b: 'b' - - a: 'c' - b: 'd' example: - #- a: 'a' #<-- error - b: 'b' - - a: 'c' - b: 'd'	8.35 KB	2025-05-25 12:27
📄 fixture-additional-items.orig swagger: '2.0' info: title: additionalItems version: '1.0' description: this spec exercise the additionalItems property on params and responses, with default and example values. This one is valid. license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: /servers/getSomeIds: get: operationId: getSomeIdsOps parameters: - name: addItems1 in: body schema: type: object # Irrelevant: success #additionalItems: true properties: id: type: string default: 'abc' example: 'def' - name: addItems2 in: query schema: type: array # Irrelevant: success #additionalItems: false items: id: type: string default: 'abc' example: 'def' - name: addItems3 in: query schema: type: array # Irrelevant: success #additionalItems: false items: id: type: number default: 1 example: 123 - name: addItems4 in: query schema: type: array # Applies: success #additionalItems: false #minItems: 1 #maxItems: 2 #uniqueItems: true items: - $ref: '#/definitions/itemsSchema1' - $ref: '#/definitions/itemsSchema2' - $ref: '#/definitions/itemsSchema3' default: - x: 'a' y: 1 - t: 1 example: - x: 'a' y: 1 - z: 1 responses: '200': definitions: itemsSchema1: type: object required: - x - y properties: x: type: string enum: - 'a' - 'b' - 'c' default: 'a' example: 'b' y: type: number default: 1 example: 9 example: x: 'c' y: 12 itemsSchema2: type: object required: - z properties: z: type: number default: 1 example: 9 example: z: 12 itemsSchema3: type: object required: - t properties: t: type: number default: 1 example: 9 example: t: 12	2.47 KB	2025-05-25 12:27
📄 fixture-additional-items.yaml swagger: '2.0' info: title: additionalItems version: '1.0' description: 'this spec exercise the additionalItems property on params and responses, with default and example values. This one is valid.' license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: /servers/getGood: get: operationId: getGoodOp parameters: - name: addItems in: body schema: type: array # Unsupported keyword #additionalItems: false items: # inline schema - type: object properties: first: type: string # ref simple schema - $ref: '#/definitions/itemsSchema0' # ref multiple complex schemas - $ref: '#/definitions/itemsSchema1' - $ref: '#/definitions/itemsSchema2' - $ref: '#/definitions/itemsSchema3' default: - first: 'Default string' #<-- validates inline schema - 'Default string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 #<-- validate schema2 example: - first: 'Default string' #<-- validates inline schema - 'A string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 responses: 200: description: 'ok' definitions: itemsSchema0: type: string itemsSchema1: type: object required: - x - c properties: x: type: string enum: - 'a' - 'b' - 'c' default: 'a' example: 'b' c: type: number default: 1 example: 9 example: x: 'c' c: 12 itemsSchema2: type: object required: - z properties: z: type: number default: 1 example: 9 example: z: 12 itemsSchema3: type: array items: type: array items: type: object properties: a: type: string default: 'a' example: 'A' b: type: string default: 'b' example: 'B' required: [ a, b ] default: a: 'x' b: 'y' example: a: 'u' b: 'v' default: - a: 'u' b: 'v' example: - a: 'u' b: 'v' default: - - a: 'a' - b: 'b' - - a: 'c' - b: 'd' example: - - a: 'a' - b: 'b' - - a: 'c' - b: 'd'	2.86 KB	2025-05-25 12:27
📄 fixture-all-formats.yaml --- swagger: '2.0' info: title: 'fixture to tests formats in parameters, schema objects' version: '1.0' description: \| This exercises the type and format validation based on complete spec produces: - application/json paths: /fixture/formats-good: get: operationId: op1 parameters: - name: p01 in: query type: string format: byte default: 'ZWxpemFiZXRocG9zZXk=' - name: p02 in: query type: string format: creditcard default: '4111-1111-1111-1111' - name: p03 in: query type: string format: date default: 1970-01-01 - name: p04 in: query type: string format: date-time default: '1963-06-19T08:30:06.283185Z' - name: p05 in: query type: string format: duration default: '3 weeks' - name: p06 in: query type: string format: email default: 'joe.bloggs@example.com' - name: p07 in: query type: string format: hexcolor default: '#FFFFFF' - name: p08 in: query type: string format: hostname default: 'www.example.com' - name: p09 in: query type: string format: ipv4 default: '192.168.0.1' - name: p10 in: query type: string format: ipv6 default: '::1' - name: p11 in: query type: string format: isbn default: '0321751043' - name: p12 in: query type: string format: isbn10 default: '0321751043' - name: p13 in: query type: string format: isbn13 default: '978 3401013190' - name: p14 in: query type: string format: mac default: '01:02:03:04:05:06' - name: p15 in: query type: string format: bsonobjectid default: '507f1f77bcf86cd799439011' - name: p16 in: query type: string format: password default: 'secret' - name: p17 in: query type: string format: rgbcolor default: 'rgb(100,100,100)' - name: p18 in: query type: string format: ssn default: '111-11-1111' - name: p19 in: query type: string format: uri default: 'http://foo.bar/?baz=qux#quux' - name: p20 in: query type: string format: uuid default: 'a8098c1a-f86e-11da-bd1a-00112444be1e' - name: p21 in: query type: string format: uuid3 default: 'bcd02e22-68f0-3046-a512-327cca9def8f' - name: p22 in: query type: string format: uuid4 default: '025b0d74-00a2-4048-bf57-227c5111bb34' - name: p23 in: query type: string format: uuid5 default: '886313e1-3b8a-5372-9b90-0c9aee199e5d' - name: n01 in: query type: number format: float default: 10.01 - name: n02 in: query type: number format: double default: 100.99 - name: n03 in: query type: integer format: int32 default: -12 - name: n04 in: query type: integer format: int64 default: 20 - name: n05 in: query type: integer format: uint32 default: 20 - name: n06 in: query type: integer format: uint64 default: 30 # TODO: check format aliases responses: 200: description: 'response exercising formats' # TODO: check format in headers schema: $ref: '#/definitions/allformats' /fixture/formats-bad: get: operationId: op2 parameters: - name: p01 in: query type: string format: byte default: 'ZWxpemFiZXRocG9zZXk' - name: p02 in: query type: string format: creditcard default: '4111-1X11-1111-1111' - name: p03 in: query type: string format: date default: 1970-13-01 - name: p04 in: query type: string format: date-time default: '1963-13-19T08:30:06.283185Z' - name: p05 in: query type: string format: duration default: 'three weeks' - name: p06 in: query type: string format: email default: 'joe.bloggs-example.com' - name: p07 in: query type: string format: hexcolor default: 'xFFFFFF' - name: p08 in: query type: string format: hostname default: 'not_a_valid_hostname' - name: p09 in: query type: string format: ipv4 default: '192.168.0.256' - name: p10 in: query type: string format: ipv6 default: 'o::1' - name: p11 in: query type: string format: isbn default: 'abc-0321751043' - name: p12 in: query type: string format: isbn10 default: 'abc-0321751043' - name: p13 in: query type: string format: isbn13 default: '978\|3401013190' - name: p14 in: query type: string format: mac default: '01:02:03:04:05:06:07' - name: p15 in: query type: string format: bsonobjectid default: 'x07f1f77bcf86cd799439011' - name: p16 in: query type: string format: password default: 0 - name: p17 in: query type: string format: rgbcolor default: 'rgb(100,100)' - name: p18 in: query type: string format: ssn default: '111-11111' - name: p19 in: query type: string format: uri default: 'httz://foo.bar/?baz=qux#quux' - name: p20 in: query type: string format: uuid default: 'a8098c1a+f86e+11da+bd1a+00112444be1e' - name: p21 in: query type: string format: uuid3 default: 'bcd02e22+68f0+3046+a512+327cca9def8f' - name: p22 in: query type: string format: uuid4 default: '025b0d74+00a2+4048+bf57+227c5111bb34' - name: p23 in: query type: string format: uuid5 default: '886313e1+3b8a+5372+9b90+0c9aee199e5d' - name: n01 in: query type: number format: float default: abc - name: n02 in: query type: number format: double default: 100.99 - name: n03 in: query type: integer format: int32 default: -12.05 - name: n04 in: query type: integer format: int64 default: 20.05 - name: n05 in: query type: integer format: uint32 default: -20 - name: n06 in: query type: integer format: uint64 default: -30 responses: 200: description: 'response exercising formats' schema: $ref: '#/definitions/allformats-bad' /fixture/body: post: operationId: op3 parameters: - name: allformat in: body schema: $ref: '#/definitions/allformats' responses: 200: description: 'response exercising formats' # TODO: check format in headers schema: $ref: '#/definitions/allformats' /fixture/file: post: operationId: op4 consumes: - multipart/form-data parameters: - name: f01 in: formData type: file required: true - name: f02 in: formData type: file required: false responses: 200: description: 'response exercising formats' definitions: allformats: type: object properties: prop01: type: string format: byte default: 'ZWxpemFiZXRocG9zZXk=' prop02: type: string format: creditcard default: '4111-1111-1111-1111' prop03: type: string format: date default: 1970-01-01 prop04: type: string format: date-time default: '1963-06-19T08:30:06.283185Z' prop05: type: string format: duration default: '3 weeks' prop06: type: string format: email default: 'joe.bloggs@example.com' prop07: type: string format: hexcolor default: '#FFFFFF' prop08: type: string format: hostname default: 'www.example.com' prop09: type: string format: ipv4 default: '192.168.0.1' prop10: type: string format: ipv6 default: '::1' prop11: type: string format: isbn default: '0321751043' prop12: type: string format: isbn10 default: '0321751043' prop13: type: string format: isbn13 default: '978 3401013190' prop14: type: string format: mac default: '01:02:03:04:05:06' prop15: type: string format: bsonobjectid default: '507f1f77bcf86cd799439011' prop16: type: string format: password default: 'secret' prop17: type: string format: rgbcolor default: 'rgb(100,100,100)' prop18: type: string format: ssn default: '111-11-1111' prop19: type: string format: uri default: 'http://foo.bar/?baz=qux#quux' prop20: type: string format: uuid default: 'a8098c1a-f86e-11da-bd1a-00112444be1e' prop21: type: string format: uuid3 default: 'bcd02e22-68f0-3046-a512-327cca9def8f' prop22: type: string format: uuid4 default: '025b0d74-00a2-4048-bf57-227c5111bb34' prop23: type: string format: uuid5 default: '886313e1-3b8a-5372-9b90-0c9aee199e5d' propn01: type: number format: float default: 10.01 propn02: type: number format: double default: 100.99 propn03: type: integer format: int32 default: -12 propn04: type: integer format: int64 default: 20 propn05: type: integer format: uint32 default: 20 propn06: type: integer format: uint64 default: 30 allformats-bad: type: object properties: prop01: type: string format: byte default: 'ZWxpemFiZXRocG9zZXk' prop02: type: string format: creditcard default: '4111-1111-1111-111K' prop03: type: string format: date default: 1970-01-32 prop04: type: string format: date-time default: '1963-06-19T99:30:06.283185Z' prop05: type: string format: duration default: 'weeks' prop06: type: string format: email default: 'joe.bloggs-example.com' prop07: type: string format: hexcolor default: 1 prop08: type: string format: hostname default: '---invalid-hostname---' prop09: type: string format: ipv4 default: '192.2.0.1.45' prop10: type: string format: ipv6 default: 'x::1' prop11: type: string format: isbn default: 'X0321751043' prop12: type: string format: isbn10 default: 'X0321751043' prop13: type: string format: isbn13 default: 'X978 3401013190' prop14: type: string format: mac default: 'X1:02:03:04:05:06' prop15: type: string format: bsonobjectid default: 'X507f1f77bcf86cd799439011' prop16: type: string format: password default: 10 prop17: type: string format: rgbcolor default: 'gb(100,100,100)' prop18: type: string format: ssn default: 'Z111-11-1111' prop19: type: string format: uri default: 'xttp://foo.bar/?baz=qux#quux' prop20: type: string format: uuid default: 'a8098c1a+f86e+11da+bd1a+00112444be1e' prop21: type: string format: uuid3 default: 'bcd02e22+68f0+3046+a512+327cca9def8f' prop22: type: string format: uuid4 default: '025b0d74+00a2+4048+bf57+227c5111bb34' prop23: type: string format: uuid5 default: '886313e1+3b8a+5372+9b90+0c9aee199e5d' propn01: type: number format: float default: abc propn02: type: number format: double default: abc propn03: type: integer format: int32 default: -12.05 propn04: type: integer format: int64 default: 20.99 propn05: type: integer format: uint32 default: 20.05 propn06: type: integer format: uint64 default: 30.05	13.92 KB	2025-05-25 12:27
📄 fixture-bad-response.yaml --- swagger: '2.0' info: title: checking $ref siblings in response version: '1.0' description: \| This one checks that wrong response declaraion with $ref sibling is correcly handled and reported produces: - application/json paths: /fixture: get: operationId: op1 parameters: - name: myid in: body schema: $ref: '#/definitions/myId' responses: 200: description: 'response with $ref sibling' schema: $ref: '#/definitions/someIds' definitions: myId: type: string someIds: type: integer	615 B	2025-05-25 12:27
📄 fixture-collisions.yaml --- swagger: "2.0" info: title: "Spec with many duplicate things" description: \| Check the following rules: - params in path are unique - no more than one param in body - paths stripped from params are unique - operationId is Unique - params in operation are unique version: "20170115" basePath: /20170115 paths: # Error: path params not unique /loadBalancers/{loadBalancerId}/backendSets/{loadBalancerId}/get: get: description: Lists all backend sets associated with a given load balancer. operationId: ope1 parameters: - name: loadBalancerId in: path type: string required: true produces: - "application/json" responses: 200: description: The list is being retrieved. headers: opc-response-id: description: \| Unique identifier for the response. type: string # Error more than 1 param in body /bigbody/get: get: description: Lists all backend sets associated with a given load balancer. operationId: ope2 parameters: - name: loadBalancerId2 in: body type: string required: true - name: loadBalancerId3 in: body type: string required: true produces: - "application/json" responses: 200: # Error duplicate path /duplpath/{id1}/get: get: description: Lists all backend sets associated with a given load balancer. operationId: ope3 parameters: - name: id1 in: path type: string required: true produces: - "application/json" responses: 200: /duplpath/{id2}/get: get: operationId: ope4 parameters: - name: id2 in: path type: string required: true produces: - "application/json" responses: 200: # Error duplicate operationId (paths are different) /duplope/{id1}/get: get: description: Lists all backend sets associated with a given load balancer (dupl). operationId: ope5 parameters: - name: id1 in: path type: string required: true produces: - "application/json" responses: 200: /duplope/{id2}/getThemAll: get: description: Lists all backend sets associated with a given load balancer (dupl). operationId: ope5 parameters: - name: id2 in: path type: string required: true produces: - "application/json" responses: 200: # Error duplicate operationId (same path, different methods) /duplope2/{id1}/get: get: description: Lists all backend sets associated with a given load balancer (dupl). operationId: ope6 parameters: - name: id1 in: path type: string required: true produces: - "application/json" responses: 200: post: description: Lists all backend sets associated with a given load balancer (dupl). operationId: ope6 parameters: - name: id1 in: path type: string required: true produces: - "application/json" responses: 200: # Error : duplicate params /dupparam/get: get: description: Lists all backend sets associated with a given load balancer (dupl). operationId: ope7 parameters: - name: id2 in: query type: string - name: id2 in: query type: string produces: - "application/json" responses: 200:	3.68 KB	2025-05-25 12:27
📄 fixture-constraints-on-numbers.yaml --- swagger: '2.0' info: title: 'fixture for issue #581' version: '1.0' description: \| Exercise boundary checks for minimum, maximum and multipleOf This provides supplementary test cases not tested in the fixture-581 series - multipleOf - maximum with native type check - minimum with native type check produces: - application/json paths: /fixture: get: operationId: op1 parameters: # MultipleOf value not compatible with format # => still performs default value check as float64, and fails - name: param1 in: query type: integer format: int32 # maxInt32+1 multipleOf: 2147483648 default: 99 # => still performs default value check as float64, and succeeds - name: param2 in: query type: integer format: int32 # maxInt32+1 multipleOf: 2147483648 default: 4294967296 # MultipleOf. Default value not compatible with format # => still performs default value check as float64, and fails - name: param3 in: query type: integer format: int32 multipleOf: 10 default: 2147483648 # MultipleOf. Default value not compatible with format # => still performs default value check as float64, and succeeds - name: param4 in: query type: integer format: int32 multipleOf: 2 default: 2147483648 # Maximum. Default value not compatible with format # => still performs default value check as float64, and fails - name: param5 in: query type: integer format: int32 # maxInt32 maximum: 2147483647 # maxInt32+1 default: 2147483648 # Maximum. Default value not compatible with format # => still performs default value check as float64, and succeeds - name: param6 in: query type: integer format: uint32 # maxInt32 maximum: 2147483647 # maxInt32+1 default: -1 # Minimum. Default value not compatible with format # => still performs default value check as float64, and succeeds - name: param7 in: query type: integer format: int32 # maxInt32 minimum: 2147483647 # maxInt32+1 default: 2147483648 # Minimum. Default value not compatible with format # => still performs default value check as float64, and fails - name: param8 in: query type: integer format: uint32 # maxInt32 minimum: 2147483647 # maxInt32+1 default: -1 responses: 200:	2.81 KB	2025-05-25 12:27
📄 fixture-empty-paths.json { "swagger": "2.0", "info": { "description": "", "version": "1.0.0", "title": "issue#161", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": {} }	451 B	2025-05-25 12:27
📄 fixture-invalid-example-property.yaml swagger: '2.0' info: title: issue-1231 version: '1.0' license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: /servers/getSomeIds: get: operationId: getSomeIdsOps parameters: - name: getSomeIds in: body schema: type: object properties: id: type: number example: ABC responses: '200':	513 B	2025-05-25 12:27
📄 fixture-items-items.yaml swagger: '2.0' info: title: items of items in simple schema version: '1.0' description: i describe license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: /servers/getGood: get: operationId: getGoodOp parameters: - name: addItems in: body schema: type: array # Unsupported keyword #additionalItems: false items: # inline schema - type: object properties: first: type: string # ref simple schema - $ref: '#/definitions/itemsSchema0' # ref multiple complex schemas - $ref: '#/definitions/itemsSchema1' - $ref: '#/definitions/itemsSchema2' - $ref: '#/definitions/itemsSchema3' default: - first: 'Default string' #<-- validates inline schema - 'Default string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 #<-- validate schema2 example: - first: 'Default string' #<-- validates inline schema - 'A string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 responses: 200: description: 'ok' /servers/getUp/{soSimple}: get: operationId: getOnTheGoodFoot parameters: - name: soSimple in: path type: array required: true items: type: array items: type: integer default: - 1 - 2 #example: #- 1 #- 2 default: - - 1 - 2 - - 1 - 2 responses: 200: description: 'ok' definitions: itemsSchema0: type: string itemsSchema1: type: object required: - x - c properties: x: type: string enum: - 'a' - 'b' - 'c' default: 'a' example: 'b' c: type: number default: 1 example: 9 example: x: 'c' c: 12 itemsSchema2: type: object required: - z properties: z: type: number default: 1 example: 9 example: z: 12 itemsSchema3: type: array items: type: array items: type: object properties: a: type: string default: 'a' example: 'A' b: type: string default: 'b' example: 'B' required: [ a, b ] default: a: 'x' b: 'y' example: a: 'u' b: 'v' default: - a: 'u' b: 'v' example: - a: 'u' b: 'v' default: - - a: 'a' - b: 'b' - - a: 'c' - b: 'd' example: - - a: 'a' - b: 'b' - - a: 'c' - b: 'd'	3.3 KB	2025-05-25 12:27
📄 fixture-no-json-example.yaml swagger: '2.0' info: title: additionalItems version: '1.0' description: 'this spec exercise the additionalItems property on params and responses, with default and example values. This one is valid.' license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: /servers/getGood: get: operationId: getGoodOp parameters: - name: addItems in: body schema: type: array # Unsupported keyword #additionalItems: false items: # inline schema - type: object properties: first: type: string # ref simple schema - $ref: '#/definitions/itemsSchema0' # ref multiple complex schemas - $ref: '#/definitions/itemsSchema1' - $ref: '#/definitions/itemsSchema2' - $ref: '#/definitions/itemsSchema3' default: - first: 'Default string' #<-- validates inline schema - 'Default string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 #<-- validate schema2 example: - first: 'Default string' #<-- validates inline schema - 'A string' #<-- validates scheme0 - x: 'a' #<-- validates schema1 c: 1 - z: 1 responses: default: description: 'default' schema: type: string examples: #<-- warning application/xml: a: "" 200: description: 'ok' examples: #<-- warning examples without schema application/json: - 'A' - 'B' definitions: itemsSchema0: type: string itemsSchema1: type: object required: - x - c properties: x: type: string enum: - 'a' - 'b' - 'c' default: 'a' example: 'b' c: type: number default: 1 example: 9 example: x: 'c' c: 12 itemsSchema2: type: object required: - z properties: z: type: number default: 1 example: 9 example: z: 12 itemsSchema3: type: array items: type: array items: type: object properties: a: type: string default: 'a' example: 'A' b: type: string default: 'b' example: 'B' required: [ a, b ] default: a: 'x' b: 'y' example: a: 'u' b: 'v' default: - a: 'u' b: 'v' example: - a: 'u' b: 'v' default: - - a: 'a' - b: 'b' - - a: 'c' - b: 'd' example: - - a: 'a' - b: 'b' - - a: 'c' - b: 'd'	3.18 KB	2025-05-25 12:27
📄 fixture-no-response.yaml --- swagger: "2.0" info: title: "Load Balancing Service API" description: API for the Load Balancing Service version: "20170115" basePath: /20170115 paths: /loadBalancers/{loadBalancerId}/backendSets: get: summary: "ListBackendSets" tags: ['loadBalancer'] description: Lists all backend sets associated with a given load balancer. operationId: "ListBackendSets" # fixed that: Missing parameter in path parameters: - name: loadBalancerId in: path type: string # fixed that: should be required required: true produces: - "application/json" responses:	665 B	2025-05-25 12:27
📄 fixture-patternProperties.json { "swagger": "2.0", "info": { "description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n", "version": "1.0.0", "title": "Swagger Petstore", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/pets": { "get": { "tags": ["pet"], "summary": "list the pets", "operationId": "getPets", "responses": { "default": { "description": "Generic Error" }, "200": { "description": "Pets list", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pet" } } } } } } }, "definitions": { "Parent": { "$ref": "#/definitions/Category" }, "Category": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Pet": { "required": [ "name", "photoUrls" ], "properties": { "id": { "type": "integer", "format": "int64" }, "category": { "$ref": "#/definitions/Category" }, "name": { "type": "string", "example": "doggie" }, "photoUrls": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "badtags": { "type": "array", "items": { "$ref": "#/definitions/TagWrong" } }, "invalidDefault": { "$ref": "#/definitions/TagInvalidDefault" }, "status": { "type": "string", "description": "pet status in the store" } } }, "Tag": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } }, "patternProperties": { "nb-.": { "type": "integer", "format": "int64", "default": 20 } } }, "TagInvalidDefault": { "type": "object", "description": "An object with default value not matching pattern properties", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } }, "patternProperties": { "nb-.": { "type": "integer", "format": "int64" } }, "default" : { "id": "myid", "name": "myname", "nb-1": "a string", "nb-2": "10" } }, "TagWrong": { "type": "object", "description": "An object with with a bad regexp in pattern properties", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } }, "patternProperties": { "nb-.*": { "type": "integer", "format": "int64", "default": 20 } } } } }	3.67 KB	2025-05-25 12:27
📄 fixture-valid-example-property.yaml swagger: '2.0' info: title: issue-1231 version: '1.0' license: name: MIT host: localhost:8081 basePath: /api/v1 schemes: - http consumes: - application/json produces: - application/json paths: /servers/getSomeIds: get: operationId: getSomeIdsOps parameters: - name: getSomeIds in: body schema: type: object properties: id: type: number example: 123 responses: '200':	513 B	2025-05-25 12:27
📄 gentest.yaml swagger: '2.0' info: title: code generation test fixture for parameters, with default values version: '1.0.0' host: localhost basePath: / consumes: - application/json produces: - application/json schemes: - http paths: /required/params: get: operationId: getRequired parameters: - name: notAnOption1 in: query type: string format: date required: true - name: notAnOption2 in: query type: string format: password pattern: '^[a-z]$' required: true - name: notAnOption3 in: query type: integer format: int32 required: true - name: notAnOption4 in: query type: integer format: int32 required: true minimum: 10 maximum: 100 multipleOf: 10 - name: notAnOption5 in: query type: array required: true maxItems: 2 items: type: string format: uuid - name: notAnOption6 in: query type: array collectionFormat: pipes required: true uniqueItems: true items: type: integer format: int32 minimum: 10 maximum: 100 multipleOf: 10 - name: notAnOption7 in: query type: array collectionFormat: pipes required: true uniqueItems: false items: type: array collectionFormat: csv uniqueItems: true items: type: string format: date responses: &stdResponses 200: description: simple type schema: type: string format: date 201: description: simple type schema: type: string format: uuid default: description: schema type schema: $ref: '#/definitions/ContainerConfig' /optional/params: get: operationId: getOptional parameters: - name: sanityCheck1 in: query type: string required: false default: sanity check one passed for primitive type - name: sanityCheck2 in: query type: number required: false default: 99.9 - name: sanityCheck3 in: query type: integer required: false default: 1000 - name: sanityCheck4 in: query type: integer format: uint32 required: false default: 100 - name: sanityCheckFormat1 in: query type: string format: uuid required: false default: a8098c1a-f86e-11da-bd1a-00112444be1e - name: isAnOption1 in: query type: string format: date required: false default: '1970-01-01' - name: isAnOption2 in: query type: string format: password pattern: '^[a-z]$' required: false default: z - name: isAnOption3 in: query type: integer format: int32 required: false default: 32 - name: isAnOption4 in: query type: integer format: int32 required: false minimum: 10 maximum: 100 multipleOf: 10 default: 60 - name: isAnOption5 in: query type: array maxItems: 2 items: type: string format: uuid default: - a8098c1a-f86e-11da-bd1a-00112444be1e - name: isAnOption6 in: query type: array collectionFormat: pipes required: false items: type: integer format: int32 minimum: 10 maximum: 100 multipleOf: 10 default: - 10 - 20 - 30 - 40 - name: isAnOption7 in: query type: array collectionFormat: pipes required: false items: type: array collectionFormat: csv items: type: string format: date default: - '2018-01-01' - '2018-01-02' - '2018-01-03' - '2018-01-04' default: - - '2012-01-01' - '2014-01-02' - '2016-01-03' - '2018-01-04' - - '2011-01-01' - '2013-01-02' - '2015-01-03' - '2017-01-04' - name: isAnOption8 in: query type: array maxItems: 2 uniqueItems: true items: type: string default: - default unformatted string array item 1 - default unformatted string array item 2 - name: isAnOption9 in: query type: array collectionFormat: pipes required: false items: type: array collectionFormat: csv items: type: string format: duration default: - 1d - 1w - 1h - 2w default: - - 1s - 1h - 1d - 1w - - 2s - 2h - 2d - 2w responses: stdResponses /path/params/{notAnOption1}/{notAnOption2}/{notAnOption3}/{notAnOption4}/{notAnOption5}/{notAnOption6}/{notAnOption7}: get: operationId: getRequiredInPath parameters: - name: notAnOption1 in: path type: string format: date required: true - name: notAnOption2 in: path type: string format: password pattern: '^[a-z]$' required: true - name: notAnOption3 in: path type: integer format: int32 required: true - name: notAnOption4 in: path type: integer format: int32 required: true minimum: 10 maximum: 100 multipleOf: 10 - name: notAnOption5 in: path type: array maxItems: 2 required: true items: type: string format: uuid - name: notAnOption6 in: path type: array collectionFormat: pipes required: true items: type: integer format: int32 minimum: 10 maximum: 100 multipleOf: 10 - name: notAnOption7 in: path type: array collectionFormat: pipes required: true items: type: array collectionFormat: csv items: type: string format: date responses: stdResponses /optional/headers: get: operationId: getInHeaders parameters: - name: isAnOption1 in: header type: string format: date required: false default: '1970-01-01' - name: isAnOption2 in: header type: string format: password pattern: '^[a-z]$' required: false default: z - name: isAnOption3 in: header type: integer format: int32 required: false default: 32 - name: isAnOption4 in: header type: integer format: int32 required: false minimum: 10 maximum: 100 multipleOf: 10 default: 60 - name: isAnOption5 in: header type: array maxItems: 2 items: type: string format: uuid default: - a8098c1a-f86e-11da-bd1a-00112444be1e - name: isAnOption6 in: header type: array collectionFormat: pipes required: false items: type: integer format: int32 minimum: 10 maximum: 100 multipleOf: 10 default: - 10 - 20 - 30 - 40 - name: isAnOption7 in: header type: array collectionFormat: pipes required: false items: type: array collectionFormat: csv items: type: string format: date default: - '2018-01-01' - '2018-01-02' - '2018-01-03' - '2018-01-04' default: - - '2012-01-01' - '2014-01-02' - '2016-01-03' - '2018-01-04' - - '2011-01-01' - '2013-01-02' - '2015-01-03' - '2017-01-04' responses: stdResponses /mixed/deepnested: get: operationId: getInDepth parameters: - name: deepNested1 in: query type: array collectionFormat: pipes required: true maxItems: 2 items: type: array collectionFormat: csv minItems: 2 items: type: array collectionFormat: ssv uniqueItems: true items: type: string pattern: '^[a-z]$' default: - a - b - c default: - - x - 'y' - z - - u - v - w default: - - - h - i - j - - k - l - m - - - h - i - j - - k - l - m - name: deepNested2 in: header type: array collectionFormat: pipes required: false maxItems: 2 items: type: array collectionFormat: csv minItems: 2 items: type: array collectionFormat: ssv uniqueItems: true items: type: string pattern: '^[a-z]$' default: - a - b - c default: - - x - 'y' - z - - u - v - w default: - - - h - i - j - - k - l - m - - - h - i - j - - k - l - m responses: stdResponses /mixed/mixedBody/{pathParam1}: post: operationId: getInBody parameters: - name: bodyBuilding in: body schema: $ref: '#/definitions/ContainerConfig' - name: queryParam1 in: query type: integer required: false allowEmptyValue: true default: 100 maximum: 1000 - name: queryParam2 in: query type: string format: date required: false default: '1970-01-01' - name: queryParam3 in: query type: integer format: uint32 minimum: 12 exclusiveMinimum: true allowEmptyValue: true required: true - name: queryParam4 in: query collectionFormat: multi maxItems: 2 type: array items: type: string format: uuid default: - a8098c1a-f86e-11da-bd1a-00112444be1e - a8098c1a-f86e-11da-bd1a-00112444be1e - name: query_issue_863 in: query type: array items: type: string enum: - enum1 - enum2 - enum3 - name: pathParam1 in: path type: string pattern: '^\w+$' required: true - name: headerParam1 in: header type: array items: type: number default: - 1.1 - 2.75 required: false responses: stdResponses /mixed/mixedBody2/{pathParam1}: post: operationId: getInBody2 parameters: - name: bodyBuilding in: body required: true schema: $ref: '#/definitions/errorResponseMsg' - name: queryParam1 in: query type: integer required: false allowEmptyValue: true default: 100 maximum: 1000 - name: queryParam2 in: query type: string format: date required: true default: '1970-01-01' - name: queryParam3 in: query type: integer format: uint32 minimum: 12 exclusiveMinimum: true allowEmptyValue: true required: true - name: queryParam4 in: query collectionFormat: multi maxItems: 2 type: array items: type: string format: uuid default: - a8098c1a-f86e-11da-bd1a-00112444be1e - name: pathParam1 in: path type: string pattern: '^\w+$' required: true - name: headerParam1 in: header type: array items: type: number default: - 1.1 - 2.75 required: false responses: stdResponses /mixed/mixedBody3/{pathParam1}: post: operationId: getInBody3 parameters: - name: bodyBuilding in: body required: false schema: $ref: '#/definitions/errorResponseMsg' - name: queryParam1 in: query type: integer required: false allowEmptyValue: true default: 100 maximum: 1000 - name: queryParam2 in: query type: string format: date required: true default: 1970-01-01 - name: queryParam3 in: query type: integer format: uint32 minimum: 12 exclusiveMinimum: true allowEmptyValue: true required: true - name: queryParam4 in: query collectionFormat: multi maxItems: 2 type: array items: type: string format: uuid default: - a8098c1a-f86e-11da-bd1a-00112444be1e - name: pathParam1 in: path type: string pattern: '^\w+$' required: true - name: headerParam1 in: header type: array items: type: number default: - 1.1 - 2.75 required: false responses: stdResponses /form/{pathParam1}: post: operationId: getInForm consumes: - multipart/formData parameters: - name: pathParam1 in: path type: string maxLength: 10 required: true - name: docname in: formData type: string pattern: '^\w+\.doc$' required: true - name: docAuthor in: formData type: string - name: attachment in: formData type: file required: true - name: addendum in: formData type: file required: false responses: stdResponses definitions: ContainerConfig: type: object required: [config1] properties: config1: type: string format: date config2: type: string format: date default: '1999-09-09' default: config1: '2019-09-09' config2: '2018-09-09' errorResponseMsg: type: object required: [ errorCode, reason ] properties: errorCode: type: integer reason: type: string severity: type: string enum: [ FATAL, CRITICAL, ERROR, WARNING, INFO ] additional: type: string enum: [ FATAL, CRITICAL, ERROR, WARNING, INFO ] default: INFO default: errorCode: 501 reason: not implemented severity: FATAL	15.58 KB	2025-05-25 12:27
📄 gentest2.yaml swagger: '2.0' info: title: code generation test fixture for parameters, with default values version: '1.0.0' host: localhost basePath: / consumes: - application/json produces: - application/json schemes: - http paths: /required/params: get: operationId: getRequired parameters: - name: notAnOption1 in: query type: string format: date required: true - name: notAnOption2 in: query type: string format: password pattern: '^[a-z]$' required: true - name: notAnOption3 in: query type: integer format: int32 required: true - name: notAnOption4 in: query type: integer format: int32 required: true minimum: 10 maximum: 100 multipleOf: 10 - name: notAnOption5 in: query type: array required: true maxItems: 2 items: type: string format: uuid - name: notAnOption6 in: query type: array collectionFormat: pipes required: true uniqueItems: true items: type: integer format: int32 minimum: 10 maximum: 100 multipleOf: 10 - name: notAnOption7 in: query type: array collectionFormat: pipes required: true uniqueItems: false items: type: array collectionFormat: csv uniqueItems: true items: type: string format: date responses: &stdResponses 200: description: simple type schema: type: string format: date 201: description: simple type schema: type: string format: uuid default: description: schema type schema: $ref: '#/definitions/ContainerConfig' /optional/params: get: operationId: getOptional parameters: - name: sanityCheck1 in: query type: string required: false default: sanity check one passed for primitive type - name: sanityCheck2 in: query type: number required: false default: 99.9 - name: sanityCheck3 in: query type: integer required: false default: 1000 - name: sanityCheck4 in: query type: integer format: uint32 required: false default: 100 - name: sanityCheckFormat1 in: query type: string format: uuid required: false default: a8098c1a-f86e-11da-bd1a-00112444be1e - name: isAnOption1 in: query type: string format: date required: false default: '1970-01-01' - name: isAnOption2 in: query type: string format: password pattern: '^[a-z]$' required: false default: z - name: isAnOption3 in: query type: integer format: int32 required: false default: 32 - name: isAnOption4 in: query type: integer format: int32 required: false minimum: 10 maximum: 100 multipleOf: 10 default: 60 - name: isAnOption5 in: query type: array maxItems: 2 items: type: string format: uuid default: - a8098c1a-f86e-11da-bd1a-00112444be1e - name: isAnOption6 in: query type: array collectionFormat: pipes required: false items: type: integer format: int32 minimum: 10 maximum: 100 multipleOf: 10 default: - 10 - 20 - 30 - 40 - name: isAnOption7 in: query type: array collectionFormat: pipes required: false items: type: array collectionFormat: csv items: type: string format: date default: - '2018-01-01' - '2018-01-02' - '2018-01-03' - '2018-01-04' default: - - '2012-01-01' - '2014-01-02' - '2016-01-03' - '2018-01-04' - - '2011-01-01' - '2013-01-02' - '2015-01-03' - '2017-01-04' - name: isAnOption8 in: query type: array maxItems: 2 uniqueItems: true items: type: string default: - default unformatted string array item 1 - default unformatted string array item 2 - name: isAnOption9 in: query type: array collectionFormat: pipes required: false items: type: array collectionFormat: csv items: type: string format: duration default: - 1d - 1w - 1h - 2w default: - - 1s - 1h - 1d - 1w - - 2s - 2h - 2d - 2w responses: stdResponses /path/params/{notAnOption1}/{notAnOption2}/{notAnOption3}/{notAnOption4}/{notAnOption5}/{notAnOption6}/{notAnOption7}: get: operationId: getRequiredInPath parameters: - name: notAnOption1 in: path type: string format: date required: true - name: notAnOption2 in: path type: string format: password pattern: '^[a-z]$' required: true - name: notAnOption3 in: path type: integer format: int32 required: true - name: notAnOption4 in: path type: integer format: int32 required: true minimum: 10 maximum: 100 multipleOf: 10 - name: notAnOption5 in: path type: array maxItems: 2 required: true items: type: string format: uuid - name: notAnOption6 in: path type: array collectionFormat: pipes required: true items: type: integer format: int32 minimum: 10 maximum: 100 multipleOf: 10 - name: notAnOption7 in: path type: array collectionFormat: pipes required: true items: type: array collectionFormat: csv items: type: string format: date responses: stdResponses /optional/headers: get: operationId: getInHeaders parameters: - name: isAnOption1 in: header type: string format: date required: false default: '1970-01-01' - name: isAnOption2 in: header type: string format: password pattern: '^[a-z]$' required: false default: z - name: isAnOption3 in: header type: integer format: int32 required: false default: 32 - name: isAnOption4 in: header type: integer format: int32 required: false minimum: 10 maximum: 100 multipleOf: 10 default: 60 - name: isAnOption5 in: header type: array maxItems: 2 items: type: string format: uuid default: - a8098c1a-f86e-11da-bd1a-00112444be1e - name: isAnOption6 in: header type: array collectionFormat: pipes required: false items: type: integer format: int32 minimum: 10 maximum: 100 multipleOf: 10 default: - 10 - 20 - 30 - 40 - name: isAnOption7 in: header type: array collectionFormat: pipes required: false items: type: array collectionFormat: csv items: type: string format: date default: - '2018-01-01' - '2018-01-02' - '2018-01-03' - '2018-01-04' default: - - '2012-01-01' - '2014-01-02' - '2016-01-03' - '2018-01-04' - - '2011-01-01' - '2013-01-02' - '2015-01-03' - '2017-01-04' responses: stdResponses /mixed/deepnested: get: operationId: getInDepth parameters: - name: deepNested1 in: query type: array collectionFormat: pipes required: true maxItems: 2 items: type: array collectionFormat: csv minItems: 2 items: type: array collectionFormat: ssv uniqueItems: true items: type: string pattern: '^[a-z]$' default: - a - b - c default: - - x - 'y' - z - - u - v - w default: - - - h - i - j - - k - l - m - - - h - i - j - - k - l - m - name: deepNested2 in: header type: array collectionFormat: pipes required: false maxItems: 2 items: type: array collectionFormat: csv minItems: 2 items: type: array collectionFormat: ssv uniqueItems: true items: type: string pattern: '^[a-z]$' default: - a - b - c default: - - x - 'y' - z - - u - v - w default: - - - h - i - j - - k - l - m - - - h - i - j - - k - l - m responses: stdResponses /mixed/mixedBody/{pathParam1}: post: operationId: getInBody parameters: - name: bodyBuilding in: body schema: $ref: '#/definitions/ContainerConfig' - name: queryParam1 in: query type: integer required: false allowEmptyValue: true default: 100 maximum: 1000 - name: queryParam2 in: query type: string format: date required: false default: '1970-01-01' - name: queryParam3 in: query type: integer format: uint32 minimum: 12 exclusiveMinimum: true allowEmptyValue: true required: true - name: queryParam4 in: query collectionFormat: multi maxItems: 2 type: array items: type: string format: uuid default: - a8098c1a-f86e-11da-bd1a-00112444be1e - a8098c1a-f86e-11da-bd1a-00112444be1e - name: query_issue_863 in: query type: array items: type: string enum: - enum1 - enum2 - enum3 - name: pathParam1 in: path type: string pattern: '^\w+$' required: true - name: headerParam1 in: header type: array items: type: number default: - 1.1 - 2.75 required: false responses: stdResponses /mixed/mixedBody2/{pathParam1}: post: operationId: getInBody2 parameters: - name: bodyBuilding in: body required: true schema: $ref: '#/definitions/errorResponseMsg' - name: queryParam1 in: query type: integer required: false allowEmptyValue: true default: 100 maximum: 1000 - name: queryParam2 in: query type: string format: date required: true default: '1970-01-01' - name: queryParam3 in: query type: integer format: uint32 minimum: 12 exclusiveMinimum: true allowEmptyValue: true required: true - name: queryParam4 in: query collectionFormat: multi maxItems: 2 type: array items: type: string format: uuid default: - a8098c1a-f86e-11da-bd1a-00112444be1e - name: pathParam1 in: path type: string pattern: '^\w+$' required: true - name: headerParam1 in: header type: array items: type: number default: - 1.1 - 2.75 required: false responses: stdResponses /mixed/mixedBody3/{pathParam1}: post: operationId: getInBody3 parameters: - name: bodyBuilding in: body required: false schema: $ref: '#/definitions/errorResponseMsg' - name: queryParam1 in: query type: integer required: false allowEmptyValue: true default: 100 maximum: 1000 - name: queryParam2 in: query type: string format: date required: true default: '1970-01-01' - name: queryParam3 in: query type: integer format: uint32 minimum: 12 exclusiveMinimum: true allowEmptyValue: true required: true - name: queryParam4 in: query collectionFormat: multi maxItems: 2 type: array items: type: string format: uuid default: - a8098c1a-f86e-11da-bd1a-00112444be1e - name: pathParam1 in: path type: string pattern: '^\w+$' required: true - name: headerParam1 in: header type: array items: type: number default: - 1.1 - 2.75 required: false responses: stdResponses /form/{pathParam1}: post: operationId: getInForm consumes: - multipart/formData parameters: - name: pathParam1 in: path type: string maxLength: 10 required: true - name: docname in: formData type: string pattern: '^\w+\.doc$' required: true - name: docAuthor in: formData type: string - name: attachment in: formData type: file required: true - name: addendum in: formData type: file required: false responses: stdResponses definitions: ContainerConfig: type: object required: [config1] properties: config1: type: string format: date config2: type: string format: date default: '1999-09-09' default: config1: '2019-09-09' config2: '2018-09-09' errorResponseMsg: type: object required: [ errorCode, reason ] properties: errorCode: type: integer reason: type: string severity: type: string enum: [ FATAL, CRITICAL, ERROR, WARNING, INFO ] additional: type: string enum: [ FATAL, CRITICAL, ERROR, WARNING, INFO ] default: INFO default: errorCode: 501 reason: not implemented severity: FATAL	15.58 KB	2025-05-25 12:27
📄 gentest3.yaml swagger: '2.0' info: title: code generation test fixture for parameters, with default values version: '1.0.0' host: localhost basePath: / consumes: - application/json produces: - application/json schemes: - http paths: /headon: get: operationId: gimmeLottaHeaders parameters: - name: sampleParam in: query type: string responses: &stdResponses 200: description: sanity check name mangling for headers headers: &myHeaders sanity_check_header_1: type: string format: uuid sanity-check-header-2: type: string format: date sanityCheckHeader3: type: integer format: uint32 sanityCheckHeader3: type: integer format: uint32 X-sanityCheckHeader4: type: string format: password pattern: '^\w+$' # headers with collections X-DeepHeader1: type: array # implicit: collectionFormat=csv items: type: integer format: uint64 maximum: 50 X-DeepHeader2: type: array collectionFormat: pipes items: type: array collectionFormat: csv uniqueItems: true items: type: array collectionFormat: tsv maxItems: 10 items: type: string format: duration schema: type: string format: date 201: description: headers with default values headers: &myDefaultHeaders sanity_check_header_0: type: string default: simple string sanity_check_header_float: type: number default: 9.99 sanity_check_header_1: type: string format: uuid default: a8098c1a-f86e-11da-bd1a-00112444be1e sanity-check-header-2: type: string format: date default: x1972-01-01 sanityCheckHeader3: type: integer format: uint32 default: 100 sanityCheckHeader3: type: number format: float32 default: 1.45 X-sanityCheckHeader4: type: string format: password pattern: '^\w+$' default: abc # headers with collections X-DeepHeader1: type: array # implicit: collectionFormat=csv items: type: integer format: uint64 maximum: 50 default: - 1 - 2 - 3 X-DeepHeader2: type: array collectionFormat: pipes items: type: array collectionFormat: csv uniqueItems: true items: type: array collectionFormat: tsv maxItems: 10 items: type: string format: duration default: - - - 1s - 2s - 3s - - 1w - 2w - 3w - - - 4s - 5s - 6s - - 4w - 5w - 6w X-DeepHeader3: type: array collectionFormat: pipes items: type: array collectionFormat: csv uniqueItems: true items: type: array collectionFormat: tsv maxItems: 10 items: type: string format: date default: - - - 1999-01-01 - 1999-01-02 - 1999-01-03 - - 1999-02-01 - 1999-02-02 - 1999-02-03 - - - 2000-01-01 - 2000-01-02 - 2000-01-03 - - 2000-02-01 - 2000-02-02 - 2000-02-03 X-DeepHeader4: type: array collectionFormat: pipes uniqueItems: true items: type: string default: - this - is - a song schema: type: string format: date default: description: headers in default response headers: *myHeaders schema: $ref: '#/definitions/errorResponseMsg' definitions: errorResponseMsg: type: object required: [ errorCode, reason ] properties: errorCode: type: integer reason: type: string severity: type: string enum: [ FATAL, CRITICAL, ERROR, WARNING, INFO ] additional: type: string enum: [ FATAL, CRITICAL, ERROR, WARNING, INFO ] default: INFO default: errorCode: 501 reason: not implemented severity: FATAL	5.6 KB	2025-05-25 12:27
📄 indirect-circular-ancestor.json { "swagger": "2.0", "info": { "description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n", "version": "1.0.0", "title": "Swagger Petstore", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/pets": { "get": { "tags": ["pet"], "summary": "list the pets", "operationId": "getPets", "responses": { "default": { "description": "Generic Error" }, "200": { "description": "Pets list", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pet" } } } } } } }, "definitions": { "Circular2": { "allOf": [{ "$ref": "#/definitions/Circular1" }, { "properties": { "createdAt": { "type": "string", "format": "date-time" } } }] }, "Parent": { "allOf": [{ "$ref": "#/definitions/Circular2" }] }, "Circular1": { "allOf": [{ "$ref": "#/definitions/Parent" }, { "properties": { "age": { "type": "integer", "format": "int32" } } }] }, "Category": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Pet": { "required": [ "name", "photoUrls" ], "properties": { "id": { "type": "integer", "format": "int64" }, "category": { "$ref": "#/definitions/Category" }, "name": { "type": "string", "example": "doggie" }, "photoUrls": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "status": { "type": "string", "description": "pet status in the store" } } }, "Tag": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } }	3.52 KB	2025-05-25 12:27
📄 invalid-formdata-body-params.json { "swagger": "2.0", "info": { "description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n", "version": "1.0.0", "title": "Swagger Petstore", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/pets": { "get": { "tags": ["pet"], "summary": "list the pets", "operationId": "getPets", "parameters": [{ "name": "limit", "in": "formData", "description": "number of items to return in the result", "type": "array", "collectionFormat": "csv", "items": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "bodyParam", "in": "body", "description": "number of items to return in the result", "schema": { "type": "integer", "format": "int32", "default": 20 } }], "responses": { "default": { "description": "Generic Error" }, "200": { "description": "Pets list", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pet" } } } } } } }, "definitions": { "Parent": { "$ref": "#/definitions/Category" }, "Category": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Pet": { "required": [ "name", "photoUrls" ], "properties": { "id": { "type": "integer", "format": "int64" }, "category": { "$ref": "#/definitions/Category" }, "name": { "type": "string", "example": "doggie" }, "photoUrls": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "status": { "type": "string", "description": "pet status in the store" } } }, "Tag": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } }	3.64 KB	2025-05-25 12:27
📄 invalid-ref.json { "swagger": "2.0", "info": { "description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n", "version": "1.0.0", "title": "Swagger Petstore", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/pets": { "get": { "tags": ["pet"], "summary": "list the pets", "operationId": "getPets", "responses": { "default": { "description": "Generic Error" }, "200": { "description": "Pets list", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pet" } } } } } } }, "definitions": { "Parent": { "$ref": "#/definitions/DoesNotExist" }, "Category": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Pet": { "required": [ "name", "photoUrls" ], "properties": { "id": { "type": "integer", "format": "int64" }, "category": { "$ref": "#/definitions/Category" }, "name": { "type": "string", "example": "doggie" }, "photoUrls": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "status": { "type": "string", "description": "pet status in the store" } } }, "Tag": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } }	2.94 KB	2025-05-25 12:27
📄 invalid-referenced.yml --- swagger: "2.0" info: version: "0.1.0" title: referenced validation invalid paths: /: get: responses: default: description: the record parameters: rateLimit: name: X-Rate-Limit in: header type: integer format: int32 responses: notFound: description: Not found definitions: record: type: object properties: createdAt: type: string format: date-time	445 B	2025-05-25 12:27
📄 nestedduplicateprops.json { "swagger": "2.0", "info": { "description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n", "version": "1.0.0", "title": "Swagger Petstore", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/pets": { "get": { "tags": ["pet"], "summary": "list the pets", "operationId": "getPets", "responses": { "default": { "description": "Generic Error" }, "200": { "description": "Pets list", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pet" } } } } } } }, "definitions": { "Parent": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "ValidChild": { "allOf": [{ "$ref": "#/definitions/Parent" }, { "properties": { "age": { "type": "integer", "format": "int32" } } }] }, "InvalidChild": { "allOf": [{ "$ref": "#/definitions/ValidChild" }, { "properties": { "name": { "type": "string" } } }] }, "Category": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Pet": { "required": [ "name", "photoUrls" ], "properties": { "id": { "type": "integer", "format": "int64" }, "category": { "$ref": "#/definitions/Category" }, "name": { "type": "string", "example": "doggie" }, "photoUrls": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "status": { "type": "string", "description": "pet status in the store" } } }, "Tag": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } }	3.61 KB	2025-05-25 12:27
📄 petstore-expanded.json { "swagger": "2.0", "info": { "version": "1.0.0", "title": "Swagger Petstore", "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "Wordnik API Team", "email": "foo@example.com", "url": "http://madskristensen.net" }, "license": { "name": "MIT", "url": "http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/api", "schemes": [ "http" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/pets": { "get": { "description": "Returns all pets from the system that the user has access to", "operationId": "findPets", "produces": [ "application/json", "application/xml", "text/xml", "text/html" ], "parameters": [ { "name": "tags", "in": "query", "description": "tags to filter by", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "limit", "in": "query", "description": "maximum number of results to return", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "pet response", "schema": { "type": "array", "items": { "$ref": "#/definitions/pet" } } }, "default": { "description": "unexpected error", "schema": { "$ref": "#/definitions/errorModel" } } } }, "post": { "description": "Creates a new pet in the store. Duplicates are allowed", "operationId": "addPet", "produces": [ "application/json" ], "parameters": [ { "name": "pet", "in": "body", "description": "Pet to add to the store", "required": true, "schema": { "$ref": "#/definitions/newPet" } } ], "responses": { "200": { "description": "pet response", "schema": { "$ref": "#/definitions/pet" } }, "default": { "description": "unexpected error", "schema": { "$ref": "#/definitions/errorModel" } } } } }, "/pets/{id}": { "get": { "description": "Returns a user based on a single ID, if the user does not have access to the pet", "operationId": "findPetById", "produces": [ "application/json", "application/xml", "text/xml", "text/html" ], "parameters": [ { "name": "id", "in": "path", "description": "ID of pet to fetch", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "pet response", "schema": { "$ref": "#/definitions/pet" } }, "default": { "description": "unexpected error", "schema": { "$ref": "#/definitions/errorModel" } } } }, "delete": { "description": "deletes a single pet based on the ID supplied", "operationId": "deletePet", "parameters": [ { "name": "id", "in": "path", "description": "ID of pet to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "204": { "description": "pet deleted" }, "default": { "description": "unexpected error", "schema": { "$ref": "#/definitions/errorModel" } } } } } }, "definitions": { "pet": { "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "tag": { "type": "string" } } }, "newPet": { "allOf": [ { "$ref": "pet" }, { "required": [ "name" ], "properties": { "id": { "type": "integer", "format": "int64" } } } ] }, "errorModel": { "required": [ "code", "message" ], "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" } } } } }	5.24 KB	2025-05-25 12:27
📄 recursive-circular-ancestor.json { "swagger": "2.0", "info": { "description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n", "version": "1.0.0", "title": "Swagger Petstore", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/pets": { "get": { "tags": ["pet"], "summary": "list the pets", "operationId": "getPets", "responses": { "default": { "description": "Generic Error" }, "200": { "description": "Pets list", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pet" } } } } } } }, "definitions": { "Circular2": { "allOf": [{ "$ref": "#/definitions/Circular1" }, { "properties": { "createdAt": { "type": "string", "format": "date-time" } } }] }, "Parent": { "$ref": "#/definitions/Circular2" }, "Circular1": { "allOf": [{ "$ref": "#/definitions/Parent" }, { "properties": { "age": { "type": "integer", "format": "int32" } } }] }, "Category": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Pet": { "required": [ "name", "photoUrls" ], "properties": { "id": { "type": "integer", "format": "int64" }, "category": { "$ref": "#/definitions/Category" }, "name": { "type": "string", "example": "doggie" }, "photoUrls": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "status": { "type": "string", "description": "pet status in the store" } } }, "Tag": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } }	3.49 KB	2025-05-25 12:27
📄 type-keyword-mismatch.yaml swagger: '2.0' info: description: Validation keyword type mismatch version: 0.0.1 title: test paths: /test/{id}/string: get: parameters: - name: id in: path required: true type: string minimum: 1 maximum: 5 multipleOf: 33 responses: '200': description: successful operation '500': description: Operation error /test/{id}/integer: get: parameters: - name: id in: path required: true type: integer minItems: 1 maxItems: 5 uniqueItems: true responses: '200': description: successful operation '500': description: Operation error /test/{id}/array: get: parameters: - name: id in: path required: true type: array minLength: 1 maxLength: 5 responses: '200': description: successful operation '500': description: Operation error	1.06 KB	2025-05-25 12:27
📄 valid-ref.json { "swagger": "2.0", "info": { "description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n", "version": "1.0.0", "title": "Swagger Petstore", "termsOfService": "http://helloreverb.com/terms/", "contact": { "name": "apiteam@wordnik.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "host": "petstore.swagger.wordnik.com", "basePath": "/v2", "schemes": [ "http" ], "paths": { "/pets": { "get": { "tags": ["pet"], "summary": "list the pets", "operationId": "getPets", "responses": { "default": { "description": "Generic Error" }, "200": { "description": "Pets list", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pet" } } } } } } }, "definitions": { "Parent": { "$ref": "#/definitions/Category" }, "Category": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Pet": { "required": [ "name", "photoUrls" ], "properties": { "id": { "type": "integer", "format": "int64" }, "category": { "$ref": "#/definitions/Category" }, "name": { "type": "string", "example": "doggie" }, "photoUrls": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" } }, "status": { "type": "string", "description": "pet status in the store" } } }, "Tag": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } }	2.94 KB	2025-05-25 12:27
📄 valid-referenced-variants.yaml --- swagger: "2.0" info: version: "0.1.0" title: referenced validation paths: /: get: parameters: - $ref: "#/parameters/rateLimit" - $ref: "#/parameters/requiredPatternProps" responses: default: description: the record schema: $ref: "#/definitions/record" 404: $ref: "#/responses/notFound" 403: $ref: "#/responses/wrongMe" /greatAgain: get: parameters: - $ref: "#/parameters/rateLimit" - $ref: "#/parameters/requiredPatternItems" responses: default: description: the record schema: $ref: "#/definitions/record" 404: $ref: "#/responses/notFound" 403: $ref: "#/responses/despicableMeItems" parameters: rateLimit: name: X-Rate-Limit in: header type: integer #<--- try error with $ref in header format: int32 requiredPatternProps: name: badPattern in: body schema: $ref: '#/definitions/record' #<--- patternProperties in parameters requiredPatternItems: name: badPatternInItems in: body schema: type: array items: $ref: '#/definitions/lotOfErrors2' #<--- patternProperties in parameters responses: notFound: description: Not found schema: $ref: "#/definitions/record" wrongMe: description: wrong me schema: $ref: "#/definitions/lotOfErrors" despicableMeItems: description: despicable me schema: type: array items: $ref: "#/definitions/lotOfErrors2" definitions: record: type: object additionalProperties: true required: [ createdAt, oneMore ] properties: createdAt: type: string format: date-time lotOfErrors: type: object required: [ a, b-1, x, z-1, bug ] properties: a: type: integer format: int32 readOnly: true #<--- warning default: 3 example: 5 additionalProperties: #type: object properties: x: type: integer z: type: integer additionalProperties: false patternProperties: #<-- unsupported: patternProperties in schema '^z-.$': type: integer format: int32 readOnly: true #<-- warning default: 3 example: 5 patternProperties: #<-- unsupported: patternProperties in schema '^b-.$': type: integer format: int32 default: 3 example: 5 '^)b-InvalidRegexp1.($': #<-- invalid regexp type: integer format: int32 default: 3 example: 5 lotOfErrors2: #<-- note the missing type to declare in items required: [ a , b-8] properties: a: type: integer format: int32 default: 3 example: 5 patternProperties: #<-- unsupported: patternProperties in schema '^b-.$': type: integer format: int32 readOnly: true #<--- warning default: 3 example: 5 '^)b-InvalidRegexp2.(*$': #<-- invalid regexp type: integer format: int32 default: 3 example: 5	3.42 KB	2025-05-25 12:27
📄 valid-referenced.yml --- swagger: "2.0" info: version: "0.1.0" title: referenced validation paths: /: get: parameters: - $ref: "#/parameters/rateLimit" responses: default: description: the record schema: $ref: "#/definitions/record" 404: $ref: "#/responses/notFound" parameters: rateLimit: name: X-Rate-Limit in: header type: integer format: int32 responses: notFound: description: Not found schema: $ref: "#/definitions/record" definitions: record: type: object properties: createdAt: type: string format: date-time	654 B	2025-05-25 12:27

Edit File:

Terminal