Created
August 11, 2020 18:39
-
-
Save alikins/93f7600d1b7f0ce7f0fe17513aa6ca6e to your computer and use it in GitHub Desktop.
pulp explicit openapi spec
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | |
paths: | |
/ansible/collections/: | |
post: | |
operationId: upload_collection | |
description: Create an artifact and trigger an asynchronous task to create Collection | |
content from it. | |
summary: Upload a collection | |
tags: | |
- 'Ansible: Collections' | |
requestBody: | |
content: | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/CollectionOneShot' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/CollectionOneShot' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/api/automation-hub/: | |
get: | |
operationId: api_automation_hub_read | |
description: '' | |
tags: | |
- 'Api: Automation-Hub' | |
responses: | |
'200': | |
description: No response body | |
/api/automation-hub/api/: | |
get: | |
operationId: api_automation_hub_api_read | |
description: |- | |
Redirect requests to /api/automation-hub/api/ to /api/automation-hub/ | |
This is a workaround for https://github.com/ansible/ansible/issues/62073. | |
This can be removed when ansible-galaxy stops appending '/api' to the url. | |
tags: | |
- 'Api: Api' | |
responses: | |
'200': | |
description: No response body | |
/api/automation-hub/content/{path}/: | |
get: | |
operationId: api_automation_hub_content_read | |
description: '' | |
parameters: | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Content' | |
responses: | |
'200': | |
description: No response body | |
/api/automation-hub/content/{path}/api/: | |
get: | |
operationId: api_automation_hub_content_api_read | |
description: |- | |
Redirect requests to /api/automation-hub/api/ to /api/automation-hub/ | |
This is a workaround for https://github.com/ansible/ansible/issues/62073. | |
This can be removed when ansible-galaxy stops appending '/api' to the url. | |
parameters: | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub Api' | |
responses: | |
'200': | |
description: No response body | |
/api/automation-hub/content/{path}/v3/artifacts/collections/: | |
post: | |
operationId: api_automation_hub_content_v3_artifacts_collections_create | |
description: Dispatch a Collection creation task. | |
parameters: | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Api: Automation-Hub Content V3 Collections' | |
requestBody: | |
content: | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Collection' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionResponse' | |
description: '' | |
/api/automation-hub/content/{path}/v3/artifacts/collections/{path}/{filename}: | |
get: | |
operationId: api_automation_hub_content_v3_artifacts_collections_read | |
description: '' | |
parameters: | |
- in: path | |
name: filename | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub Content V3 Collections' | |
responses: | |
'200': | |
description: No response body | |
/api/automation-hub/content/{path}/v3/collections/: | |
get: | |
operationId: api_automation_hub_content_v3_collections_list | |
description: ViewSet for Collections. | |
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: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub Content Collections' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/CollectionWithFixedHrefsResponse' | |
description: '' | |
/api/automation-hub/content/{path}/v3/collections/{namespace}/{name}/: | |
get: | |
operationId: api_automation_hub_content_v3_collections_read | |
description: ViewSet for Collections. | |
parameters: | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub Content Collections' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionWithFixedHrefsResponse' | |
description: '' | |
put: | |
operationId: api_automation_hub_content_v3_collections_update | |
description: Update a Collection object. | |
parameters: | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Api: Automation-Hub Content Collections' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionWithFixedHrefs' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/CollectionWithFixedHrefs' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/CollectionWithFixedHrefs' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionWithFixedHrefsResponse' | |
description: '' | |
/api/automation-hub/content/{path}/v3/collections/{namespace}/{name}/versions/: | |
get: | |
operationId: api_automation_hub_content_v3_collections_versions_list | |
description: Returns paginated CollectionVersions list. | |
parameters: | |
- name: certification | |
required: false | |
in: query | |
description: certification | |
schema: | |
type: string | |
enum: | |
- certified | |
- not_certified | |
- needs_review | |
- name: deprecated | |
required: false | |
in: query | |
description: deprecated | |
schema: | |
type: string | |
- name: is_highest | |
required: false | |
in: query | |
description: is_highest | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- name: q | |
required: false | |
in: query | |
description: q | |
schema: | |
type: string | |
- name: repository_version | |
required: false | |
in: query | |
description: repository_version | |
schema: | |
type: string | |
- name: repository_version_added | |
required: false | |
in: query | |
description: repository_version_added | |
schema: | |
type: string | |
- name: repository_version_removed | |
required: false | |
in: query | |
description: repository_version_removed | |
schema: | |
type: string | |
- name: tags | |
required: false | |
in: query | |
description: tags | |
schema: | |
type: string | |
- name: version | |
required: false | |
in: query | |
description: version | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub Content V3 Versions' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/CollectionVersionWithDownloadUrlResponse' | |
description: '' | |
/api/automation-hub/content/{path}/v3/collections/{namespace}/{name}/versions/{version}/: | |
get: | |
operationId: api_automation_hub_content_v3_collections_versions_read | |
description: Returns a CollectionVersion object. | |
parameters: | |
- name: certification | |
required: false | |
in: query | |
description: certification | |
schema: | |
type: string | |
enum: | |
- certified | |
- not_certified | |
- needs_review | |
- name: deprecated | |
required: false | |
in: query | |
description: deprecated | |
schema: | |
type: string | |
- name: is_highest | |
required: false | |
in: query | |
description: is_highest | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- name: q | |
required: false | |
in: query | |
description: q | |
schema: | |
type: string | |
- name: repository_version | |
required: false | |
in: query | |
description: repository_version | |
schema: | |
type: string | |
- name: repository_version_added | |
required: false | |
in: query | |
description: repository_version_added | |
schema: | |
type: string | |
- name: repository_version_removed | |
required: false | |
in: query | |
description: repository_version_removed | |
schema: | |
type: string | |
- name: tags | |
required: false | |
in: query | |
description: tags | |
schema: | |
type: string | |
- in: path | |
name: version | |
schema: | |
type: string | |
required: true | |
- name: version | |
required: false | |
in: query | |
description: version | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub Content V3 Versions' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionVersionWithDownloadUrlResponse' | |
description: '' | |
/api/automation-hub/content/{path}/v3/collections/{namespace}/{name}/versions/{version}/move/{source_path}/{dest_path}/: | |
post: | |
operationId: api_automation_hub_content_v3_collections_versions_move_move_content | |
description: |- | |
Remove content from source repo and add to destination repo. | |
Creates new RepositoryVersion of source repo without content included. | |
Creates new RepositoryVersion of destination repo with content included. | |
parameters: | |
- in: path | |
name: dest_path | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: source_path | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: version | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Api: Automation-Hub Content V3 Collections Move' | |
responses: | |
'200': | |
description: No response body | |
/api/automation-hub/content/{path}/v3/imports/collections/{task}/: | |
get: | |
operationId: api_automation_hub_content_v3_imports_collections_read | |
description: Returns a CollectionImport object. | |
summary: Inspect a collection import | |
parameters: | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: since | |
schema: | |
type: string | |
description: Filter messages since a given timestamp | |
- in: path | |
name: task | |
schema: | |
type: string | |
format: uuid | |
description: A unique value identifying this collection import. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub Content V3 Collections' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionImportDetailResponse' | |
description: '' | |
/api/automation-hub/content/{path}/v3/tasks/: | |
get: | |
operationId: tasks_list | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: List tasks | |
parameters: | |
- name: child_tasks | |
required: false | |
in: query | |
description: child_tasks | |
schema: | |
type: string | |
- name: created_resources | |
required: false | |
in: query | |
description: created_resources | |
schema: | |
type: string | |
- name: finished_at | |
required: false | |
in: query | |
description: finished_at | |
schema: | |
type: string | |
- name: finished_at__gt | |
required: false | |
in: query | |
description: finished_at__gt | |
schema: | |
type: string | |
- name: finished_at__gte | |
required: false | |
in: query | |
description: finished_at__gte | |
schema: | |
type: string | |
- name: finished_at__lt | |
required: false | |
in: query | |
description: finished_at__lt | |
schema: | |
type: string | |
- name: finished_at__lte | |
required: false | |
in: query | |
description: finished_at__lte | |
schema: | |
type: string | |
- name: finished_at__range | |
required: false | |
in: query | |
description: finished_at__range | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__contains | |
required: false | |
in: query | |
description: name__contains | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: parent_task | |
required: false | |
in: query | |
description: parent_task | |
schema: | |
type: string | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- name: reserved_resources_record | |
required: false | |
in: query | |
description: reserved_resources_record | |
schema: | |
type: string | |
- name: started_at | |
required: false | |
in: query | |
description: started_at | |
schema: | |
type: string | |
- name: started_at__gt | |
required: false | |
in: query | |
description: started_at__gt | |
schema: | |
type: string | |
- name: started_at__gte | |
required: false | |
in: query | |
description: started_at__gte | |
schema: | |
type: string | |
- name: started_at__lt | |
required: false | |
in: query | |
description: started_at__lt | |
schema: | |
type: string | |
- name: started_at__lte | |
required: false | |
in: query | |
description: started_at__lte | |
schema: | |
type: string | |
- name: started_at__range | |
required: false | |
in: query | |
description: started_at__range | |
schema: | |
type: string | |
- name: state | |
required: false | |
in: query | |
description: state | |
schema: | |
type: string | |
- name: state__in | |
required: false | |
in: query | |
description: state__in | |
schema: | |
type: string | |
- name: task_group | |
required: false | |
in: query | |
description: task_group | |
schema: | |
type: string | |
- name: worker | |
required: false | |
in: query | |
description: worker | |
schema: | |
type: string | |
- name: worker__in | |
required: false | |
in: query | |
description: worker__in | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Tasks | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/galaxy.LoginResponse' | |
description: '' | |
/api/automation-hub/content/{path}/v3/tasks/{pulp_id}/: | |
get: | |
operationId: tasks_read | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: Inspect a task | |
parameters: | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this task. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Tasks | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/galaxy.LoginResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/auth/login/: | |
get: | |
operationId: api_automation_hub_v3__ui_auth_login_read | |
description: '' | |
tags: | |
- 'Api: Automation-Hub V3 _Ui Login' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/galaxy.LoginResponse' | |
description: '' | |
post: | |
operationId: api_automation_hub_v3__ui_auth_login_create | |
description: '' | |
tags: | |
- 'Api: Automation-Hub V3 _Ui Login' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/galaxy.Login' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/galaxy.Login' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/galaxy.Login' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/galaxy.LoginResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/auth/logout/: | |
post: | |
operationId: api_automation_hub_v3__ui_auth_logout_create | |
description: '' | |
tags: | |
- 'Api: Automation-Hub V3 _Ui Logout' | |
responses: | |
'200': | |
description: No response body | |
/api/automation-hub/v3/_ui/collection-versions/: | |
get: | |
operationId: api_automation_hub_v3__ui_collection_versions_list | |
description: '' | |
summary: List collection versions | |
parameters: | |
- name: certification | |
required: false | |
in: query | |
description: certification | |
schema: | |
type: string | |
enum: | |
- certified | |
- not_certified | |
- needs_review | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: repository | |
required: false | |
in: query | |
description: repository | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- pulp_created | |
- -pulp_created | |
- namespace | |
- -namespace | |
- collection | |
- -collection | |
- version | |
- -version | |
- name: version | |
required: false | |
in: query | |
description: version | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Collection-Versions' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/galaxy.LoginResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/collection-versions/{version}/: | |
get: | |
operationId: api_automation_hub_v3__ui_collection_versions_read | |
description: '' | |
summary: Retrieve collection version | |
parameters: | |
- name: certification | |
required: false | |
in: query | |
description: certification | |
schema: | |
type: string | |
enum: | |
- certified | |
- not_certified | |
- needs_review | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- name: repository | |
required: false | |
in: query | |
description: repository | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- pulp_created | |
- -pulp_created | |
- namespace | |
- -namespace | |
- collection | |
- -collection | |
- version | |
- -version | |
- in: path | |
name: version | |
schema: | |
type: string | |
required: true | |
- name: version | |
required: false | |
in: query | |
description: version | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Collection-Versions' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/galaxy.LoginResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/collection-versions/{version}/certified/: | |
put: | |
operationId: api_automation_hub_v3__ui_collection_versions_certified_set_certified | |
description: '' | |
parameters: | |
- in: path | |
name: version | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Api: Automation-Hub V3 _Ui Certified' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/galaxy.Login' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/galaxy.Login' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/galaxy.Login' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/galaxy.LoginResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/collections/: | |
get: | |
operationId: api_automation_hub_v3__ui_collections_list | |
description: '' | |
tags: | |
- 'Api: Automation-Hub V3 Collections' | |
responses: | |
'200': | |
description: No response body | |
/api/automation-hub/v3/_ui/collections/{collection}/: | |
get: | |
operationId: api_automation_hub_v3__ui_collections_read | |
description: '' | |
parameters: | |
- in: path | |
name: collection | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Collections' | |
responses: | |
'200': | |
description: No response body | |
/api/automation-hub/v3/_ui/imports/collections/: | |
get: | |
operationId: api_automation_hub_v3__ui_imports_collections_list | |
description: '' | |
summary: List collection imports | |
parameters: | |
- name: created | |
required: false | |
in: query | |
description: created | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- created | |
- -created | |
- name: version | |
required: false | |
in: query | |
description: version | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 _Ui Collections' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/ImportTaskListResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/imports/collections/{task_id}/: | |
get: | |
operationId: api_automation_hub_v3__ui_imports_collections_read | |
description: '' | |
summary: Retrieve collection import | |
parameters: | |
- name: created | |
required: false | |
in: query | |
description: created | |
schema: | |
type: string | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- created | |
- -created | |
- in: path | |
name: task_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this collection import. | |
required: true | |
- name: version | |
required: false | |
in: query | |
description: version | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 _Ui Collections' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ImportTaskDetailResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/me/: | |
get: | |
operationId: api_automation_hub_v3__ui_me_read | |
description: '' | |
tags: | |
- 'Api: Automation-Hub V3 Me' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CurrentUserResponse' | |
description: '' | |
put: | |
operationId: api_automation_hub_v3__ui_me_update | |
description: '' | |
tags: | |
- 'Api: Automation-Hub V3 Me' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CurrentUser' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/CurrentUser' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/CurrentUser' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CurrentUserResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/my-namespaces/: | |
get: | |
operationId: api_automation_hub_v3__ui_my_namespaces_list | |
description: '' | |
summary: List namespaces | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 My-Namespaces' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/NamespaceSummaryResponse' | |
description: '' | |
post: | |
operationId: api_automation_hub_v3__ui_my_namespaces_create | |
description: Override to also create inbound pulp repository and distribution. | |
summary: Create a namespace | |
tags: | |
- 'Api: Automation-Hub V3 My-Namespaces' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Namespace' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Namespace' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Namespace' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/my-namespaces/{name}/: | |
get: | |
operationId: api_automation_hub_v3__ui_my_namespaces_read | |
description: '' | |
summary: Inspect a namespace | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 My-Namespaces' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceResponse' | |
description: '' | |
put: | |
operationId: api_automation_hub_v3__ui_my_namespaces_update | |
description: '' | |
summary: Update a namespace | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
tags: | |
- 'Api: Automation-Hub V3 My-Namespaces' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceUpdate' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/NamespaceUpdate' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/NamespaceUpdate' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceUpdateResponse' | |
description: '' | |
patch: | |
operationId: api_automation_hub_v3__ui_my_namespaces_partial_update | |
description: '' | |
summary: Update a namespace | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
tags: | |
- 'Api: Automation-Hub V3 My-Namespaces' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/PatchedNamespace' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/PatchedNamespace' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/PatchedNamespace' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceResponse' | |
description: '' | |
delete: | |
operationId: api_automation_hub_v3__ui_my_namespaces_delete | |
description: |- | |
Override to also delete inbound pulp repository and distribution. | |
RepositoryVersion objects get deleted on delete of AnsibleRepository. | |
summary: Delete a namespace | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
tags: | |
- 'Api: Automation-Hub V3 My-Namespaces' | |
responses: | |
'204': | |
description: No response body | |
/api/automation-hub/v3/_ui/my-synclists/: | |
get: | |
operationId: api_automation_hub_v3__ui_my_synclists_list | |
description: '' | |
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: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 My-Synclists' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/SyncListResponse' | |
description: '' | |
post: | |
operationId: api_automation_hub_v3__ui_my_synclists_create | |
description: '' | |
tags: | |
- 'Api: Automation-Hub V3 My-Synclists' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SyncList' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/SyncList' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/SyncList' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SyncListResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/my-synclists/{id}/: | |
get: | |
operationId: api_automation_hub_v3__ui_my_synclists_read | |
description: '' | |
parameters: | |
- in: path | |
name: id | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 My-Synclists' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SyncListResponse' | |
description: '' | |
put: | |
operationId: api_automation_hub_v3__ui_my_synclists_update | |
description: '' | |
parameters: | |
- in: path | |
name: id | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Api: Automation-Hub V3 My-Synclists' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SyncList' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/SyncList' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/SyncList' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SyncListResponse' | |
description: '' | |
patch: | |
operationId: api_automation_hub_v3__ui_my_synclists_partial_update | |
description: '' | |
parameters: | |
- in: path | |
name: id | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Api: Automation-Hub V3 My-Synclists' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/PatchedSyncList' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/PatchedSyncList' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/PatchedSyncList' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SyncListResponse' | |
description: '' | |
delete: | |
operationId: api_automation_hub_v3__ui_my_synclists_delete | |
description: '' | |
parameters: | |
- in: path | |
name: id | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Api: Automation-Hub V3 My-Synclists' | |
responses: | |
'204': | |
description: No response body | |
/api/automation-hub/v3/_ui/namespaces/: | |
get: | |
operationId: api_automation_hub_v3__ui_namespaces_list | |
description: '' | |
summary: List namespaces | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Namespaces' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/NamespaceSummaryResponse' | |
description: '' | |
post: | |
operationId: api_automation_hub_v3__ui_namespaces_create | |
description: Override to also create inbound pulp repository and distribution. | |
summary: Create a namespace | |
tags: | |
- 'Api: Automation-Hub V3 Namespaces' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Namespace' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Namespace' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Namespace' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/namespaces/{name}/: | |
get: | |
operationId: api_automation_hub_v3__ui_namespaces_read | |
description: '' | |
summary: Inspect a namespace | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Namespaces' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceResponse' | |
description: '' | |
put: | |
operationId: api_automation_hub_v3__ui_namespaces_update | |
description: '' | |
summary: Update a namespace | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
tags: | |
- 'Api: Automation-Hub V3 Namespaces' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceUpdate' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/NamespaceUpdate' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/NamespaceUpdate' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceUpdateResponse' | |
description: '' | |
patch: | |
operationId: api_automation_hub_v3__ui_namespaces_partial_update | |
description: '' | |
summary: Update a namespace | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
tags: | |
- 'Api: Automation-Hub V3 Namespaces' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/PatchedNamespace' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/PatchedNamespace' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/PatchedNamespace' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceResponse' | |
description: '' | |
delete: | |
operationId: api_automation_hub_v3__ui_namespaces_delete | |
description: |- | |
Override to also delete inbound pulp repository and distribution. | |
RepositoryVersion objects get deleted on delete of AnsibleRepository. | |
summary: Delete a namespace | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
tags: | |
- 'Api: Automation-Hub V3 Namespaces' | |
responses: | |
'204': | |
description: No response body | |
/api/automation-hub/v3/_ui/synclists/: | |
get: | |
operationId: api_automation_hub_v3__ui_synclists_list | |
description: '' | |
summary: List sync lists | |
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: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Synclists' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/SyncListResponse' | |
description: '' | |
post: | |
operationId: api_automation_hub_v3__ui_synclists_create | |
description: '' | |
summary: Create a sync list | |
tags: | |
- 'Api: Automation-Hub V3 Synclists' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SyncList' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/SyncList' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/SyncList' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SyncListResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/synclists/{id}/: | |
get: | |
operationId: api_automation_hub_v3__ui_synclists_read | |
description: '' | |
summary: Inspect a sync list | |
parameters: | |
- in: path | |
name: id | |
schema: | |
type: integer | |
description: A unique integer value identifying this sync list. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Synclists' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SyncListResponse' | |
description: '' | |
put: | |
operationId: api_automation_hub_v3__ui_synclists_update | |
description: '' | |
summary: Update a sync list | |
parameters: | |
- in: path | |
name: id | |
schema: | |
type: integer | |
description: A unique integer value identifying this sync list. | |
required: true | |
tags: | |
- 'Api: Automation-Hub V3 Synclists' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SyncList' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/SyncList' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/SyncList' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SyncListResponse' | |
description: '' | |
patch: | |
operationId: api_automation_hub_v3__ui_synclists_partial_update | |
description: '' | |
summary: Update a sync list | |
parameters: | |
- in: path | |
name: id | |
schema: | |
type: integer | |
description: A unique integer value identifying this sync list. | |
required: true | |
tags: | |
- 'Api: Automation-Hub V3 Synclists' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/PatchedSyncList' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/PatchedSyncList' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/PatchedSyncList' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SyncListResponse' | |
description: '' | |
delete: | |
operationId: api_automation_hub_v3__ui_synclists_delete | |
description: '' | |
summary: Delete a sync list | |
parameters: | |
- in: path | |
name: id | |
schema: | |
type: integer | |
description: A unique integer value identifying this sync list. | |
required: true | |
tags: | |
- 'Api: Automation-Hub V3 Synclists' | |
responses: | |
'204': | |
description: No response body | |
/api/automation-hub/v3/_ui/tags/: | |
get: | |
operationId: api_automation_hub_v3__ui_tags_list | |
description: '' | |
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: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Tags' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/TagResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/users/: | |
get: | |
operationId: api_automation_hub_v3__ui_users_list | |
description: '' | |
summary: List users | |
parameters: | |
- name: date_joined | |
required: false | |
in: query | |
description: date_joined | |
schema: | |
type: string | |
- name: email | |
required: false | |
in: query | |
description: email | |
schema: | |
type: string | |
- name: first_name | |
required: false | |
in: query | |
description: first_name | |
schema: | |
type: string | |
- name: last_name | |
required: false | |
in: query | |
description: last_name | |
schema: | |
type: string | |
- 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 | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- username | |
- -username | |
- first_name | |
- -first_name | |
- last_name | |
- -last_name | |
- date_joined | |
- -date_joined | |
- name: username | |
required: false | |
in: query | |
description: username | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Users' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/UserResponse' | |
description: '' | |
post: | |
operationId: api_automation_hub_v3__ui_users_create | |
description: '' | |
summary: Create an user | |
tags: | |
- 'Api: Automation-Hub V3 Users' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/User' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/User' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/User' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/UserResponse' | |
description: '' | |
/api/automation-hub/v3/_ui/users/{id}/: | |
get: | |
operationId: api_automation_hub_v3__ui_users_read | |
description: '' | |
summary: Inspect an user | |
parameters: | |
- name: date_joined | |
required: false | |
in: query | |
description: date_joined | |
schema: | |
type: string | |
- name: email | |
required: false | |
in: query | |
description: email | |
schema: | |
type: string | |
- name: first_name | |
required: false | |
in: query | |
description: first_name | |
schema: | |
type: string | |
- in: path | |
name: id | |
schema: | |
type: integer | |
description: A unique integer value identifying this user. | |
required: true | |
- name: last_name | |
required: false | |
in: query | |
description: last_name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- username | |
- -username | |
- first_name | |
- -first_name | |
- last_name | |
- -last_name | |
- date_joined | |
- -date_joined | |
- name: username | |
required: false | |
in: query | |
description: username | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Users' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/UserResponse' | |
description: '' | |
put: | |
operationId: api_automation_hub_v3__ui_users_update | |
description: '' | |
summary: Update an user | |
parameters: | |
- name: date_joined | |
required: false | |
in: query | |
description: date_joined | |
schema: | |
type: string | |
- name: email | |
required: false | |
in: query | |
description: email | |
schema: | |
type: string | |
- name: first_name | |
required: false | |
in: query | |
description: first_name | |
schema: | |
type: string | |
- in: path | |
name: id | |
schema: | |
type: integer | |
description: A unique integer value identifying this user. | |
required: true | |
- name: last_name | |
required: false | |
in: query | |
description: last_name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- username | |
- -username | |
- first_name | |
- -first_name | |
- last_name | |
- -last_name | |
- date_joined | |
- -date_joined | |
- name: username | |
required: false | |
in: query | |
description: username | |
schema: | |
type: string | |
tags: | |
- 'Api: Automation-Hub V3 Users' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/User' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/User' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/User' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/UserResponse' | |
description: '' | |
patch: | |
operationId: api_automation_hub_v3__ui_users_partial_update | |
description: '' | |
summary: Update an user | |
parameters: | |
- name: date_joined | |
required: false | |
in: query | |
description: date_joined | |
schema: | |
type: string | |
- name: email | |
required: false | |
in: query | |
description: email | |
schema: | |
type: string | |
- name: first_name | |
required: false | |
in: query | |
description: first_name | |
schema: | |
type: string | |
- in: path | |
name: id | |
schema: | |
type: integer | |
description: A unique integer value identifying this user. | |
required: true | |
- name: last_name | |
required: false | |
in: query | |
description: last_name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- username | |
- -username | |
- first_name | |
- -first_name | |
- last_name | |
- -last_name | |
- date_joined | |
- -date_joined | |
- name: username | |
required: false | |
in: query | |
description: username | |
schema: | |
type: string | |
tags: | |
- 'Api: Automation-Hub V3 Users' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/PatchedUser' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/PatchedUser' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/PatchedUser' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/UserResponse' | |
description: '' | |
delete: | |
operationId: api_automation_hub_v3__ui_users_delete | |
description: '' | |
summary: Delete an user | |
parameters: | |
- name: date_joined | |
required: false | |
in: query | |
description: date_joined | |
schema: | |
type: string | |
- name: email | |
required: false | |
in: query | |
description: email | |
schema: | |
type: string | |
- name: first_name | |
required: false | |
in: query | |
description: first_name | |
schema: | |
type: string | |
- in: path | |
name: id | |
schema: | |
type: integer | |
description: A unique integer value identifying this user. | |
required: true | |
- name: last_name | |
required: false | |
in: query | |
description: last_name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- username | |
- -username | |
- first_name | |
- -first_name | |
- last_name | |
- -last_name | |
- date_joined | |
- -date_joined | |
- name: username | |
required: false | |
in: query | |
description: username | |
schema: | |
type: string | |
tags: | |
- 'Api: Automation-Hub V3 Users' | |
responses: | |
'204': | |
description: No response body | |
/api/automation-hub/v3/artifacts/collections/: | |
post: | |
operationId: api_automation_hub_v3_artifacts_collections_create | |
description: Dispatch a Collection creation task. | |
tags: | |
- 'Api: Automation-Hub V3 Collections' | |
requestBody: | |
content: | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Collection' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionResponse' | |
description: '' | |
/api/automation-hub/v3/artifacts/collections/{path}/{filename}: | |
get: | |
operationId: api_automation_hub_v3_artifacts_collections_read | |
description: '' | |
parameters: | |
- in: path | |
name: filename | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Collections' | |
responses: | |
'200': | |
description: No response body | |
/api/automation-hub/v3/auth/token/: | |
post: | |
operationId: api_automation_hub_v3_auth_token_create | |
description: Create or refresh user token. | |
tags: | |
- 'Api: Automation-Hub V3 Token' | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: No response body | |
delete: | |
operationId: api_automation_hub_v3_auth_token_delete | |
description: Invalidate user token. | |
tags: | |
- 'Api: Automation-Hub V3 Token' | |
security: | |
- basicAuth: [] | |
responses: | |
'204': | |
description: No response body | |
/api/automation-hub/v3/collections/: | |
get: | |
operationId: api_automation_hub_v3_collections_list | |
description: ViewSet for Collections. | |
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: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub Collections' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/CollectionWithFixedHrefsResponse' | |
description: '' | |
/api/automation-hub/v3/collections/{namespace}/{name}/: | |
get: | |
operationId: api_automation_hub_v3_collections_read | |
description: ViewSet for Collections. | |
parameters: | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub Collections' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionWithFixedHrefsResponse' | |
description: '' | |
put: | |
operationId: api_automation_hub_v3_collections_update | |
description: Update a Collection object. | |
parameters: | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Api: Automation-Hub Collections' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionWithFixedHrefs' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/CollectionWithFixedHrefs' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/CollectionWithFixedHrefs' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionWithFixedHrefsResponse' | |
description: '' | |
/api/automation-hub/v3/collections/{namespace}/{name}/versions/: | |
get: | |
operationId: api_automation_hub_v3_collections_versions_list | |
description: Returns paginated CollectionVersions list. | |
parameters: | |
- name: certification | |
required: false | |
in: query | |
description: certification | |
schema: | |
type: string | |
enum: | |
- certified | |
- not_certified | |
- needs_review | |
- name: deprecated | |
required: false | |
in: query | |
description: deprecated | |
schema: | |
type: string | |
- name: is_highest | |
required: false | |
in: query | |
description: is_highest | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: q | |
required: false | |
in: query | |
description: q | |
schema: | |
type: string | |
- name: repository_version | |
required: false | |
in: query | |
description: repository_version | |
schema: | |
type: string | |
- name: repository_version_added | |
required: false | |
in: query | |
description: repository_version_added | |
schema: | |
type: string | |
- name: repository_version_removed | |
required: false | |
in: query | |
description: repository_version_removed | |
schema: | |
type: string | |
- name: tags | |
required: false | |
in: query | |
description: tags | |
schema: | |
type: string | |
- name: version | |
required: false | |
in: query | |
description: version | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Versions' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/CollectionVersionWithDownloadUrlResponse' | |
description: '' | |
/api/automation-hub/v3/collections/{namespace}/{name}/versions/{version}/: | |
get: | |
operationId: api_automation_hub_v3_collections_versions_read | |
description: Returns a CollectionVersion object. | |
parameters: | |
- name: certification | |
required: false | |
in: query | |
description: certification | |
schema: | |
type: string | |
enum: | |
- certified | |
- not_certified | |
- needs_review | |
- name: deprecated | |
required: false | |
in: query | |
description: deprecated | |
schema: | |
type: string | |
- name: is_highest | |
required: false | |
in: query | |
description: is_highest | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- name: q | |
required: false | |
in: query | |
description: q | |
schema: | |
type: string | |
- name: repository_version | |
required: false | |
in: query | |
description: repository_version | |
schema: | |
type: string | |
- name: repository_version_added | |
required: false | |
in: query | |
description: repository_version_added | |
schema: | |
type: string | |
- name: repository_version_removed | |
required: false | |
in: query | |
description: repository_version_removed | |
schema: | |
type: string | |
- name: tags | |
required: false | |
in: query | |
description: tags | |
schema: | |
type: string | |
- in: path | |
name: version | |
schema: | |
type: string | |
required: true | |
- name: version | |
required: false | |
in: query | |
description: version | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Versions' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionVersionWithDownloadUrlResponse' | |
description: '' | |
/api/automation-hub/v3/collections/{namespace}/{name}/versions/{version}/move/{source_path}/{dest_path}/: | |
post: | |
operationId: api_automation_hub_v3_collections_versions_move_move_content | |
description: |- | |
Remove content from source repo and add to destination repo. | |
Creates new RepositoryVersion of source repo without content included. | |
Creates new RepositoryVersion of destination repo with content included. | |
parameters: | |
- in: path | |
name: dest_path | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: source_path | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: version | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Api: Automation-Hub V3 Collections Move' | |
responses: | |
'200': | |
description: No response body | |
/api/automation-hub/v3/imports/collections/{task}/: | |
get: | |
operationId: api_automation_hub_v3_imports_collections_read | |
description: Returns a CollectionImport object. | |
summary: Inspect a collection import | |
parameters: | |
- in: query | |
name: since | |
schema: | |
type: string | |
description: Filter messages since a given timestamp | |
- in: path | |
name: task | |
schema: | |
type: string | |
format: uuid | |
description: A unique value identifying this collection import. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub V3 Collections' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionImportDetailResponse' | |
description: '' | |
/api/automation-hub/v3/namespaces/: | |
get: | |
operationId: api_automation_hub_v3_namespaces_list | |
description: '' | |
summary: List namespaces | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub Namespaces' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/NamespaceResponse' | |
description: '' | |
post: | |
operationId: api_automation_hub_v3_namespaces_create | |
description: Override to also create inbound pulp repository and distribution. | |
summary: Create a namespace | |
tags: | |
- 'Api: Automation-Hub Namespaces' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Namespace' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Namespace' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Namespace' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceResponse' | |
description: '' | |
/api/automation-hub/v3/namespaces/{name}/: | |
get: | |
operationId: api_automation_hub_v3_namespaces_read | |
description: '' | |
summary: Inspect a namespace | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Api: Automation-Hub Namespaces' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceResponse' | |
description: '' | |
put: | |
operationId: api_automation_hub_v3_namespaces_update | |
description: '' | |
summary: Update a namespace | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
tags: | |
- 'Api: Automation-Hub Namespaces' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Namespace' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Namespace' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Namespace' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceResponse' | |
description: '' | |
patch: | |
operationId: api_automation_hub_v3_namespaces_partial_update | |
description: '' | |
summary: Update a namespace | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
tags: | |
- 'Api: Automation-Hub Namespaces' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/PatchedNamespace' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/PatchedNamespace' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/PatchedNamespace' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/NamespaceResponse' | |
description: '' | |
delete: | |
operationId: api_automation_hub_v3_namespaces_delete | |
description: |- | |
Override to also delete inbound pulp repository and distribution. | |
RepositoryVersion objects get deleted on delete of AnsibleRepository. | |
summary: Delete a namespace | |
parameters: | |
- name: company | |
required: false | |
in: query | |
description: company | |
schema: | |
type: string | |
- name: keywords | |
required: false | |
in: query | |
description: keywords | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: sort | |
required: false | |
in: query | |
description: Ordering | |
schema: | |
type: string | |
enum: | |
- name | |
- -name | |
- company | |
- -company | |
- id | |
- -id | |
tags: | |
- 'Api: Automation-Hub Namespaces' | |
responses: | |
'204': | |
description: No response body | |
/api/automation-hub/v3/tasks/: | |
get: | |
operationId: tasks_list | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: List tasks | |
parameters: | |
- name: child_tasks | |
required: false | |
in: query | |
description: child_tasks | |
schema: | |
type: string | |
- name: created_resources | |
required: false | |
in: query | |
description: created_resources | |
schema: | |
type: string | |
- name: finished_at | |
required: false | |
in: query | |
description: finished_at | |
schema: | |
type: string | |
- name: finished_at__gt | |
required: false | |
in: query | |
description: finished_at__gt | |
schema: | |
type: string | |
- name: finished_at__gte | |
required: false | |
in: query | |
description: finished_at__gte | |
schema: | |
type: string | |
- name: finished_at__lt | |
required: false | |
in: query | |
description: finished_at__lt | |
schema: | |
type: string | |
- name: finished_at__lte | |
required: false | |
in: query | |
description: finished_at__lte | |
schema: | |
type: string | |
- name: finished_at__range | |
required: false | |
in: query | |
description: finished_at__range | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__contains | |
required: false | |
in: query | |
description: name__contains | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: parent_task | |
required: false | |
in: query | |
description: parent_task | |
schema: | |
type: string | |
- name: reserved_resources_record | |
required: false | |
in: query | |
description: reserved_resources_record | |
schema: | |
type: string | |
- name: started_at | |
required: false | |
in: query | |
description: started_at | |
schema: | |
type: string | |
- name: started_at__gt | |
required: false | |
in: query | |
description: started_at__gt | |
schema: | |
type: string | |
- name: started_at__gte | |
required: false | |
in: query | |
description: started_at__gte | |
schema: | |
type: string | |
- name: started_at__lt | |
required: false | |
in: query | |
description: started_at__lt | |
schema: | |
type: string | |
- name: started_at__lte | |
required: false | |
in: query | |
description: started_at__lte | |
schema: | |
type: string | |
- name: started_at__range | |
required: false | |
in: query | |
description: started_at__range | |
schema: | |
type: string | |
- name: state | |
required: false | |
in: query | |
description: state | |
schema: | |
type: string | |
- name: state__in | |
required: false | |
in: query | |
description: state__in | |
schema: | |
type: string | |
- name: task_group | |
required: false | |
in: query | |
description: task_group | |
schema: | |
type: string | |
- name: worker | |
required: false | |
in: query | |
description: worker | |
schema: | |
type: string | |
- name: worker__in | |
required: false | |
in: query | |
description: worker__in | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Tasks | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/galaxy.LoginResponse' | |
description: '' | |
/api/automation-hub/v3/tasks/{pulp_id}/: | |
get: | |
operationId: tasks_read | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: Inspect a task | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this task. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Tasks | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/galaxy.LoginResponse' | |
description: '' | |
/pulp/api/v3/access_policies/: | |
get: | |
operationId: access_policies_list | |
description: |- | |
ViewSet for AccessPolicy. | |
NOTE: This API endpoint is in "tech preview" and subject to change | |
summary: List access policys | |
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 | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Access_Policies | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/AccessPolicyResponse' | |
description: '' | |
/pulp/api/v3/access_policies/{pulp_id}/: | |
get: | |
operationId: access_policies_read | |
description: |- | |
ViewSet for AccessPolicy. | |
NOTE: This API endpoint is in "tech preview" and subject to change | |
summary: Inspect an access policy | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this access policy. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Access_Policies | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AccessPolicyResponse' | |
description: '' | |
put: | |
operationId: access_policies_update | |
description: |- | |
ViewSet for AccessPolicy. | |
NOTE: This API endpoint is in "tech preview" and subject to change | |
summary: Update an access policy | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this access policy. | |
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: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AccessPolicyResponse' | |
description: '' | |
patch: | |
operationId: access_policies_partial_update | |
description: |- | |
ViewSet for AccessPolicy. | |
NOTE: This API endpoint is in "tech preview" and subject to change | |
summary: Update an access policy | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this access policy. | |
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: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AccessPolicyResponse' | |
description: '' | |
/pulp/api/v3/ansible/collections/: | |
get: | |
operationId: ansible_collections_list | |
description: Viewset for Ansible Collections. | |
summary: List collections | |
parameters: | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Ansible: Collections' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/ansible.CollectionResponse' | |
description: '' | |
/pulp/api/v3/ansible/collections/{pulp_id}/: | |
get: | |
operationId: ansible_collections_read | |
description: Viewset for Ansible Collections. | |
summary: Inspect a collection | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this collection. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Ansible: Collections' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionResponse' | |
description: '' | |
/pulp/api/v3/artifacts/: | |
get: | |
operationId: artifacts_list | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
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 | |
- name: md5 | |
required: false | |
in: query | |
description: md5 | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: repository_version | |
required: false | |
in: query | |
description: repository_version | |
schema: | |
type: string | |
- name: sha1 | |
required: false | |
in: query | |
description: sha1 | |
schema: | |
type: string | |
- name: sha224 | |
required: false | |
in: query | |
description: sha224 | |
schema: | |
type: string | |
- name: sha256 | |
required: false | |
in: query | |
description: sha256 | |
schema: | |
type: string | |
- name: sha384 | |
required: false | |
in: query | |
description: sha384 | |
schema: | |
type: string | |
- name: sha512 | |
required: false | |
in: query | |
description: sha512 | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Artifacts | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/ArtifactResponse' | |
description: '' | |
post: | |
operationId: artifacts_create | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: Create an artifact | |
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: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ArtifactResponse' | |
description: '' | |
/pulp/api/v3/artifacts/{pulp_id}/: | |
get: | |
operationId: artifacts_read | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: Inspect an artifact | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this artifact. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Artifacts | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
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: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this artifact. | |
required: true | |
tags: | |
- Artifacts | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'204': | |
description: No response body | |
/pulp/api/v3/content/ansible/collection_versions/: | |
get: | |
operationId: content_ansible_collection_versions_list | |
description: ViewSet for Ansible Collection. | |
summary: List collection versions | |
parameters: | |
- name: certification | |
required: false | |
in: query | |
description: certification | |
schema: | |
type: string | |
enum: | |
- certified | |
- not_certified | |
- needs_review | |
- name: deprecated | |
required: false | |
in: query | |
description: deprecated | |
schema: | |
type: string | |
- name: is_highest | |
required: false | |
in: query | |
description: is_highest | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: q | |
required: false | |
in: query | |
description: q | |
schema: | |
type: string | |
- name: repository_version | |
required: false | |
in: query | |
description: repository_version | |
schema: | |
type: string | |
- name: repository_version_added | |
required: false | |
in: query | |
description: repository_version_added | |
schema: | |
type: string | |
- name: repository_version_removed | |
required: false | |
in: query | |
description: repository_version_removed | |
schema: | |
type: string | |
- name: tags | |
required: false | |
in: query | |
description: tags | |
schema: | |
type: string | |
- name: version | |
required: false | |
in: query | |
description: version | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Content: Collection_Versions' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/ansible.CollectionVersionResponse' | |
description: '' | |
post: | |
operationId: content_ansible_collection_versions_create | |
description: ViewSet for Ansible Collection. | |
summary: Create a collection version | |
tags: | |
- 'Content: Collection_Versions' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionVersion' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionVersion' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionVersion' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionVersionResponse' | |
description: '' | |
/pulp/api/v3/content/ansible/collection_versions/{pulp_id}/: | |
get: | |
operationId: content_ansible_collection_versions_read | |
description: ViewSet for Ansible Collection. | |
summary: Inspect a collection version | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this collection version. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Content: Collection_Versions' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionVersionResponse' | |
description: '' | |
/pulp/api/v3/content/ansible/roles/: | |
get: | |
operationId: content_ansible_roles_list | |
description: ViewSet for Role. | |
summary: List roles | |
parameters: | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: repository_version | |
required: false | |
in: query | |
description: repository_version | |
schema: | |
type: string | |
- name: repository_version_added | |
required: false | |
in: query | |
description: repository_version_added | |
schema: | |
type: string | |
- name: repository_version_removed | |
required: false | |
in: query | |
description: repository_version_removed | |
schema: | |
type: string | |
- name: version | |
required: false | |
in: query | |
description: version | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Content: Roles' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/ansible.RoleResponse' | |
description: '' | |
post: | |
operationId: content_ansible_roles_create | |
description: ViewSet for Role. | |
summary: Create a role | |
tags: | |
- 'Content: Roles' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.Role' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/ansible.Role' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/ansible.Role' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.RoleResponse' | |
description: '' | |
/pulp/api/v3/content/ansible/roles/{pulp_id}/: | |
get: | |
operationId: content_ansible_roles_read | |
description: ViewSet for Role. | |
summary: Inspect a role | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this role. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Content: Roles' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.RoleResponse' | |
description: '' | |
/pulp/api/v3/content/container/blobs/: | |
get: | |
operationId: content_container_blobs_list | |
description: ViewSet for Blobs. | |
summary: List blobs | |
parameters: | |
- name: digest | |
required: false | |
in: query | |
description: digest | |
schema: | |
type: string | |
- name: digest__in | |
required: false | |
in: query | |
description: digest__in | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: media_type | |
required: false | |
in: query | |
description: media_type | |
schema: | |
type: string | |
enum: | |
- application/vnd.docker.container.image.v1+json | |
- application/vnd.docker.image.rootfs.diff.tar.gzip | |
- application/vnd.docker.image.rootfs.foreign.diff.tar.gzip | |
- application/vnd.oci.image.config.v1+json | |
- application/vnd.oci.image.layer.v1.tar+gzip | |
- application/vnd.oci.image.layer.nondistributable.v1.tar+gzip | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: repository_version | |
required: false | |
in: query | |
description: repository_version | |
schema: | |
type: string | |
- name: repository_version_added | |
required: false | |
in: query | |
description: repository_version_added | |
schema: | |
type: string | |
- name: repository_version_removed | |
required: false | |
in: query | |
description: repository_version_removed | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Content: Blobs' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/container.BlobResponse' | |
description: '' | |
/pulp/api/v3/content/container/blobs/{pulp_id}/: | |
get: | |
operationId: content_container_blobs_read | |
description: ViewSet for Blobs. | |
summary: Inspect a blob | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this blob. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Content: Blobs' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.BlobResponse' | |
description: '' | |
/pulp/api/v3/content/container/manifests/: | |
get: | |
operationId: content_container_manifests_list | |
description: ViewSet for Manifest. | |
summary: List manifests | |
parameters: | |
- name: digest | |
required: false | |
in: query | |
description: digest | |
schema: | |
type: string | |
- name: digest__in | |
required: false | |
in: query | |
description: digest__in | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: media_type | |
required: false | |
in: query | |
description: media_type | |
schema: | |
type: string | |
enum: | |
- application/vnd.docker.distribution.manifest.v1+json | |
- application/vnd.docker.distribution.manifest.v2+json | |
- application/vnd.docker.distribution.manifest.list.v2+json | |
- application/vnd.oci.image.manifest.v1+json | |
- application/vnd.oci.image.index.v1+json | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: repository_version | |
required: false | |
in: query | |
description: repository_version | |
schema: | |
type: string | |
- name: repository_version_added | |
required: false | |
in: query | |
description: repository_version_added | |
schema: | |
type: string | |
- name: repository_version_removed | |
required: false | |
in: query | |
description: repository_version_removed | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Content: Manifests' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/container.ManifestResponse' | |
description: '' | |
/pulp/api/v3/content/container/manifests/{pulp_id}/: | |
get: | |
operationId: content_container_manifests_read | |
description: ViewSet for Manifest. | |
summary: Inspect a manifest | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this manifest. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Content: Manifests' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ManifestResponse' | |
description: '' | |
/pulp/api/v3/content/container/tags/: | |
get: | |
operationId: content_container_tags_list | |
description: ViewSet for Tag. | |
summary: List tags | |
parameters: | |
- name: digest | |
required: false | |
in: query | |
description: digest | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: media_type | |
required: false | |
in: query | |
description: media_type | |
schema: | |
type: string | |
enum: | |
- application/vnd.docker.distribution.manifest.v1+json | |
- application/vnd.docker.distribution.manifest.v2+json | |
- application/vnd.docker.distribution.manifest.list.v2+json | |
- application/vnd.oci.image.manifest.v1+json | |
- application/vnd.oci.image.index.v1+json | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: repository_version | |
required: false | |
in: query | |
description: repository_version | |
schema: | |
type: string | |
- name: repository_version_added | |
required: false | |
in: query | |
description: repository_version_added | |
schema: | |
type: string | |
- name: repository_version_removed | |
required: false | |
in: query | |
description: repository_version_removed | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Content: Tags' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/container.TagResponse' | |
description: '' | |
/pulp/api/v3/content/container/tags/{pulp_id}/: | |
get: | |
operationId: content_container_tags_read | |
description: ViewSet for Tag. | |
summary: Inspect a tag | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this tag. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Content: Tags' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.TagResponse' | |
description: '' | |
/pulp/api/v3/contentguards/container/content_redirect/: | |
get: | |
operationId: contentguards_container_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 | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Contentguards: Content_Redirect' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/container.ContentRedirectContentGuardResponse' | |
description: '' | |
post: | |
operationId: contentguards_container_content_redirect_create | |
description: Content guard to protect preauthenticated redirects to the content | |
app. | |
summary: Create a content redirect content guard | |
tags: | |
- 'Contentguards: Content_Redirect' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContentRedirectContentGuard' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/container.ContentRedirectContentGuard' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/container.ContentRedirectContentGuard' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContentRedirectContentGuardResponse' | |
description: '' | |
/pulp/api/v3/contentguards/container/content_redirect/{pulp_id}/: | |
get: | |
operationId: contentguards_container_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: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this content redirect content guard. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Contentguards: Content_Redirect' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContentRedirectContentGuardResponse' | |
description: '' | |
put: | |
operationId: contentguards_container_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: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this content redirect content guard. | |
required: true | |
tags: | |
- 'Contentguards: Content_Redirect' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContentRedirectContentGuard' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/container.ContentRedirectContentGuard' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/container.ContentRedirectContentGuard' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContentRedirectContentGuardResponse' | |
description: '' | |
patch: | |
operationId: contentguards_container_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: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this content redirect content guard. | |
required: true | |
tags: | |
- 'Contentguards: Content_Redirect' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Patchedcontainer.ContentRedirectContentGuard' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Patchedcontainer.ContentRedirectContentGuard' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Patchedcontainer.ContentRedirectContentGuard' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContentRedirectContentGuardResponse' | |
description: '' | |
delete: | |
operationId: contentguards_container_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: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this content redirect content guard. | |
required: true | |
tags: | |
- 'Contentguards: Content_Redirect' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'204': | |
description: No response body | |
/pulp/api/v3/distributions/ansible/ansible/: | |
get: | |
operationId: distributions_ansible_ansible_list | |
description: ViewSet for Ansible Distributions. | |
summary: List ansible distributions | |
parameters: | |
- name: base_path | |
required: false | |
in: query | |
description: base_path | |
schema: | |
type: string | |
- name: base_path__contains | |
required: false | |
in: query | |
description: base_path__contains | |
schema: | |
type: string | |
- name: base_path__icontains | |
required: false | |
in: query | |
description: base_path__icontains | |
schema: | |
type: string | |
- name: base_path__in | |
required: false | |
in: query | |
description: base_path__in | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Distributions: Ansible' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/ansible.AnsibleDistributionResponse' | |
description: '' | |
post: | |
operationId: distributions_ansible_ansible_create | |
description: Trigger an asynchronous create task | |
summary: Create an ansible distribution | |
tags: | |
- 'Distributions: Ansible' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleDistribution' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleDistribution' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleDistribution' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/distributions/ansible/ansible/{pulp_id}/: | |
get: | |
operationId: distributions_ansible_ansible_read | |
description: ViewSet for Ansible Distributions. | |
summary: Inspect an ansible distribution | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible distribution. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Distributions: Ansible' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleDistributionResponse' | |
description: '' | |
put: | |
operationId: distributions_ansible_ansible_update | |
description: Trigger an asynchronous update task | |
summary: Update an ansible distribution | |
parameters: | |
- name: base_path | |
required: false | |
in: query | |
description: base_path | |
schema: | |
type: string | |
- name: base_path__contains | |
required: false | |
in: query | |
description: base_path__contains | |
schema: | |
type: string | |
- name: base_path__icontains | |
required: false | |
in: query | |
description: base_path__icontains | |
schema: | |
type: string | |
- name: base_path__in | |
required: false | |
in: query | |
description: base_path__in | |
schema: | |
type: string | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible distribution. | |
required: true | |
tags: | |
- 'Distributions: Ansible' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleDistribution' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleDistribution' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleDistribution' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
patch: | |
operationId: distributions_ansible_ansible_partial_update | |
description: Trigger an asynchronous partial update task | |
summary: Update an ansible distribution | |
parameters: | |
- name: base_path | |
required: false | |
in: query | |
description: base_path | |
schema: | |
type: string | |
- name: base_path__contains | |
required: false | |
in: query | |
description: base_path__contains | |
schema: | |
type: string | |
- name: base_path__icontains | |
required: false | |
in: query | |
description: base_path__icontains | |
schema: | |
type: string | |
- name: base_path__in | |
required: false | |
in: query | |
description: base_path__in | |
schema: | |
type: string | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible distribution. | |
required: true | |
tags: | |
- 'Distributions: Ansible' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Patchedansible.AnsibleDistribution' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Patchedansible.AnsibleDistribution' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Patchedansible.AnsibleDistribution' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
delete: | |
operationId: distributions_ansible_ansible_delete | |
description: Trigger an asynchronous delete task | |
summary: Delete an ansible distribution | |
parameters: | |
- name: base_path | |
required: false | |
in: query | |
description: base_path | |
schema: | |
type: string | |
- name: base_path__contains | |
required: false | |
in: query | |
description: base_path__contains | |
schema: | |
type: string | |
- name: base_path__icontains | |
required: false | |
in: query | |
description: base_path__icontains | |
schema: | |
type: string | |
- name: base_path__in | |
required: false | |
in: query | |
description: base_path__in | |
schema: | |
type: string | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible distribution. | |
required: true | |
tags: | |
- 'Distributions: Ansible' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/distributions/container/container/: | |
get: | |
operationId: distributions_container_container_list | |
description: |- | |
The Container Distribution will serve the latest version of a Repository if | |
``repository`` is specified. The Container Distribution will serve a specific | |
repository version if ``repository_version``. Note that **either** | |
``repository`` or ``repository_version`` can be set on a Container | |
Distribution, but not both. | |
summary: List container distributions | |
parameters: | |
- name: base_path | |
required: false | |
in: query | |
description: base_path | |
schema: | |
type: string | |
- name: base_path__contains | |
required: false | |
in: query | |
description: base_path__contains | |
schema: | |
type: string | |
- name: base_path__icontains | |
required: false | |
in: query | |
description: base_path__icontains | |
schema: | |
type: string | |
- name: base_path__in | |
required: false | |
in: query | |
description: base_path__in | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Distributions: Container' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/container.ContainerDistributionResponse' | |
description: '' | |
post: | |
operationId: distributions_container_container_create | |
description: Trigger an asynchronous create task | |
summary: Create a container distribution | |
tags: | |
- 'Distributions: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerDistribution' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/container.ContainerDistribution' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/container.ContainerDistribution' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/distributions/container/container/{pulp_id}/: | |
get: | |
operationId: distributions_container_container_read | |
description: |- | |
The Container Distribution will serve the latest version of a Repository if | |
``repository`` is specified. The Container Distribution will serve a specific | |
repository version if ``repository_version``. Note that **either** | |
``repository`` or ``repository_version`` can be set on a Container | |
Distribution, but not both. | |
summary: Inspect a container distribution | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container distribution. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Distributions: Container' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerDistributionResponse' | |
description: '' | |
put: | |
operationId: distributions_container_container_update | |
description: Trigger an asynchronous update task | |
summary: Update a container distribution | |
parameters: | |
- name: base_path | |
required: false | |
in: query | |
description: base_path | |
schema: | |
type: string | |
- name: base_path__contains | |
required: false | |
in: query | |
description: base_path__contains | |
schema: | |
type: string | |
- name: base_path__icontains | |
required: false | |
in: query | |
description: base_path__icontains | |
schema: | |
type: string | |
- name: base_path__in | |
required: false | |
in: query | |
description: base_path__in | |
schema: | |
type: string | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container distribution. | |
required: true | |
tags: | |
- 'Distributions: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerDistribution' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/container.ContainerDistribution' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/container.ContainerDistribution' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
patch: | |
operationId: distributions_container_container_partial_update | |
description: Trigger an asynchronous partial update task | |
summary: Update a container distribution | |
parameters: | |
- name: base_path | |
required: false | |
in: query | |
description: base_path | |
schema: | |
type: string | |
- name: base_path__contains | |
required: false | |
in: query | |
description: base_path__contains | |
schema: | |
type: string | |
- name: base_path__icontains | |
required: false | |
in: query | |
description: base_path__icontains | |
schema: | |
type: string | |
- name: base_path__in | |
required: false | |
in: query | |
description: base_path__in | |
schema: | |
type: string | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container distribution. | |
required: true | |
tags: | |
- 'Distributions: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Patchedcontainer.ContainerDistribution' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Patchedcontainer.ContainerDistribution' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Patchedcontainer.ContainerDistribution' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
delete: | |
operationId: distributions_container_container_delete | |
description: Trigger an asynchronous delete task | |
summary: Delete a container distribution | |
parameters: | |
- name: base_path | |
required: false | |
in: query | |
description: base_path | |
schema: | |
type: string | |
- name: base_path__contains | |
required: false | |
in: query | |
description: base_path__contains | |
schema: | |
type: string | |
- name: base_path__icontains | |
required: false | |
in: query | |
description: base_path__icontains | |
schema: | |
type: string | |
- name: base_path__in | |
required: false | |
in: query | |
description: base_path__in | |
schema: | |
type: string | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container distribution. | |
required: true | |
tags: | |
- 'Distributions: Container' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/docs/api.json: | |
get: | |
operationId: pulp_api_v3_docs_api.json_read | |
description: |- | |
OpenApi3 schema for this API. Format can be selected via content negotiation. | |
- YAML: application/vnd.oai.openapi | |
- JSON: application/vnd.oai.openapi+json | |
parameters: | |
- in: query | |
name: lang | |
schema: | |
type: string | |
enum: | |
- af | |
- ar | |
- ast | |
- az | |
- be | |
- bg | |
- bn | |
- br | |
- bs | |
- ca | |
- cs | |
- cy | |
- da | |
- de | |
- dsb | |
- el | |
- en | |
- en-au | |
- en-gb | |
- eo | |
- es | |
- es-ar | |
- es-co | |
- es-mx | |
- es-ni | |
- es-ve | |
- et | |
- eu | |
- fa | |
- fi | |
- fr | |
- fy | |
- ga | |
- gd | |
- gl | |
- he | |
- hi | |
- hr | |
- hsb | |
- hu | |
- hy | |
- ia | |
- id | |
- io | |
- is | |
- it | |
- ja | |
- ka | |
- kab | |
- kk | |
- km | |
- kn | |
- ko | |
- lb | |
- lt | |
- lv | |
- mk | |
- ml | |
- mn | |
- mr | |
- my | |
- nb | |
- ne | |
- nl | |
- nn | |
- os | |
- pa | |
- pl | |
- pt | |
- pt-br | |
- ro | |
- ru | |
- sk | |
- sl | |
- sq | |
- sr | |
- sr-latn | |
- sv | |
- sw | |
- ta | |
- te | |
- th | |
- tr | |
- tt | |
- udm | |
- uk | |
- ur | |
- vi | |
- zh-hans | |
- zh-hant | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Docs: Api.Json' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
- {} | |
responses: | |
'200': | |
content: | |
application/vnd.oai.openapi+json: | |
schema: | |
type: object | |
additionalProperties: {} | |
application/json: | |
schema: | |
type: object | |
additionalProperties: {} | |
description: '' | |
/pulp/api/v3/docs/api.yaml: | |
get: | |
operationId: pulp_api_v3_docs_api.yaml_read | |
description: |- | |
OpenApi3 schema for this API. Format can be selected via content negotiation. | |
- YAML: application/vnd.oai.openapi | |
- JSON: application/vnd.oai.openapi+json | |
parameters: | |
- in: query | |
name: lang | |
schema: | |
type: string | |
enum: | |
- af | |
- ar | |
- ast | |
- az | |
- be | |
- bg | |
- bn | |
- br | |
- bs | |
- ca | |
- cs | |
- cy | |
- da | |
- de | |
- dsb | |
- el | |
- en | |
- en-au | |
- en-gb | |
- eo | |
- es | |
- es-ar | |
- es-co | |
- es-mx | |
- es-ni | |
- es-ve | |
- et | |
- eu | |
- fa | |
- fi | |
- fr | |
- fy | |
- ga | |
- gd | |
- gl | |
- he | |
- hi | |
- hr | |
- hsb | |
- hu | |
- hy | |
- ia | |
- id | |
- io | |
- is | |
- it | |
- ja | |
- ka | |
- kab | |
- kk | |
- km | |
- kn | |
- ko | |
- lb | |
- lt | |
- lv | |
- mk | |
- ml | |
- mn | |
- mr | |
- my | |
- nb | |
- ne | |
- nl | |
- nn | |
- os | |
- pa | |
- pl | |
- pt | |
- pt-br | |
- ro | |
- ru | |
- sk | |
- sl | |
- sq | |
- sr | |
- sr-latn | |
- sv | |
- sw | |
- ta | |
- te | |
- th | |
- tr | |
- tt | |
- udm | |
- uk | |
- ur | |
- vi | |
- zh-hans | |
- zh-hant | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Docs: Api.Yaml' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
- {} | |
responses: | |
'200': | |
content: | |
application/vnd.oai.openapi: | |
schema: | |
type: object | |
additionalProperties: {} | |
application/yaml: | |
schema: | |
type: object | |
additionalProperties: {} | |
description: '' | |
/pulp/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 | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Exporters: Pulp' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/PulpExporterResponse' | |
description: '' | |
post: | |
operationId: exporters_core_pulp_create | |
description: ViewSet for viewing PulpExporters. | |
summary: Create a pulp exporter | |
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: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/PulpExporterResponse' | |
description: '' | |
/pulp/api/v3/exporters/core/pulp/{exporter_pk}/exports/: | |
get: | |
operationId: exporters_core_pulp_exports_list | |
description: ViewSet for viewing exports from a PulpExporter. | |
summary: List pulp exports | |
parameters: | |
- in: path | |
name: exporter_pk | |
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 | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Exporters: Core Exports' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/PulpExportResponse' | |
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: exporter_pk | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Exporters: Core 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: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/exporters/core/pulp/{exporter_pk}/exports/{pulp_id}/: | |
get: | |
operationId: exporters_core_pulp_exports_read | |
description: ViewSet for viewing exports from a PulpExporter. | |
summary: Inspect a pulp export | |
parameters: | |
- in: path | |
name: exporter_pk | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this pulp export. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Exporters: Core Exports' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
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: exporter_pk | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this pulp export. | |
required: true | |
tags: | |
- 'Exporters: Core Exports' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'204': | |
description: No response body | |
/pulp/api/v3/exporters/core/pulp/{pulp_id}/: | |
get: | |
operationId: exporters_core_pulp_read | |
description: ViewSet for viewing PulpExporters. | |
summary: Inspect a pulp exporter | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this pulp exporter. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Exporters: Pulp' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/PulpExporterResponse' | |
description: '' | |
put: | |
operationId: exporters_core_pulp_update | |
description: ViewSet for viewing PulpExporters. | |
summary: Update a pulp exporter | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this pulp exporter. | |
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: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/PulpExporterResponse' | |
description: '' | |
patch: | |
operationId: exporters_core_pulp_partial_update | |
description: ViewSet for viewing PulpExporters. | |
summary: Update a pulp exporter | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this pulp exporter. | |
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: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/PulpExporterResponse' | |
description: '' | |
delete: | |
operationId: exporters_core_pulp_delete | |
description: ViewSet for viewing PulpExporters. | |
summary: Delete a pulp exporter | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this pulp exporter. | |
required: true | |
tags: | |
- 'Exporters: Pulp' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'204': | |
description: No response body | |
/pulp/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 | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Importers: Pulp' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/PulpImporterResponse' | |
description: '' | |
post: | |
operationId: importers_core_pulp_create | |
description: ViewSet for PulpImporters. | |
summary: Create a pulp importer | |
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: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/PulpImporterResponse' | |
description: '' | |
/pulp/api/v3/importers/core/pulp/{importer_pk}/imports/: | |
get: | |
operationId: importers_core_pulp_imports_list | |
description: ViewSet for PulpImports. | |
summary: List pulp imports | |
parameters: | |
- in: path | |
name: importer_pk | |
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 | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Importers: Core Imports' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/ImportResponse' | |
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: importer_pk | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Importers: Core 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: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/importers/core/pulp/{importer_pk}/imports/{pulp_id}/: | |
get: | |
operationId: importers_core_pulp_imports_read | |
description: ViewSet for PulpImports. | |
summary: Inspect a pulp import | |
parameters: | |
- in: path | |
name: importer_pk | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this pulp import. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Importers: Core Imports' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
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: importer_pk | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this pulp import. | |
required: true | |
tags: | |
- 'Importers: Core Imports' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'204': | |
description: No response body | |
/pulp/api/v3/importers/core/pulp/{pulp_id}/: | |
get: | |
operationId: importers_core_pulp_read | |
description: ViewSet for PulpImporters. | |
summary: Inspect a pulp importer | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this pulp importer. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Importers: Pulp' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
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_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this pulp importer. | |
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: | |
- cookieAuth: [] | |
- basicAuth: [] | |
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_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this pulp importer. | |
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: | |
- cookieAuth: [] | |
- basicAuth: [] | |
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_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this pulp importer. | |
required: true | |
tags: | |
- 'Importers: Pulp' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'204': | |
description: No response body | |
/pulp/api/v3/orphans/: | |
delete: | |
operationId: pulp_api_v3_orphans_delete | |
description: Trigger an asynchronous task that deletes allorphaned content and | |
artifacts. | |
summary: Delete orphans | |
tags: | |
- Orphans | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/pulp_ansible/tags/: | |
get: | |
operationId: pulp_ansible_tags_list | |
description: ViewSet for Tag models. | |
summary: List tags | |
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 | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Tags' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/TagResponse' | |
description: '' | |
/pulp/api/v3/remotes/ansible/ansible/: | |
get: | |
operationId: remotes_ansible_ansible_list | |
description: ViewSet for Ansible Remotes. | |
summary: List ansible remotes | |
parameters: | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: pulp_last_updated | |
required: false | |
in: query | |
description: pulp_last_updated | |
schema: | |
type: string | |
- name: pulp_last_updated__gt | |
required: false | |
in: query | |
description: pulp_last_updated__gt | |
schema: | |
type: string | |
- name: pulp_last_updated__gte | |
required: false | |
in: query | |
description: pulp_last_updated__gte | |
schema: | |
type: string | |
- name: pulp_last_updated__lt | |
required: false | |
in: query | |
description: pulp_last_updated__lt | |
schema: | |
type: string | |
- name: pulp_last_updated__lte | |
required: false | |
in: query | |
description: pulp_last_updated__lte | |
schema: | |
type: string | |
- name: pulp_last_updated__range | |
required: false | |
in: query | |
description: pulp_last_updated__range | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Remotes: Ansible' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/ansible.AnsibleRemoteResponse' | |
description: '' | |
post: | |
operationId: remotes_ansible_ansible_create | |
description: ViewSet for Ansible Remotes. | |
summary: Create an ansible remote | |
tags: | |
- 'Remotes: Ansible' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRemote' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRemote' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRemote' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRemoteResponse' | |
description: '' | |
/pulp/api/v3/remotes/ansible/ansible/{pulp_id}/: | |
get: | |
operationId: remotes_ansible_ansible_read | |
description: ViewSet for Ansible Remotes. | |
summary: Inspect an ansible remote | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible remote. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Remotes: Ansible' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRemoteResponse' | |
description: '' | |
put: | |
operationId: remotes_ansible_ansible_update | |
description: Trigger an asynchronous update task | |
summary: Update an ansible remote | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible remote. | |
required: true | |
- name: pulp_last_updated | |
required: false | |
in: query | |
description: pulp_last_updated | |
schema: | |
type: string | |
- name: pulp_last_updated__gt | |
required: false | |
in: query | |
description: pulp_last_updated__gt | |
schema: | |
type: string | |
- name: pulp_last_updated__gte | |
required: false | |
in: query | |
description: pulp_last_updated__gte | |
schema: | |
type: string | |
- name: pulp_last_updated__lt | |
required: false | |
in: query | |
description: pulp_last_updated__lt | |
schema: | |
type: string | |
- name: pulp_last_updated__lte | |
required: false | |
in: query | |
description: pulp_last_updated__lte | |
schema: | |
type: string | |
- name: pulp_last_updated__range | |
required: false | |
in: query | |
description: pulp_last_updated__range | |
schema: | |
type: string | |
tags: | |
- 'Remotes: Ansible' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRemote' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRemote' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRemote' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
patch: | |
operationId: remotes_ansible_ansible_partial_update | |
description: Trigger an asynchronous partial update task | |
summary: Update an ansible remote | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible remote. | |
required: true | |
- name: pulp_last_updated | |
required: false | |
in: query | |
description: pulp_last_updated | |
schema: | |
type: string | |
- name: pulp_last_updated__gt | |
required: false | |
in: query | |
description: pulp_last_updated__gt | |
schema: | |
type: string | |
- name: pulp_last_updated__gte | |
required: false | |
in: query | |
description: pulp_last_updated__gte | |
schema: | |
type: string | |
- name: pulp_last_updated__lt | |
required: false | |
in: query | |
description: pulp_last_updated__lt | |
schema: | |
type: string | |
- name: pulp_last_updated__lte | |
required: false | |
in: query | |
description: pulp_last_updated__lte | |
schema: | |
type: string | |
- name: pulp_last_updated__range | |
required: false | |
in: query | |
description: pulp_last_updated__range | |
schema: | |
type: string | |
tags: | |
- 'Remotes: Ansible' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Patchedansible.AnsibleRemote' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Patchedansible.AnsibleRemote' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Patchedansible.AnsibleRemote' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
delete: | |
operationId: remotes_ansible_ansible_delete | |
description: Trigger an asynchronous delete task | |
summary: Delete an ansible remote | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible remote. | |
required: true | |
- name: pulp_last_updated | |
required: false | |
in: query | |
description: pulp_last_updated | |
schema: | |
type: string | |
- name: pulp_last_updated__gt | |
required: false | |
in: query | |
description: pulp_last_updated__gt | |
schema: | |
type: string | |
- name: pulp_last_updated__gte | |
required: false | |
in: query | |
description: pulp_last_updated__gte | |
schema: | |
type: string | |
- name: pulp_last_updated__lt | |
required: false | |
in: query | |
description: pulp_last_updated__lt | |
schema: | |
type: string | |
- name: pulp_last_updated__lte | |
required: false | |
in: query | |
description: pulp_last_updated__lte | |
schema: | |
type: string | |
- name: pulp_last_updated__range | |
required: false | |
in: query | |
description: pulp_last_updated__range | |
schema: | |
type: string | |
tags: | |
- 'Remotes: Ansible' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/remotes/ansible/collection/: | |
get: | |
operationId: remotes_ansible_collection_list | |
description: ViewSet for Collection Remotes. | |
summary: List collection remotes | |
parameters: | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: pulp_last_updated | |
required: false | |
in: query | |
description: pulp_last_updated | |
schema: | |
type: string | |
- name: pulp_last_updated__gt | |
required: false | |
in: query | |
description: pulp_last_updated__gt | |
schema: | |
type: string | |
- name: pulp_last_updated__gte | |
required: false | |
in: query | |
description: pulp_last_updated__gte | |
schema: | |
type: string | |
- name: pulp_last_updated__lt | |
required: false | |
in: query | |
description: pulp_last_updated__lt | |
schema: | |
type: string | |
- name: pulp_last_updated__lte | |
required: false | |
in: query | |
description: pulp_last_updated__lte | |
schema: | |
type: string | |
- name: pulp_last_updated__range | |
required: false | |
in: query | |
description: pulp_last_updated__range | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Remotes: Collection' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/ansible.CollectionRemoteResponse' | |
description: '' | |
post: | |
operationId: remotes_ansible_collection_create | |
description: ViewSet for Collection Remotes. | |
summary: Create a collection remote | |
tags: | |
- 'Remotes: Collection' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionRemote' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionRemote' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionRemote' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionRemoteResponse' | |
description: '' | |
/pulp/api/v3/remotes/ansible/collection/{pulp_id}/: | |
get: | |
operationId: remotes_ansible_collection_read | |
description: ViewSet for Collection Remotes. | |
summary: Inspect a collection remote | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this collection remote. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Remotes: Collection' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionRemoteResponse' | |
description: '' | |
put: | |
operationId: remotes_ansible_collection_update | |
description: Trigger an asynchronous update task | |
summary: Update a collection remote | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this collection remote. | |
required: true | |
- name: pulp_last_updated | |
required: false | |
in: query | |
description: pulp_last_updated | |
schema: | |
type: string | |
- name: pulp_last_updated__gt | |
required: false | |
in: query | |
description: pulp_last_updated__gt | |
schema: | |
type: string | |
- name: pulp_last_updated__gte | |
required: false | |
in: query | |
description: pulp_last_updated__gte | |
schema: | |
type: string | |
- name: pulp_last_updated__lt | |
required: false | |
in: query | |
description: pulp_last_updated__lt | |
schema: | |
type: string | |
- name: pulp_last_updated__lte | |
required: false | |
in: query | |
description: pulp_last_updated__lte | |
schema: | |
type: string | |
- name: pulp_last_updated__range | |
required: false | |
in: query | |
description: pulp_last_updated__range | |
schema: | |
type: string | |
tags: | |
- 'Remotes: Collection' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionRemote' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionRemote' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/ansible.CollectionRemote' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
patch: | |
operationId: remotes_ansible_collection_partial_update | |
description: Trigger an asynchronous partial update task | |
summary: Update a collection remote | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this collection remote. | |
required: true | |
- name: pulp_last_updated | |
required: false | |
in: query | |
description: pulp_last_updated | |
schema: | |
type: string | |
- name: pulp_last_updated__gt | |
required: false | |
in: query | |
description: pulp_last_updated__gt | |
schema: | |
type: string | |
- name: pulp_last_updated__gte | |
required: false | |
in: query | |
description: pulp_last_updated__gte | |
schema: | |
type: string | |
- name: pulp_last_updated__lt | |
required: false | |
in: query | |
description: pulp_last_updated__lt | |
schema: | |
type: string | |
- name: pulp_last_updated__lte | |
required: false | |
in: query | |
description: pulp_last_updated__lte | |
schema: | |
type: string | |
- name: pulp_last_updated__range | |
required: false | |
in: query | |
description: pulp_last_updated__range | |
schema: | |
type: string | |
tags: | |
- 'Remotes: Collection' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Patchedansible.CollectionRemote' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Patchedansible.CollectionRemote' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Patchedansible.CollectionRemote' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
delete: | |
operationId: remotes_ansible_collection_delete | |
description: Trigger an asynchronous delete task | |
summary: Delete a collection remote | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this collection remote. | |
required: true | |
- name: pulp_last_updated | |
required: false | |
in: query | |
description: pulp_last_updated | |
schema: | |
type: string | |
- name: pulp_last_updated__gt | |
required: false | |
in: query | |
description: pulp_last_updated__gt | |
schema: | |
type: string | |
- name: pulp_last_updated__gte | |
required: false | |
in: query | |
description: pulp_last_updated__gte | |
schema: | |
type: string | |
- name: pulp_last_updated__lt | |
required: false | |
in: query | |
description: pulp_last_updated__lt | |
schema: | |
type: string | |
- name: pulp_last_updated__lte | |
required: false | |
in: query | |
description: pulp_last_updated__lte | |
schema: | |
type: string | |
- name: pulp_last_updated__range | |
required: false | |
in: query | |
description: pulp_last_updated__range | |
schema: | |
type: string | |
tags: | |
- 'Remotes: Collection' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/remotes/container/container/: | |
get: | |
operationId: remotes_container_container_list | |
description: |- | |
Container remotes represent an external repository that implements the Container | |
Registry API. Container remotes support deferred downloading by configuring | |
the ``policy`` field. ``on_demand`` and ``streamed`` policies can provide | |
significant disk space savings. | |
summary: List container remotes | |
parameters: | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: pulp_last_updated | |
required: false | |
in: query | |
description: pulp_last_updated | |
schema: | |
type: string | |
- name: pulp_last_updated__gt | |
required: false | |
in: query | |
description: pulp_last_updated__gt | |
schema: | |
type: string | |
- name: pulp_last_updated__gte | |
required: false | |
in: query | |
description: pulp_last_updated__gte | |
schema: | |
type: string | |
- name: pulp_last_updated__lt | |
required: false | |
in: query | |
description: pulp_last_updated__lt | |
schema: | |
type: string | |
- name: pulp_last_updated__lte | |
required: false | |
in: query | |
description: pulp_last_updated__lte | |
schema: | |
type: string | |
- name: pulp_last_updated__range | |
required: false | |
in: query | |
description: pulp_last_updated__range | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Remotes: Container' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/container.ContainerRemoteResponse' | |
description: '' | |
post: | |
operationId: remotes_container_container_create | |
description: |- | |
Container remotes represent an external repository that implements the Container | |
Registry API. Container remotes support deferred downloading by configuring | |
the ``policy`` field. ``on_demand`` and ``streamed`` policies can provide | |
significant disk space savings. | |
summary: Create a container remote | |
tags: | |
- 'Remotes: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRemote' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRemote' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRemote' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRemoteResponse' | |
description: '' | |
/pulp/api/v3/remotes/container/container/{pulp_id}/: | |
get: | |
operationId: remotes_container_container_read | |
description: |- | |
Container remotes represent an external repository that implements the Container | |
Registry API. Container remotes support deferred downloading by configuring | |
the ``policy`` field. ``on_demand`` and ``streamed`` policies can provide | |
significant disk space savings. | |
summary: Inspect a container remote | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container remote. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Remotes: Container' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRemoteResponse' | |
description: '' | |
put: | |
operationId: remotes_container_container_update | |
description: Trigger an asynchronous update task | |
summary: Update a container remote | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container remote. | |
required: true | |
- name: pulp_last_updated | |
required: false | |
in: query | |
description: pulp_last_updated | |
schema: | |
type: string | |
- name: pulp_last_updated__gt | |
required: false | |
in: query | |
description: pulp_last_updated__gt | |
schema: | |
type: string | |
- name: pulp_last_updated__gte | |
required: false | |
in: query | |
description: pulp_last_updated__gte | |
schema: | |
type: string | |
- name: pulp_last_updated__lt | |
required: false | |
in: query | |
description: pulp_last_updated__lt | |
schema: | |
type: string | |
- name: pulp_last_updated__lte | |
required: false | |
in: query | |
description: pulp_last_updated__lte | |
schema: | |
type: string | |
- name: pulp_last_updated__range | |
required: false | |
in: query | |
description: pulp_last_updated__range | |
schema: | |
type: string | |
tags: | |
- 'Remotes: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRemote' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRemote' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRemote' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
patch: | |
operationId: remotes_container_container_partial_update | |
description: Trigger an asynchronous partial update task | |
summary: Update a container remote | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container remote. | |
required: true | |
- name: pulp_last_updated | |
required: false | |
in: query | |
description: pulp_last_updated | |
schema: | |
type: string | |
- name: pulp_last_updated__gt | |
required: false | |
in: query | |
description: pulp_last_updated__gt | |
schema: | |
type: string | |
- name: pulp_last_updated__gte | |
required: false | |
in: query | |
description: pulp_last_updated__gte | |
schema: | |
type: string | |
- name: pulp_last_updated__lt | |
required: false | |
in: query | |
description: pulp_last_updated__lt | |
schema: | |
type: string | |
- name: pulp_last_updated__lte | |
required: false | |
in: query | |
description: pulp_last_updated__lte | |
schema: | |
type: string | |
- name: pulp_last_updated__range | |
required: false | |
in: query | |
description: pulp_last_updated__range | |
schema: | |
type: string | |
tags: | |
- 'Remotes: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Patchedcontainer.ContainerRemote' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Patchedcontainer.ContainerRemote' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Patchedcontainer.ContainerRemote' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
delete: | |
operationId: remotes_container_container_delete | |
description: Trigger an asynchronous delete task | |
summary: Delete a container remote | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container remote. | |
required: true | |
- name: pulp_last_updated | |
required: false | |
in: query | |
description: pulp_last_updated | |
schema: | |
type: string | |
- name: pulp_last_updated__gt | |
required: false | |
in: query | |
description: pulp_last_updated__gt | |
schema: | |
type: string | |
- name: pulp_last_updated__gte | |
required: false | |
in: query | |
description: pulp_last_updated__gte | |
schema: | |
type: string | |
- name: pulp_last_updated__lt | |
required: false | |
in: query | |
description: pulp_last_updated__lt | |
schema: | |
type: string | |
- name: pulp_last_updated__lte | |
required: false | |
in: query | |
description: pulp_last_updated__lte | |
schema: | |
type: string | |
- name: pulp_last_updated__range | |
required: false | |
in: query | |
description: pulp_last_updated__range | |
schema: | |
type: string | |
tags: | |
- 'Remotes: Container' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/ansible/ansible/: | |
get: | |
operationId: repositories_ansible_ansible_list | |
description: ViewSet for Ansible Remotes. | |
summary: List ansible repositorys | |
parameters: | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Repositories: Ansible' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/ansible.AnsibleRepositoryResponse' | |
description: '' | |
post: | |
operationId: repositories_ansible_ansible_create | |
description: ViewSet for Ansible Remotes. | |
summary: Create an ansible repository | |
tags: | |
- 'Repositories: Ansible' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRepository' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRepository' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRepository' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRepositoryResponse' | |
description: '' | |
/pulp/api/v3/repositories/ansible/ansible/{pulp_id}/: | |
get: | |
operationId: repositories_ansible_ansible_read | |
description: ViewSet for Ansible Remotes. | |
summary: Inspect an ansible repository | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible repository. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Repositories: Ansible' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRepositoryResponse' | |
description: '' | |
put: | |
operationId: repositories_ansible_ansible_update | |
description: Trigger an asynchronous update task | |
summary: Update an ansible repository | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible repository. | |
required: true | |
tags: | |
- 'Repositories: Ansible' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRepository' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRepository' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/ansible.AnsibleRepository' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
patch: | |
operationId: repositories_ansible_ansible_partial_update | |
description: Trigger an asynchronous partial update task | |
summary: Update an ansible repository | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible repository. | |
required: true | |
tags: | |
- 'Repositories: Ansible' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Patchedansible.AnsibleRepository' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Patchedansible.AnsibleRepository' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Patchedansible.AnsibleRepository' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
delete: | |
operationId: repositories_ansible_ansible_delete | |
description: Trigger an asynchronous delete task | |
summary: Delete an ansible repository | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible repository. | |
required: true | |
tags: | |
- 'Repositories: Ansible' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/ansible/ansible/{pulp_id}/modify/: | |
post: | |
operationId: repositories_ansible_ansible_modify | |
description: Trigger an asynchronous task to create a new repository version. | |
summary: Modify Repository Content | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible repository. | |
required: true | |
tags: | |
- 'Repositories: Ansible' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/RepositoryAddRemoveContent' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/RepositoryAddRemoveContent' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/RepositoryAddRemoveContent' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/ansible/ansible/{pulp_id}/sync/: | |
post: | |
operationId: repositories_ansible_ansible_sync | |
description: Trigger an asynchronous task to sync Ansible content. | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this ansible repository. | |
required: true | |
tags: | |
- 'Repositories: Ansible' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/RepositorySyncURL' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/RepositorySyncURL' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/RepositorySyncURL' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/ansible/ansible/{repository_pk}/versions/: | |
get: | |
operationId: repositories_ansible_ansible_versions_list | |
description: RpmRepositoryVersion represents a single file repository version. | |
summary: List repository versions | |
parameters: | |
- name: content | |
required: false | |
in: query | |
description: content | |
schema: | |
type: string | |
- name: content__in | |
required: false | |
in: query | |
description: content__in | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: number | |
required: false | |
in: query | |
description: number | |
schema: | |
type: string | |
- name: number__gt | |
required: false | |
in: query | |
description: number__gt | |
schema: | |
type: string | |
- name: number__gte | |
required: false | |
in: query | |
description: number__gte | |
schema: | |
type: string | |
- name: number__lt | |
required: false | |
in: query | |
description: number__lt | |
schema: | |
type: string | |
- name: number__lte | |
required: false | |
in: query | |
description: number__lte | |
schema: | |
type: string | |
- name: number__range | |
required: false | |
in: query | |
description: number__range | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: pulp_created | |
required: false | |
in: query | |
description: pulp_created | |
schema: | |
type: string | |
- name: pulp_created__gt | |
required: false | |
in: query | |
description: pulp_created__gt | |
schema: | |
type: string | |
- name: pulp_created__gte | |
required: false | |
in: query | |
description: pulp_created__gte | |
schema: | |
type: string | |
- name: pulp_created__lt | |
required: false | |
in: query | |
description: pulp_created__lt | |
schema: | |
type: string | |
- name: pulp_created__lte | |
required: false | |
in: query | |
description: pulp_created__lte | |
schema: | |
type: string | |
- name: pulp_created__range | |
required: false | |
in: query | |
description: pulp_created__range | |
schema: | |
type: string | |
- in: path | |
name: repository_pk | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Repositories: Ansible Versions' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/RepositoryVersionResponse' | |
description: '' | |
/pulp/api/v3/repositories/ansible/ansible/{repository_pk}/versions/{number}/: | |
get: | |
operationId: repositories_ansible_ansible_versions_read | |
description: RpmRepositoryVersion represents a single file repository version. | |
summary: Inspect a repository version | |
parameters: | |
- in: path | |
name: number | |
schema: | |
type: integer | |
maximum: 2147483647 | |
required: true | |
- in: path | |
name: repository_pk | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Repositories: Ansible Versions' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/RepositoryVersionResponse' | |
description: '' | |
delete: | |
operationId: repositories_ansible_ansible_versions_delete | |
description: Trigger an asynchronous task to delete a repositroy version. | |
summary: Delete a repository version | |
parameters: | |
- name: content | |
required: false | |
in: query | |
description: content | |
schema: | |
type: string | |
- name: content__in | |
required: false | |
in: query | |
description: content__in | |
schema: | |
type: string | |
- in: path | |
name: number | |
schema: | |
type: integer | |
maximum: 2147483647 | |
required: true | |
- name: number | |
required: false | |
in: query | |
description: number | |
schema: | |
type: string | |
- name: number__gt | |
required: false | |
in: query | |
description: number__gt | |
schema: | |
type: string | |
- name: number__gte | |
required: false | |
in: query | |
description: number__gte | |
schema: | |
type: string | |
- name: number__lt | |
required: false | |
in: query | |
description: number__lt | |
schema: | |
type: string | |
- name: number__lte | |
required: false | |
in: query | |
description: number__lte | |
schema: | |
type: string | |
- name: number__range | |
required: false | |
in: query | |
description: number__range | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: pulp_created | |
required: false | |
in: query | |
description: pulp_created | |
schema: | |
type: string | |
- name: pulp_created__gt | |
required: false | |
in: query | |
description: pulp_created__gt | |
schema: | |
type: string | |
- name: pulp_created__gte | |
required: false | |
in: query | |
description: pulp_created__gte | |
schema: | |
type: string | |
- name: pulp_created__lt | |
required: false | |
in: query | |
description: pulp_created__lt | |
schema: | |
type: string | |
- name: pulp_created__lte | |
required: false | |
in: query | |
description: pulp_created__lte | |
schema: | |
type: string | |
- name: pulp_created__range | |
required: false | |
in: query | |
description: pulp_created__range | |
schema: | |
type: string | |
- in: path | |
name: repository_pk | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Repositories: Ansible Versions' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/ansible/ansible/{repository_pk}/versions/{number}/repair/: | |
post: | |
operationId: repositories_ansible_ansible_versions_repair | |
description: Trigger an asynchronous task to repair a repositroy version. | |
parameters: | |
- in: path | |
name: number | |
schema: | |
type: integer | |
maximum: 2147483647 | |
required: true | |
- in: path | |
name: repository_pk | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Repositories: Ansible Versions' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/RepositoryVersion' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/RepositoryVersion' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/RepositoryVersion' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/: | |
get: | |
operationId: repositories_container_container_list | |
description: ViewSet for container repo. | |
summary: List container repositorys | |
parameters: | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Repositories: Container' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/container.ContainerRepositoryResponse' | |
description: '' | |
post: | |
operationId: repositories_container_container_create | |
description: ViewSet for container repo. | |
summary: Create a container repository | |
tags: | |
- 'Repositories: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRepository' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRepository' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRepository' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRepositoryResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container-push/: | |
get: | |
operationId: repositories_container_container_push_list | |
description: ViewSet for a container push repository. | |
summary: List container push repositorys | |
parameters: | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Repositories: Container-Push' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/container.ContainerPushRepositoryResponse' | |
description: '' | |
post: | |
operationId: repositories_container_container_push_create | |
description: ViewSet for a container push repository. | |
summary: Create a container push repository | |
tags: | |
- 'Repositories: Container-Push' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerPushRepository' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/container.ContainerPushRepository' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/container.ContainerPushRepository' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerPushRepositoryResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container-push/{pulp_id}/: | |
get: | |
operationId: repositories_container_container_push_read | |
description: ViewSet for a container push repository. | |
summary: Inspect a container push repository | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container push repository. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Repositories: Container-Push' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerPushRepositoryResponse' | |
description: '' | |
delete: | |
operationId: repositories_container_container_push_delete | |
description: Trigger an asynchronous delete task | |
summary: Delete a container push repository | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container push repository. | |
required: true | |
tags: | |
- 'Repositories: Container-Push' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container-push/{repository_pk}/versions/: | |
get: | |
operationId: repositories_container_container_push_versions_list | |
description: ContainerPushRepositoryVersion represents a single container push | |
repository version. | |
summary: List repository versions | |
parameters: | |
- name: content | |
required: false | |
in: query | |
description: content | |
schema: | |
type: string | |
- name: content__in | |
required: false | |
in: query | |
description: content__in | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: number | |
required: false | |
in: query | |
description: number | |
schema: | |
type: string | |
- name: number__gt | |
required: false | |
in: query | |
description: number__gt | |
schema: | |
type: string | |
- name: number__gte | |
required: false | |
in: query | |
description: number__gte | |
schema: | |
type: string | |
- name: number__lt | |
required: false | |
in: query | |
description: number__lt | |
schema: | |
type: string | |
- name: number__lte | |
required: false | |
in: query | |
description: number__lte | |
schema: | |
type: string | |
- name: number__range | |
required: false | |
in: query | |
description: number__range | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: pulp_created | |
required: false | |
in: query | |
description: pulp_created | |
schema: | |
type: string | |
- name: pulp_created__gt | |
required: false | |
in: query | |
description: pulp_created__gt | |
schema: | |
type: string | |
- name: pulp_created__gte | |
required: false | |
in: query | |
description: pulp_created__gte | |
schema: | |
type: string | |
- name: pulp_created__lt | |
required: false | |
in: query | |
description: pulp_created__lt | |
schema: | |
type: string | |
- name: pulp_created__lte | |
required: false | |
in: query | |
description: pulp_created__lte | |
schema: | |
type: string | |
- name: pulp_created__range | |
required: false | |
in: query | |
description: pulp_created__range | |
schema: | |
type: string | |
- in: path | |
name: repository_pk | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Repositories: Container Versions' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/RepositoryVersionResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container-push/{repository_pk}/versions/{number}/: | |
get: | |
operationId: repositories_container_container_push_versions_read | |
description: ContainerPushRepositoryVersion represents a single container push | |
repository version. | |
summary: Inspect a repository version | |
parameters: | |
- in: path | |
name: number | |
schema: | |
type: integer | |
maximum: 2147483647 | |
required: true | |
- in: path | |
name: repository_pk | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Repositories: Container Versions' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/RepositoryVersionResponse' | |
description: '' | |
delete: | |
operationId: repositories_container_container_push_versions_delete | |
description: Trigger an asynchronous task to delete a repositroy version. | |
summary: Delete a repository version | |
parameters: | |
- name: content | |
required: false | |
in: query | |
description: content | |
schema: | |
type: string | |
- name: content__in | |
required: false | |
in: query | |
description: content__in | |
schema: | |
type: string | |
- in: path | |
name: number | |
schema: | |
type: integer | |
maximum: 2147483647 | |
required: true | |
- name: number | |
required: false | |
in: query | |
description: number | |
schema: | |
type: string | |
- name: number__gt | |
required: false | |
in: query | |
description: number__gt | |
schema: | |
type: string | |
- name: number__gte | |
required: false | |
in: query | |
description: number__gte | |
schema: | |
type: string | |
- name: number__lt | |
required: false | |
in: query | |
description: number__lt | |
schema: | |
type: string | |
- name: number__lte | |
required: false | |
in: query | |
description: number__lte | |
schema: | |
type: string | |
- name: number__range | |
required: false | |
in: query | |
description: number__range | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: pulp_created | |
required: false | |
in: query | |
description: pulp_created | |
schema: | |
type: string | |
- name: pulp_created__gt | |
required: false | |
in: query | |
description: pulp_created__gt | |
schema: | |
type: string | |
- name: pulp_created__gte | |
required: false | |
in: query | |
description: pulp_created__gte | |
schema: | |
type: string | |
- name: pulp_created__lt | |
required: false | |
in: query | |
description: pulp_created__lt | |
schema: | |
type: string | |
- name: pulp_created__lte | |
required: false | |
in: query | |
description: pulp_created__lte | |
schema: | |
type: string | |
- name: pulp_created__range | |
required: false | |
in: query | |
description: pulp_created__range | |
schema: | |
type: string | |
- in: path | |
name: repository_pk | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Repositories: Container Versions' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container-push/{repository_pk}/versions/{number}/repair/: | |
post: | |
operationId: repositories_container_container_push_versions_repair | |
description: Trigger an asynchronous task to repair a repositroy version. | |
parameters: | |
- in: path | |
name: number | |
schema: | |
type: integer | |
maximum: 2147483647 | |
required: true | |
- in: path | |
name: repository_pk | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Repositories: Container Versions' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/RepositoryVersion' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/RepositoryVersion' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/RepositoryVersion' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/{pulp_id}/: | |
get: | |
operationId: repositories_container_container_read | |
description: ViewSet for container repo. | |
summary: Inspect a container repository | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container repository. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Repositories: Container' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRepositoryResponse' | |
description: '' | |
put: | |
operationId: repositories_container_container_update | |
description: Trigger an asynchronous update task | |
summary: Update a container repository | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container repository. | |
required: true | |
tags: | |
- 'Repositories: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRepository' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRepository' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/container.ContainerRepository' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
patch: | |
operationId: repositories_container_container_partial_update | |
description: Trigger an asynchronous partial update task | |
summary: Update a container repository | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container repository. | |
required: true | |
tags: | |
- 'Repositories: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Patchedcontainer.ContainerRepository' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Patchedcontainer.ContainerRepository' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Patchedcontainer.ContainerRepository' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
delete: | |
operationId: repositories_container_container_delete | |
description: Trigger an asynchronous delete task | |
summary: Delete a container repository | |
parameters: | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container repository. | |
required: true | |
tags: | |
- 'Repositories: Container' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/{pulp_id}/add/: | |
post: | |
operationId: repositories_container_container_add | |
description: Trigger an asynchronous task to recursively add container content. | |
summary: Add content | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container repository. | |
required: true | |
tags: | |
- 'Repositories: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/RecursiveManage' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/RecursiveManage' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/RecursiveManage' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/{pulp_id}/build_image/: | |
post: | |
operationId: repositories_container_container_build_image | |
description: Trigger an asynchronous task to build an OCI image from a Containerfile. | |
A new repository version is created with the new image and tag. This API is | |
tech preview in Pulp Container 1.1. Backwards compatibility when upgrading | |
is not guaranteed. | |
summary: Build an Image | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container repository. | |
required: true | |
tags: | |
- 'Repositories: Container' | |
requestBody: | |
content: | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/OCIBuildImage' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/OCIBuildImage' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/{pulp_id}/copy_manifests/: | |
post: | |
operationId: repositories_container_container_copy_manifests | |
description: Trigger an asynchronous task to copy manifests | |
summary: Copy manifests | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container repository. | |
required: true | |
tags: | |
- 'Repositories: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/ManifestCopy' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/ManifestCopy' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/ManifestCopy' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/{pulp_id}/copy_tags/: | |
post: | |
operationId: repositories_container_container_copy_tags | |
description: Trigger an asynchronous task to copy tags | |
summary: Copy tags | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container repository. | |
required: true | |
tags: | |
- 'Repositories: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/TagCopy' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/TagCopy' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/TagCopy' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/{pulp_id}/remove/: | |
post: | |
operationId: repositories_container_container_remove | |
description: Trigger an async task to recursively remove container content. | |
summary: Remove content | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container repository. | |
required: true | |
tags: | |
- 'Repositories: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/RecursiveManage' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/RecursiveManage' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/RecursiveManage' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/{pulp_id}/sync/: | |
post: | |
operationId: repositories_container_container_sync | |
description: Trigger an asynchronous task to sync content. | |
summary: Sync from a remote | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container repository. | |
required: true | |
tags: | |
- 'Repositories: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/RepositorySyncURL' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/RepositorySyncURL' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/RepositorySyncURL' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/{pulp_id}/tag/: | |
post: | |
operationId: repositories_container_container_tag | |
description: Trigger an asynchronous task to tag an image in the repository | |
summary: Create a Tag | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container repository. | |
required: true | |
tags: | |
- 'Repositories: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/TagImage' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/TagImage' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/TagImage' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/{pulp_id}/untag/: | |
post: | |
operationId: repositories_container_container_untag | |
description: Trigger an asynchronous task to untag an image in the repository | |
summary: Delete a tag | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this container repository. | |
required: true | |
tags: | |
- 'Repositories: Container' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/UnTagImage' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/UnTagImage' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/UnTagImage' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/{repository_pk}/versions/: | |
get: | |
operationId: repositories_container_container_versions_list | |
description: ContainerRepositoryVersion represents a single container repository | |
version. | |
summary: List repository versions | |
parameters: | |
- name: content | |
required: false | |
in: query | |
description: content | |
schema: | |
type: string | |
- name: content__in | |
required: false | |
in: query | |
description: content__in | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: number | |
required: false | |
in: query | |
description: number | |
schema: | |
type: string | |
- name: number__gt | |
required: false | |
in: query | |
description: number__gt | |
schema: | |
type: string | |
- name: number__gte | |
required: false | |
in: query | |
description: number__gte | |
schema: | |
type: string | |
- name: number__lt | |
required: false | |
in: query | |
description: number__lt | |
schema: | |
type: string | |
- name: number__lte | |
required: false | |
in: query | |
description: number__lte | |
schema: | |
type: string | |
- name: number__range | |
required: false | |
in: query | |
description: number__range | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: pulp_created | |
required: false | |
in: query | |
description: pulp_created | |
schema: | |
type: string | |
- name: pulp_created__gt | |
required: false | |
in: query | |
description: pulp_created__gt | |
schema: | |
type: string | |
- name: pulp_created__gte | |
required: false | |
in: query | |
description: pulp_created__gte | |
schema: | |
type: string | |
- name: pulp_created__lt | |
required: false | |
in: query | |
description: pulp_created__lt | |
schema: | |
type: string | |
- name: pulp_created__lte | |
required: false | |
in: query | |
description: pulp_created__lte | |
schema: | |
type: string | |
- name: pulp_created__range | |
required: false | |
in: query | |
description: pulp_created__range | |
schema: | |
type: string | |
- in: path | |
name: repository_pk | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Repositories: Container Versions' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/RepositoryVersionResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/{repository_pk}/versions/{number}/: | |
get: | |
operationId: repositories_container_container_versions_read | |
description: ContainerRepositoryVersion represents a single container repository | |
version. | |
summary: Inspect a repository version | |
parameters: | |
- in: path | |
name: number | |
schema: | |
type: integer | |
maximum: 2147483647 | |
required: true | |
- in: path | |
name: repository_pk | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Repositories: Container Versions' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/RepositoryVersionResponse' | |
description: '' | |
delete: | |
operationId: repositories_container_container_versions_delete | |
description: Trigger an asynchronous task to delete a repositroy version. | |
summary: Delete a repository version | |
parameters: | |
- name: content | |
required: false | |
in: query | |
description: content | |
schema: | |
type: string | |
- name: content__in | |
required: false | |
in: query | |
description: content__in | |
schema: | |
type: string | |
- in: path | |
name: number | |
schema: | |
type: integer | |
maximum: 2147483647 | |
required: true | |
- name: number | |
required: false | |
in: query | |
description: number | |
schema: | |
type: string | |
- name: number__gt | |
required: false | |
in: query | |
description: number__gt | |
schema: | |
type: string | |
- name: number__gte | |
required: false | |
in: query | |
description: number__gte | |
schema: | |
type: string | |
- name: number__lt | |
required: false | |
in: query | |
description: number__lt | |
schema: | |
type: string | |
- name: number__lte | |
required: false | |
in: query | |
description: number__lte | |
schema: | |
type: string | |
- name: number__range | |
required: false | |
in: query | |
description: number__range | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: pulp_created | |
required: false | |
in: query | |
description: pulp_created | |
schema: | |
type: string | |
- name: pulp_created__gt | |
required: false | |
in: query | |
description: pulp_created__gt | |
schema: | |
type: string | |
- name: pulp_created__gte | |
required: false | |
in: query | |
description: pulp_created__gte | |
schema: | |
type: string | |
- name: pulp_created__lt | |
required: false | |
in: query | |
description: pulp_created__lt | |
schema: | |
type: string | |
- name: pulp_created__lte | |
required: false | |
in: query | |
description: pulp_created__lte | |
schema: | |
type: string | |
- name: pulp_created__range | |
required: false | |
in: query | |
description: pulp_created__range | |
schema: | |
type: string | |
- in: path | |
name: repository_pk | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Repositories: Container Versions' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/repositories/container/container/{repository_pk}/versions/{number}/repair/: | |
post: | |
operationId: repositories_container_container_versions_repair | |
description: Trigger an asynchronous task to repair a repositroy version. | |
parameters: | |
- in: path | |
name: number | |
schema: | |
type: integer | |
maximum: 2147483647 | |
required: true | |
- in: path | |
name: repository_pk | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Repositories: Container Versions' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/RepositoryVersion' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/RepositoryVersion' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/RepositoryVersion' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/signing-services/: | |
get: | |
operationId: signing_services_list | |
description: A ViewSet that supports browsing of existing signing services. | |
summary: List signing services | |
parameters: | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Signing-Services | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/SigningServiceResponse' | |
description: '' | |
/pulp/api/v3/signing-services/{pulp_id}/: | |
get: | |
operationId: signing_services_read | |
description: A ViewSet that supports browsing of existing signing services. | |
summary: Inspect a signing service | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this signing service. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Signing-Services | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/SigningServiceResponse' | |
description: '' | |
/pulp/api/v3/status/: | |
get: | |
operationId: status_read | |
description: |- | |
Returns app information including the version of pulpcore and loaded pulp plugins, | |
known workers, database connection status, and messaging connection status | |
summary: Inspect status of Pulp | |
tags: | |
- Status | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/StatusResponse' | |
description: '' | |
/pulp/api/v3/task-groups/: | |
get: | |
operationId: task_groups_list | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: List task 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 | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Task-Groups | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/TaskGroupResponse' | |
description: '' | |
/pulp/api/v3/task-groups/{pulp_id}/: | |
get: | |
operationId: task_groups_read | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: Inspect a task group | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this task group. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Task-Groups | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/TaskGroupResponse' | |
description: '' | |
/pulp/api/v3/tasks/: | |
get: | |
operationId: tasks_list | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: List tasks | |
parameters: | |
- name: child_tasks | |
required: false | |
in: query | |
description: child_tasks | |
schema: | |
type: string | |
- name: created_resources | |
required: false | |
in: query | |
description: created_resources | |
schema: | |
type: string | |
- name: finished_at | |
required: false | |
in: query | |
description: finished_at | |
schema: | |
type: string | |
- name: finished_at__gt | |
required: false | |
in: query | |
description: finished_at__gt | |
schema: | |
type: string | |
- name: finished_at__gte | |
required: false | |
in: query | |
description: finished_at__gte | |
schema: | |
type: string | |
- name: finished_at__lt | |
required: false | |
in: query | |
description: finished_at__lt | |
schema: | |
type: string | |
- name: finished_at__lte | |
required: false | |
in: query | |
description: finished_at__lte | |
schema: | |
type: string | |
- name: finished_at__range | |
required: false | |
in: query | |
description: finished_at__range | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__contains | |
required: false | |
in: query | |
description: name__contains | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: parent_task | |
required: false | |
in: query | |
description: parent_task | |
schema: | |
type: string | |
- name: reserved_resources_record | |
required: false | |
in: query | |
description: reserved_resources_record | |
schema: | |
type: string | |
- name: started_at | |
required: false | |
in: query | |
description: started_at | |
schema: | |
type: string | |
- name: started_at__gt | |
required: false | |
in: query | |
description: started_at__gt | |
schema: | |
type: string | |
- name: started_at__gte | |
required: false | |
in: query | |
description: started_at__gte | |
schema: | |
type: string | |
- name: started_at__lt | |
required: false | |
in: query | |
description: started_at__lt | |
schema: | |
type: string | |
- name: started_at__lte | |
required: false | |
in: query | |
description: started_at__lte | |
schema: | |
type: string | |
- name: started_at__range | |
required: false | |
in: query | |
description: started_at__range | |
schema: | |
type: string | |
- name: state | |
required: false | |
in: query | |
description: state | |
schema: | |
type: string | |
- name: state__in | |
required: false | |
in: query | |
description: state__in | |
schema: | |
type: string | |
- name: task_group | |
required: false | |
in: query | |
description: task_group | |
schema: | |
type: string | |
- name: worker | |
required: false | |
in: query | |
description: worker | |
schema: | |
type: string | |
- name: worker__in | |
required: false | |
in: query | |
description: worker__in | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Tasks | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/TaskResponse' | |
description: '' | |
/pulp/api/v3/tasks/{pulp_id}/: | |
get: | |
operationId: tasks_read | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: Inspect a task | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this task. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Tasks | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/TaskResponse' | |
description: '' | |
patch: | |
operationId: tasks_cancel | |
description: This operation cancels a task. | |
summary: Cancel a task | |
parameters: | |
- name: child_tasks | |
required: false | |
in: query | |
description: child_tasks | |
schema: | |
type: string | |
- name: created_resources | |
required: false | |
in: query | |
description: created_resources | |
schema: | |
type: string | |
- name: finished_at | |
required: false | |
in: query | |
description: finished_at | |
schema: | |
type: string | |
- name: finished_at__gt | |
required: false | |
in: query | |
description: finished_at__gt | |
schema: | |
type: string | |
- name: finished_at__gte | |
required: false | |
in: query | |
description: finished_at__gte | |
schema: | |
type: string | |
- name: finished_at__lt | |
required: false | |
in: query | |
description: finished_at__lt | |
schema: | |
type: string | |
- name: finished_at__lte | |
required: false | |
in: query | |
description: finished_at__lte | |
schema: | |
type: string | |
- name: finished_at__range | |
required: false | |
in: query | |
description: finished_at__range | |
schema: | |
type: string | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__contains | |
required: false | |
in: query | |
description: name__contains | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- name: parent_task | |
required: false | |
in: query | |
description: parent_task | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this task. | |
required: true | |
- name: reserved_resources_record | |
required: false | |
in: query | |
description: reserved_resources_record | |
schema: | |
type: string | |
- name: started_at | |
required: false | |
in: query | |
description: started_at | |
schema: | |
type: string | |
- name: started_at__gt | |
required: false | |
in: query | |
description: started_at__gt | |
schema: | |
type: string | |
- name: started_at__gte | |
required: false | |
in: query | |
description: started_at__gte | |
schema: | |
type: string | |
- name: started_at__lt | |
required: false | |
in: query | |
description: started_at__lt | |
schema: | |
type: string | |
- name: started_at__lte | |
required: false | |
in: query | |
description: started_at__lte | |
schema: | |
type: string | |
- name: started_at__range | |
required: false | |
in: query | |
description: started_at__range | |
schema: | |
type: string | |
- name: state | |
required: false | |
in: query | |
description: state | |
schema: | |
type: string | |
- name: state__in | |
required: false | |
in: query | |
description: state__in | |
schema: | |
type: string | |
- name: task_group | |
required: false | |
in: query | |
description: task_group | |
schema: | |
type: string | |
- name: worker | |
required: false | |
in: query | |
description: worker | |
schema: | |
type: string | |
- name: worker__in | |
required: false | |
in: query | |
description: worker__in | |
schema: | |
type: string | |
tags: | |
- Tasks | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/PatchedTaskCancel' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/PatchedTaskCancel' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/PatchedTaskCancel' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/TaskResponse' | |
description: '' | |
'409': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/TaskResponse' | |
description: '' | |
delete: | |
operationId: tasks_delete | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: Delete a task | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this task. | |
required: true | |
tags: | |
- Tasks | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'204': | |
description: No response body | |
/pulp/api/v3/uploads/: | |
get: | |
operationId: uploads_list | |
description: View for chunked uploads. | |
summary: List uploads | |
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 | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Uploads | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/UploadResponse' | |
description: '' | |
post: | |
operationId: uploads_create | |
description: View for chunked uploads. | |
summary: Create an upload | |
tags: | |
- Uploads | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Upload' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Upload' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Upload' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/UploadResponse' | |
description: '' | |
/pulp/api/v3/uploads/{pulp_id}/: | |
get: | |
operationId: uploads_read | |
description: View for chunked uploads. | |
summary: Inspect an upload | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this upload. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Uploads | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/UploadDetailResponse' | |
description: '' | |
put: | |
operationId: uploads_update | |
description: Upload a chunk for an upload. | |
summary: Upload a file chunk | |
parameters: | |
- in: header | |
name: Content-Range | |
schema: | |
type: string | |
description: The Content-Range header specifies the location of the file chunk | |
within the file. | |
required: true | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this upload. | |
required: true | |
tags: | |
- Uploads | |
requestBody: | |
content: | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/UploadChunk' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/UploadChunk' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/UploadResponse' | |
description: '' | |
delete: | |
operationId: uploads_delete | |
description: View for chunked uploads. | |
summary: Delete an upload | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this upload. | |
required: true | |
tags: | |
- Uploads | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'204': | |
description: No response body | |
/pulp/api/v3/uploads/{pulp_id}/commit/: | |
post: | |
operationId: uploads_commit | |
description: Queues a Task that creates an Artifact, and the Upload gets deleted | |
and cannot be re-used. | |
summary: Finish an Upload | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this upload. | |
required: true | |
tags: | |
- Uploads | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/UploadCommit' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/UploadCommit' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/UploadCommit' | |
required: true | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp/api/v3/workers/: | |
get: | |
operationId: workers_list | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: List workers | |
parameters: | |
- name: last_heartbeat | |
required: false | |
in: query | |
description: last_heartbeat | |
schema: | |
type: string | |
- name: last_heartbeat__gt | |
required: false | |
in: query | |
description: last_heartbeat__gt | |
schema: | |
type: string | |
- name: last_heartbeat__gte | |
required: false | |
in: query | |
description: last_heartbeat__gte | |
schema: | |
type: string | |
- name: last_heartbeat__lt | |
required: false | |
in: query | |
description: last_heartbeat__lt | |
schema: | |
type: string | |
- name: last_heartbeat__lte | |
required: false | |
in: query | |
description: last_heartbeat__lte | |
schema: | |
type: string | |
- name: last_heartbeat__range | |
required: false | |
in: query | |
description: last_heartbeat__range | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- name: missing | |
required: false | |
in: query | |
description: missing | |
schema: | |
type: string | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- name: name__in | |
required: false | |
in: query | |
description: name__in | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- name: online | |
required: false | |
in: query | |
description: online | |
schema: | |
type: string | |
- name: ordering | |
required: false | |
in: query | |
description: Which field to use when ordering the results. | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Workers | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/WorkerResponse' | |
description: '' | |
/pulp/api/v3/workers/{pulp_id}/: | |
get: | |
operationId: workers_read | |
description: |- | |
A customized named ModelViewSet that knows how to register itself with the Pulp API router. | |
This viewset is discoverable by its name. | |
"Normal" Django Models and Master/Detail models are supported by the ``register_with`` method. | |
Attributes: | |
lookup_field (str): The name of the field by which an object should be looked up, in | |
addition to any parent lookups if this ViewSet is nested. Defaults to 'pk' | |
endpoint_name (str): The name of the final path segment that should identify the ViewSet's | |
collection endpoint. | |
nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must | |
correspond to the "parent_prefix" of a router with rest_framework_nested.NestedMixin. | |
None indicates this ViewSet should not be nested. | |
parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs | |
to django model filter expressions that can be used with the corresponding value from | |
self.kwargs, used only by a nested ViewSet to filter based on the parent object's | |
identity. | |
schema (DefaultSchema): The schema class to use by default in a viewset. | |
summary: Inspect a worker | |
parameters: | |
- in: path | |
name: pulp_id | |
schema: | |
type: string | |
format: uuid | |
description: A UUID string identifying this worker. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- Workers | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/WorkerResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/: | |
get: | |
operationId: pulp_ansible_galaxy_api_read | |
description: Return a response to the "GET" action. | |
parameters: | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Api' | |
responses: | |
'200': | |
description: No response body | |
/pulp_ansible/galaxy/{path}/api/v1/roles/: | |
get: | |
operationId: pulp_ansible_galaxy_api_v1_roles_list | |
description: APIView for Roles. | |
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: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Galaxy Api Roles' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/GalaxyRoleResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/v1/roles/{role_pk}/versions/: | |
get: | |
operationId: pulp_ansible_galaxy_api_v1_roles_versions_list | |
description: APIView for Role Versions. | |
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: path | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: role_pk | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Galaxy Api V1 Versions' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/GalaxyRoleVersionResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/v2/collection-imports/{task}/: | |
get: | |
operationId: pulp_ansible_galaxy_api_v2_collection_imports_read | |
description: Returns a CollectionImport object. | |
summary: Inspect a collection import | |
parameters: | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: since | |
schema: | |
type: string | |
description: Filter messages since a given timestamp | |
- in: path | |
name: task | |
schema: | |
type: string | |
format: uuid | |
description: A unique value identifying this collection import. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Galaxy Api Collection-Imports' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionImportDetailResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/v2/collections/: | |
get: | |
operationId: pulp_ansible_galaxy_api_v2_collections_list | |
description: View for Collection models. | |
parameters: | |
- name: page | |
required: false | |
in: query | |
description: A page number within the paginated result set. | |
schema: | |
type: integer | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Galaxy Api Collections' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/GalaxyCollectionResponse' | |
description: '' | |
post: | |
operationId: pulp_ansible_galaxy_api_v2_collections_create | |
description: Queues a task that creates a new Collection from an uploaded artifact. | |
parameters: | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Pulp_Ansible: Galaxy Api Collections' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/GalaxyCollection' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/GalaxyCollection' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/GalaxyCollection' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/GalaxyCollectionResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/v2/collections/{namespace}/{name}/: | |
get: | |
operationId: pulp_ansible_galaxy_api_v2_collections_read | |
description: Get the detail view of a Collection. | |
parameters: | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Galaxy Api Collections' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/GalaxyCollectionResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/v2/collections/{namespace}/{name}/versions/: | |
get: | |
operationId: pulp_ansible_galaxy_api_v2_collections_versions_list | |
description: APIView for Collections by namespace/name. | |
parameters: | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Galaxy Api V2 Versions' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/GalaxyCollectionVersionResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/v2/collections/{namespace}/{name}/versions/{version}/: | |
get: | |
operationId: pulp_ansible_galaxy_api_v2_collections_versions_read | |
description: Return a response to the "GET" action. | |
parameters: | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: version | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Galaxy Api V2 Versions' | |
responses: | |
'200': | |
description: No response body | |
/pulp_ansible/galaxy/{path}/api/v3/artifacts/collections/: | |
post: | |
operationId: pulp_ansible_galaxy_api_v3_artifacts_collections_create | |
description: Create an artifact and trigger an asynchronous task to create Collection | |
content from it. | |
summary: Upload a collection | |
parameters: | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Pulp_Ansible: Galaxy Api V3 Collections' | |
requestBody: | |
content: | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/CollectionOneShot' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/CollectionOneShot' | |
required: true | |
responses: | |
'202': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/AsyncOperationResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/v3/collections/: | |
get: | |
operationId: pulp_ansible_galaxy_api_v3_collections_list | |
description: ViewSet for Collections. | |
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: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Galaxy Api Collections' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/CollectionResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/: | |
get: | |
operationId: pulp_ansible_galaxy_api_v3_collections_read | |
description: ViewSet for Collections. | |
parameters: | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Galaxy Api Collections' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionResponse' | |
description: '' | |
put: | |
operationId: pulp_ansible_galaxy_api_v3_collections_update | |
description: Update a Collection object. | |
parameters: | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Pulp_Ansible: Galaxy Api Collections' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/Collection' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/Collection' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/Collection' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/: | |
get: | |
operationId: pulp_ansible_galaxy_api_v3_collections_versions_list | |
description: Returns paginated CollectionVersions list. | |
parameters: | |
- name: certification | |
required: false | |
in: query | |
description: certification | |
schema: | |
type: string | |
enum: | |
- certified | |
- not_certified | |
- needs_review | |
- name: deprecated | |
required: false | |
in: query | |
description: deprecated | |
schema: | |
type: string | |
- name: is_highest | |
required: false | |
in: query | |
description: is_highest | |
schema: | |
type: string | |
- name: limit | |
required: false | |
in: query | |
description: Number of results to return per page. | |
schema: | |
type: integer | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- name: offset | |
required: false | |
in: query | |
description: The initial index from which to return the results. | |
schema: | |
type: integer | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- name: q | |
required: false | |
in: query | |
description: q | |
schema: | |
type: string | |
- name: repository_version | |
required: false | |
in: query | |
description: repository_version | |
schema: | |
type: string | |
- name: repository_version_added | |
required: false | |
in: query | |
description: repository_version_added | |
schema: | |
type: string | |
- name: repository_version_removed | |
required: false | |
in: query | |
description: repository_version_removed | |
schema: | |
type: string | |
- name: tags | |
required: false | |
in: query | |
description: tags | |
schema: | |
type: string | |
- name: version | |
required: false | |
in: query | |
description: version | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Galaxy Api V3 Versions' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
count: | |
type: integer | |
example: 123 | |
next: | |
type: string | |
nullable: true | |
previous: | |
type: string | |
nullable: true | |
results: | |
type: array | |
items: | |
$ref: '#/components/schemas/CollectionVersionResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/{version}/: | |
get: | |
operationId: pulp_ansible_galaxy_api_v3_collections_versions_read | |
description: Returns a CollectionVersion object. | |
parameters: | |
- name: certification | |
required: false | |
in: query | |
description: certification | |
schema: | |
type: string | |
enum: | |
- certified | |
- not_certified | |
- needs_review | |
- name: deprecated | |
required: false | |
in: query | |
description: deprecated | |
schema: | |
type: string | |
- name: is_highest | |
required: false | |
in: query | |
description: is_highest | |
schema: | |
type: string | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- name: name | |
required: false | |
in: query | |
description: name | |
schema: | |
type: string | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- name: namespace | |
required: false | |
in: query | |
description: namespace | |
schema: | |
type: string | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- name: q | |
required: false | |
in: query | |
description: q | |
schema: | |
type: string | |
- name: repository_version | |
required: false | |
in: query | |
description: repository_version | |
schema: | |
type: string | |
- name: repository_version_added | |
required: false | |
in: query | |
description: repository_version_added | |
schema: | |
type: string | |
- name: repository_version_removed | |
required: false | |
in: query | |
description: repository_version_removed | |
schema: | |
type: string | |
- name: tags | |
required: false | |
in: query | |
description: tags | |
schema: | |
type: string | |
- in: path | |
name: version | |
schema: | |
type: string | |
required: true | |
- name: version | |
required: false | |
in: query | |
description: version | |
schema: | |
type: string | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Galaxy Api V3 Versions' | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionVersionResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/{version}/certified/: | |
put: | |
operationId: pulp_ansible_galaxy_api_v3_collections_versions_certified_set_certified | |
description: Set collection version certified status. | |
parameters: | |
- in: path | |
name: name | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: namespace | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: path | |
name: version | |
schema: | |
type: string | |
required: true | |
tags: | |
- 'Pulp_Ansible: Galaxy Api V3 Collections Certified' | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionVersion' | |
application/x-www-form-urlencoded: | |
schema: | |
$ref: '#/components/schemas/CollectionVersion' | |
multipart/form-data: | |
schema: | |
$ref: '#/components/schemas/CollectionVersion' | |
required: true | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionVersionResponse' | |
description: '' | |
/pulp_ansible/galaxy/{path}/api/v3/imports/collections/{task}/: | |
get: | |
operationId: pulp_ansible_galaxy_api_v3_imports_collections_read | |
description: Returns a CollectionImport object. | |
summary: Inspect a collection import | |
parameters: | |
- in: path | |
name: path | |
schema: | |
type: string | |
required: true | |
- in: query | |
name: since | |
schema: | |
type: string | |
description: Filter messages since a given timestamp | |
- in: path | |
name: task | |
schema: | |
type: string | |
format: uuid | |
description: A unique value identifying this collection import. | |
required: true | |
- in: query | |
name: fields | |
schema: | |
type: string | |
description: A list of fields to include in the response. | |
- in: query | |
name: exclude_fields | |
schema: | |
type: string | |
description: A list of fields to exclude from the response. | |
tags: | |
- 'Pulp_Ansible: Galaxy Api V3 Collections' | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CollectionImportDetailResponse' | |
description: '' | |
/token/: | |
get: | |
operationId: token_read | |
description: Handles GET requests for the /token/ endpoint. | |
tags: | |
- Token | |
security: | |
- cookieAuth: [] | |
- basicAuth: [] | |
responses: | |
'200': | |
description: No response body | |
components: | |
schemas: | |
AccessPolicy: | |
type: object | |
description: Serializer for AccessPolicy. | |
properties: | |
permissions_assignment: | |
type: array | |
items: | |
type: object | |
description: List of callables that define the new permissions to be created | |
for new objects. | |
statements: | |
type: array | |
items: | |
type: object | |
description: List of policy statements defining the policy. | |
viewset_name: | |
type: string | |
description: The name of ViewSet this AccessPolicy authorizes. | |
required: | |
- permissions_assignment | |
- statements | |
- viewset_name | |
AccessPolicyResponse: | |
type: object | |
description: Serializer for AccessPolicy. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
permissions_assignment: | |
type: array | |
items: | |
type: object | |
description: List of callables that define the new permissions to be created | |
for new objects. | |
statements: | |
type: array | |
items: | |
type: object | |
description: List of policy statements defining the policy. | |
viewset_name: | |
type: string | |
description: The name of ViewSet this AccessPolicy authorizes. | |
required: | |
- permissions_assignment | |
- statements | |
- viewset_name | |
Artifact: | |
type: object | |
description: |- | |
Base serializer for use with :class:`pulpcore.app.models.Model` | |
This ensures that all Serializers provide values for the 'pulp_href` field. | |
The class provides a default for the ``ref_name`` attribute in the | |
ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions | |
of plugins are namespaced properly. | |
properties: | |
file: | |
type: string | |
format: binary | |
description: The stored file. | |
size: | |
type: integer | |
description: The size of the file in bytes. | |
md5: | |
type: string | |
nullable: true | |
description: The MD5 checksum of the file if available. | |
sha1: | |
type: string | |
nullable: true | |
description: The SHA-1 checksum of the file if available. | |
sha224: | |
type: string | |
nullable: true | |
description: The SHA-224 checksum of the file if available. | |
sha256: | |
type: string | |
nullable: true | |
description: The SHA-256 checksum of the file if available. | |
sha384: | |
type: string | |
nullable: true | |
description: The SHA-384 checksum of the file if available. | |
sha512: | |
type: string | |
nullable: true | |
description: The SHA-512 checksum of the file if available. | |
required: | |
- file | |
ArtifactResponse: | |
type: object | |
description: |- | |
Base serializer for use with :class:`pulpcore.app.models.Model` | |
This ensures that all Serializers provide values for the 'pulp_href` field. | |
The class provides a default for the ``ref_name`` attribute in the | |
ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions | |
of plugins are namespaced properly. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
file: | |
type: string | |
description: The stored file. | |
size: | |
type: integer | |
description: The size of the file in bytes. | |
md5: | |
type: string | |
nullable: true | |
description: The MD5 checksum of the file if available. | |
sha1: | |
type: string | |
nullable: true | |
description: The SHA-1 checksum of the file if available. | |
sha224: | |
type: string | |
nullable: true | |
description: The SHA-224 checksum of the file if available. | |
sha256: | |
type: string | |
nullable: true | |
description: The SHA-256 checksum of the file if available. | |
sha384: | |
type: string | |
nullable: true | |
description: The SHA-384 checksum of the file if available. | |
sha512: | |
type: string | |
nullable: true | |
description: The SHA-512 checksum of the file if available. | |
required: | |
- file | |
AsyncOperationResponse: | |
type: object | |
description: Serializer for asynchronous operations. | |
properties: | |
task: | |
type: string | |
format: uri | |
description: The href of the task. | |
required: | |
- task | |
CertificationEnum: | |
enum: | |
- certified | |
- not_certified | |
- needs_review | |
type: string | |
Collection: | |
type: object | |
description: A serializer for a Collection. | |
properties: | |
created_at: | |
type: string | |
format: date-time | |
updated_at: | |
type: string | |
format: date-time | |
deprecated: | |
type: boolean | |
required: | |
- created_at | |
- deprecated | |
- updated_at | |
CollectionImportDetailResponse: | |
type: object | |
description: A serializer for a CollectionImport detail view. | |
properties: | |
id: | |
type: string | |
format: uuid | |
state: | |
type: string | |
created_at: | |
type: string | |
format: date-time | |
updated_at: | |
type: string | |
format: date-time | |
started_at: | |
type: string | |
format: date-time | |
finished_at: | |
type: string | |
format: date-time | |
error: | |
type: object | |
messages: | |
type: object | |
required: | |
- created_at | |
- error | |
- finished_at | |
- id | |
- messages | |
- started_at | |
- state | |
- updated_at | |
CollectionMetadata: | |
type: object | |
description: A serializer for a CollectionVersion metadata. | |
properties: | |
tags: | |
type: array | |
items: | |
type: string | |
required: | |
- tags | |
CollectionMetadataResponse: | |
type: object | |
description: A serializer for a CollectionVersion metadata. | |
properties: | |
authors: | |
type: array | |
items: | |
type: string | |
readOnly: true | |
contents: | |
type: object | |
readOnly: true | |
dependencies: | |
type: object | |
readOnly: true | |
description: | |
type: string | |
readOnly: true | |
documentation: | |
type: string | |
format: uri | |
readOnly: true | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
homepage: | |
type: string | |
format: uri | |
readOnly: true | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
issues: | |
type: string | |
format: uri | |
readOnly: true | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
license: | |
type: array | |
items: | |
type: string | |
readOnly: true | |
repository: | |
type: string | |
format: uri | |
readOnly: true | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
tags: | |
type: array | |
items: | |
type: string | |
required: | |
- tags | |
CollectionNamespace: | |
type: object | |
description: A serializer for a Collection Version namespace field. | |
properties: | |
name: | |
type: string | |
required: | |
- name | |
CollectionNamespaceResponse: | |
type: object | |
description: A serializer for a Collection Version namespace field. | |
properties: | |
name: | |
type: string | |
required: | |
- name | |
CollectionOneShot: | |
type: object | |
description: A serializer for the Collection One Shot Upload API. | |
properties: | |
file: | |
type: string | |
format: binary | |
description: The Collection tarball. | |
sha256: | |
type: string | |
description: An optional sha256 checksum of the uploaded file. | |
expected_namespace: | |
type: string | |
description: The expected 'namespace' of the Collection to be verified against | |
the metadata during import. | |
expected_name: | |
type: string | |
description: The expected 'name' of the Collection to be verified against | |
the metadata during import. | |
expected_version: | |
type: string | |
description: The expected version of the Collection to be verified against | |
the metadata during import. | |
required: | |
- file | |
CollectionRef: | |
type: object | |
description: A serializer for a Collection reference. | |
properties: | |
id: | |
type: string | |
name: | |
type: string | |
required: | |
- id | |
- name | |
CollectionRefResponse: | |
type: object | |
description: A serializer for a Collection reference. | |
properties: | |
id: | |
type: string | |
name: | |
type: string | |
href: | |
readOnly: true | |
required: | |
- id | |
- name | |
CollectionResponse: | |
type: object | |
description: A serializer for a Collection. | |
properties: | |
href: | |
readOnly: true | |
created_at: | |
type: string | |
format: date-time | |
updated_at: | |
type: string | |
format: date-time | |
namespace: | |
type: string | |
readOnly: true | |
name: | |
type: string | |
readOnly: true | |
deprecated: | |
type: boolean | |
versions_url: | |
readOnly: true | |
highest_version: | |
readOnly: true | |
required: | |
- created_at | |
- deprecated | |
- updated_at | |
CollectionVersion: | |
type: object | |
description: A serializer for a CollectionVersion. | |
properties: | |
certification: | |
$ref: '#/components/schemas/CertificationEnum' | |
created_at: | |
type: string | |
format: date-time | |
updated_at: | |
type: string | |
format: date-time | |
required: | |
- created_at | |
- updated_at | |
CollectionVersionResponse: | |
type: object | |
description: A serializer for a CollectionVersion. | |
properties: | |
version: | |
type: string | |
readOnly: true | |
certification: | |
$ref: '#/components/schemas/CertificationEnum' | |
href: | |
readOnly: true | |
created_at: | |
type: string | |
format: date-time | |
updated_at: | |
type: string | |
format: date-time | |
artifact: | |
readOnly: true | |
collection: | |
allOf: | |
- $ref: '#/components/schemas/CollectionRefResponse' | |
readOnly: true | |
download_url: | |
readOnly: true | |
name: | |
type: string | |
readOnly: true | |
namespace: | |
allOf: | |
- $ref: '#/components/schemas/CollectionNamespaceResponse' | |
readOnly: true | |
metadata: | |
allOf: | |
- $ref: '#/components/schemas/CollectionMetadataResponse' | |
readOnly: true | |
required: | |
- created_at | |
- updated_at | |
CollectionVersionWithDownloadUrlResponse: | |
type: object | |
description: A serializer for a CollectionVersion. | |
properties: | |
version: | |
type: string | |
readOnly: true | |
certification: | |
$ref: '#/components/schemas/CertificationEnum' | |
href: | |
readOnly: true | |
created_at: | |
type: string | |
format: date-time | |
updated_at: | |
type: string | |
format: date-time | |
artifact: | |
readOnly: true | |
collection: | |
allOf: | |
- $ref: '#/components/schemas/CollectionWithFixedHrefsRefResponse' | |
readOnly: true | |
download_url: | |
readOnly: true | |
name: | |
type: string | |
readOnly: true | |
namespace: | |
allOf: | |
- $ref: '#/components/schemas/CollectionNamespaceResponse' | |
readOnly: true | |
metadata: | |
allOf: | |
- $ref: '#/components/schemas/CollectionMetadataResponse' | |
readOnly: true | |
required: | |
- created_at | |
- updated_at | |
CollectionWithFixedHrefs: | |
type: object | |
description: A serializer for a Collection. | |
properties: | |
created_at: | |
type: string | |
format: date-time | |
updated_at: | |
type: string | |
format: date-time | |
deprecated: | |
type: boolean | |
required: | |
- created_at | |
- deprecated | |
- updated_at | |
CollectionWithFixedHrefsRefResponse: | |
type: object | |
description: A serializer for a Collection reference. | |
properties: | |
id: | |
type: string | |
name: | |
type: string | |
href: | |
readOnly: true | |
required: | |
- id | |
- name | |
CollectionWithFixedHrefsResponse: | |
type: object | |
description: A serializer for a Collection. | |
properties: | |
href: | |
readOnly: true | |
created_at: | |
type: string | |
format: date-time | |
updated_at: | |
type: string | |
format: date-time | |
namespace: | |
type: string | |
readOnly: true | |
name: | |
type: string | |
readOnly: true | |
deprecated: | |
type: boolean | |
versions_url: | |
readOnly: true | |
highest_version: | |
readOnly: true | |
required: | |
- created_at | |
- deprecated | |
- updated_at | |
ContentAppStatusResponse: | |
type: object | |
description: |- | |
Base serializer for use with :class:`pulpcore.app.models.Model` | |
This ensures that all Serializers provide values for the 'pulp_href` field. | |
The class provides a default for the ``ref_name`` attribute in the | |
ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions | |
of plugins are namespaced properly. | |
properties: | |
name: | |
type: string | |
readOnly: true | |
description: The name of the worker. | |
last_heartbeat: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of the last time the worker talked to the service. | |
ContentSummary: | |
type: object | |
description: Serializer for the RepositoryVersion content summary | |
properties: | |
added: | |
type: object | |
removed: | |
type: object | |
present: | |
type: object | |
required: | |
- added | |
- present | |
- removed | |
ContentSummaryResponse: | |
type: object | |
description: Serializer for the RepositoryVersion content summary | |
properties: | |
added: | |
type: object | |
removed: | |
type: object | |
present: | |
type: object | |
required: | |
- added | |
- present | |
- removed | |
CurrentUser: | |
type: object | |
properties: | |
username: | |
type: string | |
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ | |
only. | |
pattern: ^[\w.@+-]+$ | |
maxLength: 150 | |
first_name: | |
type: string | |
maxLength: 30 | |
last_name: | |
type: string | |
maxLength: 150 | |
email: | |
type: string | |
format: email | |
maxLength: 254 | |
password: | |
type: string | |
writeOnly: true | |
maxLength: 128 | |
required: | |
- username | |
CurrentUserResponse: | |
type: object | |
properties: | |
id: | |
type: integer | |
readOnly: true | |
username: | |
type: string | |
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ | |
only. | |
pattern: ^[\w.@+-]+$ | |
maxLength: 150 | |
first_name: | |
type: string | |
maxLength: 30 | |
last_name: | |
type: string | |
maxLength: 150 | |
email: | |
type: string | |
format: email | |
maxLength: 254 | |
groups: | |
type: array | |
items: | |
type: integer | |
readOnly: true | |
description: The groups this user belongs to. A user will get all permissions | |
granted to each of their groups. | |
date_joined: | |
type: string | |
format: date-time | |
readOnly: true | |
is_partner_engineer: | |
readOnly: true | |
required: | |
- username | |
DatabaseConnectionResponse: | |
type: object | |
description: Serializer for the database connection information | |
properties: | |
connected: | |
type: boolean | |
description: Info about whether the app can connect to the database | |
required: | |
- connected | |
GalaxyCollection: | |
type: object | |
description: A serializer for a Collection. | |
properties: | |
name: | |
type: string | |
namespace: | |
type: string | |
required: | |
- name | |
- namespace | |
GalaxyCollectionResponse: | |
type: object | |
description: A serializer for a Collection. | |
properties: | |
name: | |
type: string | |
namespace: | |
type: string | |
href: | |
readOnly: true | |
versions_url: | |
readOnly: true | |
required: | |
- name | |
- namespace | |
GalaxyCollectionVersionResponse: | |
type: object | |
description: A serializer for a CollectionVersion. | |
properties: | |
version: | |
type: string | |
href: | |
readOnly: true | |
namespace: | |
readOnly: true | |
collection: | |
readOnly: true | |
artifact: | |
readOnly: true | |
metadata: | |
$ref: '#/components/schemas/CollectionMetadataResponse' | |
required: | |
- metadata | |
- version | |
GalaxyRoleResponse: | |
type: object | |
description: A serializer for Galaxy's representation of Roles. | |
properties: | |
id: | |
readOnly: true | |
name: | |
type: string | |
namespace: | |
type: string | |
required: | |
- name | |
- namespace | |
GalaxyRoleVersionResponse: | |
type: object | |
description: A serializer for Galaxy's representation of Role versions. | |
properties: | |
name: | |
type: string | |
source: | |
readOnly: true | |
required: | |
- name | |
GroupProgressReportResponse: | |
type: object | |
description: |- | |
Base serializer for use with :class:`pulpcore.app.models.Model` | |
This ensures that all Serializers provide values for the 'pulp_href` field. | |
The class provides a default for the ``ref_name`` attribute in the | |
ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions | |
of plugins are namespaced properly. | |
properties: | |
message: | |
type: string | |
readOnly: true | |
description: The message shown to the user for the group progress report. | |
code: | |
type: string | |
readOnly: true | |
description: Identifies the type of group progress report'. | |
total: | |
type: integer | |
readOnly: true | |
description: The total count of items. | |
done: | |
type: integer | |
readOnly: true | |
description: The count of items already processed. Defaults to 0. | |
suffix: | |
type: string | |
readOnly: true | |
nullable: true | |
description: The suffix to be shown with the group progress report. | |
ImportResponse: | |
type: object | |
description: Serializer for Imports. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
task: | |
type: string | |
format: uri | |
description: A URI of the Task that ran the Import. | |
params: | |
type: object | |
description: Any parameters that were used to create the import. | |
required: | |
- params | |
- task | |
ImportTaskDetailResponse: | |
type: object | |
properties: | |
id: | |
type: string | |
format: uuid | |
state: | |
type: string | |
created_at: | |
type: string | |
format: date-time | |
updated_at: | |
type: string | |
format: date-time | |
started_at: | |
type: string | |
format: date-time | |
finished_at: | |
type: string | |
format: date-time | |
error: | |
type: object | |
messages: | |
type: object | |
required: | |
- created_at | |
- error | |
- finished_at | |
- id | |
- messages | |
- started_at | |
- state | |
- updated_at | |
ImportTaskListResponse: | |
type: object | |
properties: | |
id: | |
type: string | |
format: uuid | |
state: | |
type: string | |
created_at: | |
type: string | |
format: date-time | |
updated_at: | |
type: string | |
format: date-time | |
started_at: | |
type: string | |
format: date-time | |
finished_at: | |
type: string | |
format: date-time | |
required: | |
- created_at | |
- finished_at | |
- id | |
- started_at | |
- state | |
- updated_at | |
ManifestCopy: | |
type: object | |
description: Serializer for copying manifests from a source repository to a | |
destination repository. | |
properties: | |
source_repository: | |
type: string | |
format: uri | |
description: A URI of the repository to copy content from. | |
source_repository_version: | |
type: string | |
format: uri | |
description: A URI of the repository version to copy content from. | |
digests: | |
type: array | |
items: {} | |
description: A list of manifest digests to copy. | |
media_types: | |
type: array | |
items: | |
enum: | |
- application/vnd.docker.distribution.manifest.v1+json | |
- application/vnd.docker.distribution.manifest.v2+json | |
- application/vnd.docker.distribution.manifest.list.v2+json | |
- application/vnd.oci.image.manifest.v1+json | |
- application/vnd.oci.image.index.v1+json | |
type: string | |
description: A list of media_types to copy. | |
Namespace: | |
type: object | |
properties: | |
name: | |
type: string | |
maxLength: 64 | |
company: | |
type: string | |
maxLength: 64 | |
email: | |
type: string | |
maxLength: 256 | |
avatar_url: | |
type: string | |
format: uri | |
maxLength: 256 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
description: | |
type: string | |
maxLength: 256 | |
links: | |
type: array | |
items: | |
$ref: '#/components/schemas/NamespaceLink' | |
groups: | |
type: array | |
items: | |
type: string | |
resources: | |
type: string | |
required: | |
- groups | |
- name | |
NamespaceLink: | |
type: object | |
properties: | |
name: | |
type: string | |
maxLength: 32 | |
url: | |
type: string | |
format: uri | |
maxLength: 256 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
required: | |
- name | |
- url | |
NamespaceLinkResponse: | |
type: object | |
properties: | |
name: | |
type: string | |
maxLength: 32 | |
url: | |
type: string | |
format: uri | |
maxLength: 256 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
required: | |
- name | |
- url | |
NamespaceResponse: | |
type: object | |
properties: | |
id: | |
type: integer | |
readOnly: true | |
name: | |
type: string | |
maxLength: 64 | |
company: | |
type: string | |
maxLength: 64 | |
email: | |
type: string | |
maxLength: 256 | |
avatar_url: | |
type: string | |
format: uri | |
maxLength: 256 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
description: | |
type: string | |
maxLength: 256 | |
links: | |
type: array | |
items: | |
$ref: '#/components/schemas/NamespaceLinkResponse' | |
groups: | |
type: array | |
items: | |
type: string | |
resources: | |
type: string | |
required: | |
- groups | |
- name | |
NamespaceSummaryResponse: | |
type: object | |
description: |- | |
NamespaceSerializer but without 'links' or 'resources'. | |
For use in _ui/collection detail views. | |
properties: | |
id: | |
type: integer | |
readOnly: true | |
name: | |
type: string | |
readOnly: true | |
company: | |
type: string | |
maxLength: 64 | |
email: | |
type: string | |
maxLength: 256 | |
avatar_url: | |
type: string | |
format: uri | |
maxLength: 256 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
description: | |
type: string | |
maxLength: 256 | |
NamespaceUpdate: | |
type: object | |
description: NamespaceSerializer but read_only 'name'. | |
properties: | |
company: | |
type: string | |
maxLength: 64 | |
email: | |
type: string | |
maxLength: 256 | |
avatar_url: | |
type: string | |
format: uri | |
maxLength: 256 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
description: | |
type: string | |
maxLength: 256 | |
links: | |
type: array | |
items: | |
$ref: '#/components/schemas/NamespaceLink' | |
groups: | |
type: array | |
items: | |
type: string | |
resources: | |
type: string | |
required: | |
- groups | |
NamespaceUpdateResponse: | |
type: object | |
description: NamespaceSerializer but read_only 'name'. | |
properties: | |
id: | |
type: integer | |
readOnly: true | |
name: | |
type: string | |
readOnly: true | |
company: | |
type: string | |
maxLength: 64 | |
email: | |
type: string | |
maxLength: 256 | |
avatar_url: | |
type: string | |
format: uri | |
maxLength: 256 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
description: | |
type: string | |
maxLength: 256 | |
links: | |
type: array | |
items: | |
$ref: '#/components/schemas/NamespaceLinkResponse' | |
groups: | |
type: array | |
items: | |
type: string | |
resources: | |
type: string | |
required: | |
- groups | |
OCIBuildImage: | |
type: object | |
description: |- | |
Serializer for building an OCI container image from a Containerfile. | |
The Containerfile can either be specified via an artifact url, or a new file can be uploaded. | |
A repository must be specified, to which the container image content will be added. | |
properties: | |
containerfile_artifact: | |
type: string | |
format: uri | |
description: Artifact representing the Containerfile that should be used | |
to run buildah. | |
containerfile: | |
type: string | |
format: binary | |
description: An uploaded Containerfile that should be used to run buildah. | |
tag: | |
type: string | |
default: latest | |
description: A tag name for the new image being built. | |
artifacts: | |
type: object | |
description: A JSON string where each key is an artifact href and the value | |
is it's relative path (name) inside the /pulp_working_directory of the | |
build container executing the Containerfile. | |
PatchedAccessPolicy: | |
type: object | |
description: Serializer for AccessPolicy. | |
properties: | |
permissions_assignment: | |
type: array | |
items: | |
type: object | |
description: List of callables that define the new permissions to be created | |
for new objects. | |
statements: | |
type: array | |
items: | |
type: object | |
description: List of policy statements defining the policy. | |
viewset_name: | |
type: string | |
description: The name of ViewSet this AccessPolicy authorizes. | |
PatchedNamespace: | |
type: object | |
properties: | |
name: | |
type: string | |
maxLength: 64 | |
company: | |
type: string | |
maxLength: 64 | |
email: | |
type: string | |
maxLength: 256 | |
avatar_url: | |
type: string | |
format: uri | |
maxLength: 256 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
description: | |
type: string | |
maxLength: 256 | |
links: | |
type: array | |
items: | |
$ref: '#/components/schemas/PatchedNamespaceLink' | |
groups: | |
type: array | |
items: | |
type: string | |
resources: | |
type: string | |
PatchedNamespaceLink: | |
type: object | |
properties: | |
name: | |
type: string | |
maxLength: 32 | |
url: | |
type: string | |
format: uri | |
maxLength: 256 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
PatchedPulpExporter: | |
type: object | |
description: Serializer for pulp exporters. | |
properties: | |
name: | |
type: string | |
description: Unique name of the file system exporter. | |
path: | |
type: string | |
description: File system directory to store exported tar.gzs. | |
repositories: | |
type: array | |
items: | |
type: string | |
format: uri | |
last_export: | |
type: string | |
format: uri | |
nullable: true | |
description: Last attempted export for this PulpExporter | |
PatchedPulpImporter: | |
type: object | |
description: Serializer for PulpImporters. | |
properties: | |
name: | |
type: string | |
description: Unique name of the Importer. | |
repo_mapping: | |
type: object | |
description: 'Mapping of repo names in an export file to the repo names | |
in Pulp. For example, if the export has a repo named ''foo'' and the repo | |
to import content into was ''bar'', the mapping would be "{''foo'': ''bar''}".' | |
PatchedSyncList: | |
type: object | |
properties: | |
name: | |
type: string | |
maxLength: 64 | |
policy: | |
$ref: '#/components/schemas/Policy119Enum' | |
repository: | |
type: string | |
format: uuid | |
collections: | |
type: array | |
items: | |
$ref: '#/components/schemas/PatchedSyncListCollectionSummary' | |
namespaces: | |
type: array | |
items: | |
type: string | |
users: | |
type: array | |
items: | |
type: string | |
groups: | |
type: array | |
items: | |
type: string | |
PatchedSyncListCollectionSummary: | |
type: object | |
properties: | |
namespace: | |
type: string | |
maxLength: 64 | |
name: | |
type: string | |
maxLength: 64 | |
PatchedTaskCancel: | |
type: object | |
description: |- | |
Base serializer for use with :class:`pulpcore.app.models.Model` | |
This ensures that all Serializers provide values for the 'pulp_href` field. | |
The class provides a default for the ``ref_name`` attribute in the | |
ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions | |
of plugins are namespaced properly. | |
properties: | |
state: | |
type: string | |
description: The desired state of the task. Only 'canceled' is accepted. | |
PatchedUser: | |
type: object | |
properties: | |
username: | |
type: string | |
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ | |
only. | |
pattern: ^[\w.@+-]+$ | |
maxLength: 150 | |
first_name: | |
type: string | |
maxLength: 30 | |
last_name: | |
type: string | |
maxLength: 150 | |
email: | |
type: string | |
format: email | |
maxLength: 254 | |
groups: | |
type: array | |
items: | |
type: integer | |
description: The groups this user belongs to. A user will get all permissions | |
granted to each of their groups. | |
password: | |
type: string | |
writeOnly: true | |
maxLength: 128 | |
Patchedansible.AnsibleDistribution: | |
type: object | |
description: Serializer for Ansible Distributions. | |
properties: | |
base_path: | |
type: string | |
description: The base (relative) path component of the published url. Avoid | |
paths that overlap with other distribution base paths | |
(e.g. "foo" and "foo/bar") | |
content_guard: | |
type: string | |
format: uri | |
nullable: true | |
description: An optional content-guard. | |
name: | |
type: string | |
description: A unique name. Ex, `rawhide` and `stable`. | |
repository: | |
type: string | |
format: uri | |
nullable: true | |
description: The latest RepositoryVersion for this Repository will be served. | |
repository_version: | |
type: string | |
format: uri | |
nullable: true | |
description: RepositoryVersion to be served | |
Patchedansible.AnsibleRemote: | |
type: object | |
description: A serializer for Ansible Remotes. | |
properties: | |
name: | |
type: string | |
description: A unique name for this remote. | |
url: | |
type: string | |
description: The URL of an external content source. | |
ca_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded CA certificate used to validate the server certificate | |
presented by the remote server. | |
client_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded client certificate used for authentication. | |
client_key: | |
type: string | |
nullable: true | |
description: A PEM encoded private key used for authentication. | |
tls_validation: | |
type: boolean | |
description: If True, TLS peer validation must be performed. | |
proxy_url: | |
type: string | |
nullable: true | |
description: 'The proxy URL. Format: scheme://user:password@host:port' | |
username: | |
type: string | |
nullable: true | |
description: The username to be used for authentication when syncing. | |
password: | |
type: string | |
nullable: true | |
description: The password to be used for authentication when syncing. | |
download_concurrency: | |
type: integer | |
minimum: 1 | |
description: Total number of simultaneous connections. | |
policy: | |
allOf: | |
- $ref: '#/components/schemas/PolicyF25Enum' | |
default: immediate | |
description: The policy to use when downloading content. | |
Patchedansible.AnsibleRepository: | |
type: object | |
description: Serializer for Ansible Repositories. | |
properties: | |
name: | |
type: string | |
description: A unique name for this repository. | |
description: | |
type: string | |
nullable: true | |
description: An optional description. | |
remote: | |
type: string | |
format: uri | |
nullable: true | |
Patchedansible.CollectionRemote: | |
type: object | |
description: A serializer for Collection Remotes. | |
properties: | |
name: | |
type: string | |
description: A unique name for this remote. | |
url: | |
type: string | |
description: The URL of an external content source. | |
ca_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded CA certificate used to validate the server certificate | |
presented by the remote server. | |
client_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded client certificate used for authentication. | |
client_key: | |
type: string | |
nullable: true | |
description: A PEM encoded private key used for authentication. | |
tls_validation: | |
type: boolean | |
description: If True, TLS peer validation must be performed. | |
proxy_url: | |
type: string | |
nullable: true | |
description: 'The proxy URL. Format: scheme://user:password@host:port' | |
username: | |
type: string | |
nullable: true | |
description: The username to be used for authentication when syncing. | |
password: | |
type: string | |
nullable: true | |
description: The password to be used for authentication when syncing. | |
download_concurrency: | |
type: integer | |
minimum: 1 | |
description: Total number of simultaneous connections. | |
policy: | |
allOf: | |
- $ref: '#/components/schemas/PolicyF25Enum' | |
default: immediate | |
description: The policy to use when downloading content. | |
requirements_file: | |
type: string | |
nullable: true | |
description: The string version of Collection requirements yaml. | |
auth_url: | |
type: string | |
nullable: true | |
description: The URL to receive a session token from, e.g. used with Automation | |
Hub. | |
maxLength: 255 | |
token: | |
type: string | |
nullable: true | |
description: The token key to use for authentication. See https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#configuring-the-ansible-galaxy-clientfor | |
more details | |
maxLength: 2000 | |
Patchedcontainer.ContainerDistribution: | |
type: object | |
description: A serializer for ContainerDistribution. | |
properties: | |
name: | |
type: string | |
description: A unique name. Ex, `rawhide` and `stable`. | |
content_guard: | |
type: string | |
format: uri | |
description: An optional content-guard. If none is specified, a default | |
one will be used. | |
repository_version: | |
type: string | |
format: uri | |
nullable: true | |
description: RepositoryVersion to be served | |
repository: | |
type: string | |
format: uri | |
nullable: true | |
description: The latest RepositoryVersion for this Repository will be served. | |
base_path: | |
type: string | |
description: The base (relative) path component of the published url. Avoid | |
paths that overlap with other distribution base paths | |
(e.g. "foo" and "foo/bar") | |
Patchedcontainer.ContainerRemote: | |
type: object | |
description: A Serializer for ContainerRemote. | |
properties: | |
name: | |
type: string | |
description: A unique name for this remote. | |
url: | |
type: string | |
description: The URL of an external content source. | |
ca_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded CA certificate used to validate the server certificate | |
presented by the remote server. | |
client_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded client certificate used for authentication. | |
client_key: | |
type: string | |
nullable: true | |
description: A PEM encoded private key used for authentication. | |
tls_validation: | |
type: boolean | |
description: If True, TLS peer validation must be performed. | |
proxy_url: | |
type: string | |
nullable: true | |
description: 'The proxy URL. Format: scheme://user:password@host:port' | |
username: | |
type: string | |
nullable: true | |
description: The username to be used for authentication when syncing. | |
password: | |
type: string | |
nullable: true | |
description: The password to be used for authentication when syncing. | |
download_concurrency: | |
type: integer | |
minimum: 1 | |
description: Total number of simultaneous connections. | |
policy: | |
allOf: | |
- $ref: '#/components/schemas/Policy63aEnum' | |
default: immediate | |
description: "\n immediate - All manifests and blobs are downloaded\ | |
\ and saved during a sync.\n on_demand - Only tags and manifests\ | |
\ are downloaded. Blobs are not\n downloaded until\ | |
\ they are requested for the first time by a client.\n streamed\ | |
\ - Blobs are streamed to the client with every request and never saved.\n\ | |
\ " | |
upstream_name: | |
type: string | |
description: Name of the upstream repository | |
whitelist_tags: | |
type: array | |
items: | |
type: string | |
nullable: true | |
description: A list of whitelisted tags to sync | |
Patchedcontainer.ContainerRepository: | |
type: object | |
description: Serializer for Container Repositories. | |
properties: | |
name: | |
type: string | |
description: A unique name for this repository. | |
description: | |
type: string | |
nullable: true | |
description: An optional description. | |
remote: | |
type: string | |
format: uri | |
nullable: true | |
Patchedcontainer.ContentRedirectContentGuard: | |
type: object | |
description: A serializer for ContentRedirectContentGuard. | |
properties: | |
name: | |
type: string | |
description: The unique name. | |
description: | |
type: string | |
nullable: true | |
description: An optional description. | |
Policy119Enum: | |
enum: | |
- blacklist | |
- whitelist | |
type: string | |
Policy63aEnum: | |
enum: | |
- immediate | |
- on_demand | |
- streamed | |
type: string | |
PolicyF25Enum: | |
enum: | |
- immediate | |
- When syncing, download all metadata and content now. | |
type: string | |
ProgressReportResponse: | |
type: object | |
description: |- | |
Base serializer for use with :class:`pulpcore.app.models.Model` | |
This ensures that all Serializers provide values for the 'pulp_href` field. | |
The class provides a default for the ``ref_name`` attribute in the | |
ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions | |
of plugins are namespaced properly. | |
properties: | |
message: | |
type: string | |
readOnly: true | |
description: The message shown to the user for the progress report. | |
code: | |
type: string | |
readOnly: true | |
description: Identifies the type of progress report'. | |
state: | |
type: string | |
readOnly: true | |
description: 'The current state of the progress report. The possible values | |
are: ''waiting'', ''skipped'', ''running'', ''completed'', ''failed'' | |
and ''canceled''. The default is ''waiting''.' | |
total: | |
type: integer | |
readOnly: true | |
description: The total count of items. | |
done: | |
type: integer | |
readOnly: true | |
description: The count of items already processed. Defaults to 0. | |
suffix: | |
type: string | |
readOnly: true | |
nullable: true | |
description: The suffix to be shown with the progress report. | |
PulpExport: | |
type: object | |
description: Serializer for PulpExports. | |
properties: | |
task: | |
type: string | |
format: uri | |
nullable: true | |
description: A URI of the task that ran the Export. | |
full: | |
type: boolean | |
writeOnly: true | |
default: true | |
description: Do a Full (true) or Incremental (false) export. | |
dry_run: | |
type: boolean | |
writeOnly: true | |
default: false | |
description: Generate report on what would be exported and disk-space required. | |
versions: | |
type: array | |
items: | |
type: string | |
format: uri | |
writeOnly: true | |
writeOnly: true | |
description: List of explicit repo-version hrefs to export (replaces current_version). | |
chunk_size: | |
type: string | |
writeOnly: true | |
description: Chunk export-tarfile into pieces of chunk_size bytes.Recognizes | |
units of B/KB/MB/GB/TB. | |
start_versions: | |
type: array | |
items: | |
type: string | |
format: uri | |
writeOnly: true | |
writeOnly: true | |
description: List of explicit last-exported-repo-version hrefs (replaces | |
last_export). | |
PulpExportResponse: | |
type: object | |
description: Serializer for PulpExports. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
task: | |
type: string | |
format: uri | |
nullable: true | |
description: A URI of the task that ran the Export. | |
exported_resources: | |
type: array | |
items: {} | |
readOnly: true | |
description: Resources that were exported. | |
params: | |
type: object | |
readOnly: true | |
description: Any additional parameters that were used to create the export. | |
output_file_info: | |
type: object | |
readOnly: true | |
description: 'Dictionary of filename: sha256hash entries for export-output-file(s)' | |
PulpExporter: | |
type: object | |
description: Serializer for pulp exporters. | |
properties: | |
name: | |
type: string | |
description: Unique name of the file system exporter. | |
path: | |
type: string | |
description: File system directory to store exported tar.gzs. | |
repositories: | |
type: array | |
items: | |
type: string | |
format: uri | |
last_export: | |
type: string | |
format: uri | |
nullable: true | |
description: Last attempted export for this PulpExporter | |
required: | |
- name | |
- path | |
- repositories | |
PulpExporterResponse: | |
type: object | |
description: Serializer for pulp exporters. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
name: | |
type: string | |
description: Unique name of the file system exporter. | |
path: | |
type: string | |
description: File system directory to store exported tar.gzs. | |
repositories: | |
type: array | |
items: | |
type: string | |
format: uri | |
last_export: | |
type: string | |
format: uri | |
nullable: true | |
description: Last attempted export for this PulpExporter | |
required: | |
- name | |
- path | |
- repositories | |
PulpImport: | |
type: object | |
description: Serializer for call to import into Pulp. | |
properties: | |
path: | |
type: string | |
description: Path to export that will be imported. | |
toc: | |
type: string | |
description: Path to a table-of-contents file describing chunks to be validated, | |
reassembled, and imported. | |
PulpImporter: | |
type: object | |
description: Serializer for PulpImporters. | |
properties: | |
name: | |
type: string | |
description: Unique name of the Importer. | |
repo_mapping: | |
type: object | |
description: 'Mapping of repo names in an export file to the repo names | |
in Pulp. For example, if the export has a repo named ''foo'' and the repo | |
to import content into was ''bar'', the mapping would be "{''foo'': ''bar''}".' | |
required: | |
- name | |
PulpImporterResponse: | |
type: object | |
description: Serializer for PulpImporters. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
name: | |
type: string | |
description: Unique name of the Importer. | |
repo_mapping: | |
type: object | |
description: 'Mapping of repo names in an export file to the repo names | |
in Pulp. For example, if the export has a repo named ''foo'' and the repo | |
to import content into was ''bar'', the mapping would be "{''foo'': ''bar''}".' | |
required: | |
- name | |
RecursiveManage: | |
type: object | |
description: Serializer for adding and removing content to/from a Container | |
repository. | |
properties: | |
content_units: | |
type: array | |
items: {} | |
description: A list of content units to operate on. | |
RedisConnectionResponse: | |
type: object | |
description: Serializer for information about the Redis connection | |
properties: | |
connected: | |
type: boolean | |
description: Info about whether the app can connect to Redis | |
required: | |
- connected | |
RepositoryAddRemoveContent: | |
type: object | |
description: |- | |
Base serializer for use with :class:`pulpcore.app.models.Model` | |
This ensures that all Serializers provide values for the 'pulp_href` field. | |
The class provides a default for the ``ref_name`` attribute in the | |
ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions | |
of plugins are namespaced properly. | |
properties: | |
add_content_units: | |
type: array | |
items: {} | |
description: A list of content units to add to a new repository version. | |
This content is added after remove_content_units are removed. | |
remove_content_units: | |
type: array | |
items: {} | |
description: A list of content units to remove from the latest repository | |
version. You may also specify '*' as an entry to remove all content. This | |
content is removed before add_content_units are added. | |
base_version: | |
type: string | |
format: uri | |
description: A repository version whose content will be used as the initial | |
set of content for the new repository version | |
RepositorySyncURL: | |
type: object | |
properties: | |
remote: | |
type: string | |
format: uri | |
description: A remote to sync from. This will override a remote set on repository. | |
mirror: | |
type: boolean | |
default: false | |
description: If ``True``, synchronization will remove all content that is | |
not present in the remote repository. If ``False``, sync will be additive | |
only. | |
RepositoryVersion: | |
type: object | |
description: |- | |
Base serializer for use with :class:`pulpcore.app.models.Model` | |
This ensures that all Serializers provide values for the 'pulp_href` field. | |
The class provides a default for the ``ref_name`` attribute in the | |
ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions | |
of plugins are namespaced properly. | |
properties: | |
base_version: | |
type: string | |
format: uri | |
description: A repository version whose content was used as the initial | |
set of content for this repository version | |
RepositoryVersionResponse: | |
type: object | |
description: |- | |
Base serializer for use with :class:`pulpcore.app.models.Model` | |
This ensures that all Serializers provide values for the 'pulp_href` field. | |
The class provides a default for the ``ref_name`` attribute in the | |
ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions | |
of plugins are namespaced properly. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
number: | |
type: integer | |
readOnly: true | |
base_version: | |
type: string | |
format: uri | |
description: A repository version whose content was used as the initial | |
set of content for this repository version | |
content_summary: | |
allOf: | |
- $ref: '#/components/schemas/ContentSummaryResponse' | |
readOnly: true | |
description: Various count summaries of the content in the version and the | |
HREF to view them. | |
SigningServiceResponse: | |
type: object | |
description: A serializer for the model declaring a signing service. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
name: | |
type: string | |
description: A unique name used to recognize a script. | |
script: | |
type: string | |
description: An absolute path to a script which is going to be used for | |
the signing. | |
required: | |
- name | |
- script | |
StatusResponse: | |
type: object | |
description: Serializer for the status information of the app | |
properties: | |
versions: | |
type: array | |
items: | |
$ref: '#/components/schemas/VersionResponse' | |
description: Version information of Pulp components | |
online_workers: | |
type: array | |
items: | |
$ref: '#/components/schemas/WorkerResponse' | |
description: List of online workers known to the application. An online | |
worker is actively heartbeating and can respond to new work | |
online_content_apps: | |
type: array | |
items: | |
$ref: '#/components/schemas/ContentAppStatusResponse' | |
description: List of online content apps known to the application. An online | |
content app is actively heartbeating and can serve data to clients | |
database_connection: | |
allOf: | |
- $ref: '#/components/schemas/DatabaseConnectionResponse' | |
description: Database connection information | |
redis_connection: | |
allOf: | |
- $ref: '#/components/schemas/RedisConnectionResponse' | |
description: Redis connection information | |
storage: | |
allOf: | |
- $ref: '#/components/schemas/StorageResponse' | |
description: Storage information | |
required: | |
- database_connection | |
- online_content_apps | |
- online_workers | |
- redis_connection | |
- versions | |
StorageResponse: | |
type: object | |
description: Serializer for information about the storage system | |
properties: | |
total: | |
type: integer | |
description: Total number of bytes | |
minimum: 0 | |
used: | |
type: integer | |
description: Number of bytes in use | |
minimum: 0 | |
free: | |
type: integer | |
description: Number of free bytes | |
minimum: 0 | |
required: | |
- free | |
- total | |
- used | |
SyncList: | |
type: object | |
properties: | |
name: | |
type: string | |
maxLength: 64 | |
policy: | |
$ref: '#/components/schemas/Policy119Enum' | |
repository: | |
type: string | |
format: uuid | |
collections: | |
type: array | |
items: | |
$ref: '#/components/schemas/SyncListCollectionSummary' | |
namespaces: | |
type: array | |
items: | |
type: string | |
users: | |
type: array | |
items: | |
type: string | |
groups: | |
type: array | |
items: | |
type: string | |
required: | |
- collections | |
- groups | |
- name | |
- namespaces | |
- repository | |
- users | |
SyncListCollectionSummary: | |
type: object | |
properties: | |
namespace: | |
type: string | |
maxLength: 64 | |
name: | |
type: string | |
maxLength: 64 | |
required: | |
- name | |
- namespace | |
SyncListCollectionSummaryResponse: | |
type: object | |
properties: | |
namespace: | |
type: string | |
maxLength: 64 | |
name: | |
type: string | |
maxLength: 64 | |
required: | |
- name | |
- namespace | |
SyncListResponse: | |
type: object | |
properties: | |
id: | |
type: integer | |
readOnly: true | |
name: | |
type: string | |
maxLength: 64 | |
policy: | |
$ref: '#/components/schemas/Policy119Enum' | |
repository: | |
type: string | |
format: uuid | |
collections: | |
type: array | |
items: | |
$ref: '#/components/schemas/SyncListCollectionSummaryResponse' | |
namespaces: | |
type: array | |
items: | |
type: string | |
users: | |
type: array | |
items: | |
type: string | |
groups: | |
type: array | |
items: | |
type: string | |
required: | |
- collections | |
- groups | |
- name | |
- namespaces | |
- repository | |
- users | |
TagCopy: | |
type: object | |
description: Serializer for copying tags from a source repository to a destination | |
repository. | |
properties: | |
source_repository: | |
type: string | |
format: uri | |
description: A URI of the repository to copy content from. | |
source_repository_version: | |
type: string | |
format: uri | |
description: A URI of the repository version to copy content from. | |
names: | |
type: array | |
items: {} | |
description: A list of tag names to copy. | |
TagImage: | |
type: object | |
description: A serializer for parsing and validating data associated with a | |
manifest tagging. | |
properties: | |
tag: | |
type: string | |
description: A tag name | |
digest: | |
type: string | |
description: sha256 of the Manifest file | |
required: | |
- digest | |
- tag | |
TagResponse: | |
type: object | |
description: A serializer for the Tag model. | |
properties: | |
name: | |
type: string | |
readOnly: true | |
TaskGroupResponse: | |
type: object | |
description: |- | |
Base serializer for use with :class:`pulpcore.app.models.Model` | |
This ensures that all Serializers provide values for the 'pulp_href` field. | |
The class provides a default for the ``ref_name`` attribute in the | |
ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions | |
of plugins are namespaced properly. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
description: | |
type: string | |
description: A description of the task group. | |
all_tasks_dispatched: | |
type: boolean | |
description: Whether all tasks have been spawned for this task group. | |
waiting: | |
type: integer | |
readOnly: true | |
description: Number of tasks in the 'waiting' state | |
skipped: | |
type: integer | |
readOnly: true | |
description: Number of tasks in the 'skipped' state | |
running: | |
type: integer | |
readOnly: true | |
description: Number of tasks in the 'running' state | |
completed: | |
type: integer | |
readOnly: true | |
description: Number of tasks in the 'completed' state | |
canceled: | |
type: integer | |
readOnly: true | |
description: Number of tasks in the 'canceled' state | |
failed: | |
type: integer | |
readOnly: true | |
description: Number of tasks in the 'failed' state | |
group_progress_reports: | |
type: array | |
items: | |
$ref: '#/components/schemas/GroupProgressReportResponse' | |
readOnly: true | |
required: | |
- all_tasks_dispatched | |
- description | |
TaskResponse: | |
type: object | |
description: |- | |
Base serializer for use with :class:`pulpcore.app.models.Model` | |
This ensures that all Serializers provide values for the 'pulp_href` field. | |
The class provides a default for the ``ref_name`` attribute in the | |
ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions | |
of plugins are namespaced properly. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
state: | |
type: string | |
readOnly: true | |
description: 'The current state of the task. The possible values include: | |
''waiting'', ''skipped'', ''running'', ''completed'', ''failed'' and ''canceled''.' | |
name: | |
type: string | |
description: The name of task. | |
started_at: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of the when this task started execution. | |
finished_at: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of the when this task stopped execution. | |
error: | |
type: object | |
readOnly: true | |
description: A JSON Object of a fatal error encountered during the execution | |
of this task. | |
worker: | |
type: string | |
format: uri | |
readOnly: true | |
description: The worker associated with this task. This field is empty if | |
a worker is not yet assigned. | |
parent_task: | |
type: string | |
format: uri | |
readOnly: true | |
description: The parent task that spawned this task. | |
child_tasks: | |
type: array | |
items: | |
type: string | |
format: uri | |
readOnly: true | |
description: Any tasks spawned by this task. | |
task_group: | |
type: string | |
format: uri | |
readOnly: true | |
description: The task group that this task is a member of. | |
progress_reports: | |
type: array | |
items: | |
$ref: '#/components/schemas/ProgressReportResponse' | |
readOnly: true | |
created_resources: | |
type: array | |
items: | |
type: string | |
format: uri | |
readOnly: true | |
description: Resources created by this task. | |
required: | |
- name | |
UnTagImage: | |
type: object | |
description: A serializer for parsing and validating data associated with a | |
manifest untagging. | |
properties: | |
tag: | |
type: string | |
description: A tag name | |
required: | |
- tag | |
Upload: | |
type: object | |
description: Serializer for chunked uploads. | |
properties: | |
size: | |
type: integer | |
description: The size of the upload in bytes. | |
required: | |
- size | |
UploadChunk: | |
type: object | |
properties: | |
file: | |
type: string | |
format: binary | |
writeOnly: true | |
description: A chunk of the uploaded file. | |
sha256: | |
type: string | |
writeOnly: true | |
nullable: true | |
description: The SHA-256 checksum of the chunk if available. | |
required: | |
- file | |
UploadChunkResponse: | |
type: object | |
properties: | |
offset: | |
type: integer | |
readOnly: true | |
size: | |
type: integer | |
readOnly: true | |
UploadCommit: | |
type: object | |
properties: | |
sha256: | |
type: string | |
description: The expected sha256 checksum for the file. | |
required: | |
- sha256 | |
UploadDetailResponse: | |
type: object | |
description: Serializer for chunked uploads. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
size: | |
type: integer | |
description: The size of the upload in bytes. | |
completed: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp when upload is committed. | |
chunks: | |
type: array | |
items: | |
$ref: '#/components/schemas/UploadChunkResponse' | |
readOnly: true | |
required: | |
- size | |
UploadResponse: | |
type: object | |
description: Serializer for chunked uploads. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
size: | |
type: integer | |
description: The size of the upload in bytes. | |
completed: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp when upload is committed. | |
required: | |
- size | |
User: | |
type: object | |
properties: | |
username: | |
type: string | |
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ | |
only. | |
pattern: ^[\w.@+-]+$ | |
maxLength: 150 | |
first_name: | |
type: string | |
maxLength: 30 | |
last_name: | |
type: string | |
maxLength: 150 | |
email: | |
type: string | |
format: email | |
maxLength: 254 | |
groups: | |
type: array | |
items: | |
type: integer | |
description: The groups this user belongs to. A user will get all permissions | |
granted to each of their groups. | |
password: | |
type: string | |
writeOnly: true | |
maxLength: 128 | |
required: | |
- username | |
UserResponse: | |
type: object | |
properties: | |
id: | |
type: integer | |
readOnly: true | |
username: | |
type: string | |
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ | |
only. | |
pattern: ^[\w.@+-]+$ | |
maxLength: 150 | |
first_name: | |
type: string | |
maxLength: 30 | |
last_name: | |
type: string | |
maxLength: 150 | |
email: | |
type: string | |
format: email | |
maxLength: 254 | |
groups: | |
type: array | |
items: | |
type: integer | |
description: The groups this user belongs to. A user will get all permissions | |
granted to each of their groups. | |
date_joined: | |
type: string | |
format: date-time | |
readOnly: true | |
required: | |
- username | |
VersionResponse: | |
type: object | |
description: Serializer for the version information of Pulp components | |
properties: | |
component: | |
type: string | |
description: Name of a versioned component of Pulp | |
version: | |
type: string | |
description: Version of the component (e.g. 3.0.0) | |
required: | |
- component | |
- version | |
WorkerResponse: | |
type: object | |
description: |- | |
Base serializer for use with :class:`pulpcore.app.models.Model` | |
This ensures that all Serializers provide values for the 'pulp_href` field. | |
The class provides a default for the ``ref_name`` attribute in the | |
ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions | |
of plugins are namespaced properly. | |
properties: | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
name: | |
type: string | |
readOnly: true | |
description: The name of the worker. | |
last_heartbeat: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of the last time the worker talked to the service. | |
ansible.AnsibleDistribution: | |
type: object | |
description: Serializer for Ansible Distributions. | |
properties: | |
base_path: | |
type: string | |
description: The base (relative) path component of the published url. Avoid | |
paths that overlap with other distribution base paths | |
(e.g. "foo" and "foo/bar") | |
content_guard: | |
type: string | |
format: uri | |
nullable: true | |
description: An optional content-guard. | |
name: | |
type: string | |
description: A unique name. Ex, `rawhide` and `stable`. | |
repository: | |
type: string | |
format: uri | |
nullable: true | |
description: The latest RepositoryVersion for this Repository will be served. | |
repository_version: | |
type: string | |
format: uri | |
nullable: true | |
description: RepositoryVersion to be served | |
required: | |
- base_path | |
- name | |
ansible.AnsibleDistributionResponse: | |
type: object | |
description: Serializer for Ansible Distributions. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
base_path: | |
type: string | |
description: The base (relative) path component of the published url. Avoid | |
paths that overlap with other distribution base paths | |
(e.g. "foo" and "foo/bar") | |
content_guard: | |
type: string | |
format: uri | |
nullable: true | |
description: An optional content-guard. | |
name: | |
type: string | |
description: A unique name. Ex, `rawhide` and `stable`. | |
repository: | |
type: string | |
format: uri | |
nullable: true | |
description: The latest RepositoryVersion for this Repository will be served. | |
repository_version: | |
type: string | |
format: uri | |
nullable: true | |
description: RepositoryVersion to be served | |
client_url: | |
readOnly: true | |
description: The URL of a Collection content source. | |
required: | |
- base_path | |
- name | |
ansible.AnsibleRemote: | |
type: object | |
description: A serializer for Ansible Remotes. | |
properties: | |
name: | |
type: string | |
description: A unique name for this remote. | |
url: | |
type: string | |
description: The URL of an external content source. | |
ca_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded CA certificate used to validate the server certificate | |
presented by the remote server. | |
client_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded client certificate used for authentication. | |
client_key: | |
type: string | |
nullable: true | |
description: A PEM encoded private key used for authentication. | |
tls_validation: | |
type: boolean | |
description: If True, TLS peer validation must be performed. | |
proxy_url: | |
type: string | |
nullable: true | |
description: 'The proxy URL. Format: scheme://user:password@host:port' | |
username: | |
type: string | |
nullable: true | |
description: The username to be used for authentication when syncing. | |
password: | |
type: string | |
nullable: true | |
description: The password to be used for authentication when syncing. | |
download_concurrency: | |
type: integer | |
minimum: 1 | |
description: Total number of simultaneous connections. | |
policy: | |
allOf: | |
- $ref: '#/components/schemas/PolicyF25Enum' | |
default: immediate | |
description: The policy to use when downloading content. | |
required: | |
- name | |
- url | |
ansible.AnsibleRemoteResponse: | |
type: object | |
description: A serializer for Ansible Remotes. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
name: | |
type: string | |
description: A unique name for this remote. | |
url: | |
type: string | |
description: The URL of an external content source. | |
ca_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded CA certificate used to validate the server certificate | |
presented by the remote server. | |
client_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded client certificate used for authentication. | |
client_key: | |
type: string | |
nullable: true | |
description: A PEM encoded private key used for authentication. | |
tls_validation: | |
type: boolean | |
description: If True, TLS peer validation must be performed. | |
proxy_url: | |
type: string | |
nullable: true | |
description: 'The proxy URL. Format: scheme://user:password@host:port' | |
username: | |
type: string | |
nullable: true | |
description: The username to be used for authentication when syncing. | |
password: | |
type: string | |
nullable: true | |
description: The password to be used for authentication when syncing. | |
pulp_last_updated: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of the most recent update of the remote. | |
download_concurrency: | |
type: integer | |
minimum: 1 | |
description: Total number of simultaneous connections. | |
policy: | |
allOf: | |
- $ref: '#/components/schemas/PolicyF25Enum' | |
default: immediate | |
description: The policy to use when downloading content. | |
required: | |
- name | |
- url | |
ansible.AnsibleRepository: | |
type: object | |
description: Serializer for Ansible Repositories. | |
properties: | |
name: | |
type: string | |
description: A unique name for this repository. | |
description: | |
type: string | |
nullable: true | |
description: An optional description. | |
remote: | |
type: string | |
format: uri | |
nullable: true | |
required: | |
- name | |
ansible.AnsibleRepositoryResponse: | |
type: object | |
description: Serializer for Ansible Repositories. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
versions_href: | |
type: string | |
format: uri | |
readOnly: true | |
latest_version_href: | |
type: string | |
format: uri | |
readOnly: true | |
name: | |
type: string | |
description: A unique name for this repository. | |
description: | |
type: string | |
nullable: true | |
description: An optional description. | |
remote: | |
type: string | |
format: uri | |
nullable: true | |
required: | |
- name | |
ansible.CollectionRemote: | |
type: object | |
description: A serializer for Collection Remotes. | |
properties: | |
name: | |
type: string | |
description: A unique name for this remote. | |
url: | |
type: string | |
description: The URL of an external content source. | |
ca_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded CA certificate used to validate the server certificate | |
presented by the remote server. | |
client_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded client certificate used for authentication. | |
client_key: | |
type: string | |
nullable: true | |
description: A PEM encoded private key used for authentication. | |
tls_validation: | |
type: boolean | |
description: If True, TLS peer validation must be performed. | |
proxy_url: | |
type: string | |
nullable: true | |
description: 'The proxy URL. Format: scheme://user:password@host:port' | |
username: | |
type: string | |
nullable: true | |
description: The username to be used for authentication when syncing. | |
password: | |
type: string | |
nullable: true | |
description: The password to be used for authentication when syncing. | |
download_concurrency: | |
type: integer | |
minimum: 1 | |
description: Total number of simultaneous connections. | |
policy: | |
allOf: | |
- $ref: '#/components/schemas/PolicyF25Enum' | |
default: immediate | |
description: The policy to use when downloading content. | |
requirements_file: | |
type: string | |
nullable: true | |
description: The string version of Collection requirements yaml. | |
auth_url: | |
type: string | |
nullable: true | |
description: The URL to receive a session token from, e.g. used with Automation | |
Hub. | |
maxLength: 255 | |
token: | |
type: string | |
nullable: true | |
description: The token key to use for authentication. See https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#configuring-the-ansible-galaxy-clientfor | |
more details | |
maxLength: 2000 | |
required: | |
- name | |
- url | |
ansible.CollectionRemoteResponse: | |
type: object | |
description: A serializer for Collection Remotes. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
name: | |
type: string | |
description: A unique name for this remote. | |
url: | |
type: string | |
description: The URL of an external content source. | |
ca_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded CA certificate used to validate the server certificate | |
presented by the remote server. | |
client_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded client certificate used for authentication. | |
client_key: | |
type: string | |
nullable: true | |
description: A PEM encoded private key used for authentication. | |
tls_validation: | |
type: boolean | |
description: If True, TLS peer validation must be performed. | |
proxy_url: | |
type: string | |
nullable: true | |
description: 'The proxy URL. Format: scheme://user:password@host:port' | |
username: | |
type: string | |
nullable: true | |
description: The username to be used for authentication when syncing. | |
password: | |
type: string | |
nullable: true | |
description: The password to be used for authentication when syncing. | |
pulp_last_updated: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of the most recent update of the remote. | |
download_concurrency: | |
type: integer | |
minimum: 1 | |
description: Total number of simultaneous connections. | |
policy: | |
allOf: | |
- $ref: '#/components/schemas/PolicyF25Enum' | |
default: immediate | |
description: The policy to use when downloading content. | |
requirements_file: | |
type: string | |
nullable: true | |
description: The string version of Collection requirements yaml. | |
auth_url: | |
type: string | |
nullable: true | |
description: The URL to receive a session token from, e.g. used with Automation | |
Hub. | |
maxLength: 255 | |
token: | |
type: string | |
nullable: true | |
description: The token key to use for authentication. See https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#configuring-the-ansible-galaxy-clientfor | |
more details | |
maxLength: 2000 | |
required: | |
- name | |
- url | |
ansible.CollectionResponse: | |
type: object | |
description: A serializer for Ansible Collections. | |
properties: | |
name: | |
type: string | |
description: The name of the Collection. | |
namespace: | |
type: string | |
description: The namespace of the Collection. | |
required: | |
- name | |
- namespace | |
ansible.CollectionVersion: | |
type: object | |
description: A serializer for CollectionVersion Content. | |
properties: | |
artifact: | |
type: string | |
format: uri | |
description: Artifact file representing the physical content | |
id: | |
type: string | |
format: uuid | |
description: A collection identifier. | |
authors: | |
type: array | |
items: | |
type: string | |
description: A list of the CollectionVersion content's authors. | |
contents: | |
type: array | |
items: | |
type: object | |
description: A JSON field with data about the contents. | |
dependencies: | |
type: object | |
description: A dict declaring Collections that this collection requires | |
to be installed for it to be usable. | |
description: | |
type: string | |
description: A short summary description of the collection. | |
docs_blob: | |
type: object | |
description: A JSON field holding the various documentation blobs in the | |
collection. | |
documentation: | |
type: string | |
format: uri | |
description: The URL to any online docs. | |
maxLength: 2000 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
homepage: | |
type: string | |
format: uri | |
description: The URL to the homepage of the collection/project. | |
maxLength: 2000 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
issues: | |
type: string | |
format: uri | |
description: The URL to the collection issue tracker. | |
maxLength: 2000 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
certification: | |
type: string | |
description: Indicates that the version is certified | |
license: | |
type: array | |
items: | |
type: string | |
description: A list of licenses for content inside of a collection. | |
name: | |
type: string | |
description: The name of the collection. | |
maxLength: 32 | |
namespace: | |
type: string | |
description: The namespace of the collection. | |
maxLength: 32 | |
repository: | |
type: string | |
format: uri | |
description: The URL of the originating SCM repository. | |
maxLength: 2000 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
version: | |
type: string | |
description: The version of the collection. | |
maxLength: 32 | |
required: | |
- artifact | |
- authors | |
- certification | |
- contents | |
- dependencies | |
- description | |
- docs_blob | |
- documentation | |
- homepage | |
- id | |
- issues | |
- license | |
- name | |
- namespace | |
- repository | |
- version | |
ansible.CollectionVersionResponse: | |
type: object | |
description: A serializer for CollectionVersion Content. | |
properties: | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
artifact: | |
type: string | |
format: uri | |
description: Artifact file representing the physical content | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
md5: | |
type: string | |
readOnly: true | |
description: The MD5 checksum if available. | |
sha1: | |
type: string | |
readOnly: true | |
description: The SHA-1 checksum if available. | |
sha224: | |
type: string | |
readOnly: true | |
description: The SHA-224 checksum if available. | |
sha256: | |
type: string | |
readOnly: true | |
description: The SHA-256 checksum if available. | |
sha384: | |
type: string | |
readOnly: true | |
description: The SHA-384 checksum if available. | |
sha512: | |
type: string | |
readOnly: true | |
description: The SHA-512 checksum if available. | |
id: | |
type: string | |
format: uuid | |
description: A collection identifier. | |
authors: | |
type: array | |
items: | |
type: string | |
description: A list of the CollectionVersion content's authors. | |
contents: | |
type: array | |
items: | |
type: object | |
description: A JSON field with data about the contents. | |
dependencies: | |
type: object | |
description: A dict declaring Collections that this collection requires | |
to be installed for it to be usable. | |
description: | |
type: string | |
description: A short summary description of the collection. | |
docs_blob: | |
type: object | |
description: A JSON field holding the various documentation blobs in the | |
collection. | |
documentation: | |
type: string | |
format: uri | |
description: The URL to any online docs. | |
maxLength: 2000 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
homepage: | |
type: string | |
format: uri | |
description: The URL to the homepage of the collection/project. | |
maxLength: 2000 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
issues: | |
type: string | |
format: uri | |
description: The URL to the collection issue tracker. | |
maxLength: 2000 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
certification: | |
type: string | |
description: Indicates that the version is certified | |
license: | |
type: array | |
items: | |
type: string | |
description: A list of licenses for content inside of a collection. | |
name: | |
type: string | |
description: The name of the collection. | |
maxLength: 32 | |
namespace: | |
type: string | |
description: The namespace of the collection. | |
maxLength: 32 | |
repository: | |
type: string | |
format: uri | |
description: The URL of the originating SCM repository. | |
maxLength: 2000 | |
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\ | |
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\ | |
.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\\ | |
.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\ | |
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z" | |
tags: | |
type: array | |
items: | |
$ref: '#/components/schemas/ansible.TagResponse' | |
readOnly: true | |
version: | |
type: string | |
description: The version of the collection. | |
maxLength: 32 | |
deprecated: | |
type: boolean | |
readOnly: true | |
description: Whether or not the collection has been deprecated. | |
required: | |
- artifact | |
- authors | |
- certification | |
- contents | |
- dependencies | |
- description | |
- docs_blob | |
- documentation | |
- homepage | |
- id | |
- issues | |
- license | |
- name | |
- namespace | |
- repository | |
- version | |
ansible.Role: | |
type: object | |
description: A serializer for Role versions. | |
properties: | |
artifact: | |
type: string | |
format: uri | |
description: Artifact file representing the physical content | |
version: | |
type: string | |
name: | |
type: string | |
namespace: | |
type: string | |
required: | |
- artifact | |
- name | |
- namespace | |
- version | |
ansible.RoleResponse: | |
type: object | |
description: A serializer for Role versions. | |
properties: | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
artifact: | |
type: string | |
format: uri | |
description: Artifact file representing the physical content | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
version: | |
type: string | |
name: | |
type: string | |
namespace: | |
type: string | |
required: | |
- artifact | |
- name | |
- namespace | |
- version | |
ansible.TagResponse: | |
type: object | |
description: A serializer for nesting in the CollectionVersion model. | |
properties: | |
name: | |
type: string | |
readOnly: true | |
description: The name of the Tag. | |
container.BlobResponse: | |
type: object | |
description: Serializer for Blobs. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
artifact: | |
type: string | |
format: uri | |
description: Artifact file representing the physical content | |
digest: | |
type: string | |
description: sha256 of the Blob file | |
media_type: | |
type: string | |
description: Blob media type of the file | |
required: | |
- artifact | |
- digest | |
- media_type | |
container.ContainerDistribution: | |
type: object | |
description: A serializer for ContainerDistribution. | |
properties: | |
name: | |
type: string | |
description: A unique name. Ex, `rawhide` and `stable`. | |
content_guard: | |
type: string | |
format: uri | |
description: An optional content-guard. If none is specified, a default | |
one will be used. | |
repository_version: | |
type: string | |
format: uri | |
nullable: true | |
description: RepositoryVersion to be served | |
repository: | |
type: string | |
format: uri | |
nullable: true | |
description: The latest RepositoryVersion for this Repository will be served. | |
base_path: | |
type: string | |
description: The base (relative) path component of the published url. Avoid | |
paths that overlap with other distribution base paths | |
(e.g. "foo" and "foo/bar") | |
required: | |
- base_path | |
- name | |
container.ContainerDistributionResponse: | |
type: object | |
description: A serializer for ContainerDistribution. | |
properties: | |
name: | |
type: string | |
description: A unique name. Ex, `rawhide` and `stable`. | |
content_guard: | |
type: string | |
format: uri | |
description: An optional content-guard. If none is specified, a default | |
one will be used. | |
repository_version: | |
type: string | |
format: uri | |
nullable: true | |
description: RepositoryVersion to be served | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
repository: | |
type: string | |
format: uri | |
nullable: true | |
description: The latest RepositoryVersion for this Repository will be served. | |
base_path: | |
type: string | |
description: The base (relative) path component of the published url. Avoid | |
paths that overlap with other distribution base paths | |
(e.g. "foo" and "foo/bar") | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
registry_path: | |
type: string | |
readOnly: true | |
description: The Registry hostame/name/ to use with docker pull command | |
defined by this distribution. | |
required: | |
- base_path | |
- name | |
container.ContainerPushRepository: | |
type: object | |
description: Serializer for Container Push Repositories. | |
properties: | |
name: | |
type: string | |
description: A unique name for this repository. | |
description: | |
type: string | |
nullable: true | |
description: An optional description. | |
remote: | |
type: string | |
format: uri | |
nullable: true | |
required: | |
- name | |
container.ContainerPushRepositoryResponse: | |
type: object | |
description: Serializer for Container Push Repositories. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
versions_href: | |
type: string | |
format: uri | |
readOnly: true | |
latest_version_href: | |
type: string | |
format: uri | |
readOnly: true | |
name: | |
type: string | |
description: A unique name for this repository. | |
description: | |
type: string | |
nullable: true | |
description: An optional description. | |
remote: | |
type: string | |
format: uri | |
nullable: true | |
required: | |
- name | |
container.ContainerRemote: | |
type: object | |
description: A Serializer for ContainerRemote. | |
properties: | |
name: | |
type: string | |
description: A unique name for this remote. | |
url: | |
type: string | |
description: The URL of an external content source. | |
ca_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded CA certificate used to validate the server certificate | |
presented by the remote server. | |
client_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded client certificate used for authentication. | |
client_key: | |
type: string | |
nullable: true | |
description: A PEM encoded private key used for authentication. | |
tls_validation: | |
type: boolean | |
description: If True, TLS peer validation must be performed. | |
proxy_url: | |
type: string | |
nullable: true | |
description: 'The proxy URL. Format: scheme://user:password@host:port' | |
username: | |
type: string | |
nullable: true | |
description: The username to be used for authentication when syncing. | |
password: | |
type: string | |
nullable: true | |
description: The password to be used for authentication when syncing. | |
download_concurrency: | |
type: integer | |
minimum: 1 | |
description: Total number of simultaneous connections. | |
policy: | |
allOf: | |
- $ref: '#/components/schemas/Policy63aEnum' | |
default: immediate | |
description: "\n immediate - All manifests and blobs are downloaded\ | |
\ and saved during a sync.\n on_demand - Only tags and manifests\ | |
\ are downloaded. Blobs are not\n downloaded until\ | |
\ they are requested for the first time by a client.\n streamed\ | |
\ - Blobs are streamed to the client with every request and never saved.\n\ | |
\ " | |
upstream_name: | |
type: string | |
description: Name of the upstream repository | |
whitelist_tags: | |
type: array | |
items: | |
type: string | |
nullable: true | |
description: A list of whitelisted tags to sync | |
required: | |
- name | |
- upstream_name | |
- url | |
container.ContainerRemoteResponse: | |
type: object | |
description: A Serializer for ContainerRemote. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
name: | |
type: string | |
description: A unique name for this remote. | |
url: | |
type: string | |
description: The URL of an external content source. | |
ca_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded CA certificate used to validate the server certificate | |
presented by the remote server. | |
client_cert: | |
type: string | |
nullable: true | |
description: A PEM encoded client certificate used for authentication. | |
client_key: | |
type: string | |
nullable: true | |
description: A PEM encoded private key used for authentication. | |
tls_validation: | |
type: boolean | |
description: If True, TLS peer validation must be performed. | |
proxy_url: | |
type: string | |
nullable: true | |
description: 'The proxy URL. Format: scheme://user:password@host:port' | |
username: | |
type: string | |
nullable: true | |
description: The username to be used for authentication when syncing. | |
password: | |
type: string | |
nullable: true | |
description: The password to be used for authentication when syncing. | |
pulp_last_updated: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of the most recent update of the remote. | |
download_concurrency: | |
type: integer | |
minimum: 1 | |
description: Total number of simultaneous connections. | |
policy: | |
allOf: | |
- $ref: '#/components/schemas/Policy63aEnum' | |
default: immediate | |
description: "\n immediate - All manifests and blobs are downloaded\ | |
\ and saved during a sync.\n on_demand - Only tags and manifests\ | |
\ are downloaded. Blobs are not\n downloaded until\ | |
\ they are requested for the first time by a client.\n streamed\ | |
\ - Blobs are streamed to the client with every request and never saved.\n\ | |
\ " | |
upstream_name: | |
type: string | |
description: Name of the upstream repository | |
whitelist_tags: | |
type: array | |
items: | |
type: string | |
nullable: true | |
description: A list of whitelisted tags to sync | |
required: | |
- name | |
- upstream_name | |
- url | |
container.ContainerRepository: | |
type: object | |
description: Serializer for Container Repositories. | |
properties: | |
name: | |
type: string | |
description: A unique name for this repository. | |
description: | |
type: string | |
nullable: true | |
description: An optional description. | |
remote: | |
type: string | |
format: uri | |
nullable: true | |
required: | |
- name | |
container.ContainerRepositoryResponse: | |
type: object | |
description: Serializer for Container Repositories. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
versions_href: | |
type: string | |
format: uri | |
readOnly: true | |
latest_version_href: | |
type: string | |
format: uri | |
readOnly: true | |
name: | |
type: string | |
description: A unique name for this repository. | |
description: | |
type: string | |
nullable: true | |
description: An optional description. | |
remote: | |
type: string | |
format: uri | |
nullable: true | |
required: | |
- name | |
container.ContentRedirectContentGuard: | |
type: object | |
description: A serializer for ContentRedirectContentGuard. | |
properties: | |
name: | |
type: string | |
description: The unique name. | |
description: | |
type: string | |
nullable: true | |
description: An optional description. | |
required: | |
- name | |
container.ContentRedirectContentGuardResponse: | |
type: object | |
description: A serializer for ContentRedirectContentGuard. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
name: | |
type: string | |
description: The unique name. | |
description: | |
type: string | |
nullable: true | |
description: An optional description. | |
required: | |
- name | |
container.ManifestResponse: | |
type: object | |
description: Serializer for Manifests. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
artifact: | |
type: string | |
format: uri | |
description: Artifact file representing the physical content | |
digest: | |
type: string | |
description: sha256 of the Manifest file | |
schema_version: | |
type: integer | |
description: Manifest schema version | |
media_type: | |
type: string | |
description: Manifest media type of the file | |
listed_manifests: | |
type: array | |
items: | |
type: string | |
format: uri | |
description: Manifests that are referenced by this Manifest List | |
config_blob: | |
type: string | |
format: uri | |
description: Blob that contains configuration for this Manifest | |
blobs: | |
type: array | |
items: | |
type: string | |
format: uri | |
description: Blobs that are referenced by this Manifest | |
required: | |
- artifact | |
- blobs | |
- digest | |
- listed_manifests | |
- media_type | |
- schema_version | |
container.TagResponse: | |
type: object | |
description: Serializer for Tags. | |
properties: | |
pulp_href: | |
type: string | |
format: uri | |
readOnly: true | |
pulp_created: | |
type: string | |
format: date-time | |
readOnly: true | |
description: Timestamp of creation. | |
name: | |
type: string | |
description: Tag name | |
tagged_manifest: | |
type: string | |
format: uri | |
description: Manifest that is tagged | |
required: | |
- name | |
- tagged_manifest | |
galaxy.Login: | |
type: object | |
properties: | |
username: | |
type: string | |
password: | |
type: string | |
required: | |
- password | |
- username | |
galaxy.LoginResponse: | |
type: object | |
properties: | |
pulp_id: | |
type: string | |
format: uuid | |
name: | |
type: string | |
state: | |
type: string | |
started_at: | |
type: string | |
format: date-time | |
finished_at: | |
type: string | |
format: date-time | |
required: | |
- finished_at | |
- name | |
- pulp_id | |
- started_at | |
- state | |
securitySchemes: | |
basicAuth: | |
type: http | |
scheme: basic | |
cookieAuth: | |
type: apiKey | |
in: cookie | |
name: Session | |
servers: | |
- url: http://localhost:5001/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment