Skip to content

Commit

Permalink
Update bindings to release/v4.4.9
Browse files Browse the repository at this point in the history
  • Loading branch information
jlsherrill committed Jun 17, 2024
1 parent 81f37b5 commit c962def
Show file tree
Hide file tree
Showing 108 changed files with 601 additions and 158 deletions.
94 changes: 89 additions & 5 deletions candlepin-api-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.2
info:
title: Candlepin
description: Candlepin is a subscription management server written in Java. It helps with management of software subscriptions.
version: 4.4.6
version: 4.4.9

servers:
- url: /candlepin
Expand Down Expand Up @@ -3153,8 +3153,68 @@ paths:
default:
$ref: '#/components/responses/default'

put:
description: |
Updates the specified using the non-null fields specified in the provided EnvironmentDTO.
Note that some fields of an environment cannot be changed without deleting and recreating
the environment -- such as its ID or organization (owner) -- and some other properties that
are mutable may not be changed by this operation, such as environment content overrides. In
the case of the created and updated timestamps, this operation may not directly update those
fields, but the updated field may be changed as a result of other fields changing.
Ignored EnvironmentDTO fields:
- id
- owner
- environmentContent
- created
- updated*
operationId: updateEnvironment
tags:
- environment
parameters:
- name: env_id
in: path
required: true
schema:
type: string
requestBody:
description: |
An EnvironmentDTO containing the data to use to update the target environment. The object
need not be fully populated, as some fields cannot be changed by an update operation and
will be ignored. Any field which is not intended to be updated should be left undefined or
null. An empty, non-null value should be used to clear any existing value in a given
field.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentDTO'
security: []
responses:
200:
description: |
The updated environment
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentDTO'
404:
description: |
An environment with the specified ID does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ExceptionMessage'
default:
$ref: '#/components/responses/default'

delete:
description: "Deletes an environment. WARNING: this will delete all consumers in the environment and revoke their entitlement certificates."
description: |
Deletes the specified environment, unregistering and deleting any consumers registered to
the environment with no other remaining environments. If the retain_consumers flag is set to
true, no consumer deletion will occur, and any such consumers will be moved to the
organization's default content view.
operationId: deleteEnvironment
tags:
- environment
Expand All @@ -3164,6 +3224,15 @@ paths:
required: true
schema:
type: string
- name: retain_consumers
description: |
Whether or not to retain affected consumers with no remaining environments. If set to
true, affected consumers will be moved to the organization's default content view.
in: query
required: false
schema:
type: boolean
default: false
security: []
responses:
204:
Expand Down Expand Up @@ -3311,7 +3380,16 @@ paths:
$ref: '#/components/responses/default'

delete:
description: "Demotes a Content from an Environment. Consumer's registered to this environment will not see this content in their entitlement certificates. (after they are regenerated and synced to clients) This call accepts multiple content IDs to demote at once, allowing us to mass demote, then trigger a cert regeneration. NOTE: This call expects the actual content IDs, *not* the ID created for each EnvironmentContent object created after a promotion. This is to help integrate with other management apps which should not have to track/lookup a specific ID for the content to demote."
description: |
Demotes a Content from an Environment. Consumer's registered to this environment will not
see this content in their entitlement certificates. (after they are regenerated and synced
to clients) This call accepts multiple content IDs to demote at once, allowing us to mass
demote, then trigger a cert regeneration.
NOTE: This call expects the actual content IDs, *not* the ID created for each
EnvironmentContent object created after a promotion. This is to help integrate with other
management apps which should not have to track/lookup a specific ID for the content to
demote.
operationId: demoteContent
tags:
- environment
Expand Down Expand Up @@ -3814,7 +3892,13 @@ paths:
post:
tags:
- hypervisors
description: Creates or Updates the list of Hypervisor hosts Allows agents such as virt-who to update hosts' information . This is typically used when a host is unable to register to candlepin via subscription manager. In situations where consumers already exist it is probably best not to allow creation of new hypervisor consumers. Most consumers do not have a hypervisorId attribute, so that should be added manually when necessary by the management environment. Default is true. If false is specified, hypervisorIds that are not found will result in a failed state of the job.
description: |
Creates or Updates the list of Hypervisor hosts Allows agents such as virt-who to update hosts'
information . This is typically used when a host is unable to register to candlepin via subscription
manager. In situations where consumers already exist it is probably best not to allow creation of new
hypervisor consumers. Most consumers do not have a hypervisorId attribute, so that should be added
manually when necessary by the management environment. Default is true. If false is specified,
hypervisorIds that are not found will result in a failed state of the job.
operationId: hypervisorUpdateAsync
security: []
requestBody:
Expand Down Expand Up @@ -5286,7 +5370,7 @@ paths:
description: Creates an environment for the owner
tags:
- owner
operationId: createEnv
operationId: createEnvironment
security: []
parameters:
- name: owner_key
Expand Down
2 changes: 1 addition & 1 deletion release/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.5.0
7.6.0
9 changes: 5 additions & 4 deletions release/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Candlepin is a subscription management server written in Java. It helps with man
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: 4.4.6
- Package version: 4.4.6
- Generator version: 7.5.0
- API version: 4.4.9
- Package version: 4.4.9
- Generator version: 7.6.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen

