Created
May 28, 2024 07:35
-
-
Save lzap/675cbdef585395cebb4751f755de5ced to your computer and use it in GitHub Desktop.
Pulp OpenAPI June 2024
This file has been truncated, but you can view the full file.
This file contains hidden or 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
{ | |
"openapi": "3.0.3", | |
"info": { | |
"title": "Pulp 3 API", | |
"version": "v3", | |
"description": "Fetch, Upload, Organize, and Distribute Software Packages", | |
"contact": { | |
"name": "Pulp Team", | |
"email": "[email protected]", | |
"url": "https://pulpproject.org" | |
}, | |
"license": { | |
"name": "GPLv2+", | |
"url": "https://raw.githubusercontent.com/pulp/pulpcore/master/LICENSE" | |
}, | |
"x-logo": { | |
"url": "https://pulp.plan.io/attachments/download/517478/pulp_logo_word_rectangle.svg" | |
}, | |
"x-pulp-app-versions": { | |
"core": "3.54.0", | |
"gem": "0.5.1", | |
"ostree": "2.3.0", | |
"rpm": "3.25.3", | |
"certguard": "3.54.0", | |
"file": "3.54.0" | |
}, | |
"x-pulp-domain-enabled": true | |
}, | |
"paths": { | |
"/api/pulp/{pulp_domain}/api/v3/access_policies/": { | |
"get": { | |
"operationId": "access_policies_list", | |
"description": "ViewSet for AccessPolicy.\n\nNOTE: This API endpoint is in \"tech preview\" and subject to change", | |
"summary": "List access policys", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "customized", | |
"schema": { | |
"type": "boolean" | |
}, | |
"description": "Filter results where customized matches value" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-creation_hooks", | |
"-customized", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-queryset_scoping", | |
"-statements", | |
"-viewset_name", | |
"creation_hooks", | |
"customized", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"queryset_scoping", | |
"statements", | |
"viewset_name" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `creation_hooks` - Creation hooks\n* `-creation_hooks` - Creation hooks (descending)\n* `statements` - Statements\n* `-statements` - Statements (descending)\n* `viewset_name` - Viewset name\n* `-viewset_name` - Viewset name (descending)\n* `customized` - Customized\n* `-customized` - Customized (descending)\n* `queryset_scoping` - Queryset scoping\n* `-queryset_scoping` - Queryset scoping (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "viewset_name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where viewset_name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "viewset_name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where viewset_name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "viewset_name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where viewset_name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "viewset_name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where viewset_name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "viewset_name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where viewset_name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "viewset_name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where viewset_name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "viewset_name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where viewset_name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "viewset_name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where viewset_name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "viewset_name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where viewset_name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Access_Policies" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedAccessPolicyResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{access_policy_href}": { | |
"get": { | |
"operationId": "access_policies_read", | |
"description": "ViewSet for AccessPolicy.\n\nNOTE: This API endpoint is in \"tech preview\" and subject to change", | |
"summary": "Inspect an access policy", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "access_policy_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Access_Policies" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AccessPolicyResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "access_policies_update", | |
"description": "ViewSet for AccessPolicy.\n\nNOTE: This API endpoint is in \"tech preview\" and subject to change", | |
"summary": "Update an access policy", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "access_policy_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Access_Policies" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AccessPolicy" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/AccessPolicy" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/AccessPolicy" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AccessPolicyResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "access_policies_partial_update", | |
"description": "ViewSet for AccessPolicy.\n\nNOTE: This API endpoint is in \"tech preview\" and subject to change", | |
"summary": "Update an access policy", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "access_policy_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Access_Policies" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedAccessPolicy" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedAccessPolicy" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedAccessPolicy" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AccessPolicyResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{access_policy_href}reset/": { | |
"post": { | |
"operationId": "access_policies_reset", | |
"description": "Reset the access policy to its uncustomized default value.", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "access_policy_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Access_Policies" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AccessPolicyResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/acs/file/file/": { | |
"get": { | |
"operationId": "acs_file_file_list", | |
"description": "Alternate Content Source ViewSet for File\n\nACS support is provided as a tech preview in pulp_file.", | |
"summary": "List file alternate content sources", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-last_refreshed", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"last_refreshed", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `last_refreshed` - Last refreshed\n* `-last_refreshed` - Last refreshed (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Acs: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedfile.FileAlternateContentSourceResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "acs_file_file_create", | |
"description": "Alternate Content Source ViewSet for File\n\nACS support is provided as a tech preview in pulp_file.", | |
"summary": "Create a file alternate content source", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Acs: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileAlternateContentSource" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileAlternateContentSource" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileAlternateContentSource" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileAlternateContentSourceResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_alternate_content_source_href}": { | |
"get": { | |
"operationId": "acs_file_file_read", | |
"description": "Alternate Content Source ViewSet for File\n\nACS support is provided as a tech preview in pulp_file.", | |
"summary": "Inspect a file alternate content source", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Acs: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileAlternateContentSourceResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "acs_file_file_update", | |
"description": "Trigger an asynchronous update task", | |
"summary": "Update a file alternate content source", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Acs: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileAlternateContentSource" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileAlternateContentSource" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileAlternateContentSource" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "acs_file_file_partial_update", | |
"description": "Trigger an asynchronous partial update task", | |
"summary": "Update a file alternate content source", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Acs: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedfile.FileAlternateContentSource" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedfile.FileAlternateContentSource" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedfile.FileAlternateContentSource" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "acs_file_file_delete", | |
"description": "Trigger an asynchronous delete ACS task", | |
"summary": "Delete a file alternate content source", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Acs: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_alternate_content_source_href}add_role/": { | |
"post": { | |
"operationId": "acs_file_file_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Acs: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_alternate_content_source_href}list_roles/": { | |
"get": { | |
"operationId": "acs_file_file_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Acs: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ObjectRolesResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_alternate_content_source_href}my_permissions/": { | |
"get": { | |
"operationId": "acs_file_file_my_permissions", | |
"description": "List permissions available to the current user on this object.", | |
"summary": "List user permissions", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Acs: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/MyPermissionsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_alternate_content_source_href}refresh/": { | |
"post": { | |
"operationId": "acs_file_file_refresh", | |
"description": "Trigger an asynchronous task to create Alternate Content Source content.", | |
"summary": "Refresh metadata", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Acs: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TaskGroupOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_alternate_content_source_href}remove_role/": { | |
"post": { | |
"operationId": "acs_file_file_remove_role", | |
"description": "Remove a role for this object from users/groups.", | |
"summary": "Remove a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Acs: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/acs/rpm/rpm/": { | |
"get": { | |
"operationId": "acs_rpm_rpm_list", | |
"description": "ViewSet for ACS.", | |
"summary": "List rpm alternate content sources", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-last_refreshed", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"last_refreshed", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `last_refreshed` - Last refreshed\n* `-last_refreshed` - Last refreshed (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Acs: Rpm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.RpmAlternateContentSourceResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "acs_rpm_rpm_create", | |
"description": "ViewSet for ACS.", | |
"summary": "Create a rpm alternate content source", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Acs: Rpm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmAlternateContentSource" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmAlternateContentSource" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmAlternateContentSource" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmAlternateContentSourceResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_alternate_content_source_href}": { | |
"get": { | |
"operationId": "acs_rpm_rpm_read", | |
"description": "ViewSet for ACS.", | |
"summary": "Inspect a rpm alternate content source", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Acs: Rpm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmAlternateContentSourceResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "acs_rpm_rpm_update", | |
"description": "Trigger an asynchronous update task", | |
"summary": "Update a rpm alternate content source", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Acs: Rpm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmAlternateContentSource" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmAlternateContentSource" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmAlternateContentSource" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "acs_rpm_rpm_partial_update", | |
"description": "Trigger an asynchronous partial update task", | |
"summary": "Update a rpm alternate content source", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Acs: Rpm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedrpm.RpmAlternateContentSource" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedrpm.RpmAlternateContentSource" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedrpm.RpmAlternateContentSource" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "acs_rpm_rpm_delete", | |
"description": "Trigger an asynchronous delete ACS task", | |
"summary": "Delete a rpm alternate content source", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Acs: Rpm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_alternate_content_source_href}add_role/": { | |
"post": { | |
"operationId": "acs_rpm_rpm_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Acs: Rpm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_alternate_content_source_href}list_roles/": { | |
"get": { | |
"operationId": "acs_rpm_rpm_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Acs: Rpm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ObjectRolesResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_alternate_content_source_href}my_permissions/": { | |
"get": { | |
"operationId": "acs_rpm_rpm_my_permissions", | |
"description": "List permissions available to the current user on this object.", | |
"summary": "List user permissions", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Acs: Rpm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/MyPermissionsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_alternate_content_source_href}refresh/": { | |
"post": { | |
"operationId": "acs_rpm_rpm_refresh", | |
"description": "Trigger an asynchronous task to create Alternate Content Source content.", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Acs: Rpm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TaskGroupOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_alternate_content_source_href}remove_role/": { | |
"post": { | |
"operationId": "acs_rpm_rpm_remove_role", | |
"description": "Remove a role for this object from users/groups.", | |
"summary": "Remove a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_alternate_content_source_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Acs: Rpm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/artifacts/": { | |
"get": { | |
"operationId": "artifacts_list", | |
"description": "A customized named ModelViewSet that knows how to register itself with the Pulp API router.\n\nThis viewset is discoverable by its name.\n\"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method.\n\nAttributes:\n lookup_field (str): The name of the field by which an object should be looked up, in\n addition to any parent lookups if this ViewSet is nested. Defaults to 'pk'\n endpoint_name (str): The name of the final path segment that should identify the ViewSet's\n collection endpoint.\n nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must\n correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin.\n None indicates this ViewSet should not be nested.\n parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs\n to django model filter expressions that can be used with the corresponding value from\n self.kwargs, used only by a nested ViewSet to filter based on the parent object's\n identity.\n schema (DefaultSchema): The schema class to use by default in a viewset.", | |
"summary": "List artifacts", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "md5", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where md5 matches value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-file", | |
"-md5", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-sha1", | |
"-sha224", | |
"-sha256", | |
"-sha384", | |
"-sha512", | |
"-size", | |
"-timestamp_of_interest", | |
"file", | |
"md5", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"sha1", | |
"sha224", | |
"sha256", | |
"sha384", | |
"sha512", | |
"size", | |
"timestamp_of_interest" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `file` - File\n* `-file` - File (descending)\n* `size` - Size\n* `-size` - Size (descending)\n* `md5` - Md5\n* `-md5` - Md5 (descending)\n* `sha1` - Sha1\n* `-sha1` - Sha1 (descending)\n* `sha224` - Sha224\n* `-sha224` - Sha224 (descending)\n* `sha256` - Sha256\n* `-sha256` - Sha256 (descending)\n* `sha384` - Sha384\n* `-sha384` - Sha384 (descending)\n* `sha512` - Sha512\n* `-sha512` - Sha512 (descending)\n* `timestamp_of_interest` - Timestamp of interest\n* `-timestamp_of_interest` - Timestamp of interest (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Artifacts have been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "sha1", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where sha1 matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "sha224", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where sha224 matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "sha256", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where sha256 matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "sha384", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where sha384 matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "sha512", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where sha512 matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Artifacts" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedArtifactResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "artifacts_create", | |
"description": "A customized named ModelViewSet that knows how to register itself with the Pulp API router.\n\nThis viewset is discoverable by its name.\n\"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method.\n\nAttributes:\n lookup_field (str): The name of the field by which an object should be looked up, in\n addition to any parent lookups if this ViewSet is nested. Defaults to 'pk'\n endpoint_name (str): The name of the final path segment that should identify the ViewSet's\n collection endpoint.\n nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must\n correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin.\n None indicates this ViewSet should not be nested.\n parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs\n to django model filter expressions that can be used with the corresponding value from\n self.kwargs, used only by a nested ViewSet to filter based on the parent object's\n identity.\n schema (DefaultSchema): The schema class to use by default in a viewset.", | |
"summary": "Create an artifact", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Artifacts" | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Artifact" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Artifact" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ArtifactResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{artifact_href}": { | |
"get": { | |
"operationId": "artifacts_read", | |
"description": "A customized named ModelViewSet that knows how to register itself with the Pulp API router.\n\nThis viewset is discoverable by its name.\n\"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method.\n\nAttributes:\n lookup_field (str): The name of the field by which an object should be looked up, in\n addition to any parent lookups if this ViewSet is nested. Defaults to 'pk'\n endpoint_name (str): The name of the final path segment that should identify the ViewSet's\n collection endpoint.\n nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must\n correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin.\n None indicates this ViewSet should not be nested.\n parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs\n to django model filter expressions that can be used with the corresponding value from\n self.kwargs, used only by a nested ViewSet to filter based on the parent object's\n identity.\n schema (DefaultSchema): The schema class to use by default in a viewset.", | |
"summary": "Inspect an artifact", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "artifact_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Artifacts" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ArtifactResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "artifacts_delete", | |
"description": "Remove Artifact only if it is not associated with any Content.", | |
"summary": "Delete an artifact", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "artifact_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Artifacts" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/": { | |
"get": { | |
"operationId": "content_list", | |
"description": "Endpoint to list all content.", | |
"summary": "List content", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-pk", | |
"pk" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_type", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"core.publishedmetadata", | |
"file.file", | |
"gem.gem", | |
"ostree.commit", | |
"ostree.config", | |
"ostree.content", | |
"ostree.object", | |
"ostree.refs", | |
"ostree.summary", | |
"rpm.advisory", | |
"rpm.distribution_tree", | |
"rpm.modulemd", | |
"rpm.modulemd_defaults", | |
"rpm.modulemd_obsolete", | |
"rpm.package", | |
"rpm.packagecategory", | |
"rpm.packageenvironment", | |
"rpm.packagegroup", | |
"rpm.packagelangpacks", | |
"rpm.repo_metadata_file" | |
] | |
}, | |
"description": "Pulp type\n\n* `core.publishedmetadata` - core.publishedmetadata\n* `gem.gem` - gem.gem\n* `ostree.object` - ostree.object\n* `ostree.commit` - ostree.commit\n* `ostree.refs` - ostree.refs\n* `ostree.content` - ostree.content\n* `ostree.config` - ostree.config\n* `ostree.summary` - ostree.summary\n* `rpm.advisory` - rpm.advisory\n* `rpm.packagegroup` - rpm.packagegroup\n* `rpm.packagecategory` - rpm.packagecategory\n* `rpm.packageenvironment` - rpm.packageenvironment\n* `rpm.packagelangpacks` - rpm.packagelangpacks\n* `rpm.repo_metadata_file` - rpm.repo_metadata_file\n* `rpm.distribution_tree` - rpm.distribution_tree\n* `rpm.package` - rpm.package\n* `rpm.modulemd` - rpm.modulemd\n* `rpm.modulemd_defaults` - rpm.modulemd_defaults\n* `rpm.modulemd_obsolete` - rpm.modulemd_obsolete\n* `file.file` - file.file" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_type__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"core.publishedmetadata", | |
"file.file", | |
"gem.gem", | |
"ostree.commit", | |
"ostree.config", | |
"ostree.content", | |
"ostree.object", | |
"ostree.refs", | |
"ostree.summary", | |
"rpm.advisory", | |
"rpm.distribution_tree", | |
"rpm.modulemd", | |
"rpm.modulemd_defaults", | |
"rpm.modulemd_obsolete", | |
"rpm.package", | |
"rpm.packagecategory", | |
"rpm.packageenvironment", | |
"rpm.packagegroup", | |
"rpm.packagelangpacks", | |
"rpm.repo_metadata_file" | |
] | |
} | |
}, | |
"description": "Multiple values may be separated by commas.\n\n* `core.publishedmetadata` - core.publishedmetadata\n* `gem.gem` - gem.gem\n* `ostree.object` - ostree.object\n* `ostree.commit` - ostree.commit\n* `ostree.refs` - ostree.refs\n* `ostree.content` - ostree.content\n* `ostree.config` - ostree.config\n* `ostree.summary` - ostree.summary\n* `rpm.advisory` - rpm.advisory\n* `rpm.packagegroup` - rpm.packagegroup\n* `rpm.packagecategory` - rpm.packagecategory\n* `rpm.packageenvironment` - rpm.packageenvironment\n* `rpm.packagelangpacks` - rpm.packagelangpacks\n* `rpm.repo_metadata_file` - rpm.repo_metadata_file\n* `rpm.distribution_tree` - rpm.distribution_tree\n* `rpm.package` - rpm.package\n* `rpm.modulemd` - rpm.modulemd\n* `rpm.modulemd_defaults` - rpm.modulemd_defaults\n* `rpm.modulemd_obsolete` - rpm.modulemd_obsolete\n* `file.file` - file.file", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedMultipleArtifactContentResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/file/files/": { | |
"get": { | |
"operationId": "content_file_files_list", | |
"description": "\nFileContent represents a single file and its metadata, which can be added and removed from\nrepositories.", | |
"summary": "List file contents", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-digest", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"-relative_path", | |
"-timestamp_of_interest", | |
"-upstream_id", | |
"digest", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type", | |
"relative_path", | |
"timestamp_of_interest", | |
"upstream_id" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `upstream_id` - Upstream id\n* `-upstream_id` - Upstream id (descending)\n* `timestamp_of_interest` - Timestamp of interest\n* `-timestamp_of_interest` - Timestamp of interest (descending)\n* `relative_path` - Relative path\n* `-relative_path` - Relative path (descending)\n* `digest` - Digest\n* `-digest` - Digest (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "relative_path", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where relative_path matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "sha256", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Files" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedfile.FileContentResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "content_file_files_create", | |
"description": "Trigger an asynchronous task to create content,optionally create new repository version.", | |
"summary": "Create a file content", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Content: Files" | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileContent" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileContent" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_content_href}": { | |
"get": { | |
"operationId": "content_file_files_read", | |
"description": "\nFileContent represents a single file and its metadata, which can be added and removed from\nrepositories.", | |
"summary": "Inspect a file content", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_content_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Files" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileContentResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/gem/gem/": { | |
"get": { | |
"operationId": "content_gem_gem_list", | |
"description": "A ViewSet for GemContent.", | |
"summary": "List gem contents", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "checksum", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where checksum matches value" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-checksum", | |
"-dependencies", | |
"-name", | |
"-pk", | |
"-platform", | |
"-prerelease", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"-required_ruby_version", | |
"-required_rubygems_version", | |
"-timestamp_of_interest", | |
"-upstream_id", | |
"-version", | |
"checksum", | |
"dependencies", | |
"name", | |
"pk", | |
"platform", | |
"prerelease", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type", | |
"required_ruby_version", | |
"required_rubygems_version", | |
"timestamp_of_interest", | |
"upstream_id", | |
"version" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `upstream_id` - Upstream id\n* `-upstream_id` - Upstream id (descending)\n* `timestamp_of_interest` - Timestamp of interest\n* `-timestamp_of_interest` - Timestamp of interest (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `version` - Version\n* `-version` - Version (descending)\n* `platform` - Platform\n* `-platform` - Platform (descending)\n* `checksum` - Checksum\n* `-checksum` - Checksum (descending)\n* `prerelease` - Prerelease\n* `-prerelease` - Prerelease (descending)\n* `dependencies` - Dependencies\n* `-dependencies` - Dependencies (descending)\n* `required_ruby_version` - Required ruby version\n* `-required_ruby_version` - Required ruby version (descending)\n* `required_rubygems_version` - Required rubygems version\n* `-required_rubygems_version` - Required rubygems version (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "query", | |
"name": "prerelease", | |
"schema": { | |
"type": "boolean" | |
}, | |
"description": "Filter results where prerelease matches value" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where version matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Gem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedgem.GemContentResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "content_gem_gem_create", | |
"description": "Trigger an asynchronous task to create content,optionally create new repository version.", | |
"summary": "Create a gem content", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Content: Gem" | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemContent" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemContent" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{gem_gem_content_href}": { | |
"get": { | |
"operationId": "content_gem_gem_read", | |
"description": "A ViewSet for GemContent.", | |
"summary": "Inspect a gem content", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_content_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Gem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemContentResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/ostree/commits/": { | |
"get": { | |
"operationId": "content_ostree_commits_list", | |
"description": "A ViewSet class for OSTree commits.", | |
"summary": "List ostree commits", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "checksum", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where checksum matches value" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-checksum", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"-relative_path", | |
"-timestamp_of_interest", | |
"-upstream_id", | |
"checksum", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type", | |
"relative_path", | |
"timestamp_of_interest", | |
"upstream_id" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `upstream_id` - Upstream id\n* `-upstream_id` - Upstream id (descending)\n* `timestamp_of_interest` - Timestamp of interest\n* `-timestamp_of_interest` - Timestamp of interest (descending)\n* `checksum` - Checksum\n* `-checksum` - Checksum (descending)\n* `relative_path` - Relative path\n* `-relative_path` - Relative path (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Commits" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedostree.OstreeCommitResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_commit_href}": { | |
"get": { | |
"operationId": "content_ostree_commits_read", | |
"description": "A ViewSet class for OSTree commits.", | |
"summary": "Inspect an ostree commit", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_commit_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Commits" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeCommitResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/ostree/configs/": { | |
"get": { | |
"operationId": "content_ostree_configs_list", | |
"description": "A ViewSet class for OSTree repository configurations.", | |
"summary": "List ostree configs", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-pk", | |
"pk" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Configs" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedostree.OstreeConfigResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_config_href}": { | |
"get": { | |
"operationId": "content_ostree_configs_read", | |
"description": "A ViewSet class for OSTree repository configurations.", | |
"summary": "Inspect an ostree config", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_config_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Configs" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeConfigResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/ostree/content/": { | |
"get": { | |
"operationId": "content_ostree_content_list", | |
"description": "A ViewSet class for uncategorized content units (e.g., static deltas).", | |
"summary": "List ostree contents", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-pk", | |
"pk" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Content" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedostree.OstreeContentResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "content_ostree_content_create", | |
"description": "Trigger an asynchronous task to create content,optionally create new repository version.", | |
"summary": "Create an ostree content", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Content: Content" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeContent" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeContent" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeContent" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_content_href}": { | |
"get": { | |
"operationId": "content_ostree_content_read", | |
"description": "A ViewSet class for uncategorized content units (e.g., static deltas).", | |
"summary": "Inspect an ostree content", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_content_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Content" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeContentResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/ostree/objects/": { | |
"get": { | |
"operationId": "content_ostree_objects_list", | |
"description": "A ViewSet class for OSTree objects (e.g., dirtree, dirmeta, file).", | |
"summary": "List ostree objects", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "checksum", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where checksum matches value" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-checksum", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"-relative_path", | |
"-timestamp_of_interest", | |
"-typ", | |
"-upstream_id", | |
"checksum", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type", | |
"relative_path", | |
"timestamp_of_interest", | |
"typ", | |
"upstream_id" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `upstream_id` - Upstream id\n* `-upstream_id` - Upstream id (descending)\n* `timestamp_of_interest` - Timestamp of interest\n* `-timestamp_of_interest` - Timestamp of interest (descending)\n* `typ` - Typ\n* `-typ` - Typ (descending)\n* `checksum` - Checksum\n* `-checksum` - Checksum (descending)\n* `relative_path` - Relative path\n* `-relative_path` - Relative path (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Objects" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedostree.OstreeObjectResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_object_href}": { | |
"get": { | |
"operationId": "content_ostree_objects_read", | |
"description": "A ViewSet class for OSTree objects (e.g., dirtree, dirmeta, file).", | |
"summary": "Inspect an ostree object", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_object_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Objects" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeObjectResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/ostree/refs/": { | |
"get": { | |
"operationId": "content_ostree_refs_list", | |
"description": "A ViewSet class for OSTree head commits.", | |
"summary": "List ostree refs", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "checksum", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"-relative_path", | |
"-timestamp_of_interest", | |
"-upstream_id", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type", | |
"relative_path", | |
"timestamp_of_interest", | |
"upstream_id" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `upstream_id` - Upstream id\n* `-upstream_id` - Upstream id (descending)\n* `timestamp_of_interest` - Timestamp of interest\n* `-timestamp_of_interest` - Timestamp of interest (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `relative_path` - Relative path\n* `-relative_path` - Relative path (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Refs" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedostree.OstreeRefResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_ref_href}": { | |
"get": { | |
"operationId": "content_ostree_refs_read", | |
"description": "A ViewSet class for OSTree head commits.", | |
"summary": "Inspect an ostree ref", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_ref_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Refs" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeRefResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/ostree/summaries/": { | |
"get": { | |
"operationId": "content_ostree_summaries_list", | |
"description": "A ViewSet class for OSTree repository summary files.", | |
"summary": "List ostree summarys", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-pk", | |
"pk" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Summaries" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedostree.OstreeSummaryResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_summary_href}": { | |
"get": { | |
"operationId": "content_ostree_summaries_read", | |
"description": "A ViewSet class for OSTree repository summary files.", | |
"summary": "Inspect an ostree summary", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_summary_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Summaries" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeSummaryResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/rpm/advisories/": { | |
"get": { | |
"operationId": "content_rpm_advisories_list", | |
"description": "A ViewSet for UpdateRecord.\n\nDefine endpoint name which will appear in the API endpoint for this content type.\nFor example::\n http://pulp.example.com/pulp/api/v3/content/rpm/advisories/\n\nAlso specify queryset and serializer for UpdateRecord.", | |
"summary": "List update records", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "id", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where id matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where id is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-description", | |
"-digest", | |
"-fromstr", | |
"-id", | |
"-issued_date", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"-pushcount", | |
"-reboot_suggested", | |
"-release", | |
"-rights", | |
"-severity", | |
"-solution", | |
"-status", | |
"-summary", | |
"-timestamp_of_interest", | |
"-title", | |
"-type", | |
"-updated_date", | |
"-upstream_id", | |
"-version", | |
"description", | |
"digest", | |
"fromstr", | |
"id", | |
"issued_date", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type", | |
"pushcount", | |
"reboot_suggested", | |
"release", | |
"rights", | |
"severity", | |
"solution", | |
"status", | |
"summary", | |
"timestamp_of_interest", | |
"title", | |
"type", | |
"updated_date", | |
"upstream_id", | |
"version" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `upstream_id` - Upstream id\n* `-upstream_id` - Upstream id (descending)\n* `timestamp_of_interest` - Timestamp of interest\n* `-timestamp_of_interest` - Timestamp of interest (descending)\n* `id` - Id\n* `-id` - Id (descending)\n* `updated_date` - Updated date\n* `-updated_date` - Updated date (descending)\n* `description` - Description\n* `-description` - Description (descending)\n* `issued_date` - Issued date\n* `-issued_date` - Issued date (descending)\n* `fromstr` - Fromstr\n* `-fromstr` - Fromstr (descending)\n* `status` - Status\n* `-status` - Status (descending)\n* `title` - Title\n* `-title` - Title (descending)\n* `summary` - Summary\n* `-summary` - Summary (descending)\n* `version` - Version\n* `-version` - Version (descending)\n* `type` - Type\n* `-type` - Type (descending)\n* `severity` - Severity\n* `-severity` - Severity (descending)\n* `solution` - Solution\n* `-solution` - Solution (descending)\n* `release` - Release\n* `-release` - Release (descending)\n* `rights` - Rights\n* `-rights` - Rights (descending)\n* `reboot_suggested` - Reboot suggested\n* `-reboot_suggested` - Reboot suggested (descending)\n* `pushcount` - Pushcount\n* `-pushcount` - Pushcount (descending)\n* `digest` - Digest\n* `-digest` - Digest (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "severity", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where severity matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "severity__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where severity is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "severity__ne", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where severity not equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "status", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where status matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "status__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where status is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "status__ne", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where status not equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "type", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where type matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "type__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where type is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "type__ne", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where type not equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Advisories" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.UpdateRecordResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "content_rpm_advisories_create", | |
"description": "Trigger an asynchronous task to create content,optionally create new repository version.", | |
"summary": "Create an update record", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Content: Advisories" | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.UpdateRecord" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.UpdateRecord" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_update_record_href}": { | |
"get": { | |
"operationId": "content_rpm_advisories_read", | |
"description": "A ViewSet for UpdateRecord.\n\nDefine endpoint name which will appear in the API endpoint for this content type.\nFor example::\n http://pulp.example.com/pulp/api/v3/content/rpm/advisories/\n\nAlso specify queryset and serializer for UpdateRecord.", | |
"summary": "Inspect an update record", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_update_record_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Advisories" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.UpdateRecordResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/rpm/distribution_trees/": { | |
"get": { | |
"operationId": "content_rpm_distribution_trees_list", | |
"description": "Distribution Tree Viewset.", | |
"summary": "List distribution trees", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-pk", | |
"pk" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Distribution_Trees" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.DistributionTreeResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_distribution_tree_href}": { | |
"get": { | |
"operationId": "content_rpm_distribution_trees_read", | |
"description": "Distribution Tree Viewset.", | |
"summary": "Inspect a distribution tree", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_distribution_tree_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Distribution_Trees" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.DistributionTreeResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/rpm/modulemd_defaults/": { | |
"get": { | |
"operationId": "content_rpm_modulemd_defaults_list", | |
"description": "ViewSet for Modulemd.", | |
"summary": "List modulemd defaultss", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "module", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where module matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "module__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where module is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-digest", | |
"-module", | |
"-pk", | |
"-profiles", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"-snippet", | |
"-stream", | |
"-timestamp_of_interest", | |
"-upstream_id", | |
"digest", | |
"module", | |
"pk", | |
"profiles", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type", | |
"snippet", | |
"stream", | |
"timestamp_of_interest", | |
"upstream_id" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `upstream_id` - Upstream id\n* `-upstream_id` - Upstream id (descending)\n* `timestamp_of_interest` - Timestamp of interest\n* `-timestamp_of_interest` - Timestamp of interest (descending)\n* `module` - Module\n* `-module` - Module (descending)\n* `stream` - Stream\n* `-stream` - Stream (descending)\n* `profiles` - Profiles\n* `-profiles` - Profiles (descending)\n* `digest` - Digest\n* `-digest` - Digest (descending)\n* `snippet` - Snippet\n* `-snippet` - Snippet (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "sha256", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "stream", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where stream matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "stream__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where stream is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Modulemd_Defaults" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.ModulemdDefaultsResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "content_rpm_modulemd_defaults_create", | |
"description": "Trigger an asynchronous task to create content,optionally create new repository version.", | |
"summary": "Create a modulemd defaults", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Content: Modulemd_Defaults" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.ModulemdDefaults" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.ModulemdDefaults" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.ModulemdDefaults" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_modulemd_defaults_href}": { | |
"get": { | |
"operationId": "content_rpm_modulemd_defaults_read", | |
"description": "ViewSet for Modulemd.", | |
"summary": "Inspect a modulemd defaults", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_modulemd_defaults_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Modulemd_Defaults" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.ModulemdDefaultsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/rpm/modulemd_obsoletes/": { | |
"get": { | |
"operationId": "content_rpm_modulemd_obsoletes_list", | |
"description": "ViewSet for Modulemd.", | |
"summary": "List modulemd obsoletes", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-pk", | |
"pk" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Modulemd_Obsoletes" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.ModulemdObsoleteResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "content_rpm_modulemd_obsoletes_create", | |
"description": "Trigger an asynchronous task to create content,optionally create new repository version.", | |
"summary": "Create a modulemd obsolete", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Content: Modulemd_Obsoletes" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.ModulemdObsolete" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.ModulemdObsolete" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.ModulemdObsolete" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_modulemd_obsolete_href}": { | |
"get": { | |
"operationId": "content_rpm_modulemd_obsoletes_read", | |
"description": "ViewSet for Modulemd.", | |
"summary": "Inspect a modulemd obsolete", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_modulemd_obsolete_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Modulemd_Obsoletes" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.ModulemdObsoleteResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/rpm/modulemds/": { | |
"get": { | |
"operationId": "content_rpm_modulemds_list", | |
"description": "ViewSet for Modulemd.", | |
"summary": "List modulemds", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "arch", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where arch matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "arch__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where arch is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "context", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where context matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "context__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where context is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-arch", | |
"-artifacts", | |
"-context", | |
"-dependencies", | |
"-description", | |
"-digest", | |
"-name", | |
"-pk", | |
"-profiles", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"-snippet", | |
"-static_context", | |
"-stream", | |
"-timestamp_of_interest", | |
"-upstream_id", | |
"-version", | |
"arch", | |
"artifacts", | |
"context", | |
"dependencies", | |
"description", | |
"digest", | |
"name", | |
"pk", | |
"profiles", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type", | |
"snippet", | |
"static_context", | |
"stream", | |
"timestamp_of_interest", | |
"upstream_id", | |
"version" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `upstream_id` - Upstream id\n* `-upstream_id` - Upstream id (descending)\n* `timestamp_of_interest` - Timestamp of interest\n* `-timestamp_of_interest` - Timestamp of interest (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `stream` - Stream\n* `-stream` - Stream (descending)\n* `version` - Version\n* `-version` - Version (descending)\n* `context` - Context\n* `-context` - Context (descending)\n* `arch` - Arch\n* `-arch` - Arch (descending)\n* `static_context` - Static context\n* `-static_context` - Static context (descending)\n* `dependencies` - Dependencies\n* `-dependencies` - Dependencies (descending)\n* `artifacts` - Artifacts\n* `-artifacts` - Artifacts (descending)\n* `profiles` - Profiles\n* `-profiles` - Profiles (descending)\n* `description` - Description\n* `-description` - Description (descending)\n* `digest` - Digest\n* `-digest` - Digest (descending)\n* `snippet` - Snippet\n* `-snippet` - Snippet (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "sha256", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "stream", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where stream matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "stream__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where stream is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where version matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "version__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where version is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Modulemds" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.ModulemdResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "content_rpm_modulemds_create", | |
"description": "Trigger an asynchronous task to create content,optionally create new repository version.", | |
"summary": "Create a modulemd", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Content: Modulemds" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.Modulemd" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.Modulemd" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.Modulemd" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_modulemd_href}": { | |
"get": { | |
"operationId": "content_rpm_modulemds_read", | |
"description": "ViewSet for Modulemd.", | |
"summary": "Inspect a modulemd", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_modulemd_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Modulemds" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.ModulemdResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/rpm/packagecategories/": { | |
"get": { | |
"operationId": "content_rpm_packagecategories_list", | |
"description": "PackageCategory ViewSet.", | |
"summary": "List package categorys", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-pk", | |
"pk" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Packagecategories" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.PackageCategoryResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_package_category_href}": { | |
"get": { | |
"operationId": "content_rpm_packagecategories_read", | |
"description": "PackageCategory ViewSet.", | |
"summary": "Inspect a package category", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_package_category_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Packagecategories" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.PackageCategoryResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/rpm/packageenvironments/": { | |
"get": { | |
"operationId": "content_rpm_packageenvironments_list", | |
"description": "PackageEnvironment ViewSet.", | |
"summary": "List package environments", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-pk", | |
"pk" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Packageenvironments" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.PackageEnvironmentResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_package_environment_href}": { | |
"get": { | |
"operationId": "content_rpm_packageenvironments_read", | |
"description": "PackageEnvironment ViewSet.", | |
"summary": "Inspect a package environment", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_package_environment_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Packageenvironments" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.PackageEnvironmentResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/rpm/packagegroups/": { | |
"get": { | |
"operationId": "content_rpm_packagegroups_list", | |
"description": "PackageGroup ViewSet.", | |
"summary": "List package groups", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-pk", | |
"pk" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Packagegroups" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.PackageGroupResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_package_group_href}": { | |
"get": { | |
"operationId": "content_rpm_packagegroups_read", | |
"description": "PackageGroup ViewSet.", | |
"summary": "Inspect a package group", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_package_group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Packagegroups" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.PackageGroupResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/rpm/packagelangpacks/": { | |
"get": { | |
"operationId": "content_rpm_packagelangpacks_list", | |
"description": "PackageLangpacks ViewSet.", | |
"summary": "List package langpackss", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-pk", | |
"pk" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Packagelangpacks" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.PackageLangpacksResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_package_langpacks_href}": { | |
"get": { | |
"operationId": "content_rpm_packagelangpacks_read", | |
"description": "PackageLangpacks ViewSet.", | |
"summary": "Inspect a package langpacks", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_package_langpacks_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Packagelangpacks" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.PackageLangpacksResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/rpm/packages/": { | |
"get": { | |
"operationId": "content_rpm_packages_list", | |
"description": "A ViewSet for Package.\n\nDefine endpoint name which will appear in the API endpoint for this content type.\nFor example::\n http://pulp.example.com/pulp/api/v3/content/rpm/packages/\n\nAlso specify queryset and serializer for Package.", | |
"summary": "List packages", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "arch", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where arch matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "arch__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where arch contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "arch__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where arch is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "arch__ne", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where arch not equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "arch__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where arch starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "checksum_type", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"md5", | |
"sha1", | |
"sha1", | |
"sha224", | |
"sha256", | |
"sha384", | |
"sha512", | |
"unknown" | |
] | |
}, | |
"description": "Filter results where checksum_type matches value\n\n* `unknown` - unknown\n* `md5` - md5\n* `sha1` - sha1\n* `sha1` - sha1\n* `sha224` - sha224\n* `sha256` - sha256\n* `sha384` - sha384\n* `sha512` - sha512" | |
}, | |
{ | |
"in": "query", | |
"name": "checksum_type__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where checksum_type is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "checksum_type__ne", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where checksum_type not equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "epoch", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where epoch matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "epoch__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where epoch is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "epoch__ne", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where epoch not equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "filename", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__ne", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name not equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-arch", | |
"-changelogs", | |
"-checksum_type", | |
"-conflicts", | |
"-description", | |
"-enhances", | |
"-epoch", | |
"-evr", | |
"-files", | |
"-is_modular", | |
"-location_base", | |
"-location_href", | |
"-name", | |
"-obsoletes", | |
"-pk", | |
"-pkgId", | |
"-provides", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"-recommends", | |
"-release", | |
"-requires", | |
"-rpm_buildhost", | |
"-rpm_group", | |
"-rpm_header_end", | |
"-rpm_header_start", | |
"-rpm_license", | |
"-rpm_packager", | |
"-rpm_sourcerpm", | |
"-rpm_vendor", | |
"-size_archive", | |
"-size_installed", | |
"-size_package", | |
"-suggests", | |
"-summary", | |
"-supplements", | |
"-time_build", | |
"-time_file", | |
"-timestamp_of_interest", | |
"-upstream_id", | |
"-url", | |
"-version", | |
"arch", | |
"changelogs", | |
"checksum_type", | |
"conflicts", | |
"description", | |
"enhances", | |
"epoch", | |
"evr", | |
"files", | |
"is_modular", | |
"location_base", | |
"location_href", | |
"name", | |
"obsoletes", | |
"pk", | |
"pkgId", | |
"provides", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type", | |
"recommends", | |
"release", | |
"requires", | |
"rpm_buildhost", | |
"rpm_group", | |
"rpm_header_end", | |
"rpm_header_start", | |
"rpm_license", | |
"rpm_packager", | |
"rpm_sourcerpm", | |
"rpm_vendor", | |
"size_archive", | |
"size_installed", | |
"size_package", | |
"suggests", | |
"summary", | |
"supplements", | |
"time_build", | |
"time_file", | |
"timestamp_of_interest", | |
"upstream_id", | |
"url", | |
"version" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `upstream_id` - Upstream id\n* `-upstream_id` - Upstream id (descending)\n* `timestamp_of_interest` - Timestamp of interest\n* `-timestamp_of_interest` - Timestamp of interest (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `epoch` - Epoch\n* `-epoch` - Epoch (descending)\n* `version` - Version\n* `-version` - Version (descending)\n* `release` - Release\n* `-release` - Release (descending)\n* `arch` - Arch\n* `-arch` - Arch (descending)\n* `evr` - Evr\n* `-evr` - Evr (descending)\n* `pkgId` - Pkgid\n* `-pkgId` - Pkgid (descending)\n* `checksum_type` - Checksum type\n* `-checksum_type` - Checksum type (descending)\n* `summary` - Summary\n* `-summary` - Summary (descending)\n* `description` - Description\n* `-description` - Description (descending)\n* `url` - Url\n* `-url` - Url (descending)\n* `changelogs` - Changelogs\n* `-changelogs` - Changelogs (descending)\n* `files` - Files\n* `-files` - Files (descending)\n* `requires` - Requires\n* `-requires` - Requires (descending)\n* `provides` - Provides\n* `-provides` - Provides (descending)\n* `conflicts` - Conflicts\n* `-conflicts` - Conflicts (descending)\n* `obsoletes` - Obsoletes\n* `-obsoletes` - Obsoletes (descending)\n* `suggests` - Suggests\n* `-suggests` - Suggests (descending)\n* `enhances` - Enhances\n* `-enhances` - Enhances (descending)\n* `recommends` - Recommends\n* `-recommends` - Recommends (descending)\n* `supplements` - Supplements\n* `-supplements` - Supplements (descending)\n* `location_base` - Location base\n* `-location_base` - Location base (descending)\n* `location_href` - Location href\n* `-location_href` - Location href (descending)\n* `rpm_buildhost` - Rpm buildhost\n* `-rpm_buildhost` - Rpm buildhost (descending)\n* `rpm_group` - Rpm group\n* `-rpm_group` - Rpm group (descending)\n* `rpm_license` - Rpm license\n* `-rpm_license` - Rpm license (descending)\n* `rpm_packager` - Rpm packager\n* `-rpm_packager` - Rpm packager (descending)\n* `rpm_sourcerpm` - Rpm sourcerpm\n* `-rpm_sourcerpm` - Rpm sourcerpm (descending)\n* `rpm_vendor` - Rpm vendor\n* `-rpm_vendor` - Rpm vendor (descending)\n* `rpm_header_start` - Rpm header start\n* `-rpm_header_start` - Rpm header start (descending)\n* `rpm_header_end` - Rpm header end\n* `-rpm_header_end` - Rpm header end (descending)\n* `size_archive` - Size archive\n* `-size_archive` - Size archive (descending)\n* `size_installed` - Size installed\n* `-size_installed` - Size installed (descending)\n* `size_package` - Size package\n* `-size_package` - Size package (descending)\n* `time_build` - Time build\n* `-time_build` - Time build (descending)\n* `time_file` - Time file\n* `-time_file` - Time file (descending)\n* `is_modular` - Is modular\n* `-is_modular` - Is modular (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "query", | |
"name": "pkgId", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where pkgId matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "pkgId__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where pkgId is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "release", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where release matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "release__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where release contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "release__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where release is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "release__ne", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where release not equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "release__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where release starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "sha256", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where version matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "version__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where version is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "version__ne", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where version not equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Packages" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.PackageResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "content_rpm_packages_create", | |
"description": "Trigger an asynchronous task to create content,optionally create new repository version.", | |
"summary": "Create a package", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Content: Packages" | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.Package" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.Package" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_package_href}": { | |
"get": { | |
"operationId": "content_rpm_packages_read", | |
"description": "A ViewSet for Package.\n\nDefine endpoint name which will appear in the API endpoint for this content type.\nFor example::\n http://pulp.example.com/pulp/api/v3/content/rpm/packages/\n\nAlso specify queryset and serializer for Package.", | |
"summary": "Inspect a package", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_package_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Packages" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.PackageResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/content/rpm/repo_metadata_files/": { | |
"get": { | |
"operationId": "content_rpm_repo_metadata_files_list", | |
"description": "RepoMetadataFile Viewset.", | |
"summary": "List repo metadata files", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-pk", | |
"pk" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "orphaned_for", | |
"schema": { | |
"type": "number" | |
}, | |
"description": "Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME." | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_added", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version_removed", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Repo_Metadata_Files" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.RepoMetadataFileResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_repo_metadata_file_href}": { | |
"get": { | |
"operationId": "content_rpm_repo_metadata_files_read", | |
"description": "RepoMetadataFile Viewset.", | |
"summary": "Inspect a repo metadata file", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_repo_metadata_file_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Content: Repo_Metadata_Files" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RepoMetadataFileResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/contentguards/": { | |
"get": { | |
"operationId": "contentguards_list", | |
"description": "Endpoint to list all contentguards.", | |
"summary": "List content guards", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-description", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"description", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `description` - Description\n* `-description` - Description (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_type", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"certguard.rhsm", | |
"certguard.x509", | |
"core.composite", | |
"core.content_redirect", | |
"core.header", | |
"core.rbac" | |
] | |
}, | |
"description": "Pulp type\n\n* `core.rbac` - core.rbac\n* `core.content_redirect` - core.content_redirect\n* `core.header` - core.header\n* `core.composite` - core.composite\n* `certguard.rhsm` - certguard.rhsm\n* `certguard.x509` - certguard.x509" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_type__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"certguard.rhsm", | |
"certguard.x509", | |
"core.composite", | |
"core.content_redirect", | |
"core.header", | |
"core.rbac" | |
] | |
} | |
}, | |
"description": "Multiple values may be separated by commas.\n\n* `core.rbac` - core.rbac\n* `core.content_redirect` - core.content_redirect\n* `core.header` - core.header\n* `core.composite` - core.composite\n* `certguard.rhsm` - certguard.rhsm\n* `certguard.x509` - certguard.x509", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedContentGuardResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/contentguards/certguard/rhsm/": { | |
"get": { | |
"operationId": "contentguards_certguard_rhsm_list", | |
"description": "RHSMCertGuard API Viewsets.", | |
"summary": "List rhsm cert guards", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-description", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"description", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `description` - Description\n* `-description` - Description (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Rhsm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedcertguard.RHSMCertGuardResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "contentguards_certguard_rhsm_create", | |
"description": "RHSMCertGuard API Viewsets.", | |
"summary": "Create a rhsm cert guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Rhsm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.RHSMCertGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.RHSMCertGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.RHSMCertGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.RHSMCertGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{certguard_r_h_s_m_cert_guard_href}": { | |
"get": { | |
"operationId": "contentguards_certguard_rhsm_read", | |
"description": "RHSMCertGuard API Viewsets.", | |
"summary": "Inspect a rhsm cert guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "certguard_r_h_s_m_cert_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Rhsm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.RHSMCertGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "contentguards_certguard_rhsm_update", | |
"description": "RHSMCertGuard API Viewsets.", | |
"summary": "Update a rhsm cert guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "certguard_r_h_s_m_cert_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Rhsm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.RHSMCertGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.RHSMCertGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.RHSMCertGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.RHSMCertGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "contentguards_certguard_rhsm_partial_update", | |
"description": "RHSMCertGuard API Viewsets.", | |
"summary": "Update a rhsm cert guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "certguard_r_h_s_m_cert_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Rhsm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedcertguard.RHSMCertGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedcertguard.RHSMCertGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedcertguard.RHSMCertGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.RHSMCertGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "contentguards_certguard_rhsm_delete", | |
"description": "RHSMCertGuard API Viewsets.", | |
"summary": "Delete a rhsm cert guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "certguard_r_h_s_m_cert_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Rhsm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/contentguards/certguard/x509/": { | |
"get": { | |
"operationId": "contentguards_certguard_x509_list", | |
"description": "X509CertGuard API Viewsets.", | |
"summary": "List x509 cert guards", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-description", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"description", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `description` - Description\n* `-description` - Description (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: X509" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedcertguard.X509CertGuardResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "contentguards_certguard_x509_create", | |
"description": "X509CertGuard API Viewsets.", | |
"summary": "Create a x509 cert guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Contentguards: X509" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.X509CertGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.X509CertGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.X509CertGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.X509CertGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{certguard_x509_cert_guard_href}": { | |
"get": { | |
"operationId": "contentguards_certguard_x509_read", | |
"description": "X509CertGuard API Viewsets.", | |
"summary": "Inspect a x509 cert guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "certguard_x509_cert_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: X509" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.X509CertGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "contentguards_certguard_x509_update", | |
"description": "X509CertGuard API Viewsets.", | |
"summary": "Update a x509 cert guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "certguard_x509_cert_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: X509" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.X509CertGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.X509CertGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.X509CertGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.X509CertGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "contentguards_certguard_x509_partial_update", | |
"description": "X509CertGuard API Viewsets.", | |
"summary": "Update a x509 cert guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "certguard_x509_cert_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: X509" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedcertguard.X509CertGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedcertguard.X509CertGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedcertguard.X509CertGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/certguard.X509CertGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "contentguards_certguard_x509_delete", | |
"description": "X509CertGuard API Viewsets.", | |
"summary": "Delete a x509 cert guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "certguard_x509_cert_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: X509" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/contentguards/core/composite/": { | |
"get": { | |
"operationId": "contentguards_core_composite_list", | |
"description": "Content guard that queries a list-of content-guards for access permissions.", | |
"summary": "List composite content guards", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-description", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"description", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `description` - Description\n* `-description` - Description (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Composite" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedCompositeContentGuardResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "contentguards_core_composite_create", | |
"description": "Content guard that queries a list-of content-guards for access permissions.", | |
"summary": "Create a composite content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Composite" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CompositeContentGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/CompositeContentGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/CompositeContentGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CompositeContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{composite_content_guard_href}": { | |
"get": { | |
"operationId": "contentguards_core_composite_read", | |
"description": "Content guard that queries a list-of content-guards for access permissions.", | |
"summary": "Inspect a composite content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "composite_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Composite" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CompositeContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "contentguards_core_composite_update", | |
"description": "Content guard that queries a list-of content-guards for access permissions.", | |
"summary": "Update a composite content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "composite_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Composite" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CompositeContentGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/CompositeContentGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/CompositeContentGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CompositeContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "contentguards_core_composite_partial_update", | |
"description": "Content guard that queries a list-of content-guards for access permissions.", | |
"summary": "Update a composite content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "composite_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Composite" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedCompositeContentGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedCompositeContentGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedCompositeContentGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CompositeContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "contentguards_core_composite_delete", | |
"description": "Content guard that queries a list-of content-guards for access permissions.", | |
"summary": "Delete a composite content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "composite_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Composite" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"{composite_content_guard_href}add_role/": { | |
"post": { | |
"operationId": "contentguards_core_composite_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "composite_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Composite" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{composite_content_guard_href}list_roles/": { | |
"get": { | |
"operationId": "contentguards_core_composite_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "composite_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Composite" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ObjectRolesResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{composite_content_guard_href}my_permissions/": { | |
"get": { | |
"operationId": "contentguards_core_composite_my_permissions", | |
"description": "List permissions available to the current user on this object.", | |
"summary": "List user permissions", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "composite_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Composite" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/MyPermissionsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{composite_content_guard_href}remove_role/": { | |
"post": { | |
"operationId": "contentguards_core_composite_remove_role", | |
"description": "Remove a role for this object from users/groups.", | |
"summary": "Remove a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "composite_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Composite" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/contentguards/core/content_redirect/": { | |
"get": { | |
"operationId": "contentguards_core_content_redirect_list", | |
"description": "Content guard to protect preauthenticated redirects to the content app.", | |
"summary": "List content redirect content guards", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-description", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"description", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `description` - Description\n* `-description` - Description (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Content_Redirect" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedContentRedirectContentGuardResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "contentguards_core_content_redirect_create", | |
"description": "Content guard to protect preauthenticated redirects to the content app.", | |
"summary": "Create a content redirect content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Content_Redirect" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentRedirectContentGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentRedirectContentGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentRedirectContentGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentRedirectContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{content_redirect_content_guard_href}": { | |
"get": { | |
"operationId": "contentguards_core_content_redirect_read", | |
"description": "Content guard to protect preauthenticated redirects to the content app.", | |
"summary": "Inspect a content redirect content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "content_redirect_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Content_Redirect" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentRedirectContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "contentguards_core_content_redirect_update", | |
"description": "Content guard to protect preauthenticated redirects to the content app.", | |
"summary": "Update a content redirect content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "content_redirect_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Content_Redirect" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentRedirectContentGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentRedirectContentGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentRedirectContentGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentRedirectContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "contentguards_core_content_redirect_partial_update", | |
"description": "Content guard to protect preauthenticated redirects to the content app.", | |
"summary": "Update a content redirect content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "content_redirect_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Content_Redirect" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedContentRedirectContentGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedContentRedirectContentGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedContentRedirectContentGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ContentRedirectContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "contentguards_core_content_redirect_delete", | |
"description": "Content guard to protect preauthenticated redirects to the content app.", | |
"summary": "Delete a content redirect content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "content_redirect_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Content_Redirect" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"{content_redirect_content_guard_href}add_role/": { | |
"post": { | |
"operationId": "contentguards_core_content_redirect_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "content_redirect_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Content_Redirect" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{content_redirect_content_guard_href}list_roles/": { | |
"get": { | |
"operationId": "contentguards_core_content_redirect_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "content_redirect_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Content_Redirect" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ObjectRolesResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{content_redirect_content_guard_href}my_permissions/": { | |
"get": { | |
"operationId": "contentguards_core_content_redirect_my_permissions", | |
"description": "List permissions available to the current user on this object.", | |
"summary": "List user permissions", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "content_redirect_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Content_Redirect" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/MyPermissionsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{content_redirect_content_guard_href}remove_role/": { | |
"post": { | |
"operationId": "contentguards_core_content_redirect_remove_role", | |
"description": "Remove a role for this object from users/groups.", | |
"summary": "Remove a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "content_redirect_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Content_Redirect" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/contentguards/core/header/": { | |
"get": { | |
"operationId": "contentguards_core_header_list", | |
"description": "Content guard to protect the content app using a specific header.", | |
"summary": "List header content guards", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-description", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"description", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `description` - Description\n* `-description` - Description (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Header" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedHeaderContentGuardResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "contentguards_core_header_create", | |
"description": "Content guard to protect the content app using a specific header.", | |
"summary": "Create a header content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Header" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/HeaderContentGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/HeaderContentGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/HeaderContentGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/HeaderContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{header_content_guard_href}": { | |
"get": { | |
"operationId": "contentguards_core_header_read", | |
"description": "Content guard to protect the content app using a specific header.", | |
"summary": "Inspect a header content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "header_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Header" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/HeaderContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "contentguards_core_header_update", | |
"description": "Content guard to protect the content app using a specific header.", | |
"summary": "Update a header content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "header_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Header" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/HeaderContentGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/HeaderContentGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/HeaderContentGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/HeaderContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "contentguards_core_header_partial_update", | |
"description": "Content guard to protect the content app using a specific header.", | |
"summary": "Update a header content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "header_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Header" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedHeaderContentGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedHeaderContentGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedHeaderContentGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/HeaderContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "contentguards_core_header_delete", | |
"description": "Content guard to protect the content app using a specific header.", | |
"summary": "Delete a header content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "header_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Header" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"{header_content_guard_href}add_role/": { | |
"post": { | |
"operationId": "contentguards_core_header_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "header_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Header" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{header_content_guard_href}list_roles/": { | |
"get": { | |
"operationId": "contentguards_core_header_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "header_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Header" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ObjectRolesResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{header_content_guard_href}my_permissions/": { | |
"get": { | |
"operationId": "contentguards_core_header_my_permissions", | |
"description": "List permissions available to the current user on this object.", | |
"summary": "List user permissions", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "header_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Header" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/MyPermissionsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{header_content_guard_href}remove_role/": { | |
"post": { | |
"operationId": "contentguards_core_header_remove_role", | |
"description": "Remove a role for this object from users/groups.", | |
"summary": "Remove a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "header_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Header" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/contentguards/core/rbac/": { | |
"get": { | |
"operationId": "contentguards_core_rbac_list", | |
"description": "Viewset for creating contentguards that use RBAC to protect content.\nHas add and remove actions for managing permission for users and groups to download content\nprotected by this guard.", | |
"summary": "List rbac content guards", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-description", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"description", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `description` - Description\n* `-description` - Description (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Rbac" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedRBACContentGuardResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "contentguards_core_rbac_create", | |
"description": "Viewset for creating contentguards that use RBAC to protect content.\nHas add and remove actions for managing permission for users and groups to download content\nprotected by this guard.", | |
"summary": "Create a rbac content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Rbac" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RBACContentGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/RBACContentGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/RBACContentGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RBACContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{r_b_a_c_content_guard_href}": { | |
"get": { | |
"operationId": "contentguards_core_rbac_read", | |
"description": "Viewset for creating contentguards that use RBAC to protect content.\nHas add and remove actions for managing permission for users and groups to download content\nprotected by this guard.", | |
"summary": "Inspect a rbac content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "r_b_a_c_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Rbac" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RBACContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "contentguards_core_rbac_update", | |
"description": "Viewset for creating contentguards that use RBAC to protect content.\nHas add and remove actions for managing permission for users and groups to download content\nprotected by this guard.", | |
"summary": "Update a rbac content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "r_b_a_c_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Rbac" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RBACContentGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/RBACContentGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/RBACContentGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RBACContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "contentguards_core_rbac_partial_update", | |
"description": "Viewset for creating contentguards that use RBAC to protect content.\nHas add and remove actions for managing permission for users and groups to download content\nprotected by this guard.", | |
"summary": "Update a rbac content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "r_b_a_c_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Rbac" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedRBACContentGuard" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedRBACContentGuard" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedRBACContentGuard" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RBACContentGuardResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "contentguards_core_rbac_delete", | |
"description": "Viewset for creating contentguards that use RBAC to protect content.\nHas add and remove actions for managing permission for users and groups to download content\nprotected by this guard.", | |
"summary": "Delete a rbac content guard", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "r_b_a_c_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Rbac" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"{r_b_a_c_content_guard_href}add_role/": { | |
"post": { | |
"operationId": "contentguards_core_rbac_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "r_b_a_c_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Rbac" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{r_b_a_c_content_guard_href}list_roles/": { | |
"get": { | |
"operationId": "contentguards_core_rbac_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "r_b_a_c_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Rbac" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ObjectRolesResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{r_b_a_c_content_guard_href}my_permissions/": { | |
"get": { | |
"operationId": "contentguards_core_rbac_my_permissions", | |
"description": "List permissions available to the current user on this object.", | |
"summary": "List user permissions", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "r_b_a_c_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Contentguards: Rbac" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/MyPermissionsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{r_b_a_c_content_guard_href}remove_role/": { | |
"post": { | |
"operationId": "contentguards_core_rbac_remove_role", | |
"description": "Remove a role for this object from users/groups.", | |
"summary": "Remove a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "r_b_a_c_content_guard_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Contentguards: Rbac" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/distributions/": { | |
"get": { | |
"operationId": "distributions_list", | |
"description": "Provides base viewset for Distributions.", | |
"summary": "List distributions", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "base_path", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where base_path is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-base_path", | |
"-hidden", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_labels", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"base_path", | |
"hidden", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_labels", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `pulp_labels` - Pulp labels\n* `-pulp_labels` - Pulp labels (descending)\n* `base_path` - Base path\n* `-base_path` - Base path (descending)\n* `hidden` - Hidden\n* `-hidden` - Hidden (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_label_select", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter labels by search string" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_type", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"core.artifact", | |
"file.file", | |
"gem.gem", | |
"ostree.ostree", | |
"rpm.rpm" | |
] | |
}, | |
"description": "Pulp type\n\n* `core.artifact` - core.artifact\n* `gem.gem` - gem.gem\n* `ostree.ostree` - ostree.ostree\n* `rpm.rpm` - rpm.rpm\n* `file.file` - file.file" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_type__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"core.artifact", | |
"file.file", | |
"gem.gem", | |
"ostree.ostree", | |
"rpm.rpm" | |
] | |
} | |
}, | |
"description": "Multiple values may be separated by commas.\n\n* `core.artifact` - core.artifact\n* `gem.gem` - gem.gem\n* `ostree.ostree` - ostree.ostree\n* `rpm.rpm` - rpm.rpm\n* `file.file` - file.file", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"description": "Filter results where repository matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "repository__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Filter results where repository is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "with_content", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter distributions based on the content served by them" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedDistributionResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/distributions/core/artifacts/": { | |
"get": { | |
"operationId": "distributions_core_artifacts_list", | |
"description": "ViewSet for ArtifactDistribution.", | |
"summary": "List artifact distributions", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "base_path", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where base_path is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-base_path", | |
"-hidden", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_labels", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"base_path", | |
"hidden", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_labels", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `pulp_labels` - Pulp labels\n* `-pulp_labels` - Pulp labels (descending)\n* `base_path` - Base path\n* `-base_path` - Base path (descending)\n* `hidden` - Hidden\n* `-hidden` - Hidden (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_label_select", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter labels by search string" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"description": "Filter results where repository matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "repository__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Filter results where repository is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "with_content", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter distributions based on the content served by them" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Artifacts" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedArtifactDistributionResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{artifact_distribution_href}": { | |
"get": { | |
"operationId": "distributions_core_artifacts_read", | |
"description": "ViewSet for ArtifactDistribution.", | |
"summary": "Inspect an artifact distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "artifact_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Artifacts" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ArtifactDistributionResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/distributions/file/file/": { | |
"get": { | |
"operationId": "distributions_file_file_list", | |
"description": "\nFileDistributions host File\nPublications which makes the metadata and the referenced File Content available to HTTP\nclients. Additionally, a FileDistribution with an associated FilePublication can be the target\nurl of a File Remote , allowing\nanother instance of Pulp to sync the content.", | |
"summary": "List file distributions", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "base_path", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where base_path is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-base_path", | |
"-hidden", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_labels", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"base_path", | |
"hidden", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_labels", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `pulp_labels` - Pulp labels\n* `-pulp_labels` - Pulp labels (descending)\n* `base_path` - Base path\n* `-base_path` - Base path (descending)\n* `hidden` - Hidden\n* `-hidden` - Hidden (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_label_select", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter labels by search string" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"description": "Filter results where repository matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "repository__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Filter results where repository is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "with_content", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter distributions based on the content served by them" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedfile.FileDistributionResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "distributions_file_file_create", | |
"description": "Trigger an asynchronous create task", | |
"summary": "Create a file distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Distributions: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileDistribution" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileDistribution" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileDistribution" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_distribution_href}": { | |
"get": { | |
"operationId": "distributions_file_file_read", | |
"description": "\nFileDistributions host File\nPublications which makes the metadata and the referenced File Content available to HTTP\nclients. Additionally, a FileDistribution with an associated FilePublication can be the target\nurl of a File Remote , allowing\nanother instance of Pulp to sync the content.", | |
"summary": "Inspect a file distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileDistributionResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "distributions_file_file_update", | |
"description": "Trigger an asynchronous update task", | |
"summary": "Update a file distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileDistribution" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileDistribution" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FileDistribution" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "distributions_file_file_partial_update", | |
"description": "Trigger an asynchronous partial update task", | |
"summary": "Update a file distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedfile.FileDistribution" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedfile.FileDistribution" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedfile.FileDistribution" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "distributions_file_file_delete", | |
"description": "Trigger an asynchronous delete task", | |
"summary": "Delete a file distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_distribution_href}add_role/": { | |
"post": { | |
"operationId": "distributions_file_file_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_distribution_href}list_roles/": { | |
"get": { | |
"operationId": "distributions_file_file_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ObjectRolesResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_distribution_href}my_permissions/": { | |
"get": { | |
"operationId": "distributions_file_file_my_permissions", | |
"description": "List permissions available to the current user on this object.", | |
"summary": "List user permissions", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/MyPermissionsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_distribution_href}remove_role/": { | |
"post": { | |
"operationId": "distributions_file_file_remove_role", | |
"description": "Remove a role for this object from users/groups.", | |
"summary": "Remove a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_distribution_href}set_label/": { | |
"post": { | |
"operationId": "distributions_file_file_set_label", | |
"description": "Set a single pulp_label on the object to a specific value or null.", | |
"summary": "Set a label", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabel" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabel" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabel" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabelResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_distribution_href}unset_label/": { | |
"post": { | |
"operationId": "distributions_file_file_unset_label", | |
"description": "Unset a single pulp_label on the object.", | |
"summary": "Unset a label", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabel" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabel" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabel" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabelResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/distributions/gem/gem/": { | |
"get": { | |
"operationId": "distributions_gem_gem_list", | |
"description": "ViewSet for GemDistributions.", | |
"summary": "List gem distributions", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "base_path", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where base_path is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-base_path", | |
"-hidden", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_labels", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"base_path", | |
"hidden", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_labels", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `pulp_labels` - Pulp labels\n* `-pulp_labels` - Pulp labels (descending)\n* `base_path` - Base path\n* `-base_path` - Base path (descending)\n* `hidden` - Hidden\n* `-hidden` - Hidden (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_label_select", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter labels by search string" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"description": "Filter results where repository matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "repository__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Filter results where repository is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "with_content", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter distributions based on the content served by them" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Gem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedgem.GemDistributionResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "distributions_gem_gem_create", | |
"description": "Trigger an asynchronous create task", | |
"summary": "Create a gem distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Distributions: Gem" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemDistribution" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemDistribution" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemDistribution" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{gem_gem_distribution_href}": { | |
"get": { | |
"operationId": "distributions_gem_gem_read", | |
"description": "ViewSet for GemDistributions.", | |
"summary": "Inspect a gem distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Gem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemDistributionResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "distributions_gem_gem_update", | |
"description": "Trigger an asynchronous update task", | |
"summary": "Update a gem distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Gem" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemDistribution" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemDistribution" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemDistribution" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "distributions_gem_gem_partial_update", | |
"description": "Trigger an asynchronous partial update task", | |
"summary": "Update a gem distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Gem" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedgem.GemDistribution" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedgem.GemDistribution" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedgem.GemDistribution" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "distributions_gem_gem_delete", | |
"description": "Trigger an asynchronous delete task", | |
"summary": "Delete a gem distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Gem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{gem_gem_distribution_href}add_role/": { | |
"post": { | |
"operationId": "distributions_gem_gem_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Gem" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{gem_gem_distribution_href}list_roles/": { | |
"get": { | |
"operationId": "distributions_gem_gem_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Gem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ObjectRolesResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{gem_gem_distribution_href}my_permissions/": { | |
"get": { | |
"operationId": "distributions_gem_gem_my_permissions", | |
"description": "List permissions available to the current user on this object.", | |
"summary": "List user permissions", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Gem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/MyPermissionsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{gem_gem_distribution_href}remove_role/": { | |
"post": { | |
"operationId": "distributions_gem_gem_remove_role", | |
"description": "Remove a role for this object from users/groups.", | |
"summary": "Remove a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Gem" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{gem_gem_distribution_href}set_label/": { | |
"post": { | |
"operationId": "distributions_gem_gem_set_label", | |
"description": "Set a single pulp_label on the object to a specific value or null.", | |
"summary": "Set a label", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Gem" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabel" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabel" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabel" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabelResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{gem_gem_distribution_href}unset_label/": { | |
"post": { | |
"operationId": "distributions_gem_gem_unset_label", | |
"description": "Unset a single pulp_label on the object.", | |
"summary": "Unset a label", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Gem" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabel" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabel" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabel" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabelResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/distributions/ostree/ostree/": { | |
"get": { | |
"operationId": "distributions_ostree_ostree_list", | |
"description": "A ViewSet class for OSTree distributions.", | |
"summary": "List ostree distributions", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "base_path", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where base_path is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-base_path", | |
"-hidden", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_labels", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"base_path", | |
"hidden", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_labels", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `pulp_labels` - Pulp labels\n* `-pulp_labels` - Pulp labels (descending)\n* `base_path` - Base path\n* `-base_path` - Base path (descending)\n* `hidden` - Hidden\n* `-hidden` - Hidden (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_label_select", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter labels by search string" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"description": "Filter results where repository matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "repository__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Filter results where repository is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "with_content", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter distributions based on the content served by them" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Ostree" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedostree.OstreeDistributionResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "distributions_ostree_ostree_create", | |
"description": "Trigger an asynchronous create task", | |
"summary": "Create an ostree distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Distributions: Ostree" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeDistribution" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeDistribution" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeDistribution" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_distribution_href}": { | |
"get": { | |
"operationId": "distributions_ostree_ostree_read", | |
"description": "A ViewSet class for OSTree distributions.", | |
"summary": "Inspect an ostree distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Ostree" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeDistributionResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "distributions_ostree_ostree_update", | |
"description": "Trigger an asynchronous update task", | |
"summary": "Update an ostree distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Ostree" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeDistribution" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeDistribution" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/ostree.OstreeDistribution" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "distributions_ostree_ostree_partial_update", | |
"description": "Trigger an asynchronous partial update task", | |
"summary": "Update an ostree distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Ostree" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedostree.OstreeDistribution" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedostree.OstreeDistribution" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedostree.OstreeDistribution" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "distributions_ostree_ostree_delete", | |
"description": "Trigger an asynchronous delete task", | |
"summary": "Delete an ostree distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Ostree" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_distribution_href}add_role/": { | |
"post": { | |
"operationId": "distributions_ostree_ostree_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Ostree" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_distribution_href}list_roles/": { | |
"get": { | |
"operationId": "distributions_ostree_ostree_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Ostree" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ObjectRolesResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_distribution_href}my_permissions/": { | |
"get": { | |
"operationId": "distributions_ostree_ostree_my_permissions", | |
"description": "List permissions available to the current user on this object.", | |
"summary": "List user permissions", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Ostree" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/MyPermissionsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_distribution_href}remove_role/": { | |
"post": { | |
"operationId": "distributions_ostree_ostree_remove_role", | |
"description": "Remove a role for this object from users/groups.", | |
"summary": "Remove a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Ostree" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_distribution_href}set_label/": { | |
"post": { | |
"operationId": "distributions_ostree_ostree_set_label", | |
"description": "Set a single pulp_label on the object to a specific value or null.", | |
"summary": "Set a label", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Ostree" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabel" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabel" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabel" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabelResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{ostree_ostree_distribution_href}unset_label/": { | |
"post": { | |
"operationId": "distributions_ostree_ostree_unset_label", | |
"description": "Unset a single pulp_label on the object.", | |
"summary": "Unset a label", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "ostree_ostree_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Ostree" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabel" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabel" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabel" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabelResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/distributions/rpm/rpm/": { | |
"get": { | |
"operationId": "distributions_rpm_rpm_list", | |
"description": "ViewSet for RPM Distributions.", | |
"summary": "List rpm distributions", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "base_path", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where base_path contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "base_path__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where base_path is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-base_path", | |
"-hidden", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_labels", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"base_path", | |
"hidden", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_labels", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `pulp_labels` - Pulp labels\n* `-pulp_labels` - Pulp labels (descending)\n* `base_path` - Base path\n* `-base_path` - Base path (descending)\n* `hidden` - Hidden\n* `-hidden` - Hidden (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_label_select", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter labels by search string" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"description": "Filter results where repository matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "repository__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Filter results where repository is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "with_content", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter distributions based on the content served by them" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Rpm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedrpm.RpmDistributionResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "distributions_rpm_rpm_create", | |
"description": "Trigger an asynchronous create task", | |
"summary": "Create a rpm distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Distributions: Rpm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmDistribution" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmDistribution" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmDistribution" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_distribution_href}": { | |
"get": { | |
"operationId": "distributions_rpm_rpm_read", | |
"description": "ViewSet for RPM Distributions.", | |
"summary": "Inspect a rpm distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Rpm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmDistributionResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "distributions_rpm_rpm_update", | |
"description": "Trigger an asynchronous update task", | |
"summary": "Update a rpm distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Rpm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmDistribution" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmDistribution" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/rpm.RpmDistribution" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "distributions_rpm_rpm_partial_update", | |
"description": "Trigger an asynchronous partial update task", | |
"summary": "Update a rpm distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Rpm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedrpm.RpmDistribution" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedrpm.RpmDistribution" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Patchedrpm.RpmDistribution" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "distributions_rpm_rpm_delete", | |
"description": "Trigger an asynchronous delete task", | |
"summary": "Delete a rpm distribution", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Rpm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_distribution_href}add_role/": { | |
"post": { | |
"operationId": "distributions_rpm_rpm_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Rpm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_distribution_href}list_roles/": { | |
"get": { | |
"operationId": "distributions_rpm_rpm_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Rpm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ObjectRolesResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_distribution_href}my_permissions/": { | |
"get": { | |
"operationId": "distributions_rpm_rpm_my_permissions", | |
"description": "List permissions available to the current user on this object.", | |
"summary": "List user permissions", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Distributions: Rpm" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/MyPermissionsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_distribution_href}remove_role/": { | |
"post": { | |
"operationId": "distributions_rpm_rpm_remove_role", | |
"description": "Remove a role for this object from users/groups.", | |
"summary": "Remove a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Rpm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_distribution_href}set_label/": { | |
"post": { | |
"operationId": "distributions_rpm_rpm_set_label", | |
"description": "Set a single pulp_label on the object to a specific value or null.", | |
"summary": "Set a label", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Rpm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabel" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabel" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabel" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetLabelResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{rpm_rpm_distribution_href}unset_label/": { | |
"post": { | |
"operationId": "distributions_rpm_rpm_unset_label", | |
"description": "Unset a single pulp_label on the object.", | |
"summary": "Unset a label", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "rpm_rpm_distribution_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Distributions: Rpm" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabel" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabel" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabel" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UnsetLabelResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/domains/": { | |
"get": { | |
"operationId": "domains_list", | |
"description": "ViewSet for Domain.\n\nNOTE: This API endpoint is in \"tech preview\" and subject to change", | |
"summary": "List domains", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-description", | |
"-hide_guarded_distributions", | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-redirect_to_object_storage", | |
"-storage_class", | |
"-storage_settings", | |
"description", | |
"hide_guarded_distributions", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"redirect_to_object_storage", | |
"storage_class", | |
"storage_settings" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `description` - Description\n* `-description` - Description (descending)\n* `storage_class` - Storage class\n* `-storage_class` - Storage class (descending)\n* `storage_settings` - Storage settings\n* `-storage_settings` - Storage settings (descending)\n* `redirect_to_object_storage` - Redirect to object storage\n* `-redirect_to_object_storage` - Redirect to object storage (descending)\n* `hide_guarded_distributions` - Hide guarded distributions\n* `-hide_guarded_distributions` - Hide guarded distributions (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Domains" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedDomainResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "domains_create", | |
"description": "ViewSet for Domain.\n\nNOTE: This API endpoint is in \"tech preview\" and subject to change", | |
"summary": "Create a domain", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Domains" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Domain" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Domain" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Domain" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DomainResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{domain_href}": { | |
"get": { | |
"operationId": "domains_read", | |
"description": "ViewSet for Domain.\n\nNOTE: This API endpoint is in \"tech preview\" and subject to change", | |
"summary": "Inspect a domain", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "domain_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Domains" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DomainResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "domains_update", | |
"description": "Trigger an asynchronous update task", | |
"summary": "Update a domain", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "domain_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Domains" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Domain" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Domain" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Domain" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "domains_partial_update", | |
"description": "Trigger an asynchronous partial update task", | |
"summary": "Update a domain", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "domain_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Domains" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedDomain" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedDomain" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedDomain" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "domains_delete", | |
"description": "Trigger an asynchronous delete task", | |
"summary": "Delete a domain", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "domain_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Domains" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/exporters/core/filesystem/": { | |
"get": { | |
"operationId": "exporters_core_filesystem_list", | |
"description": "Endpoint for managing FilesystemExporters.", | |
"summary": "List filesystem exporters", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-method", | |
"-name", | |
"-path", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"method", | |
"name", | |
"path", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `path` - Path\n* `-path` - Path (descending)\n* `method` - Method\n* `-method` - Method (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Exporters: Filesystem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedFilesystemExporterResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "exporters_core_filesystem_create", | |
"description": "Endpoint for managing FilesystemExporters.", | |
"summary": "Create a filesystem exporter", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Exporters: Filesystem" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FilesystemExporter" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/FilesystemExporter" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/FilesystemExporter" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FilesystemExporterResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{filesystem_exporter_href}exports/": { | |
"get": { | |
"operationId": "exporters_core_filesystem_exports_list", | |
"description": "Endpoint for managing FilesystemExports.", | |
"summary": "List filesystem exports", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "filesystem_exporter_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Exporters: Filesystem Exports" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedFilesystemExportResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "exporters_core_filesystem_exports_create", | |
"description": "Trigger an asynchronous task to export files to the filesystem", | |
"summary": "Create a filesystem export", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "filesystem_exporter_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Exporters: Filesystem Exports" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FilesystemExport" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/FilesystemExport" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/FilesystemExport" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{filesystem_filesystem_export_href}": { | |
"get": { | |
"operationId": "exporters_core_filesystem_exports_read", | |
"description": "Endpoint for managing FilesystemExports.", | |
"summary": "Inspect a filesystem export", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "filesystem_filesystem_export_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Exporters: Filesystem Exports" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FilesystemExportResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "exporters_core_filesystem_exports_delete", | |
"description": "Endpoint for managing FilesystemExports.", | |
"summary": "Delete a filesystem export", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "filesystem_filesystem_export_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Exporters: Filesystem Exports" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"{filesystem_exporter_href}": { | |
"get": { | |
"operationId": "exporters_core_filesystem_read", | |
"description": "Endpoint for managing FilesystemExporters.", | |
"summary": "Inspect a filesystem exporter", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "filesystem_exporter_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Exporters: Filesystem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FilesystemExporterResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "exporters_core_filesystem_update", | |
"description": "Trigger an asynchronous update task", | |
"summary": "Update a filesystem exporter", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "filesystem_exporter_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Exporters: Filesystem" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FilesystemExporter" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/FilesystemExporter" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/FilesystemExporter" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "exporters_core_filesystem_partial_update", | |
"description": "Trigger an asynchronous partial update task", | |
"summary": "Update a filesystem exporter", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "filesystem_exporter_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Exporters: Filesystem" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedFilesystemExporter" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedFilesystemExporter" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedFilesystemExporter" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "exporters_core_filesystem_delete", | |
"description": "Trigger an asynchronous delete task", | |
"summary": "Delete a filesystem exporter", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "filesystem_exporter_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Exporters: Filesystem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/exporters/core/pulp/": { | |
"get": { | |
"operationId": "exporters_core_pulp_list", | |
"description": "ViewSet for viewing PulpExporters.", | |
"summary": "List pulp exporters", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-name", | |
"-path", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"name", | |
"path", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `path` - Path\n* `-path` - Path (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Exporters: Pulp" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedPulpExporterResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "exporters_core_pulp_create", | |
"description": "ViewSet for viewing PulpExporters.", | |
"summary": "Create a pulp exporter", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Exporters: Pulp" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpExporter" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpExporter" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpExporter" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpExporterResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{pulp_exporter_href}exports/": { | |
"get": { | |
"operationId": "exporters_core_pulp_exports_list", | |
"description": "ViewSet for viewing exports from a PulpExporter.", | |
"summary": "List pulp exports", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_exporter_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Exporters: Pulp Exports" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedPulpExportResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "exporters_core_pulp_exports_create", | |
"description": "Trigger an asynchronous task to export a set of repositories", | |
"summary": "Create a pulp export", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_exporter_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Exporters: Pulp Exports" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpExport" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpExport" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpExport" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{pulp_pulp_export_href}": { | |
"get": { | |
"operationId": "exporters_core_pulp_exports_read", | |
"description": "ViewSet for viewing exports from a PulpExporter.", | |
"summary": "Inspect a pulp export", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_pulp_export_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Exporters: Pulp Exports" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpExportResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "exporters_core_pulp_exports_delete", | |
"description": "ViewSet for viewing exports from a PulpExporter.", | |
"summary": "Delete a pulp export", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_pulp_export_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Exporters: Pulp Exports" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"{pulp_exporter_href}": { | |
"get": { | |
"operationId": "exporters_core_pulp_read", | |
"description": "ViewSet for viewing PulpExporters.", | |
"summary": "Inspect a pulp exporter", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_exporter_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Exporters: Pulp" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpExporterResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "exporters_core_pulp_update", | |
"description": "Trigger an asynchronous update task", | |
"summary": "Update a pulp exporter", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_exporter_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Exporters: Pulp" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpExporter" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpExporter" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpExporter" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "exporters_core_pulp_partial_update", | |
"description": "Trigger an asynchronous partial update task", | |
"summary": "Update a pulp exporter", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_exporter_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Exporters: Pulp" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedPulpExporter" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedPulpExporter" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedPulpExporter" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "exporters_core_pulp_delete", | |
"description": "Trigger an asynchronous delete task", | |
"summary": "Delete a pulp exporter", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_exporter_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Exporters: Pulp" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/groups/": { | |
"get": { | |
"operationId": "groups_list", | |
"description": "ViewSet for Group.", | |
"summary": "List groups", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "id", | |
"schema": { | |
"type": "integer" | |
}, | |
"description": "Filter results where id matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "integer" | |
} | |
}, | |
"description": "Filter results where id is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-id", | |
"-name", | |
"-pk", | |
"id", | |
"name", | |
"pk" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `id` - Id\n* `-id` - Id (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Groups" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedGroupResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "groups_create", | |
"description": "ViewSet for Group.", | |
"summary": "Create a group", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Groups" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Group" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Group" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Group" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{group_href}roles/": { | |
"get": { | |
"operationId": "groups_roles_list", | |
"description": "ViewSet for GroupRole.", | |
"summary": "List group roles", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "content_object", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "content_object" | |
}, | |
{ | |
"in": "query", | |
"name": "domain", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"description": "Foreign Key referenced by HREF" | |
}, | |
{ | |
"in": "path", | |
"name": "group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-description", | |
"-pk", | |
"-pulp_created", | |
"-role", | |
"description", | |
"pk", | |
"pulp_created", | |
"role" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `role` - Role\n* `-role` - Role (descending)\n* `description` - Description\n* `-description` - Description (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "role", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "role__contains", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "role__icontains", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "role__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "role__startswith", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Groups: Roles" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedGroupRoleResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "groups_roles_create", | |
"description": "ViewSet for GroupRole.", | |
"summary": "Create a group role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Groups: Roles" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{groups_group_role_href}": { | |
"get": { | |
"operationId": "groups_roles_read", | |
"description": "ViewSet for GroupRole.", | |
"summary": "Inspect a group role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "groups_group_role_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Groups: Roles" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "groups_roles_delete", | |
"description": "ViewSet for GroupRole.", | |
"summary": "Delete a group role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "groups_group_role_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Groups: Roles" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"{group_href}users/": { | |
"get": { | |
"operationId": "groups_users_list", | |
"description": "List group users.", | |
"summary": "List users", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Groups: Users" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedGroupUserResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "groups_users_create", | |
"description": "Add a user to a group.", | |
"summary": "Create an user", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Groups: Users" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupUser" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupUser" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupUser" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupUserResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{groups_user_href}": { | |
"delete": { | |
"operationId": "groups_users_delete", | |
"description": "Remove a user from a group.", | |
"summary": "Delete an user", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "groups_user_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Groups: Users" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"{group_href}": { | |
"get": { | |
"operationId": "groups_read", | |
"description": "ViewSet for Group.", | |
"summary": "Inspect a group", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Groups" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "groups_update", | |
"description": "ViewSet for Group.", | |
"summary": "Update a group", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Groups" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Group" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/Group" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/Group" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "groups_partial_update", | |
"description": "ViewSet for Group.", | |
"summary": "Update a group", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Groups" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedGroup" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedGroup" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedGroup" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "groups_delete", | |
"description": "ViewSet for Group.", | |
"summary": "Delete a group", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Groups" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"{group_href}add_role/": { | |
"post": { | |
"operationId": "groups_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Groups" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{group_href}list_roles/": { | |
"get": { | |
"operationId": "groups_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Groups" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ObjectRolesResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{group_href}my_permissions/": { | |
"get": { | |
"operationId": "groups_my_permissions", | |
"description": "List permissions available to the current user on this object.", | |
"summary": "List user permissions", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Groups" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/MyPermissionsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{group_href}remove_role/": { | |
"post": { | |
"operationId": "groups_remove_role", | |
"description": "Remove a role for this object from users/groups.", | |
"summary": "Remove a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "group_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Groups" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/importers/core/pulp/": { | |
"get": { | |
"operationId": "importers_core_pulp_list", | |
"description": "ViewSet for PulpImporters.", | |
"summary": "List pulp importers", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "name", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__contains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__icontains", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name contains value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iexact", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Filter results where name is in a comma-separated list of values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "name__iregex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__istartswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__regex", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name matches regex value" | |
}, | |
{ | |
"in": "query", | |
"name": "name__startswith", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Filter results where name starts with value" | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-name", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"name", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `name` - Name\n* `-name` - Name (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Importers: Pulp" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedPulpImporterResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "importers_core_pulp_create", | |
"description": "ViewSet for PulpImporters.", | |
"summary": "Create a pulp importer", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Importers: Pulp" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImporter" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImporter" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImporter" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImporterResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{pulp_importer_href}imports/": { | |
"get": { | |
"operationId": "importers_core_pulp_imports_list", | |
"description": "ViewSet for PulpImports.", | |
"summary": "List pulp imports", | |
"parameters": [ | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_importer_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Importers: Pulp Imports" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedImportResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "importers_core_pulp_imports_create", | |
"description": "Trigger an asynchronous task to import a Pulp export.", | |
"summary": "Create a pulp import", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_importer_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Importers: Pulp Imports" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImport" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImport" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImport" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TaskGroupOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{pulp_pulp_import_href}": { | |
"get": { | |
"operationId": "importers_core_pulp_imports_read", | |
"description": "ViewSet for PulpImports.", | |
"summary": "Inspect a pulp import", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_pulp_import_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Importers: Pulp Imports" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ImportResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "importers_core_pulp_imports_delete", | |
"description": "ViewSet for PulpImports.", | |
"summary": "Delete a pulp import", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_pulp_import_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Importers: Pulp Imports" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"{pulp_importer_href}": { | |
"get": { | |
"operationId": "importers_core_pulp_read", | |
"description": "ViewSet for PulpImporters.", | |
"summary": "Inspect a pulp importer", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_importer_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Importers: Pulp" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImporterResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"put": { | |
"operationId": "importers_core_pulp_update", | |
"description": "ViewSet for PulpImporters.", | |
"summary": "Update a pulp importer", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_importer_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Importers: Pulp" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImporter" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImporter" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImporter" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImporterResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"patch": { | |
"operationId": "importers_core_pulp_partial_update", | |
"description": "ViewSet for PulpImporters.", | |
"summary": "Update a pulp importer", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_importer_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Importers: Pulp" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedPulpImporter" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedPulpImporter" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PatchedPulpImporter" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImporterResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "importers_core_pulp_delete", | |
"description": "ViewSet for PulpImporters.", | |
"summary": "Delete a pulp importer", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_importer_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Importers: Pulp" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/importers/core/pulp/import-check/": { | |
"post": { | |
"operationId": "pulp_import_check_post", | |
"description": "Evaluates validity of proposed PulpImport parameters 'toc', 'path', and 'repo_mapping'.\n\n* Checks that toc, path are in ALLOWED_IMPORT_PATHS\n* if ALLOWED:\n * Checks that toc, path exist and are readable\n * If toc specified, checks that containing dir is writeable\n* Checks that repo_mapping is valid JSON", | |
"summary": "Validate the parameters to be used for a PulpImport call", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Importers: Pulp Import-Check" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImportCheck" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImportCheck" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImportCheck" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PulpImportCheckResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/orphans/": { | |
"delete": { | |
"operationId": "orphans_delete", | |
"description": "DEPRECATED! Trigger an asynchronous task that deletes all orphaned content and artifacts. Use the `POST /pulp/api/v3/orphans/cleanup/` call instead.", | |
"summary": "Delete orphans", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Orphans" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/orphans/cleanup/": { | |
"post": { | |
"operationId": "orphans_cleanup_cleanup", | |
"description": "Trigger an asynchronous orphan cleanup operation.", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Orphans: Cleanup" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrphansCleanup" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/OrphansCleanup" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/OrphansCleanup" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/publications/": { | |
"get": { | |
"operationId": "publications_list", | |
"description": "A base class for any publication viewset.", | |
"summary": "List publications", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "content", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Content Unit referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "content__in", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Content Unit referenced by HREF" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-complete", | |
"-pass_through", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"complete", | |
"pass_through", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `complete` - Complete\n* `-complete` - Complete (descending)\n* `pass_through` - Pass through\n* `-pass_through` - Pass through (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__gt", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created is greater than value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__gte", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created is greater than or equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__lt", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created is less than value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__lte", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created is less than or equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__range", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"description": "Filter results where pulp_created is between two comma separated values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_type", | |
"schema": { | |
"type": "string", | |
"enum": [ | |
"file.file", | |
"gem.gem", | |
"rpm.rpm" | |
] | |
}, | |
"description": "Pulp type\n\n* `gem.gem` - gem.gem\n* `rpm.rpm` - rpm.rpm\n* `file.file` - file.file" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_type__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"file.file", | |
"gem.gem", | |
"rpm.rpm" | |
] | |
} | |
}, | |
"description": "Multiple values may be separated by commas.\n\n* `gem.gem` - gem.gem\n* `rpm.rpm` - rpm.rpm\n* `file.file` - file.file", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Publications" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaginatedPublicationResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/publications/file/file/": { | |
"get": { | |
"operationId": "publications_file_file_list", | |
"description": "\nA FilePublication contains metadata about all the File Content in a particular File Repository Version.\nOnce a FilePublication has been created, it can be hosted using the\nFile Distribution API.", | |
"summary": "List file publications", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "content", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Content Unit referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "content__in", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Content Unit referenced by HREF" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-complete", | |
"-pass_through", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"complete", | |
"pass_through", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `complete` - Complete\n* `-complete` - Complete (descending)\n* `pass_through` - Pass through\n* `-pass_through` - Pass through (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__gt", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created is greater than value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__gte", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created is greater than or equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__lt", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created is less than value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__lte", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created is less than or equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__range", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"description": "Filter results where pulp_created is between two comma separated values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Publications: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedfile.FilePublicationResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "publications_file_file_create", | |
"description": "Trigger an asynchronous task to publish file content.", | |
"summary": "Create a file publication", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Publications: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FilePublication" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FilePublication" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FilePublication" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_publication_href}": { | |
"get": { | |
"operationId": "publications_file_file_read", | |
"description": "\nA FilePublication contains metadata about all the File Content in a particular File Repository Version.\nOnce a FilePublication has been created, it can be hosted using the\nFile Distribution API.", | |
"summary": "Inspect a file publication", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_publication_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Publications: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/file.FilePublicationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "publications_file_file_delete", | |
"description": "\nA FilePublication contains metadata about all the File Content in a particular File Repository Version.\nOnce a FilePublication has been created, it can be hosted using the\nFile Distribution API.", | |
"summary": "Delete a file publication", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_publication_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Publications: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"{file_file_publication_href}add_role/": { | |
"post": { | |
"operationId": "publications_file_file_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_publication_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Publications: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_publication_href}list_roles/": { | |
"get": { | |
"operationId": "publications_file_file_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_publication_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Publications: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ObjectRolesResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_publication_href}my_permissions/": { | |
"get": { | |
"operationId": "publications_file_file_my_permissions", | |
"description": "List permissions available to the current user on this object.", | |
"summary": "List user permissions", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_publication_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Publications: File" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/MyPermissionsResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{file_file_publication_href}remove_role/": { | |
"post": { | |
"operationId": "publications_file_file_remove_role", | |
"description": "Remove a role for this object from users/groups.", | |
"summary": "Remove a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "file_file_publication_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Publications: File" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"/api/pulp/{pulp_domain}/api/v3/publications/gem/gem/": { | |
"get": { | |
"operationId": "publications_gem_gem_list", | |
"description": "A ViewSet for GemPublication.", | |
"summary": "List gem publications", | |
"parameters": [ | |
{ | |
"in": "query", | |
"name": "content", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Content Unit referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "content__in", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Content Unit referenced by HREF" | |
}, | |
{ | |
"name": "limit", | |
"required": false, | |
"in": "query", | |
"description": "Number of results to return per page.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"name": "offset", | |
"required": false, | |
"in": "query", | |
"description": "The initial index from which to return the results.", | |
"schema": { | |
"type": "integer" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "ordering", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"-complete", | |
"-pass_through", | |
"-pk", | |
"-pulp_created", | |
"-pulp_id", | |
"-pulp_last_updated", | |
"-pulp_type", | |
"complete", | |
"pass_through", | |
"pk", | |
"pulp_created", | |
"pulp_id", | |
"pulp_last_updated", | |
"pulp_type" | |
] | |
} | |
}, | |
"description": "Ordering\n\n* `pulp_id` - Pulp id\n* `-pulp_id` - Pulp id (descending)\n* `pulp_created` - Pulp created\n* `-pulp_created` - Pulp created (descending)\n* `pulp_last_updated` - Pulp last updated\n* `-pulp_last_updated` - Pulp last updated (descending)\n* `pulp_type` - Pulp type\n* `-pulp_type` - Pulp type (descending)\n* `complete` - Complete\n* `-complete` - Complete (descending)\n* `pass_through` - Pass through\n* `-pass_through` - Pass through (descending)\n* `pk` - Pk\n* `-pk` - Pk (descending)", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created matches value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__gt", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created is greater than value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__gte", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created is greater than or equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__lt", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created is less than value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__lte", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"description": "Filter results where pulp_created is less than or equal to value" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_created__range", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"description": "Filter results where pulp_created is between two comma separated values", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_href__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "pulp_id__in", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"description": "Multiple values may be separated by commas.", | |
"explode": false, | |
"style": "form" | |
}, | |
{ | |
"in": "query", | |
"name": "q", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"in": "query", | |
"name": "repository", | |
"schema": { | |
"type": "string" | |
}, | |
"description": "Repository referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "repository_version", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"description": "Repository Version referenced by HREF" | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Publications: Gem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/Paginatedgem.GemPublicationResponseList" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"post": { | |
"operationId": "publications_gem_gem_create", | |
"description": "Trigger an asynchronous task to publish gem content", | |
"summary": "Create a gem publication", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "pulp_domain", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true, | |
"x-isDomain": true | |
} | |
], | |
"tags": [ | |
"Publications: Gem" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemPublication" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemPublication" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemPublication" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"202": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AsyncOperationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{gem_gem_publication_href}": { | |
"get": { | |
"operationId": "publications_gem_gem_read", | |
"description": "A ViewSet for GemPublication.", | |
"summary": "Inspect a gem publication", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_publication_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response." | |
}, | |
{ | |
"in": "query", | |
"name": "exclude_fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to exclude from the response." | |
} | |
], | |
"tags": [ | |
"Publications: Gem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"200": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/gem.GemPublicationResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
}, | |
"delete": { | |
"operationId": "publications_gem_gem_delete", | |
"description": "A ViewSet for GemPublication.", | |
"summary": "Delete a gem publication", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_publication_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Publications: Gem" | |
], | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "No response body" | |
} | |
} | |
} | |
}, | |
"{gem_gem_publication_href}add_role/": { | |
"post": { | |
"operationId": "publications_gem_gem_add_role", | |
"description": "Add a role for this object to users/groups.", | |
"summary": "Add a role", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_publication_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
} | |
], | |
"tags": [ | |
"Publications: Gem" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"application/x-www-form-urlencoded": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
}, | |
"multipart/form-data": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRole" | |
} | |
} | |
}, | |
"required": true | |
}, | |
"security": [ | |
{ | |
"basicAuth": [] | |
}, | |
{ | |
"cookieAuth": [] | |
}, | |
{ | |
"json_header_remote_authentication": [] | |
} | |
], | |
"responses": { | |
"201": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/NestedRoleResponse" | |
} | |
} | |
}, | |
"description": "" | |
} | |
} | |
} | |
}, | |
"{gem_gem_publication_href}list_roles/": { | |
"get": { | |
"operationId": "publications_gem_gem_list_roles", | |
"description": "List roles assigned to this object.", | |
"summary": "List roles", | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "gem_gem_publication_href", | |
"schema": { | |
"type": "string" | |
}, | |
"required": true | |
}, | |
{ | |
"in": "query", | |
"name": "fields", | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"description": "A list of fields to include in the response. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
https://redocly.github.io/redoc/?url=https://gist.githubusercontent.com/lzap/675cbdef585395cebb4751f755de5ced/raw/bbc64afeb08c015605735734ca422e834311d6b4/pulp-openapi.json