Skip to content

Instantly share code, notes, and snippets.

@daviddavis
Created October 23, 2017 20:46
Show Gist options
  • Save daviddavis/fdc9ea401fad93d4d6f951ae08f526e9 to your computer and use it in GitHub Desktop.
Save daviddavis/fdc9ea401fad93d4d6f951ae08f526e9 to your computer and use it in GitHub Desktop.
{
"_meta": {
"title": "Pulp API",
"url": "http://localhost:8000/api/v3/"
},
"_type": "document",
"artifacts": {
"create": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "form",
"name": "file",
"required": true,
"schema": {
"_type": "string",
"description": "The stored file.",
"title": "File"
}
},
{
"location": "form",
"name": "size",
"schema": {
"_type": "integer",
"description": "The size of the file in bytes.",
"title": "Size"
}
},
{
"location": "form",
"name": "md5",
"schema": {
"_type": "string",
"description": "The MD5 checksum of the file if available.",
"title": "Md5"
}
},
{
"location": "form",
"name": "sha1",
"schema": {
"_type": "string",
"description": "The SHA-1 checksum of the file if available.",
"title": "Sha1"
}
},
{
"location": "form",
"name": "sha224",
"schema": {
"_type": "string",
"description": "The SHA-224 checksum of the file if available.",
"title": "Sha224"
}
},
{
"location": "form",
"name": "sha256",
"schema": {
"_type": "string",
"description": "The SHA-256 checksum of the file if available.",
"title": "Sha256"
}
},
{
"location": "form",
"name": "sha384",
"schema": {
"_type": "string",
"description": "The SHA-384 checksum of the file if available.",
"title": "Sha384"
}
},
{
"location": "form",
"name": "sha512",
"schema": {
"_type": "string",
"description": "The SHA-512 checksum of the file if available.",
"title": "Sha512"
}
}
],
"url": "/api/v3/artifacts/"
},
"delete": {
"_type": "link",
"action": "delete",
"fields": [
{
"location": "path",
"name": "id",
"required": true,
"schema": {
"_type": "string",
"description": "A UUID string identifying this artifact.",
"title": "id"
}
},
{
"location": "query",
"name": "md5",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha1",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha224",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha256",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha384",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha512",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/artifacts/{id}/"
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
},
{
"location": "query",
"name": "md5",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha1",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha224",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha256",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha384",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha512",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/artifacts/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "id",
"required": true,
"schema": {
"_type": "string",
"description": "A UUID string identifying this artifact.",
"title": "id"
}
},
{
"location": "query",
"name": "md5",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha1",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha224",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha256",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha384",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "sha512",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/artifacts/{id}/"
}
},
"content": {
"example": {
"create": {
"_type": "link",
"action": "post",
"description": "Create a new Content instance from a JSON payload in the request.\n\nArgs:\n request (:class:`rest_framework.request.Request`): request containing JSON payload with\n information about the content being created.\n\nReturns:\n :class:`rest_framework.response.Response` with a 201 status code.\n\nRaises:\n :class:`rest_framework.exceptions.ValidationError` when artifact URLs are not valid or\n the relative paths start with a '/'.",
"encoding": "application/json",
"fields": [
{
"location": "form",
"name": "notes",
"schema": {
"_type": "string",
"description": "A mapping of string keys to string values, for storing notes on this object.",
"title": "Notes"
}
},
{
"location": "form",
"name": "artifacts",
"required": true,
"schema": {
"_type": "string",
"description": "A dict mapping relative paths inside the Content to the correspondingArtifact URLs. E.g.: {'relative/path': 'http://localhost/full_artifact_path'}",
"title": "Artifacts"
}
},
{
"location": "form",
"name": "path",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "Path"
}
},
{
"location": "form",
"name": "digest",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "Digest"
}
}
],
"url": "/api/v3/content/example/"
},
"delete": {
"_type": "link",
"action": "delete",
"fields": [
{
"location": "path",
"name": "id",
"required": true,
"schema": {
"_type": "string",
"description": "A UUID string identifying this example content.",
"title": "id"
}
},
{
"location": "query",
"name": "path",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "digest",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/content/example/{id}/"
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
},
{
"location": "query",
"name": "path",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "digest",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/content/example/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "id",
"required": true,
"schema": {
"_type": "string",
"description": "A UUID string identifying this example content.",
"title": "id"
}
},
{
"location": "query",
"name": "path",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "digest",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/content/example/{id}/"
}
},
"file": {
"create": {
"_type": "link",
"action": "post",
"description": "Create a new Content instance from a JSON payload in the request.\n\nArgs:\n request (:class:`rest_framework.request.Request`): request containing JSON payload with\n information about the content being created.\n\nReturns:\n :class:`rest_framework.response.Response` with a 201 status code.\n\nRaises:\n :class:`rest_framework.exceptions.ValidationError` when artifact URLs are not valid or\n the relative paths start with a '/'.",
"encoding": "application/json",
"fields": [
{
"location": "form",
"name": "notes",
"schema": {
"_type": "string",
"description": "A mapping of string keys to string values, for storing notes on this object.",
"title": "Notes"
}
},
{
"location": "form",
"name": "artifacts",
"required": true,
"schema": {
"_type": "string",
"description": "A dict mapping relative paths inside the Content to the correspondingArtifact URLs. E.g.: {'relative/path': 'http://localhost/full_artifact_path'}",
"title": "Artifacts"
}
},
{
"location": "form",
"name": "path",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "Path"
}
},
{
"location": "form",
"name": "digest",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "Digest"
}
}
],
"url": "/api/v3/content/file/"
},
"delete": {
"_type": "link",
"action": "delete",
"fields": [
{
"location": "path",
"name": "id",
"required": true,
"schema": {
"_type": "string",
"description": "A UUID string identifying this file content.",
"title": "id"
}
},
{
"location": "query",
"name": "path",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "digest",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/content/file/{id}/"
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
},
{
"location": "query",
"name": "path",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "digest",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/content/file/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "id",
"required": true,
"schema": {
"_type": "string",
"description": "A UUID string identifying this file content.",
"title": "id"
}
},
{
"location": "query",
"name": "path",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "digest",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/content/file/{id}/"
}
}
},
"jwt": {
"create": {
"_type": "link",
"action": "post",
"description": "API View that receives a POST with a user's username and password.\n\nReturns a JSON Web Token that can be used for authenticated requests.",
"encoding": "application/json",
"fields": [
{
"location": "form",
"name": "username",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "Password"
}
}
],
"url": "/api/v3/jwt/"
}
},
"repositories": {
"content": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
}
],
"url": "/api/v3/repositories/{name}/content/"
},
"create": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A unique name for this repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "description",
"schema": {
"_type": "string",
"description": "An optional description.",
"title": "Description"
}
},
{
"location": "form",
"name": "notes",
"schema": {
"_type": "string",
"description": "A mapping of string keys to string values, for storing notes on this object.",
"title": "Notes"
}
}
],
"url": "/api/v3/repositories/"
},
"delete": {
"_type": "link",
"action": "delete",
"description": "Generates a Task to delete a :class:`~pulpcore.app.models.Repository`",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name_in_list",
"schema": {
"_type": "string",
"description": "Multiple values may be separated by commas.",
"title": ""
}
},
{
"location": "query",
"name": "content_added_since",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{name}/"
},
"importers": {
"example-asyncio": {
"create": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this importer, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "feed_url",
"schema": {
"_type": "string",
"description": "The URL of an external content source.",
"title": "Feed url"
}
},
{
"location": "form",
"name": "download_policy",
"required": true,
"schema": {
"_type": "enum",
"description": "The policy for downloading content.",
"enum": [
"immediate",
"on_demand",
"background"
],
"title": "Download policy"
}
},
{
"location": "form",
"name": "sync_mode",
"required": true,
"schema": {
"_type": "enum",
"description": "How the importer should sync from the upstream repository.",
"enum": [
"additive",
"mirror"
],
"title": "Sync mode"
}
},
{
"location": "form",
"name": "validate",
"schema": {
"_type": "boolean",
"description": "If True, the plugin will validate imported artifacts.",
"title": "Validate"
}
},
{
"location": "form",
"name": "ssl_ca_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.",
"title": "Ssl ca certificate"
}
},
{
"location": "form",
"name": "ssl_client_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded client certificate used for authentication.",
"title": "Ssl client certificate"
}
},
{
"location": "form",
"name": "ssl_client_key",
"schema": {
"_type": "string",
"description": "A PEM encoded private key used for authentication.",
"title": "Ssl client key"
}
},
{
"location": "form",
"name": "ssl_validation",
"schema": {
"_type": "boolean",
"description": "If True, SSL peer validation must be performed.",
"title": "Ssl validation"
}
},
{
"location": "form",
"name": "proxy_url",
"schema": {
"_type": "string",
"description": "The proxy URL. Format: scheme://user:password@host:port",
"title": "Proxy url"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "The username to be used for authentication when syncing.",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "The password to be used for authentication when syncing.",
"title": "Password"
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-asyncio/"
},
"delete": {
"_type": "link",
"action": "delete",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-asyncio/{name}/"
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-asyncio/"
},
"partial_update": {
"_type": "link",
"action": "patch",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"schema": {
"_type": "string",
"description": "A name for this importer, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "feed_url",
"schema": {
"_type": "string",
"description": "The URL of an external content source.",
"title": "Feed url"
}
},
{
"location": "form",
"name": "download_policy",
"schema": {
"_type": "enum",
"description": "The policy for downloading content.",
"enum": [
"immediate",
"on_demand",
"background"
],
"title": "Download policy"
}
},
{
"location": "form",
"name": "sync_mode",
"schema": {
"_type": "enum",
"description": "How the importer should sync from the upstream repository.",
"enum": [
"additive",
"mirror"
],
"title": "Sync mode"
}
},
{
"location": "form",
"name": "validate",
"schema": {
"_type": "boolean",
"description": "If True, the plugin will validate imported artifacts.",
"title": "Validate"
}
},
{
"location": "form",
"name": "ssl_ca_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.",
"title": "Ssl ca certificate"
}
},
{
"location": "form",
"name": "ssl_client_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded client certificate used for authentication.",
"title": "Ssl client certificate"
}
},
{
"location": "form",
"name": "ssl_client_key",
"schema": {
"_type": "string",
"description": "A PEM encoded private key used for authentication.",
"title": "Ssl client key"
}
},
{
"location": "form",
"name": "ssl_validation",
"schema": {
"_type": "boolean",
"description": "If True, SSL peer validation must be performed.",
"title": "Ssl validation"
}
},
{
"location": "form",
"name": "proxy_url",
"schema": {
"_type": "string",
"description": "The proxy URL. Format: scheme://user:password@host:port",
"title": "Proxy url"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "The username to be used for authentication when syncing.",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "The password to be used for authentication when syncing.",
"title": "Password"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-asyncio/{name}/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-asyncio/{name}/"
},
"sync": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this importer, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "feed_url",
"schema": {
"_type": "string",
"description": "The URL of an external content source.",
"title": "Feed url"
}
},
{
"location": "form",
"name": "download_policy",
"required": true,
"schema": {
"_type": "enum",
"description": "The policy for downloading content.",
"enum": [
"immediate",
"on_demand",
"background"
],
"title": "Download policy"
}
},
{
"location": "form",
"name": "sync_mode",
"required": true,
"schema": {
"_type": "enum",
"description": "How the importer should sync from the upstream repository.",
"enum": [
"additive",
"mirror"
],
"title": "Sync mode"
}
},
{
"location": "form",
"name": "validate",
"schema": {
"_type": "boolean",
"description": "If True, the plugin will validate imported artifacts.",
"title": "Validate"
}
},
{
"location": "form",
"name": "ssl_ca_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.",
"title": "Ssl ca certificate"
}
},
{
"location": "form",
"name": "ssl_client_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded client certificate used for authentication.",
"title": "Ssl client certificate"
}
},
{
"location": "form",
"name": "ssl_client_key",
"schema": {
"_type": "string",
"description": "A PEM encoded private key used for authentication.",
"title": "Ssl client key"
}
},
{
"location": "form",
"name": "ssl_validation",
"schema": {
"_type": "boolean",
"description": "If True, SSL peer validation must be performed.",
"title": "Ssl validation"
}
},
{
"location": "form",
"name": "proxy_url",
"schema": {
"_type": "string",
"description": "The proxy URL. Format: scheme://user:password@host:port",
"title": "Proxy url"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "The username to be used for authentication when syncing.",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "The password to be used for authentication when syncing.",
"title": "Password"
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-asyncio/{name}/sync/"
},
"update": {
"_type": "link",
"action": "put",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this importer, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "feed_url",
"schema": {
"_type": "string",
"description": "The URL of an external content source.",
"title": "Feed url"
}
},
{
"location": "form",
"name": "download_policy",
"required": true,
"schema": {
"_type": "enum",
"description": "The policy for downloading content.",
"enum": [
"immediate",
"on_demand",
"background"
],
"title": "Download policy"
}
},
{
"location": "form",
"name": "sync_mode",
"required": true,
"schema": {
"_type": "enum",
"description": "How the importer should sync from the upstream repository.",
"enum": [
"additive",
"mirror"
],
"title": "Sync mode"
}
},
{
"location": "form",
"name": "validate",
"schema": {
"_type": "boolean",
"description": "If True, the plugin will validate imported artifacts.",
"title": "Validate"
}
},
{
"location": "form",
"name": "ssl_ca_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.",
"title": "Ssl ca certificate"
}
},
{
"location": "form",
"name": "ssl_client_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded client certificate used for authentication.",
"title": "Ssl client certificate"
}
},
{
"location": "form",
"name": "ssl_client_key",
"schema": {
"_type": "string",
"description": "A PEM encoded private key used for authentication.",
"title": "Ssl client key"
}
},
{
"location": "form",
"name": "ssl_validation",
"schema": {
"_type": "boolean",
"description": "If True, SSL peer validation must be performed.",
"title": "Ssl validation"
}
},
{
"location": "form",
"name": "proxy_url",
"schema": {
"_type": "string",
"description": "The proxy URL. Format: scheme://user:password@host:port",
"title": "Proxy url"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "The username to be used for authentication when syncing.",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "The password to be used for authentication when syncing.",
"title": "Password"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-asyncio/{name}/"
}
},
"example-futures": {
"create": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this importer, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "feed_url",
"schema": {
"_type": "string",
"description": "The URL of an external content source.",
"title": "Feed url"
}
},
{
"location": "form",
"name": "download_policy",
"required": true,
"schema": {
"_type": "enum",
"description": "The policy for downloading content.",
"enum": [
"immediate",
"on_demand",
"background"
],
"title": "Download policy"
}
},
{
"location": "form",
"name": "sync_mode",
"required": true,
"schema": {
"_type": "enum",
"description": "How the importer should sync from the upstream repository.",
"enum": [
"additive",
"mirror"
],
"title": "Sync mode"
}
},
{
"location": "form",
"name": "validate",
"schema": {
"_type": "boolean",
"description": "If True, the plugin will validate imported artifacts.",
"title": "Validate"
}
},
{
"location": "form",
"name": "ssl_ca_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.",
"title": "Ssl ca certificate"
}
},
{
"location": "form",
"name": "ssl_client_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded client certificate used for authentication.",
"title": "Ssl client certificate"
}
},
{
"location": "form",
"name": "ssl_client_key",
"schema": {
"_type": "string",
"description": "A PEM encoded private key used for authentication.",
"title": "Ssl client key"
}
},
{
"location": "form",
"name": "ssl_validation",
"schema": {
"_type": "boolean",
"description": "If True, SSL peer validation must be performed.",
"title": "Ssl validation"
}
},
{
"location": "form",
"name": "proxy_url",
"schema": {
"_type": "string",
"description": "The proxy URL. Format: scheme://user:password@host:port",
"title": "Proxy url"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "The username to be used for authentication when syncing.",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "The password to be used for authentication when syncing.",
"title": "Password"
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-futures/"
},
"delete": {
"_type": "link",
"action": "delete",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-futures/{name}/"
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-futures/"
},
"partial_update": {
"_type": "link",
"action": "patch",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"schema": {
"_type": "string",
"description": "A name for this importer, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "feed_url",
"schema": {
"_type": "string",
"description": "The URL of an external content source.",
"title": "Feed url"
}
},
{
"location": "form",
"name": "download_policy",
"schema": {
"_type": "enum",
"description": "The policy for downloading content.",
"enum": [
"immediate",
"on_demand",
"background"
],
"title": "Download policy"
}
},
{
"location": "form",
"name": "sync_mode",
"schema": {
"_type": "enum",
"description": "How the importer should sync from the upstream repository.",
"enum": [
"additive",
"mirror"
],
"title": "Sync mode"
}
},
{
"location": "form",
"name": "validate",
"schema": {
"_type": "boolean",
"description": "If True, the plugin will validate imported artifacts.",
"title": "Validate"
}
},
{
"location": "form",
"name": "ssl_ca_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.",
"title": "Ssl ca certificate"
}
},
{
"location": "form",
"name": "ssl_client_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded client certificate used for authentication.",
"title": "Ssl client certificate"
}
},
{
"location": "form",
"name": "ssl_client_key",
"schema": {
"_type": "string",
"description": "A PEM encoded private key used for authentication.",
"title": "Ssl client key"
}
},
{
"location": "form",
"name": "ssl_validation",
"schema": {
"_type": "boolean",
"description": "If True, SSL peer validation must be performed.",
"title": "Ssl validation"
}
},
{
"location": "form",
"name": "proxy_url",
"schema": {
"_type": "string",
"description": "The proxy URL. Format: scheme://user:password@host:port",
"title": "Proxy url"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "The username to be used for authentication when syncing.",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "The password to be used for authentication when syncing.",
"title": "Password"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-futures/{name}/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-futures/{name}/"
},
"sync": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this importer, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "feed_url",
"schema": {
"_type": "string",
"description": "The URL of an external content source.",
"title": "Feed url"
}
},
{
"location": "form",
"name": "download_policy",
"required": true,
"schema": {
"_type": "enum",
"description": "The policy for downloading content.",
"enum": [
"immediate",
"on_demand",
"background"
],
"title": "Download policy"
}
},
{
"location": "form",
"name": "sync_mode",
"required": true,
"schema": {
"_type": "enum",
"description": "How the importer should sync from the upstream repository.",
"enum": [
"additive",
"mirror"
],
"title": "Sync mode"
}
},
{
"location": "form",
"name": "validate",
"schema": {
"_type": "boolean",
"description": "If True, the plugin will validate imported artifacts.",
"title": "Validate"
}
},
{
"location": "form",
"name": "ssl_ca_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.",
"title": "Ssl ca certificate"
}
},
{
"location": "form",
"name": "ssl_client_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded client certificate used for authentication.",
"title": "Ssl client certificate"
}
},
{
"location": "form",
"name": "ssl_client_key",
"schema": {
"_type": "string",
"description": "A PEM encoded private key used for authentication.",
"title": "Ssl client key"
}
},
{
"location": "form",
"name": "ssl_validation",
"schema": {
"_type": "boolean",
"description": "If True, SSL peer validation must be performed.",
"title": "Ssl validation"
}
},
{
"location": "form",
"name": "proxy_url",
"schema": {
"_type": "string",
"description": "The proxy URL. Format: scheme://user:password@host:port",
"title": "Proxy url"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "The username to be used for authentication when syncing.",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "The password to be used for authentication when syncing.",
"title": "Password"
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-futures/{name}/sync/"
},
"update": {
"_type": "link",
"action": "put",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this importer, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "feed_url",
"schema": {
"_type": "string",
"description": "The URL of an external content source.",
"title": "Feed url"
}
},
{
"location": "form",
"name": "download_policy",
"required": true,
"schema": {
"_type": "enum",
"description": "The policy for downloading content.",
"enum": [
"immediate",
"on_demand",
"background"
],
"title": "Download policy"
}
},
{
"location": "form",
"name": "sync_mode",
"required": true,
"schema": {
"_type": "enum",
"description": "How the importer should sync from the upstream repository.",
"enum": [
"additive",
"mirror"
],
"title": "Sync mode"
}
},
{
"location": "form",
"name": "validate",
"schema": {
"_type": "boolean",
"description": "If True, the plugin will validate imported artifacts.",
"title": "Validate"
}
},
{
"location": "form",
"name": "ssl_ca_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.",
"title": "Ssl ca certificate"
}
},
{
"location": "form",
"name": "ssl_client_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded client certificate used for authentication.",
"title": "Ssl client certificate"
}
},
{
"location": "form",
"name": "ssl_client_key",
"schema": {
"_type": "string",
"description": "A PEM encoded private key used for authentication.",
"title": "Ssl client key"
}
},
{
"location": "form",
"name": "ssl_validation",
"schema": {
"_type": "boolean",
"description": "If True, SSL peer validation must be performed.",
"title": "Ssl validation"
}
},
{
"location": "form",
"name": "proxy_url",
"schema": {
"_type": "string",
"description": "The proxy URL. Format: scheme://user:password@host:port",
"title": "Proxy url"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "The username to be used for authentication when syncing.",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "The password to be used for authentication when syncing.",
"title": "Password"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/example-futures/{name}/"
}
},
"file": {
"create": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this importer, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "feed_url",
"schema": {
"_type": "string",
"description": "The URL of an external content source.",
"title": "Feed url"
}
},
{
"location": "form",
"name": "download_policy",
"required": true,
"schema": {
"_type": "enum",
"description": "The policy for downloading content.",
"enum": [
"immediate",
"on_demand",
"background"
],
"title": "Download policy"
}
},
{
"location": "form",
"name": "sync_mode",
"required": true,
"schema": {
"_type": "enum",
"description": "How the importer should sync from the upstream repository.",
"enum": [
"additive",
"mirror"
],
"title": "Sync mode"
}
},
{
"location": "form",
"name": "validate",
"schema": {
"_type": "boolean",
"description": "If True, the plugin will validate imported artifacts.",
"title": "Validate"
}
},
{
"location": "form",
"name": "ssl_ca_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.",
"title": "Ssl ca certificate"
}
},
{
"location": "form",
"name": "ssl_client_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded client certificate used for authentication.",
"title": "Ssl client certificate"
}
},
{
"location": "form",
"name": "ssl_client_key",
"schema": {
"_type": "string",
"description": "A PEM encoded private key used for authentication.",
"title": "Ssl client key"
}
},
{
"location": "form",
"name": "ssl_validation",
"schema": {
"_type": "boolean",
"description": "If True, SSL peer validation must be performed.",
"title": "Ssl validation"
}
},
{
"location": "form",
"name": "proxy_url",
"schema": {
"_type": "string",
"description": "The proxy URL. Format: scheme://user:password@host:port",
"title": "Proxy url"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "The username to be used for authentication when syncing.",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "The password to be used for authentication when syncing.",
"title": "Password"
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/file/"
},
"delete": {
"_type": "link",
"action": "delete",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/file/{name}/"
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/file/"
},
"partial_update": {
"_type": "link",
"action": "patch",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"schema": {
"_type": "string",
"description": "A name for this importer, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "feed_url",
"schema": {
"_type": "string",
"description": "The URL of an external content source.",
"title": "Feed url"
}
},
{
"location": "form",
"name": "download_policy",
"schema": {
"_type": "enum",
"description": "The policy for downloading content.",
"enum": [
"immediate",
"on_demand",
"background"
],
"title": "Download policy"
}
},
{
"location": "form",
"name": "sync_mode",
"schema": {
"_type": "enum",
"description": "How the importer should sync from the upstream repository.",
"enum": [
"additive",
"mirror"
],
"title": "Sync mode"
}
},
{
"location": "form",
"name": "validate",
"schema": {
"_type": "boolean",
"description": "If True, the plugin will validate imported artifacts.",
"title": "Validate"
}
},
{
"location": "form",
"name": "ssl_ca_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.",
"title": "Ssl ca certificate"
}
},
{
"location": "form",
"name": "ssl_client_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded client certificate used for authentication.",
"title": "Ssl client certificate"
}
},
{
"location": "form",
"name": "ssl_client_key",
"schema": {
"_type": "string",
"description": "A PEM encoded private key used for authentication.",
"title": "Ssl client key"
}
},
{
"location": "form",
"name": "ssl_validation",
"schema": {
"_type": "boolean",
"description": "If True, SSL peer validation must be performed.",
"title": "Ssl validation"
}
},
{
"location": "form",
"name": "proxy_url",
"schema": {
"_type": "string",
"description": "The proxy URL. Format: scheme://user:password@host:port",
"title": "Proxy url"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "The username to be used for authentication when syncing.",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "The password to be used for authentication when syncing.",
"title": "Password"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/file/{name}/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/file/{name}/"
},
"sync": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this importer, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "feed_url",
"schema": {
"_type": "string",
"description": "The URL of an external content source.",
"title": "Feed url"
}
},
{
"location": "form",
"name": "download_policy",
"required": true,
"schema": {
"_type": "enum",
"description": "The policy for downloading content.",
"enum": [
"immediate",
"on_demand",
"background"
],
"title": "Download policy"
}
},
{
"location": "form",
"name": "sync_mode",
"required": true,
"schema": {
"_type": "enum",
"description": "How the importer should sync from the upstream repository.",
"enum": [
"additive",
"mirror"
],
"title": "Sync mode"
}
},
{
"location": "form",
"name": "validate",
"schema": {
"_type": "boolean",
"description": "If True, the plugin will validate imported artifacts.",
"title": "Validate"
}
},
{
"location": "form",
"name": "ssl_ca_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.",
"title": "Ssl ca certificate"
}
},
{
"location": "form",
"name": "ssl_client_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded client certificate used for authentication.",
"title": "Ssl client certificate"
}
},
{
"location": "form",
"name": "ssl_client_key",
"schema": {
"_type": "string",
"description": "A PEM encoded private key used for authentication.",
"title": "Ssl client key"
}
},
{
"location": "form",
"name": "ssl_validation",
"schema": {
"_type": "boolean",
"description": "If True, SSL peer validation must be performed.",
"title": "Ssl validation"
}
},
{
"location": "form",
"name": "proxy_url",
"schema": {
"_type": "string",
"description": "The proxy URL. Format: scheme://user:password@host:port",
"title": "Proxy url"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "The username to be used for authentication when syncing.",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "The password to be used for authentication when syncing.",
"title": "Password"
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/file/{name}/sync/"
},
"update": {
"_type": "link",
"action": "put",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this importer, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "feed_url",
"schema": {
"_type": "string",
"description": "The URL of an external content source.",
"title": "Feed url"
}
},
{
"location": "form",
"name": "download_policy",
"required": true,
"schema": {
"_type": "enum",
"description": "The policy for downloading content.",
"enum": [
"immediate",
"on_demand",
"background"
],
"title": "Download policy"
}
},
{
"location": "form",
"name": "sync_mode",
"required": true,
"schema": {
"_type": "enum",
"description": "How the importer should sync from the upstream repository.",
"enum": [
"additive",
"mirror"
],
"title": "Sync mode"
}
},
{
"location": "form",
"name": "validate",
"schema": {
"_type": "boolean",
"description": "If True, the plugin will validate imported artifacts.",
"title": "Validate"
}
},
{
"location": "form",
"name": "ssl_ca_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded CA certificate used to validate the server certificate presented by the remote server.",
"title": "Ssl ca certificate"
}
},
{
"location": "form",
"name": "ssl_client_certificate",
"schema": {
"_type": "string",
"description": "A PEM encoded client certificate used for authentication.",
"title": "Ssl client certificate"
}
},
{
"location": "form",
"name": "ssl_client_key",
"schema": {
"_type": "string",
"description": "A PEM encoded private key used for authentication.",
"title": "Ssl client key"
}
},
{
"location": "form",
"name": "ssl_validation",
"schema": {
"_type": "boolean",
"description": "If True, SSL peer validation must be performed.",
"title": "Ssl validation"
}
},
{
"location": "form",
"name": "proxy_url",
"schema": {
"_type": "string",
"description": "The proxy URL. Format: scheme://user:password@host:port",
"title": "Proxy url"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "The username to be used for authentication when syncing.",
"title": "Username"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "The password to be used for authentication when syncing.",
"title": "Password"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/importers/file/{name}/"
}
}
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name_in_list",
"schema": {
"_type": "string",
"description": "Multiple values may be separated by commas.",
"title": ""
}
},
{
"location": "query",
"name": "content_added_since",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/"
},
"partial_update": {
"_type": "link",
"action": "patch",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "form",
"name": "name",
"schema": {
"_type": "string",
"description": "A unique name for this repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "description",
"schema": {
"_type": "string",
"description": "An optional description.",
"title": "Description"
}
},
{
"location": "form",
"name": "notes",
"schema": {
"_type": "string",
"description": "A mapping of string keys to string values, for storing notes on this object.",
"title": "Notes"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name_in_list",
"schema": {
"_type": "string",
"description": "Multiple values may be separated by commas.",
"title": ""
}
},
{
"location": "query",
"name": "content_added_since",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{name}/"
},
"publishers": {
"example": {
"create": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this publisher, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "auto_publish",
"schema": {
"_type": "boolean",
"description": "An indication that the automatic publish may happen when the repository content has changed.",
"title": "Auto publish"
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/"
},
"delete": {
"_type": "link",
"action": "delete",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/{name}/"
},
"distributions": {
"create": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "path",
"name": "publisher_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "The name of the distribution. Ex, `rawhide` and `stable`.",
"title": "Name"
}
},
{
"location": "form",
"name": "base_path",
"required": true,
"schema": {
"_type": "string",
"description": "The base (relative) path component of the published url.",
"title": "Base path"
}
},
{
"location": "form",
"name": "auto_updated",
"required": true,
"schema": {
"_type": "boolean",
"description": "The publication is updated automatically when the publisher has created a new publication",
"title": "Auto updated"
}
},
{
"location": "form",
"name": "http",
"required": true,
"schema": {
"_type": "boolean",
"description": "The publication is distributed using HTTP.",
"title": "Http"
}
},
{
"location": "form",
"name": "https",
"required": true,
"schema": {
"_type": "boolean",
"description": "The publication is distributed using HTTPS.",
"title": "Https"
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/{publisher_name}/distributions/"
},
"delete": {
"_type": "link",
"action": "delete",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "path",
"name": "publisher_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/{publisher_name}/distributions/{name}/"
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "path",
"name": "publisher_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/{publisher_name}/distributions/"
},
"partial_update": {
"_type": "link",
"action": "patch",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "path",
"name": "publisher_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"schema": {
"_type": "string",
"description": "The name of the distribution. Ex, `rawhide` and `stable`.",
"title": "Name"
}
},
{
"location": "form",
"name": "base_path",
"schema": {
"_type": "string",
"description": "The base (relative) path component of the published url.",
"title": "Base path"
}
},
{
"location": "form",
"name": "auto_updated",
"schema": {
"_type": "boolean",
"description": "The publication is updated automatically when the publisher has created a new publication",
"title": "Auto updated"
}
},
{
"location": "form",
"name": "http",
"schema": {
"_type": "boolean",
"description": "The publication is distributed using HTTP.",
"title": "Http"
}
},
{
"location": "form",
"name": "https",
"schema": {
"_type": "boolean",
"description": "The publication is distributed using HTTPS.",
"title": "Https"
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/{publisher_name}/distributions/{name}/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "path",
"name": "publisher_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/{publisher_name}/distributions/{name}/"
},
"update": {
"_type": "link",
"action": "put",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "path",
"name": "publisher_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "The name of the distribution. Ex, `rawhide` and `stable`.",
"title": "Name"
}
},
{
"location": "form",
"name": "base_path",
"required": true,
"schema": {
"_type": "string",
"description": "The base (relative) path component of the published url.",
"title": "Base path"
}
},
{
"location": "form",
"name": "auto_updated",
"required": true,
"schema": {
"_type": "boolean",
"description": "The publication is updated automatically when the publisher has created a new publication",
"title": "Auto updated"
}
},
{
"location": "form",
"name": "http",
"required": true,
"schema": {
"_type": "boolean",
"description": "The publication is distributed using HTTP.",
"title": "Http"
}
},
{
"location": "form",
"name": "https",
"required": true,
"schema": {
"_type": "boolean",
"description": "The publication is distributed using HTTPS.",
"title": "Https"
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/{publisher_name}/distributions/{name}/"
}
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/"
},
"partial_update": {
"_type": "link",
"action": "patch",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"schema": {
"_type": "string",
"description": "A name for this publisher, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "auto_publish",
"schema": {
"_type": "boolean",
"description": "An indication that the automatic publish may happen when the repository content has changed.",
"title": "Auto publish"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/{name}/"
},
"publish": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this publisher, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "auto_publish",
"schema": {
"_type": "boolean",
"description": "An indication that the automatic publish may happen when the repository content has changed.",
"title": "Auto publish"
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/{name}/publish/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/{name}/"
},
"update": {
"_type": "link",
"action": "put",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this publisher, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "auto_publish",
"schema": {
"_type": "boolean",
"description": "An indication that the automatic publish may happen when the repository content has changed.",
"title": "Auto publish"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/example/{name}/"
}
},
"file": {
"create": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this publisher, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "auto_publish",
"schema": {
"_type": "boolean",
"description": "An indication that the automatic publish may happen when the repository content has changed.",
"title": "Auto publish"
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/"
},
"delete": {
"_type": "link",
"action": "delete",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/{name}/"
},
"distributions": {
"create": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "path",
"name": "publisher_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "The name of the distribution. Ex, `rawhide` and `stable`.",
"title": "Name"
}
},
{
"location": "form",
"name": "base_path",
"required": true,
"schema": {
"_type": "string",
"description": "The base (relative) path component of the published url.",
"title": "Base path"
}
},
{
"location": "form",
"name": "auto_updated",
"required": true,
"schema": {
"_type": "boolean",
"description": "The publication is updated automatically when the publisher has created a new publication",
"title": "Auto updated"
}
},
{
"location": "form",
"name": "http",
"required": true,
"schema": {
"_type": "boolean",
"description": "The publication is distributed using HTTP.",
"title": "Http"
}
},
{
"location": "form",
"name": "https",
"required": true,
"schema": {
"_type": "boolean",
"description": "The publication is distributed using HTTPS.",
"title": "Https"
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/{publisher_name}/distributions/"
},
"delete": {
"_type": "link",
"action": "delete",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "path",
"name": "publisher_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/{publisher_name}/distributions/{name}/"
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "path",
"name": "publisher_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/{publisher_name}/distributions/"
},
"partial_update": {
"_type": "link",
"action": "patch",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "path",
"name": "publisher_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"schema": {
"_type": "string",
"description": "The name of the distribution. Ex, `rawhide` and `stable`.",
"title": "Name"
}
},
{
"location": "form",
"name": "base_path",
"schema": {
"_type": "string",
"description": "The base (relative) path component of the published url.",
"title": "Base path"
}
},
{
"location": "form",
"name": "auto_updated",
"schema": {
"_type": "boolean",
"description": "The publication is updated automatically when the publisher has created a new publication",
"title": "Auto updated"
}
},
{
"location": "form",
"name": "http",
"schema": {
"_type": "boolean",
"description": "The publication is distributed using HTTP.",
"title": "Http"
}
},
{
"location": "form",
"name": "https",
"schema": {
"_type": "boolean",
"description": "The publication is distributed using HTTPS.",
"title": "Https"
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/{publisher_name}/distributions/{name}/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "path",
"name": "publisher_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/{publisher_name}/distributions/{name}/"
},
"update": {
"_type": "link",
"action": "put",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "path",
"name": "publisher_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "The name of the distribution. Ex, `rawhide` and `stable`.",
"title": "Name"
}
},
{
"location": "form",
"name": "base_path",
"required": true,
"schema": {
"_type": "string",
"description": "The base (relative) path component of the published url.",
"title": "Base path"
}
},
{
"location": "form",
"name": "auto_updated",
"required": true,
"schema": {
"_type": "boolean",
"description": "The publication is updated automatically when the publisher has created a new publication",
"title": "Auto updated"
}
},
{
"location": "form",
"name": "http",
"required": true,
"schema": {
"_type": "boolean",
"description": "The publication is distributed using HTTP.",
"title": "Http"
}
},
{
"location": "form",
"name": "https",
"required": true,
"schema": {
"_type": "boolean",
"description": "The publication is distributed using HTTPS.",
"title": "Https"
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/{publisher_name}/distributions/{name}/"
}
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/"
},
"partial_update": {
"_type": "link",
"action": "patch",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"schema": {
"_type": "string",
"description": "A name for this publisher, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "auto_publish",
"schema": {
"_type": "boolean",
"description": "An indication that the automatic publish may happen when the repository content has changed.",
"title": "Auto publish"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/{name}/"
},
"publish": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this publisher, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "auto_publish",
"schema": {
"_type": "boolean",
"description": "An indication that the automatic publish may happen when the repository content has changed.",
"title": "Auto publish"
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/{name}/publish/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/{name}/"
},
"update": {
"_type": "link",
"action": "put",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "path",
"name": "repository_name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A name for this publisher, unique within the associated repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "auto_publish",
"schema": {
"_type": "boolean",
"description": "An indication that the automatic publish may happen when the repository content has changed.",
"title": "Auto publish"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "last_updated",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "repo_name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{repository_name}/publishers/file/{name}/"
}
}
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name_in_list",
"schema": {
"_type": "string",
"description": "Multiple values may be separated by commas.",
"title": ""
}
},
{
"location": "query",
"name": "content_added_since",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{name}/"
},
"update": {
"_type": "link",
"action": "put",
"description": "Generates a Task to update a :class:`~pulpcore.app.models.Repository`",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
},
{
"location": "form",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "A unique name for this repository.",
"title": "Name"
}
},
{
"location": "form",
"name": "description",
"schema": {
"_type": "string",
"description": "An optional description.",
"title": "Description"
}
},
{
"location": "form",
"name": "notes",
"schema": {
"_type": "string",
"description": "A mapping of string keys to string values, for storing notes on this object.",
"title": "Notes"
}
},
{
"location": "query",
"name": "name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "name_in_list",
"schema": {
"_type": "string",
"description": "Multiple values may be separated by commas.",
"title": ""
}
},
{
"location": "query",
"name": "content_added_since",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
}
],
"url": "/api/v3/repositories/{name}/"
}
},
"repositorycontents": {
"create": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "form",
"name": "repository",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "Repository"
}
},
{
"location": "form",
"name": "content",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "Content"
}
}
],
"url": "/api/v3/repositorycontents/"
},
"delete": {
"_type": "link",
"action": "delete",
"fields": [
{
"location": "path",
"name": "id",
"required": true,
"schema": {
"_type": "string",
"description": "A UUID string identifying this repository content.",
"title": "id"
}
}
],
"url": "/api/v3/repositorycontents/{id}/"
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
}
],
"url": "/api/v3/repositorycontents/"
},
"partial_update": {
"_type": "link",
"action": "patch",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "id",
"required": true,
"schema": {
"_type": "string",
"description": "A UUID string identifying this repository content.",
"title": "id"
}
},
{
"location": "form",
"name": "repository",
"schema": {
"_type": "string",
"description": "",
"title": "Repository"
}
},
{
"location": "form",
"name": "content",
"schema": {
"_type": "string",
"description": "",
"title": "Content"
}
}
],
"url": "/api/v3/repositorycontents/{id}/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "id",
"required": true,
"schema": {
"_type": "string",
"description": "A UUID string identifying this repository content.",
"title": "id"
}
}
],
"url": "/api/v3/repositorycontents/{id}/"
},
"update": {
"_type": "link",
"action": "put",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "id",
"required": true,
"schema": {
"_type": "string",
"description": "A UUID string identifying this repository content.",
"title": "id"
}
},
{
"location": "form",
"name": "repository",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "Repository"
}
},
{
"location": "form",
"name": "content",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "Content"
}
}
],
"url": "/api/v3/repositorycontents/{id}/"
}
},
"status": {
"list": {
"_type": "link",
"action": "get",
"description": "Returns app information including the version, known workers, database connection status,\nand messaging connection status\n\nArgs:\n request (rest_framework.request.Request): container representing request state\n format (str): requested format of the status response (e.g. json)\n\nReturns:\n rest_framework.response.Response: container for the response information",
"url": "/api/v3/status/"
}
},
"tasks": {
"cancel": {
"_type": "link",
"action": "post",
"fields": [
{
"location": "path",
"name": "id",
"required": true,
"schema": {
"_type": "string",
"description": "A UUID string identifying this task.",
"title": "id"
}
}
],
"url": "/api/v3/tasks/{id}/cancel/"
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
},
{
"location": "query",
"name": "state",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "worker__name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "tags",
"schema": {
"_type": "string",
"description": "Multiple values may be separated by commas.",
"title": ""
}
}
],
"url": "/api/v3/tasks/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "id",
"required": true,
"schema": {
"_type": "string",
"description": "A UUID string identifying this task.",
"title": "id"
}
},
{
"location": "query",
"name": "state",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "worker__name",
"schema": {
"_type": "string",
"description": "",
"title": ""
}
},
{
"location": "query",
"name": "tags",
"schema": {
"_type": "string",
"description": "Multiple values may be separated by commas.",
"title": ""
}
}
],
"url": "/api/v3/tasks/{id}/"
}
},
"users": {
"create": {
"_type": "link",
"action": "post",
"encoding": "application/json",
"fields": [
{
"location": "form",
"name": "username",
"required": true,
"schema": {
"_type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"title": "Username"
}
},
{
"location": "form",
"name": "is_superuser",
"schema": {
"_type": "boolean",
"description": "Designates that this user has all permissions without explicitly assigning them.",
"title": "Is superuser"
}
},
{
"location": "form",
"name": "password",
"required": true,
"schema": {
"_type": "string",
"description": "Password",
"title": "Password"
}
}
],
"url": "/api/v3/users/"
},
"delete": {
"_type": "link",
"action": "delete",
"fields": [
{
"location": "path",
"name": "username",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "username"
}
}
],
"url": "/api/v3/users/{username}/"
},
"jwt_reset": {
"_type": "link",
"action": "put",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "username",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "username"
}
},
{
"location": "form",
"name": "username",
"required": true,
"schema": {
"_type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"title": "Username"
}
},
{
"location": "form",
"name": "is_superuser",
"schema": {
"_type": "boolean",
"description": "Designates that this user has all permissions without explicitly assigning them.",
"title": "Is superuser"
}
},
{
"location": "form",
"name": "password",
"required": true,
"schema": {
"_type": "string",
"description": "Password",
"title": "Password"
}
}
],
"url": "/api/v3/users/{username}/jwt_reset/"
},
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
}
],
"url": "/api/v3/users/"
},
"partial_update": {
"_type": "link",
"action": "patch",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "username",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "username"
}
},
{
"location": "form",
"name": "username",
"schema": {
"_type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"title": "Username"
}
},
{
"location": "form",
"name": "is_superuser",
"schema": {
"_type": "boolean",
"description": "Designates that this user has all permissions without explicitly assigning them.",
"title": "Is superuser"
}
},
{
"location": "form",
"name": "password",
"schema": {
"_type": "string",
"description": "Password",
"title": "Password"
}
}
],
"url": "/api/v3/users/{username}/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "username",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "username"
}
}
],
"url": "/api/v3/users/{username}/"
},
"update": {
"_type": "link",
"action": "put",
"encoding": "application/json",
"fields": [
{
"location": "path",
"name": "username",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "username"
}
},
{
"location": "form",
"name": "username",
"required": true,
"schema": {
"_type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"title": "Username"
}
},
{
"location": "form",
"name": "is_superuser",
"schema": {
"_type": "boolean",
"description": "Designates that this user has all permissions without explicitly assigning them.",
"title": "Is superuser"
}
},
{
"location": "form",
"name": "password",
"required": true,
"schema": {
"_type": "string",
"description": "Password",
"title": "Password"
}
}
],
"url": "/api/v3/users/{username}/"
}
},
"workers": {
"list": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "query",
"name": "cursor",
"schema": {
"_type": "string",
"description": "The pagination cursor value.",
"title": "Cursor"
}
}
],
"url": "/api/v3/workers/"
},
"read": {
"_type": "link",
"action": "get",
"fields": [
{
"location": "path",
"name": "name",
"required": true,
"schema": {
"_type": "string",
"description": "",
"title": "name"
}
}
],
"url": "/api/v3/workers/{name}/"
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment