├── .gitignore ├── CNAME ├── DCO ├── Dockerfile ├── LICENSE ├── NOTICE ├── README.md ├── _config.yml ├── _includes └── login.md ├── _layouts ├── doc.html └── fullpage.html ├── _plugins └── environment_variables.rb ├── api ├── generate-token.png ├── index.md ├── newapp.png └── swagger │ ├── css │ ├── reset.css │ └── screen.css │ ├── images │ ├── explorer_icons.png │ ├── logo_small.png │ ├── pet_store_api.png │ ├── throbber.gif │ └── wordnik_api.png │ ├── index.html │ ├── lib │ ├── backbone-min.js │ ├── handlebars-2.0.0.js │ ├── highlight.7.3.pack.js │ ├── jquery-1.8.0.min.js │ ├── jquery.ba-bbq.min.js │ ├── jquery.slideto.min.js │ ├── jquery.wiggle.min.js │ ├── marked.js │ ├── swagger-oauth.js │ ├── underscore-min.js │ └── underscore-min.map │ ├── o2c.html │ └── swagger-ui.js ├── bower_components └── simple-jekyll-search │ ├── .bower.json │ ├── README.md │ ├── bower.json │ └── dest │ └── jekyll-search.js ├── build.sh ├── code-of-conduct.md ├── glossary ├── access-token.md ├── build-trigger.md ├── index.html ├── organizations.md ├── robot-accounts.md └── teams.md ├── guides ├── add-custom-invoice-field.png ├── building.md ├── create-repo.md ├── custom-trigger.md ├── customizing-invoices.md ├── delete-custom-invoice-field.png ├── git-submodules.md ├── github-read-only.md ├── healthcheck.png ├── index.md ├── listeners.png ├── login.md ├── notifications.md ├── pushpull.md ├── repo-permissions.md ├── repo-permissions.png ├── repo-view.md ├── skip-build.md ├── squashed-images.md ├── tag-operations.md ├── tag-operations.png ├── tag-templating.md ├── view-credentials-dropdown.png └── view-credentials.png ├── images ├── bg_hr.png ├── blacktocat.png ├── body-bg.jpg ├── download-button.png ├── github-blue-button.png ├── github-button.png ├── header-bg.jpg ├── highlight-bg.jpg ├── icon_download.png ├── quay-logo.png ├── sidebar-bg.jpg └── sprite_download.png ├── index.html ├── issues ├── 429.md ├── auth-failure.md ├── base-pull-issue.md ├── build-trigger-robot.png ├── cannot-add-trigger.md ├── cannot-load-build-logs.md ├── cannot-locate-dockerfile.md ├── checksum-mismatch.md ├── could-not-reach-any-registry-endpoint.md ├── ecs-auth-failure.md ├── image-exists.md ├── image-write-error.md ├── invalid-access-token.md ├── invalid-auth-token.md ├── invalid-oauth-token.md ├── invalid-request.md ├── iotimeout.md ├── login-failure.md ├── missing-checksum-cookie.md ├── missing-checksum.md ├── no-create-permission.md ├── no-login.md ├── no-repo-write-permission.md ├── not-implemented.md ├── odd-login-failure.md ├── odd-pull-failure.md ├── push-timestamp-wrong.md ├── quay-mesos.md ├── robot-login-failure.md ├── unknown-image.md └── upload-in-progress.md ├── javascripts └── main.js ├── params.json ├── qe-mysql-failure.md ├── run.sh ├── search.json ├── solution ├── getting-started.md ├── image00.png ├── index.html ├── zimage00.png └── zimage01.png └── stylesheets ├── docs.css ├── print.css ├── pygment_trac.css └── stylesheet.css /.gitignore: -------------------------------------------------------------------------------- 1 | _site/* 2 | -------------------------------------------------------------------------------- /CNAME: -------------------------------------------------------------------------------- 1 | docs.quay.io 2 | -------------------------------------------------------------------------------- /DCO: -------------------------------------------------------------------------------- 1 | Developer Certificate of Origin 2 | Version 1.1 3 | 4 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 5 | 660 York Street, Suite 102, 6 | San Francisco, CA 94110 USA 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | 12 | Developer's Certificate of Origin 1.1 13 | 14 | By making a contribution to this project, I certify that: 15 | 16 | (a) The contribution was created in whole or in part by me and I 17 | have the right to submit it under the open source license 18 | indicated in the file; or 19 | 20 | (b) The contribution is based upon previous work that, to the best 21 | of my knowledge, is covered under an appropriate open source 22 | license and I have the right under that license to submit that 23 | work with modifications, whether created in whole or in part 24 | by me, under the same open source license (unless I am 25 | permitted to submit under a different license), as indicated 26 | in the file; or 27 | 28 | (c) The contribution was provided directly to me by some other 29 | person who certified (a), (b) or (c) and I have not modified 30 | it. 31 | 32 | (d) I understand and agree that this project and the contribution 33 | are public and that a record of the contribution (including all 34 | personal information I submit with it, including my sign-off) is 35 | maintained indefinitely and may be redistributed consistent with 36 | this project or the open source license(s) involved. 37 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM jekyll/jekyll:builder 2 | 3 | RUN apk --update --no-cache add curl python python-dev 4 | RUN curl https://s3.amazonaws.com/aws-cli/awscli-bundle.zip -o awscli-bundle.zip && \ 5 | unzip awscli-bundle.zip && \ 6 | ./awscli-bundle/install -i /usr/local/aws -b /usr/local/bin/aws && \ 7 | rm -rf awscli-bundle.zip awscli-bundle 8 | 9 | WORKDIR /srv/jekyll 10 | 11 | COPY run.sh / 12 | COPY build.sh / 13 | 14 | ADD . /srv/jekyll 15 | 16 | CMD ["jekyll", "serve"] 17 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | CoreOS Project 2 | Copyright 2018 CoreOS, Inc 3 | 4 | This product includes software developed at CoreOS, Inc. 5 | (http://www.coreos.com/). 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Documentation for Quay.io. 2 | 3 | [![Docker Repository on Quay.io](https://quay.io/repository/coreos/quay-docs/status "Docker Repository on Quay.io")](https://quay.io/repository/coreos/quay-docs) 4 | 5 | ## Run in a container (on prem) 6 | 7 | ``` 8 | docker run -p 4000:4000 quay.io/coreos/quay-docs 9 | ``` 10 | 11 | ## Run locally (development) 12 | 13 | To edit using Jekyll: 14 | ``` 15 | jekyll serve --watch --baseurl="" 16 | ``` 17 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | markdown: kramdown 2 | kramdown: 3 | input: GFM 4 | syntax_highlighter: rouge 5 | hard_wrap: false 6 | highlighter: rouge 7 | 8 | exclude: ["README.md", "Dockerfile", "CNAME", "build.sh", "run.sh"] 9 | -------------------------------------------------------------------------------- /_includes/login.md: -------------------------------------------------------------------------------- 1 | To sign into Quay.io, execute the `docker login quay.io` command: 2 | 3 | Note: If you go to your Quay account settings you can create an encrypted password for more security. 4 | 5 | ``` 6 | $ docker login quay.io 7 | Username: myusername 8 | Password: mypassword 9 | ``` 10 | -------------------------------------------------------------------------------- /_layouts/doc.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Quay Documentation 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 70 | 71 |
72 |
73 |
74 |
75 |
76 |

{{ page.title }}

77 | {{ content }} 78 |
79 |
80 |
81 |
82 |
83 | 84 | 85 | 86 | 87 | 88 | 93 | 94 | 95 | 96 | -------------------------------------------------------------------------------- /_layouts/fullpage.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Quay Documentation 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 32 | 33 | 34 | 35 | 56 | 57 |
58 | {{ content }} 59 |
60 | 61 | 62 | 63 | 64 | 65 | 70 | 71 | 72 | 73 | -------------------------------------------------------------------------------- /_plugins/environment_variables.rb: -------------------------------------------------------------------------------- 1 | # Plugin to add environment variables to the `site` object in Liquid templates 2 | 3 | module Jekyll 4 | class EnvironmentVariablesGenerator < Generator 5 | def generate(site) 6 | site.config['quayhost'] = ENV['QUAY_HOST'] || 'https://quay.io/' 7 | end 8 | end 9 | end -------------------------------------------------------------------------------- /api/generate-token.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/coreos/quay-docs/0dcf687434a96330dc1afda67e6c6590b06ec4aa/api/generate-token.png -------------------------------------------------------------------------------- /api/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: doc 3 | title: Quay.io API 4 | sublayout: api 5 | index: true 6 | --- 7 | The Quay.io API is a full [OAuth 2](http://oauth.net/2/), RESTful API. 8 | 9 | **Note:** The Quay API is currently marked as version 1 and considered stable within minor versions 10 | of Quay Enterprise. The API may (but, in practice, never has) experience breaking changes across 11 | **major** versions of Quay Enterprise or at any time on Quay.io. 12 | 13 | ### Overview 14 | 15 | #### API Endpoint 16 | 17 | All APIs are accessed from the `https://quay.io/api/v1/` endpoint. 18 | 19 | For Enterprise customers, the endpoint is `http(s)://yourdomain/api/v1/`. 20 | 21 | #### Data format 22 | 23 | All data is sent and received as JSON. 24 | 25 | ### API Explorer 26 | 27 | The full list of defined methods and endpoints can be found in the [API Explorer](/api/swagger). 28 | 29 | ### Scopes 30 | 31 | The majority of calls to the Quay.io API require a token with one or more _scopes_, which specify 32 | the permissions granted to the token to perform some work. 33 | 34 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 59 | 60 |
ScopeDescription
repo:read 57 | The application will be able to view and pull all repositories visible to the granting user 58 |
61 | 62 | ### Applications and Tokens 63 | 64 | #### Creating a new application 65 | 66 | All calls to the Quay.io REST API must occur via a token created for a defined _Application_. 67 | 68 | A new application can be created under an [Organization](/glossary/organizations.html) in the _Applications_ tab. 69 | 70 | 71 | 72 | ### OAuth 2 Access Tokens 73 | 74 | All calls to API methods which are not read-only and public require the use of an OAuth 2 _access token_, specified via a header. Access tokens for the Quay.io are long-lived and do not expire. 75 | 76 | #### Generating a Token (OAuth web flow) 77 | 78 | If your application will be used by various users of Quay.io or the Enterprise Registry, then generating a token requires running the OAuth 2 web flow (See [Google's example](https://developers.google.com/accounts/docs/OAuth2WebServer)). 79 | 80 | To do so, your application must make a request like so (replace `quay.io` with your domain for Enterprise Registry): 81 | 82 | ``` 83 | GET https://quay.io/oauth/authorize?response_type=token&redirect_uri={your redirect URI}&realm=realm&client_id={application client ID}&scope={comma delineated set of scopes to request} 84 | ``` 85 | 86 | Once the user has approved the permissions for your application, the browser will load the specified redirect URI with the access token appended like so: 87 | 88 | ``` 89 | http://example.com/the/redirect/uri/path#access_token={created access token} 90 | ``` 91 | 92 | This access token can then be saved to make API requests. 93 | 94 | 95 | #### Generating a Token (for internal application use) 96 | 97 | **Note:** The generated token will be created on behalf of the **currently logged in user**. 98 | 99 | If the API call will be conducted by an internal application, an access token can be generated simply by clicking on the _Generate Token_ tab under the application, choosing scopes, and then clicking the _Generate Access Token_ button. After conducting the OAuth flow for the current account, the newly generated token will be displayed. 100 | 101 | 102 | 103 | ### Making an API request 104 | 105 | API requests are made by executing the documented HTTP verb (GET, POST, PUT or DELETE) against the API endpoint URL, with an Authorization header **containing the access token** and (if necessary) body content in JSON form. 106 | 107 | #### Example: Find all repositories belonging to the token's user 108 | 109 | ``` 110 | Authorization: Bearer AccessTokenGoesHere 111 | GET https://quay.io/api/v1/repository?private=true&public=false 112 | ``` 113 | 114 | 115 | #### Example: Adding a team permission to a repository 116 | 117 | ``` 118 | Authorization: Bearer AccessTokenGoesHere 119 | PUT https://quay.io/api/v1/repository/some/repo/permissions/team/someteam 120 | 121 | { 122 | "role": "read" 123 | } 124 | ``` 125 | 126 | ### Pulling and Pushing using an access token 127 | 128 | OAuth 2 access tokens granted by Quay.io applications can invoke `docker pull` and `docker push` on behalf of the user if they have the `repo:read` and `repo:write` scopes (respectively). 129 | 130 | To login, the `docker login` command can be used with the username `$oauthtoken` and the access token as the password: 131 | 132 | ``` 133 | $ docker login quay.io 134 | Username: $oauthtoken 135 | Password: ThisIsTheAccessToken 136 | Email: ignore@this.com 137 | ``` 138 | -------------------------------------------------------------------------------- /api/newapp.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/coreos/quay-docs/0dcf687434a96330dc1afda67e6c6590b06ec4aa/api/newapp.png -------------------------------------------------------------------------------- /api/swagger/css/reset.css: -------------------------------------------------------------------------------- 1 | /* http://meyerweb.com/eric/tools/css/reset/ v2.0 | 20110126 */ 2 | html, 3 | body, 4 | div, 5 | span, 6 | applet, 7 | object, 8 | iframe, 9 | h1, 10 | h2, 11 | h3, 12 | h4, 13 | h5, 14 | h6, 15 | p, 16 | blockquote, 17 | pre, 18 | a, 19 | abbr, 20 | acronym, 21 | address, 22 | big, 23 | cite, 24 | code, 25 | del, 26 | dfn, 27 | em, 28 | img, 29 | ins, 30 | kbd, 31 | q, 32 | s, 33 | samp, 34 | small, 35 | strike, 36 | strong, 37 | sub, 38 | sup, 39 | tt, 40 | var, 41 | b, 42 | u, 43 | i, 44 | center, 45 | dl, 46 | dt, 47 | dd, 48 | ol, 49 | ul, 50 | li, 51 | fieldset, 52 | form, 53 | label, 54 | legend, 55 | table, 56 | caption, 57 | tbody, 58 | tfoot, 59 | thead, 60 | tr, 61 | th, 62 | td, 63 | article, 64 | aside, 65 | canvas, 66 | details, 67 | embed, 68 | figure, 69 | figcaption, 70 | footer, 71 | header, 72 | hgroup, 73 | menu, 74 | nav, 75 | output, 76 | ruby, 77 | section, 78 | summary, 79 | time, 80 | mark, 81 | audio, 82 | video { 83 | margin: 0; 84 | padding: 0; 85 | border: 0; 86 | font-size: 100%; 87 | font: inherit; 88 | vertical-align: baseline; 89 | } 90 | /* HTML5 display-role reset for older browsers */ 91 | article, 92 | aside, 93 | details, 94 | figcaption, 95 | figure, 96 | footer, 97 | header, 98 | hgroup, 99 | menu, 100 | nav, 101 | section { 102 | display: block; 103 | } 104 | body { 105 | line-height: 1; 106 | } 107 | ol, 108 | ul { 109 | list-style: none; 110 | } 111 | blockquote, 112 | q { 113 | quotes: none; 114 | } 115 | blockquote:before, 116 | blockquote:after, 117 | q:before, 118 | q:after { 119 | content: ''; 120 | content: none; 121 | } 122 | table { 123 | border-collapse: collapse; 124 | border-spacing: 0; 125 | } 126 | -------------------------------------------------------------------------------- /api/swagger/images/explorer_icons.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/coreos/quay-docs/0dcf687434a96330dc1afda67e6c6590b06ec4aa/api/swagger/images/explorer_icons.png -------------------------------------------------------------------------------- /api/swagger/images/logo_small.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/coreos/quay-docs/0dcf687434a96330dc1afda67e6c6590b06ec4aa/api/swagger/images/logo_small.png -------------------------------------------------------------------------------- /api/swagger/images/pet_store_api.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/coreos/quay-docs/0dcf687434a96330dc1afda67e6c6590b06ec4aa/api/swagger/images/pet_store_api.png -------------------------------------------------------------------------------- /api/swagger/images/throbber.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/coreos/quay-docs/0dcf687434a96330dc1afda67e6c6590b06ec4aa/api/swagger/images/throbber.gif -------------------------------------------------------------------------------- /api/swagger/images/wordnik_api.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/coreos/quay-docs/0dcf687434a96330dc1afda67e6c6590b06ec4aa/api/swagger/images/wordnik_api.png -------------------------------------------------------------------------------- /api/swagger/index.html: -------------------------------------------------------------------------------- 1 | --- 2 | layout: fullpage 3 | bodyclass: swagger-section 4 | title: API Explorer 5 | --- 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 71 | 72 | 214 | 215 |
216 |
217 |
218 |

{{ page.title }}

219 |
Note: The endpoints listed below do not include superuser endpoints available on Quay Enterprise installations. To view those endpoints, point a Swagger UI at the /api/v1/discovery URL on your own installation.
220 |
 
221 |
222 |
223 |
224 |
225 | -------------------------------------------------------------------------------- /api/swagger/lib/backbone-min.js: -------------------------------------------------------------------------------- 1 | // Backbone.js 1.1.2 2 | 3 | (function(t,e){if(typeof define==="function"&&define.amd){define(["underscore","jquery","exports"],function(i,r,s){t.Backbone=e(t,s,i,r)})}else if(typeof exports!=="undefined"){var i=require("underscore");e(t,exports,i)}else{t.Backbone=e(t,{},t._,t.jQuery||t.Zepto||t.ender||t.$)}})(this,function(t,e,i,r){var s=t.Backbone;var n=[];var a=n.push;var o=n.slice;var h=n.splice;e.VERSION="1.1.2";e.$=r;e.noConflict=function(){t.Backbone=s;return this};e.emulateHTTP=false;e.emulateJSON=false;var u=e.Events={on:function(t,e,i){if(!c(this,"on",t,[e,i])||!e)return this;this._events||(this._events={});var r=this._events[t]||(this._events[t]=[]);r.push({callback:e,context:i,ctx:i||this});return this},once:function(t,e,r){if(!c(this,"once",t,[e,r])||!e)return this;var s=this;var n=i.once(function(){s.off(t,n);e.apply(this,arguments)});n._callback=e;return this.on(t,n,r)},off:function(t,e,r){var s,n,a,o,h,u,l,f;if(!this._events||!c(this,"off",t,[e,r]))return this;if(!t&&!e&&!r){this._events=void 0;return this}o=t?[t]:i.keys(this._events);for(h=0,u=o.length;h").attr(t);this.setElement(r,false)}else{this.setElement(i.result(this,"el"),false)}}});e.sync=function(t,r,s){var n=T[t];i.defaults(s||(s={}),{emulateHTTP:e.emulateHTTP,emulateJSON:e.emulateJSON});var a={type:n,dataType:"json"};if(!s.url){a.url=i.result(r,"url")||M()}if(s.data==null&&r&&(t==="create"||t==="update"||t==="patch")){a.contentType="application/json";a.data=JSON.stringify(s.attrs||r.toJSON(s))}if(s.emulateJSON){a.contentType="application/x-www-form-urlencoded";a.data=a.data?{model:a.data}:{}}if(s.emulateHTTP&&(n==="PUT"||n==="DELETE"||n==="PATCH")){a.type="POST";if(s.emulateJSON)a.data._method=n;var o=s.beforeSend;s.beforeSend=function(t){t.setRequestHeader("X-HTTP-Method-Override",n);if(o)return o.apply(this,arguments)}}if(a.type!=="GET"&&!s.emulateJSON){a.processData=false}if(a.type==="PATCH"&&k){a.xhr=function(){return new ActiveXObject("Microsoft.XMLHTTP")}}var h=s.xhr=e.ajax(i.extend(a,s));r.trigger("request",r,h,s);return h};var k=typeof window!=="undefined"&&!!window.ActiveXObject&&!(window.XMLHttpRequest&&(new XMLHttpRequest).dispatchEvent);var T={create:"POST",update:"PUT",patch:"PATCH","delete":"DELETE",read:"GET"};e.ajax=function(){return e.$.ajax.apply(e.$,arguments)};var $=e.Router=function(t){t||(t={});if(t.routes)this.routes=t.routes;this._bindRoutes();this.initialize.apply(this,arguments)};var S=/\((.*?)\)/g;var H=/(\(\?)?:\w+/g;var A=/\*\w+/g;var I=/[\-{}\[\]+?.,\\\^$|#\s]/g;i.extend($.prototype,u,{initialize:function(){},route:function(t,r,s){if(!i.isRegExp(t))t=this._routeToRegExp(t);if(i.isFunction(r)){s=r;r=""}if(!s)s=this[r];var n=this;e.history.route(t,function(i){var a=n._extractParameters(t,i);n.execute(s,a);n.trigger.apply(n,["route:"+r].concat(a));n.trigger("route",r,a);e.history.trigger("route",n,r,a)});return this},execute:function(t,e){if(t)t.apply(this,e)},navigate:function(t,i){e.history.navigate(t,i);return this},_bindRoutes:function(){if(!this.routes)return;this.routes=i.result(this,"routes");var t,e=i.keys(this.routes);while((t=e.pop())!=null){this.route(t,this.routes[t])}},_routeToRegExp:function(t){t=t.replace(I,"\\$&").replace(S,"(?:$1)?").replace(H,function(t,e){return e?t:"([^/?]+)"}).replace(A,"([^?]*?)");return new RegExp("^"+t+"(?:\\?([\\s\\S]*))?$")},_extractParameters:function(t,e){var r=t.exec(e).slice(1);return i.map(r,function(t,e){if(e===r.length-1)return t||null;return t?decodeURIComponent(t):null})}});var N=e.History=function(){this.handlers=[];i.bindAll(this,"checkUrl");if(typeof window!=="undefined"){this.location=window.location;this.history=window.history}};var R=/^[#\/]|\s+$/g;var O=/^\/+|\/+$/g;var P=/msie [\w.]+/;var C=/\/$/;var j=/#.*$/;N.started=false;i.extend(N.prototype,u,{interval:50,atRoot:function(){return this.location.pathname.replace(/[^\/]$/,"$&/")===this.root},getHash:function(t){var e=(t||this).location.href.match(/#(.*)$/);return e?e[1]:""},getFragment:function(t,e){if(t==null){if(this._hasPushState||!this._wantsHashChange||e){t=decodeURI(this.location.pathname+this.location.search);var i=this.root.replace(C,"");if(!t.indexOf(i))t=t.slice(i.length)}else{t=this.getHash()}}return t.replace(R,"")},start:function(t){if(N.started)throw new Error("Backbone.history has already been started");N.started=true;this.options=i.extend({root:"/"},this.options,t);this.root=this.options.root;this._wantsHashChange=this.options.hashChange!==false;this._wantsPushState=!!this.options.pushState;this._hasPushState=!!(this.options.pushState&&this.history&&this.history.pushState);var r=this.getFragment();var s=document.documentMode;var n=P.exec(navigator.userAgent.toLowerCase())&&(!s||s<=7);this.root=("/"+this.root+"/").replace(O,"/");if(n&&this._wantsHashChange){var a=e.$('