## Installation
Expand Down Expand Up @@ -163,6 +163,7 @@ Class | Method | HTTP request | Description
*EnvironmentAPI* | [**GetEnvironmentContentOverrides**](docs/EnvironmentAPI.md#getenvironmentcontentoverrides) | **Get** /environments/{environment_id}/content_overrides |
*EnvironmentAPI* | [**PromoteContent**](docs/EnvironmentAPI.md#promotecontent) | **Post** /environments/{env_id}/content |
*EnvironmentAPI* | [**PutEnvironmentContentOverrides**](docs/EnvironmentAPI.md#putenvironmentcontentoverrides) | **Put** /environments/{environment_id}/content_overrides |
*EnvironmentAPI* | [**UpdateEnvironment**](docs/EnvironmentAPI.md#updateenvironment) | **Put** /environments/{env_id} |
*GuestIdsAPI* | [**DeleteGuest**](docs/GuestIdsAPI.md#deleteguest) | **Delete** /consumers/{consumer_uuid}/guestids/{guest_id} |
*GuestIdsAPI* | [**GetGuestId**](docs/GuestIdsAPI.md#getguestid) | **Get** /consumers/{consumer_uuid}/guestids/{guest_id} |
*GuestIdsAPI* | [**GetGuestIds**](docs/GuestIdsAPI.md#getguestids) | **Get** /consumers/{consumer_uuid}/guestids |
Expand All @@ -180,7 +181,7 @@ Class | Method | HTTP request | Description
*OwnerAPI* | [**Claim**](docs/OwnerAPI.md#claim) | **Put** /owners/{anonymous_owner_key}/claim |
*OwnerAPI* | [**CountConsumers**](docs/OwnerAPI.md#countconsumers) | **Get** /owners/{owner_key}/consumers/count |
*OwnerAPI* | [**CreateActivationKey**](docs/OwnerAPI.md#createactivationkey) | **Post** /owners/{owner_key}/activation_keys |
*OwnerAPI* | [**CreateEnv**](docs/OwnerAPI.md#createenv) | **Post** /owners/{owner_key}/environments |
*OwnerAPI* | [**CreateEnvironment**](docs/OwnerAPI.md#createenvironment) | **Post** /owners/{owner_key}/environments |
*OwnerAPI* | [**CreateOwner**](docs/OwnerAPI.md#createowner) | **Post** /owners |
*OwnerAPI* | [**CreatePool**](docs/OwnerAPI.md#createpool) | **Post** /owners/{owner_key}/pools |
*OwnerAPI* | [**CreateUeberCertificate**](docs/OwnerAPI.md#createuebercertificate) | **Post** /owners/{owner_key}/uebercert |
Expand Down
130 changes: 110 additions & 20 deletions release/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
description: Candlepin is a subscription management server written in Java. It helps
with management of software subscriptions.
title: Candlepin
version: 4.4.6
version: 4.4.9
servers:
- url: /candlepin
security:
Expand Down Expand Up @@ -3997,8 +3997,11 @@ paths:
- distributor_versions
/environments/{env_id}:
delete:
description: "Deletes an environment. WARNING: this will delete all consumers\
\ in the environment and revoke their entitlement certificates."
description: |
Deletes the specified environment, unregistering and deleting any consumers registered to
the environment with no other remaining environments. If the retain_consumers flag is set to
true, no consumer deletion will occur, and any such consumers will be moved to the
organization's default content view.
operationId: deleteEnvironment
parameters:
- explode: false
Expand All @@ -4008,6 +4011,17 @@ paths:
schema:
type: string
style: simple
- description: |
Whether or not to retain affected consumers with no remaining environments. If set to
true, affected consumers will be moved to the organization's default content view.
explode: true
in: query
name: retain_consumers
required: false
schema:
default: false
type: boolean
style: form
responses:
"204":
description: Environment was successfully deleted.
Expand Down Expand Up @@ -4071,6 +4085,69 @@ paths:
security: []
tags:
- environment
put:
description: |
Updates the specified using the non-null fields specified in the provided EnvironmentDTO.
Note that some fields of an environment cannot be changed without deleting and recreating
the environment -- such as its ID or organization (owner) -- and some other properties that
are mutable may not be changed by this operation, such as environment content overrides. In
the case of the created and updated timestamps, this operation may not directly update those
fields, but the updated field may be changed as a result of other fields changing.
Ignored EnvironmentDTO fields:
- id
- owner
- environmentContent
- created
- updated*
operationId: updateEnvironment
parameters:
- explode: false
in: path
name: env_id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentDTO'
description: |
An EnvironmentDTO containing the data to use to update the target environment. The object
need not be fully populated, as some fields cannot be changed by an update operation and
will be ignored. Any field which is not intended to be updated should be left undefined or
null. An empty, non-null value should be used to clear any existing value in a given
field.
required: true
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentDTO'
description: |
The updated environment
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ExceptionMessage'
description: |
An environment with the specified ID does not exist
default:
content:
application/json:
example:
displayMessage: An unexpected exception has occurred
requestUuid: c4347004-8792-41fe-a4d8-fccaa0d3898a
schema:
$ref: '#/components/schemas/ExceptionMessage'
description: An unexpected exception has occurred
security: []
tags:
- environment
/environments/{env_id}/consumers:
post:
description: Creates a Consumer in an Environment
Expand Down Expand Up @@ -4156,14 +4233,16 @@ paths:
- environment
/environments/{env_id}/content:
delete:
description: "Demotes a Content from an Environment. Consumer's registered to\
\ this environment will not see this content in their entitlement certificates.\
\ (after they are regenerated and synced to clients) This call accepts multiple\
\ content IDs to demote at once, allowing us to mass demote, then trigger\
\ a cert regeneration. NOTE: This call expects the actual content IDs, *not*\
\ the ID created for each EnvironmentContent object created after a promotion.\
\ This is to help integrate with other management apps which should not have\
\ to track/lookup a specific ID for the content to demote."
description: |
Demotes a Content from an Environment. Consumer's registered to this environment will not
see this content in their entitlement certificates. (after they are regenerated and synced
to clients) This call accepts multiple content IDs to demote at once, allowing us to mass
demote, then trigger a cert regeneration.
NOTE: This call expects the actual content IDs, *not* the ID created for each
EnvironmentContent object created after a promotion. This is to help integrate with other
management apps which should not have to track/lookup a specific ID for the content to
demote.
operationId: demoteContent
parameters:
- explode: false
Expand Down Expand Up @@ -4873,14 +4952,13 @@ paths:
isContainer: false
/hypervisors/{owner}:
post:
description: "Creates or Updates the list of Hypervisor hosts Allows agents\
\ such as virt-who to update hosts' information . This is typically used when\
\ a host is unable to register to candlepin via subscription manager. In situations\
\ where consumers already exist it is probably best not to allow creation\
\ of new hypervisor consumers. Most consumers do not have a hypervisorId\
\ attribute, so that should be added manually when necessary by the management\
\ environment. Default is true. If false is specified, hypervisorIds that\
\ are not found will result in a failed state of the job."
description: |
Creates or Updates the list of Hypervisor hosts Allows agents such as virt-who to update hosts'
information . This is typically used when a host is unable to register to candlepin via subscription
manager. In situations where consumers already exist it is probably best not to allow creation of new
hypervisor consumers. Most consumers do not have a hypervisorId attribute, so that should be added
manually when necessary by the management environment. Default is true. If false is specified,
hypervisorIds that are not found will result in a failed state of the job.
operationId: hypervisorUpdateAsync
parameters:
- description: Owner key
Expand Down Expand Up @@ -6838,7 +6916,7 @@ paths:
isContainer: true
post:
description: Creates an environment for the owner
operationId: createEnv
operationId: createEnvironment
parameters:
- description: The key of the owner
explode: false
Expand Down Expand Up @@ -15312,6 +15390,18 @@ components:
href: href
contentAccessMode: contentAccessMode
key: key
serial:
serial: 1
created: 2020-04-23 03:23:50.927000
expiration: expiration
id: 6
revoked: true
updated: 2020-04-23 03:23:50.927000
created: 2020-04-23 03:23:50.927000
cert: cert
id: id
updated: 2020-04-23 03:23:50.927000
key: key
UserDTO:
allOf:
- $ref: '#/components/schemas/TimestampedEntity'
Expand Down
2 changes: 1 addition & 1 deletion release/api_activation_key.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion release/api_admin.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion release/api_cdn.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion release/api_certificate_revocation_list.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit c962def

Please sign in to comment.