Created
July 12, 2018 12:59
-
-
Save daviddavis/a095ec44e9625c4d3bd7b9a711176e8e to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{"swagger": "2.0", "info": {"title": "Pulp3 API", "version": "v3"}, "host": "localhost:8000", "schemes": ["http"], "basePath": "/pulp/api/v3", "consumes": ["application/json"], "produces": ["application/json"], "securityDefinitions": {"basic": {"type": "basic"}}, "security": [{"basic": []}], "paths": {"/artifacts/": {"get": {"operationId": "artifacts_list", "description": "", "parameters": [{"name": "md5", "in": "query", "description": "Filter results where md5 matches value", "required": false, "type": "string"}, {"name": "sha1", "in": "query", "description": "Filter results where sha1 matches value", "required": false, "type": "string"}, {"name": "sha224", "in": "query", "description": "Filter results where sha224 matches value", "required": false, "type": "string"}, {"name": "sha256", "in": "query", "description": "Filter results where sha256 matches value", "required": false, "type": "string"}, {"name": "sha384", "in": "query", "description": "Filter results where sha384 matches value", "required": false, "type": "string"}, {"name": "sha512", "in": "query", "description": "Filter results where sha512 matches value", "required": false, "type": "string"}, {"name": "cursor", "in": "query", "description": "The pagination cursor value.", "required": false, "type": "string"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": ""}}, "consumes": ["multipart/form-data", "application/x-www-form-urlencoded"], "tags": ["artifacts"]}, "post": {"operationId": "artifacts_create", "description": "", "parameters": [{"name": "id", "in": "formData", "required": false, "type": "string", "format": "uuid"}, {"name": "_href", "in": "formData", "required": false, "type": "string", "format": "uri"}, {"name": "created", "in": "formData", "description": "Timestamp of creation.", "required": false, "type": "string", "format": "date-time"}, {"name": "file", "in": "formData", "description": "The stored file.", "required": true, "type": "file"}, {"name": "size", "in": "formData", "description": "The size of the file in bytes.", "required": false, "type": "integer"}, {"name": "md5", "in": "formData", "description": "The MD5 checksum of the file if available.", "required": false, "type": "string"}, {"name": "sha1", "in": "formData", "description": "The SHA-1 checksum of the file if available.", "required": false, "type": "string"}, {"name": "sha224", "in": "formData", "description": "The SHA-224 checksum of the file if available.", "required": false, "type": "string"}, {"name": "sha256", "in": "formData", "description": "The SHA-256 checksum of the file if available.", "required": false, "type": "string"}, {"name": "sha384", "in": "formData", "description": "The SHA-384 checksum of the file if available.", "required": false, "type": "string"}, {"name": "sha512", "in": "formData", "description": "The SHA-512 checksum of the file if available.", "required": false, "type": "string"}], "responses": {"201": {"description": ""}}, "consumes": ["multipart/form-data", "application/x-www-form-urlencoded"], "tags": ["artifacts"]}, "parameters": []}, "/artifacts/{id}/": {"get": {"operationId": "artifacts_read", "description": "", "parameters": [], "responses": {"200": {"description": ""}}, "consumes": ["multipart/form-data", "application/x-www-form-urlencoded"], "tags": ["artifacts"]}, "delete": {"operationId": "artifacts_delete", "description": "Remove Artifact only if it is not associated with any Content.", "parameters": [], "responses": {"204": {"description": ""}}, "consumes": ["multipart/form-data", "application/x-www-form-urlencoded"], "tags": ["artifacts"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this artifact.", "required": true, "type": "string", "format": "uuid"}]}, "/content/file/files/": {"get": {"operationId": "content_file_files_list", "description": "", "parameters": [{"name": "relative_path", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "digest", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "cursor", "in": "query", "description": "The pagination cursor value.", "required": false, "type": "string"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["results"], "type": "object", "properties": {"next": {"type": "string", "format": "uri"}, "previous": {"type": "string", "format": "uri"}, "results": {"type": "array", "items": {"$ref": "#/definitions/FileContent"}}}}}}, "tags": ["content"]}, "post": {"operationId": "content_file_files_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/FileContent"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/FileContent"}}}, "tags": ["content"]}, "parameters": []}, "/content/file/files/{id}/": {"get": {"operationId": "content_file_files_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/FileContent"}}}, "tags": ["content"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this file content.", "required": true, "type": "string", "format": "uuid"}]}, "/distributions/": {"get": {"operationId": "distributions_list", "description": "", "parameters": [{"name": "name", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "name__in", "in": "query", "description": "Filter results where name is in comma-separated list of values", "required": false, "type": "string"}, {"name": "base_path", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "base_path__contains", "in": "query", "description": "Filter results where base_path contains value", "required": false, "type": "string"}, {"name": "base_path__icontains", "in": "query", "description": "Filter results where base_path contains value", "required": false, "type": "string"}, {"name": "base_path__in", "in": "query", "description": "Filter results where base_path is in comma-separated list of values", "required": false, "type": "string"}, {"name": "cursor", "in": "query", "description": "The pagination cursor value.", "required": false, "type": "string"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["results"], "type": "object", "properties": {"next": {"type": "string", "format": "uri"}, "previous": {"type": "string", "format": "uri"}, "results": {"type": "array", "items": {"$ref": "#/definitions/Distribution"}}}}}}, "tags": ["distributions"]}, "post": {"operationId": "distributions_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Distribution"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Distribution"}}}, "tags": ["distributions"]}, "parameters": []}, "/distributions/{id}/": {"get": {"operationId": "distributions_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Distribution"}}}, "tags": ["distributions"]}, "put": {"operationId": "distributions_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Distribution"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Distribution"}}}, "tags": ["distributions"]}, "patch": {"operationId": "distributions_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Distribution"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Distribution"}}}, "tags": ["distributions"]}, "delete": {"operationId": "distributions_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["distributions"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this distribution.", "required": true, "type": "string", "format": "uuid"}]}, "/orphans/": {"delete": {"operationId": "orphans_delete", "description": "Cleans up all the Content and Artifact orphans in the system", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["orphans"]}, "parameters": []}, "/publications/": {"get": {"operationId": "publications_list", "description": "", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "cursor", "in": "query", "description": "The pagination cursor value.", "required": false, "type": "string"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["results"], "type": "object", "properties": {"next": {"type": "string", "format": "uri"}, "previous": {"type": "string", "format": "uri"}, "results": {"type": "array", "items": {"$ref": "#/definitions/Publication"}}}}}}, "tags": ["publications"]}, "parameters": []}, "/publications/{id}/": {"get": {"operationId": "publications_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Publication"}}}, "tags": ["publications"]}, "delete": {"operationId": "publications_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["publications"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this publication.", "required": true, "type": "string", "format": "uuid"}]}, "/publishers/file/": {"get": {"operationId": "publishers_file_list", "description": "", "parameters": [{"name": "name", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "name__in", "in": "query", "description": "Filter results where name is in comma-separated list of values", "required": false, "type": "string"}, {"name": "last_updated__lt", "in": "query", "description": "Filter results where last_updated is less than value", "required": false, "type": "string"}, {"name": "last_updated__lte", "in": "query", "description": "Filter results where last_updated is less than or equal to value", "required": false, "type": "string"}, {"name": "last_updated__gt", "in": "query", "description": "Filter results where last_updated is greater than value", "required": false, "type": "string"}, {"name": "last_updated__gte", "in": "query", "description": "Filter results where last_updated is greater than or equal to value", "required": false, "type": "string"}, {"name": "last_updated__range", "in": "query", "description": "Filter results where last_updated is in range of values", "required": false, "type": "string"}, {"name": "last_updated", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "cursor", "in": "query", "description": "The pagination cursor value.", "required": false, "type": "string"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["results"], "type": "object", "properties": {"next": {"type": "string", "format": "uri"}, "previous": {"type": "string", "format": "uri"}, "results": {"type": "array", "items": {"$ref": "#/definitions/FilePublisher"}}}}}}, "tags": ["publishers"]}, "post": {"operationId": "publishers_file_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/FilePublisher"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/FilePublisher"}}}, "tags": ["publishers"]}, "parameters": []}, "/publishers/file/{id}/": {"get": {"operationId": "publishers_file_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/FilePublisher"}}}, "tags": ["publishers"]}, "put": {"operationId": "publishers_file_update", "description": "Trigger an asynchronous update task", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/FilePublisher"}}], "responses": {"202": {"description": "", "schema": {"$ref": "#/definitions/AsnycOperationResponse"}}}, "tags": ["publishers"]}, "patch": {"operationId": "publishers_file_partial_update", "description": "Trigger an asynchronous partial update task", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/FilePublisher"}}], "responses": {"202": {"description": "", "schema": {"$ref": "#/definitions/AsnycOperationResponse"}}}, "tags": ["publishers"]}, "delete": {"operationId": "publishers_file_delete", "description": "Trigger an asynchronous delete task", "parameters": [], "responses": {"202": {"description": "", "schema": {"$ref": "#/definitions/AsnycOperationResponse"}}}, "tags": ["publishers"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this file publisher.", "required": true, "type": "string", "format": "uuid"}]}, "/publishers/file/{id}/publish/": {"post": {"operationId": "publishers_file_publish", "description": "Trigger an asynchronous task to publish file content.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/RepositoryPublishURL"}}], "responses": {"202": {"description": "", "schema": {"$ref": "#/definitions/AsnycOperationResponse"}}}, "tags": ["publishers"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this file publisher.", "required": true, "type": "string", "format": "uuid"}]}, "/remotes/file/": {"get": {"operationId": "remotes_file_list", "description": "", "parameters": [{"name": "name", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "name__in", "in": "query", "description": "Filter results where name is in comma-separated list of values", "required": false, "type": "string"}, {"name": "last_updated__lt", "in": "query", "description": "Filter results where last_updated is less than value", "required": false, "type": "string"}, {"name": "last_updated__lte", "in": "query", "description": "Filter results where last_updated is less than or equal to value", "required": false, "type": "string"}, {"name": "last_updated__gt", "in": "query", "description": "Filter results where last_updated is greater than value", "required": false, "type": "string"}, {"name": "last_updated__gte", "in": "query", "description": "Filter results where last_updated is greater than or equal to value", "required": false, "type": "string"}, {"name": "last_updated__range", "in": "query", "description": "Filter results where last_updated is in range of values", "required": false, "type": "string"}, {"name": "last_updated", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "cursor", "in": "query", "description": "The pagination cursor value.", "required": false, "type": "string"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["results"], "type": "object", "properties": {"next": {"type": "string", "format": "uri"}, "previous": {"type": "string", "format": "uri"}, "results": {"type": "array", "items": {"$ref": "#/definitions/FileRemote"}}}}}}, "tags": ["remotes"]}, "post": {"operationId": "remotes_file_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/FileRemote"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/FileRemote"}}}, "tags": ["remotes"]}, "parameters": []}, "/remotes/file/{id}/": {"get": {"operationId": "remotes_file_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/FileRemote"}}}, "tags": ["remotes"]}, "put": {"operationId": "remotes_file_update", "description": "Trigger an asynchronous update task", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/FileRemote"}}], "responses": {"202": {"description": "", "schema": {"$ref": "#/definitions/AsnycOperationResponse"}}}, "tags": ["remotes"]}, "patch": {"operationId": "remotes_file_partial_update", "description": "Trigger an asynchronous partial update task", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/FileRemote"}}], "responses": {"202": {"description": "", "schema": {"$ref": "#/definitions/AsnycOperationResponse"}}}, "tags": ["remotes"]}, "delete": {"operationId": "remotes_file_delete", "description": "Trigger an asynchronous delete task", "parameters": [], "responses": {"202": {"description": "", "schema": {"$ref": "#/definitions/AsnycOperationResponse"}}}, "tags": ["remotes"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this file remote.", "required": true, "type": "string", "format": "uuid"}]}, "/remotes/file/{id}/sync/": {"post": {"operationId": "remotes_file_sync", "description": "Trigger an asynchronous task to sync file content.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/RepositorySyncURL"}}], "responses": {"202": {"description": "", "schema": {"$ref": "#/definitions/AsnycOperationResponse"}}}, "tags": ["remotes"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this file remote.", "required": true, "type": "string", "format": "uuid"}]}, "/repositories/": {"get": {"operationId": "repositories_list", "description": "", "parameters": [{"name": "name", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "name__in", "in": "query", "description": "Filter results where name is in comma-separated list of values", "required": false, "type": "string"}, {"name": "cursor", "in": "query", "description": "The pagination cursor value.", "required": false, "type": "string"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["results"], "type": "object", "properties": {"next": {"type": "string", "format": "uri"}, "previous": {"type": "string", "format": "uri"}, "results": {"type": "array", "items": {"$ref": "#/definitions/Repository"}}}}}}, "tags": ["repositories"]}, "post": {"operationId": "repositories_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Repository"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Repository"}}}, "tags": ["repositories"]}, "parameters": []}, "/repositories/{id}/": {"get": {"operationId": "repositories_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Repository"}}}, "tags": ["repositories"]}, "put": {"operationId": "repositories_update", "description": "Trigger an asynchronous task to updatea repository.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Repository"}}], "responses": {"202": {"description": "", "schema": {"$ref": "#/definitions/AsnycOperationResponse"}}}, "tags": ["repositories"]}, "patch": {"operationId": "repositories_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Repository"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Repository"}}}, "tags": ["repositories"]}, "delete": {"operationId": "repositories_delete", "description": "Trigger an asynchronous task to delete a repository.", "parameters": [], "responses": {"202": {"description": "", "schema": {"$ref": "#/definitions/AsnycOperationResponse"}}}, "tags": ["repositories"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this repository.", "required": true, "type": "string", "format": "uuid"}]}, "/repositories/{repository_pk}/versions/": {"get": {"operationId": "repositories_versions_list", "description": "", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "number", "in": "query", "description": "", "required": false, "type": "number"}, {"name": "number__lt", "in": "query", "description": "Filter results where number is less than value", "required": false, "type": "number"}, {"name": "number__lte", "in": "query", "description": "Filter results where number is less than or equal to value", "required": false, "type": "number"}, {"name": "number__gt", "in": "query", "description": "Filter results where number is greater than value", "required": false, "type": "number"}, {"name": "number__gte", "in": "query", "description": "Filter results where number is greater than or equal to value", "required": false, "type": "number"}, {"name": "number__range", "in": "query", "description": "Filter results where number is in range of values", "required": false, "type": "number"}, {"name": "created__lt", "in": "query", "description": "Filter results where created is less than value", "required": false, "type": "string"}, {"name": "created__lte", "in": "query", "description": "Filter results where created is less than or equal to value", "required": false, "type": "string"}, {"name": "created__gt", "in": "query", "description": "Filter results where created is greater than value", "required": false, "type": "string"}, {"name": "created__gte", "in": "query", "description": "Filter results where created is greater than or equal to value", "required": false, "type": "string"}, {"name": "created__range", "in": "query", "description": "Filter results where created is in range of values", "required": false, "type": "string"}, {"name": "content", "in": "query", "description": "Content Unit referenced by HREF", "required": false, "type": "string"}, {"name": "created", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "cursor", "in": "query", "description": "The pagination cursor value.", "required": false, "type": "string"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["results"], "type": "object", "properties": {"next": {"type": "string", "format": "uri"}, "previous": {"type": "string", "format": "uri"}, "results": {"type": "array", "items": {"$ref": "#/definitions/RepositoryVersion"}}}}}}, "tags": ["repositories"]}, "post": {"operationId": "repositories_versions_create", "description": "Trigger an asynchronous task to create a new repository version.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/RepositoryVersion"}}], "responses": {"202": {"description": "", "schema": {"$ref": "#/definitions/AsnycOperationResponse"}}}, "tags": ["repositories"]}, "parameters": [{"name": "repository_pk", "in": "path", "required": true, "type": "string"}]}, "/repositories/{repository_pk}/versions/{number}/": {"get": {"operationId": "repositories_versions_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/RepositoryVersion"}}}, "tags": ["repositories"]}, "delete": {"operationId": "repositories_versions_delete", "description": "Trigger an asynchronous task to delete a repositroy version.", "parameters": [], "responses": {"202": {"description": "", "schema": {"$ref": "#/definitions/AsnycOperationResponse"}}}, "tags": ["repositories"]}, "parameters": [{"name": "number", "in": "path", "required": true, "type": "integer"}, {"name": "repository_pk", "in": "path", "required": true, "type": "string"}]}, "/repositories/{repository_pk}/versions/{number}/added_content/": {"get": {"operationId": "repositories_versions_added_content", "description": "List added Content", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Content"}}}, "tags": ["repositories"]}, "parameters": [{"name": "number", "in": "path", "required": true, "type": "integer"}, {"name": "repository_pk", "in": "path", "required": true, "type": "string"}]}, "/repositories/{repository_pk}/versions/{number}/content/": {"get": {"operationId": "repositories_versions_content", "description": "List Content", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Content"}}}, "tags": ["repositories"]}, "parameters": [{"name": "number", "in": "path", "required": true, "type": "integer"}, {"name": "repository_pk", "in": "path", "required": true, "type": "string"}]}, "/repositories/{repository_pk}/versions/{number}/removed_content/": {"get": {"operationId": "repositories_versions_removed_content", "description": "List removed Content", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Content"}}}, "tags": ["repositories"]}, "parameters": [{"name": "number", "in": "path", "required": true, "type": "integer"}, {"name": "repository_pk", "in": "path", "required": true, "type": "string"}]}, "/status/": {"get": {"operationId": "status_list", "description": "Returns app information including the version of pulpcore and loaded pulp plugins,\nknown workers, database connection status, and messaging connection status", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["status"]}, "parameters": []}, "/tasks/": {"get": {"operationId": "tasks_list", "description": "", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "state", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "state__in", "in": "query", "description": "Filter results where state is in comma-separated list of values", "required": false, "type": "string"}, {"name": "worker", "in": "query", "description": "Foreign Key referenced by HREF", "required": false, "type": "string"}, {"name": "worker__in", "in": "query", "description": "Filter results where worker is in comma-separated list of values", "required": false, "type": "string"}, {"name": "started_at__lt", "in": "query", "description": "Filter results where started_at is less than value", "required": false, "type": "string"}, {"name": "started_at__lte", "in": "query", "description": "Filter results where started_at is less than or equal to value", "required": false, "type": "string"}, {"name": "started_at__gt", "in": "query", "description": "Filter results where started_at is greater than value", "required": false, "type": "string"}, {"name": "started_at__gte", "in": "query", "description": "Filter results where started_at is greater than or equal to value", "required": false, "type": "string"}, {"name": "started_at__range", "in": "query", "description": "Filter results where started_at is in range of values", "required": false, "type": "string"}, {"name": "finished_at__lt", "in": "query", "description": "Filter results where finished_at is less than value", "required": false, "type": "string"}, {"name": "finished_at__lte", "in": "query", "description": "Filter results where finished_at is less than or equal to value", "required": false, "type": "string"}, {"name": "finished_at__gt", "in": "query", "description": "Filter results where finished_at is greater than value", "required": false, "type": "string"}, {"name": "finished_at__gte", "in": "query", "description": "Filter results where finished_at is greater than or equal to value", "required": false, "type": "string"}, {"name": "finished_at__range", "in": "query", "description": "Filter results where finished_at is in range of values", "required": false, "type": "string"}, {"name": "parent", "in": "query", "description": "Foreign Key referenced by HREF", "required": false, "type": "string"}, {"name": "started_at", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "finished_at", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "cursor", "in": "query", "description": "The pagination cursor value.", "required": false, "type": "string"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["results"], "type": "object", "properties": {"next": {"type": "string", "format": "uri"}, "previous": {"type": "string", "format": "uri"}, "results": {"type": "array", "items": {"$ref": "#/definitions/Task"}}}}}}, "tags": ["tasks"]}, "parameters": []}, "/tasks/{id}/": {"get": {"operationId": "tasks_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Task"}}}, "tags": ["tasks"]}, "delete": {"operationId": "tasks_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["tasks"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this task.", "required": true, "type": "string", "format": "uuid"}]}, "/tasks/{id}/cancel/": {"post": {"operationId": "tasks_cancel", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Task"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Task"}}}, "tags": ["tasks"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this task.", "required": true, "type": "string", "format": "uuid"}]}, "/users/": {"get": {"operationId": "users_list", "description": "", "parameters": [{"name": "username", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "username__in", "in": "query", "description": "Filter results where username is in comma-separated list of values", "required": false, "type": "string"}, {"name": "cursor", "in": "query", "description": "The pagination cursor value.", "required": false, "type": "string"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["results"], "type": "object", "properties": {"next": {"type": "string", "format": "uri"}, "previous": {"type": "string", "format": "uri"}, "results": {"type": "array", "items": {"$ref": "#/definitions/User"}}}}}}, "tags": ["users"]}, "post": {"operationId": "users_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/User"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["users"]}, "parameters": []}, "/users/{id}/": {"get": {"operationId": "users_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["users"]}, "put": {"operationId": "users_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/User"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["users"]}, "patch": {"operationId": "users_partial_update", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/User"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["users"]}, "delete": {"operationId": "users_delete", "description": "", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["users"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this user.", "required": true, "type": "string", "format": "uuid"}]}, "/workers/": {"get": {"operationId": "workers_list", "description": "", "parameters": [{"name": "name", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "name__in", "in": "query", "description": "Filter results where name is in comma-separated list of values", "required": false, "type": "string"}, {"name": "last_heartbeat__lt", "in": "query", "description": "Filter results where last_heartbeat is less than value", "required": false, "type": "string"}, {"name": "last_heartbeat__lte", "in": "query", "description": "Filter results where last_heartbeat is less than or equal to value", "required": false, "type": "string"}, {"name": "last_heartbeat__gt", "in": "query", "description": "Filter results where last_heartbeat is greater than value", "required": false, "type": "string"}, {"name": "last_heartbeat__gte", "in": "query", "description": "Filter results where last_heartbeat is greater than or equal to value", "required": false, "type": "string"}, {"name": "last_heartbeat__range", "in": "query", "description": "Filter results where last_heartbeat is in range of values", "required": false, "type": "string"}, {"name": "online", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "missing", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "last_heartbeat", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "cursor", "in": "query", "description": "The pagination cursor value.", "required": false, "type": "string"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}], "responses": {"200": {"description": "", "schema": {"required": ["results"], "type": "object", "properties": {"next": {"type": "string", "format": "uri"}, "previous": {"type": "string", "format": "uri"}, "results": {"type": "array", "items": {"$ref": "#/definitions/Worker"}}}}}}, "tags": ["workers"]}, "parameters": []}, "/workers/{id}/": {"get": {"operationId": "workers_read", "description": "", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Worker"}}}, "tags": ["workers"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this worker.", "required": true, "type": "string", "format": "uuid"}]}}, "definitions": {"FileContent": {"required": ["relative_path", "artifact"], "type": "object", "properties": {"created": {"title": "Created", "description": "Timestamp of creation.", "type": "string", "format": "date-time", "readOnly": true}, "_href": {"title": " href", "type": "string", "format": "uri", "readOnly": true}, "id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true, "minLength": 1}, "notes": {"title": "Notes", "description": "A mapping of string keys to string values, for storing notes on this object.", "type": "object", "additionalProperties": {"type": "string", "minLength": 1}}, "relative_path": {"title": "Relative path", "description": "Relative location of the file within the repository", "type": "string", "minLength": 1}, "artifact": {"title": "Artifact", "description": "Artifact file representing the physical content", "type": "string", "format": "uri"}}}, "Distribution": {"required": ["name", "base_path"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "_href": {"title": " href", "type": "string", "format": "uri", "readOnly": true}, "created": {"title": "Created", "description": "Timestamp of creation.", "type": "string", "format": "date-time", "readOnly": true}, "name": {"title": "Name", "description": "A unique distribution name. Ex, `rawhide` and `stable`.", "type": "string", "maxLength": 255, "minLength": 1}, "base_path": {"title": "Base path", "description": "The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\")", "type": "string", "maxLength": 255, "minLength": 1}, "publisher": {"title": "Publisher", "description": "Publications created by this publisher and repository are automaticallyserved as defined by this distribution", "type": "string", "format": "uri"}, "publication": {"title": "Publication", "description": "The publication being served as defined by this distribution", "type": "string", "format": "uri"}, "base_url": {"title": "Base url", "description": "The URL for accessing the publication as defined by this distribution.", "type": "string", "readOnly": true, "minLength": 1}, "repository": {"title": "Repository", "description": "Publications created by this repository and publisher are automaticallyserved as defined by this distribution", "type": "string", "format": "uri"}}}, "Publication": {"required": ["publisher"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "_href": {"title": " href", "type": "string", "format": "uri", "readOnly": true}, "created": {"title": "Created", "description": "Timestamp of creation.", "type": "string", "format": "date-time", "readOnly": true}, "publisher": {"title": "Publisher", "description": "The publisher that created this publication.", "type": "string", "format": "uri"}, "distributions": {"description": "This publication is currently being served asdefined by these distributions.", "type": "array", "items": {"description": "This publication is currently being served asdefined by these distributions.", "type": "string", "format": "uri"}, "readOnly": true, "uniqueItems": true}, "repository_version": {"title": "Repository version", "type": "string", "format": "uri", "readOnly": true}}}, "FilePublisher": {"required": ["name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "_href": {"title": " href", "type": "string", "format": "uri", "readOnly": true}, "created": {"title": "Created", "description": "Timestamp of creation.", "type": "string", "format": "date-time", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true, "minLength": 1}, "name": {"title": "Name", "description": "A unique name for this publisher.", "type": "string", "minLength": 1}, "last_updated": {"title": "Last updated", "description": "Timestamp of the most recent update of the publisher configuration.", "type": "string", "format": "date-time", "readOnly": true}, "last_published": {"title": "Last published", "description": "Timestamp of the most recent successful publish.", "type": "string", "format": "date-time", "readOnly": true}, "distributions": {"type": "array", "items": {"type": "string", "format": "uri"}, "readOnly": true, "uniqueItems": true}}}, "AsnycOperationResponse": {"required": ["_href", "task_id"], "type": "object", "properties": {"_href": {"title": " href", "description": "URL to a task.", "type": "string", "format": "uri", "minLength": 1}, "task_id": {"title": "Task id", "description": "Task UUID", "type": "string", "format": "uuid"}}}, "RepositoryPublishURL": {"type": "object", "properties": {"repository": {"title": "Repository", "description": "A URI of the repository to be synchronized.", "type": "string", "format": "uri"}, "repository_version": {"title": "Repository Version", "description": "A URI of the repository version to be published.", "type": "string", "format": "uri"}}}, "FileRemote": {"required": ["name", "url"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "_href": {"title": " href", "type": "string", "format": "uri", "readOnly": true}, "created": {"title": "Created", "description": "Timestamp of creation.", "type": "string", "format": "date-time", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true, "minLength": 1}, "name": {"title": "Name", "description": "A unique name for this remote.", "type": "string", "minLength": 1}, "url": {"title": "Url", "description": "The URL of an external content source.", "type": "string", "minLength": 1}, "validate": {"title": "Validate", "description": "If True, the plugin will validate imported artifacts.", "type": "boolean"}, "ssl_ca_certificate": {"title": "Ssl ca certificate", "description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.", "type": "string", "readOnly": true}, "ssl_client_certificate": {"title": "Ssl client certificate", "description": "A PEM encoded client certificate used for authentication.", "type": "string", "readOnly": true}, "ssl_client_key": {"title": "Ssl client key", "description": "A PEM encoded private key used for authentication.", "type": "string", "readOnly": true}, "ssl_validation": {"title": "Ssl validation", "description": "If True, SSL peer validation must be performed.", "type": "boolean"}, "proxy_url": {"title": "Proxy url", "description": "The proxy URL. Format: scheme://user:password@host:port", "type": "string"}, "username": {"title": "Username", "description": "The username to be used for authentication when syncing.", "type": "string"}, "password": {"title": "Password", "description": "The password to be used for authentication when syncing.", "type": "string"}, "last_synced": {"title": "Last synced", "description": "Timestamp of the most recent successful sync.", "type": "string", "format": "date-time", "readOnly": true}, "last_updated": {"title": "Last updated", "description": "Timestamp of the most recent update of the remote.", "type": "string", "format": "date-time", "readOnly": true}}}, "RepositorySyncURL": {"required": ["repository"], "type": "object", "properties": {"repository": {"title": "Repository", "description": "A URI of the repository to be synchronized.", "type": "string", "format": "uri"}}}, "Repository": {"required": ["name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "_href": {"title": " href", "type": "string", "format": "uri", "readOnly": true}, "created": {"title": "Created", "description": "Timestamp of creation.", "type": "string", "format": "date-time", "readOnly": true}, "_versions_href": {"title": " versions href", "type": "string", "format": "uri", "readOnly": true}, "_latest_version_href": {"title": " latest version href", "type": "string", "format": "uri", "readOnly": true}, "name": {"title": "Name", "description": "A unique name for this repository.", "type": "string", "minLength": 1}, "description": {"title": "Description", "description": "An optional description.", "type": "string"}, "notes": {"title": "Notes", "description": "A mapping of string keys to string values, for storing notes on this object.", "type": "object", "additionalProperties": {"type": "string", "minLength": 1}}}}, "RepositoryVersion": {"required": ["add_content_units", "remove_content_units"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "_href": {"title": " href", "type": "string", "format": "uri", "readOnly": true}, "created": {"title": "Created", "description": "Timestamp of creation.", "type": "string", "format": "date-time", "readOnly": true}, "_content_href": {"title": " content href", "type": "string", "format": "uri", "readOnly": true}, "_added_href": {"title": " added href", "type": "string", "format": "uri", "readOnly": true}, "_removed_href": {"title": " removed href", "type": "string", "format": "uri", "readOnly": true}, "number": {"title": "Number", "type": "integer", "readOnly": true}, "content_summary": {"title": "Content summary", "description": "A list of counts of each type of content in this version.", "type": "object", "additionalProperties": {"type": "string"}, "readOnly": true}, "add_content_units": {"description": "A list of content units to add to a new repository version", "type": "array", "items": {"type": "string"}}, "remove_content_units": {"description": "A list of content units to remove from the latest repository version", "type": "array", "items": {"type": "string"}}}}, "Content": {"required": ["artifacts"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "_href": {"title": " href", "type": "string", "format": "uri", "readOnly": true}, "created": {"title": "Created", "description": "Timestamp of creation.", "type": "string", "format": "date-time", "readOnly": true}, "type": {"title": "Type", "type": "string", "readOnly": true, "minLength": 1}, "notes": {"title": "Notes", "description": "A mapping of string keys to string values, for storing notes on this object.", "type": "object", "additionalProperties": {"type": "string", "minLength": 1}}, "artifacts": {"title": "Artifacts", "description": "A dict mapping relative paths inside the Content to the correspondingArtifact URLs. E.g.: {'relative/path': 'http://localhost/full_artifact_path'}", "type": "object", "additionalProperties": {"type": "string"}}}}, "ProgressReport": {"type": "object", "properties": {"message": {"title": "Message", "description": "The message shown to the user for the progress report.", "type": "string", "readOnly": true, "minLength": 1}, "state": {"title": "State", "description": "The current state of the progress report. The possible values are: 'waiting', 'skipped', 'running', 'completed', 'failed' and 'canceled'. The default is 'waiting'.", "type": "string", "readOnly": true, "minLength": 1}, "total": {"title": "Total", "description": "The total count of items to be handled by the ProgressBar.", "type": "integer", "readOnly": true}, "done": {"title": "Done", "description": "The count of items already processed. Defaults to 0.", "type": "integer", "readOnly": true}, "suffix": {"title": "Suffix", "description": "The suffix to be shown with the progress report.", "type": "string", "readOnly": true, "minLength": 1}, "task": {"title": "Task", "description": "The task associated with this progress report.", "type": "string", "format": "uri", "readOnly": true}}}, "CreatedResource": {"description": "Resources created by this task.", "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "_href": {"title": " href", "type": "string", "format": "uri", "readOnly": true}, "created": {"title": "Created", "description": "Timestamp of creation.", "type": "string", "format": "date-time", "readOnly": true}}}, "Task": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "_href": {"title": " href", "type": "string", "format": "uri", "readOnly": true}, "created": {"title": "Created", "description": "Timestamp of creation.", "type": "string", "format": "date-time", "readOnly": true}, "state": {"title": "State", "description": "The current state of the task. The possible values include: 'waiting', 'skipped', 'running', 'completed', 'failed' and 'canceled'.", "type": "string", "readOnly": true, "minLength": 1}, "started_at": {"title": "Started at", "description": "Timestamp of the when this task started execution.", "type": "string", "format": "date-time", "readOnly": true}, "finished_at": {"title": "Finished at", "description": "Timestamp of the when this task stopped execution.", "type": "string", "format": "date-time", "readOnly": true}, "non_fatal_errors": {"title": "Non fatal errors", "description": "A JSON Object of non-fatal errors encountered during the execution of this task.", "type": "string", "readOnly": true}, "error": {"title": "Error", "description": "A JSON Object of a fatal error encountered during the execution of this task.", "type": "string", "readOnly": true}, "worker": {"title": "Worker", "description": "The worker associated with this task. This field is empty if a worker is not yet assigned.", "type": "string", "format": "uri", "readOnly": true}, "parent": {"title": "Parent", "description": "The parent task that spawned this task.", "type": "string", "format": "uri", "readOnly": true}, "spawned_tasks": {"description": "Any tasks spawned by this task.", "type": "array", "items": {"description": "Any tasks spawned by this task.", "type": "string", "format": "uri"}, "readOnly": true, "uniqueItems": true}, "progress_reports": {"type": "array", "items": {"$ref": "#/definitions/ProgressReport"}, "readOnly": true}, "created_resources": {"description": "Resources created by this task.", "type": "array", "items": {"$ref": "#/definitions/CreatedResource"}, "readOnly": true}}}, "User": {"required": ["username", "password"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "_href": {"title": " href", "type": "string", "format": "uri", "readOnly": true}, "created": {"title": "Created", "description": "Timestamp of creation.", "type": "string", "format": "date-time", "readOnly": true}, "username": {"title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1}, "password": {"title": "Password", "description": "Password", "type": "string", "minLength": 1}}}, "Worker": {"type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "_href": {"title": " href", "type": "string", "format": "uri", "readOnly": true}, "name": {"title": "Name", "description": "The name of the worker.", "type": "string", "readOnly": true, "minLength": 1}, "last_heartbeat": {"title": "Last heartbeat", "description": "Timestamp of the last time the worker talked to the service.", "type": "string", "format": "date-time", "readOnly": true}, "online": {"title": "Online", "description": "True if the worker is considered online, otherwise False", "type": "boolean", "readOnly": true}, "missing": {"title": "Missing", "description": "True if the worker is considerd missing, otherwise False", "type": "boolean", "readOnly": true}}}}} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment