Skip to content

Commit

Permalink
RHINENG-10978: document that /export is not paginated
Browse files Browse the repository at this point in the history
  • Loading branch information
psegedy committed Jul 2, 2024
1 parent 7211436 commit b666b29
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 18 deletions.
18 changes: 9 additions & 9 deletions docs/v3/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -1233,7 +1233,7 @@
"/export/advisories": {
"get": {
"summary": "Export applicable advisories for all my systems",
"description": "Export applicable advisories for all my systems",
"description": "Export applicable advisories for all my systems. Export endpoints are not paginated.",
"operationId": "exportAdvisories",
"parameters": [
{
Expand Down Expand Up @@ -1372,7 +1372,7 @@
"/export/advisories/{advisory_id}/systems": {
"get": {
"summary": "Export systems for my account",
"description": "Export systems for my account",
"description": "Export systems for my account. Export endpoints are not paginated.",
"operationId": "exportAdvisorySystems",
"parameters": [
{
Expand Down Expand Up @@ -1597,7 +1597,7 @@
"/export/baselines/{baseline_id}/systems": {
"get": {
"summary": "Export systems belonging to a baseline",
"description": "Export systems applicable to a baseline",
"description": "Export systems applicable to a baseline. Export endpoints are not paginated.",
"operationId": "exportBaselineSystems",
"parameters": [
{
Expand Down Expand Up @@ -1806,7 +1806,7 @@
"/export/packages": {
"get": {
"summary": "Show me all installed packages across my systems",
"description": "Show me all installed packages across my systems",
"description": "Show me all installed packages across my systems. Export endpoints are not paginated.",
"operationId": "exportPackages",
"parameters": [
{
Expand Down Expand Up @@ -1936,7 +1936,7 @@
"/export/packages/{package_name}/systems": {
"get": {
"summary": "Show me all my systems which have a package installed",
"description": "Show me all my systems which have a package installed",
"description": "Show me all my systems which have a package installed. Export endpoints are not paginated.",
"operationId": "exportPackageSystems",
"parameters": [
{
Expand Down Expand Up @@ -2093,7 +2093,7 @@
"/export/systems": {
"get": {
"summary": "Export systems for my account",
"description": "Export systems for my account",
"description": "Export systems for my account. Export endpoints are not paginated.",
"operationId": "exportSystems",
"parameters": [
{
Expand Down Expand Up @@ -2423,7 +2423,7 @@
"/export/systems/{inventory_id}/advisories": {
"get": {
"summary": "Export applicable advisories for all my systems",
"description": "Export applicable advisories for all my systems",
"description": "Export applicable advisories for all my systems. Export endpoints are not paginated.",
"operationId": "exportSystemAdvisories",
"parameters": [
{
Expand Down Expand Up @@ -2593,7 +2593,7 @@
"/export/systems/{inventory_id}/packages": {
"get": {
"summary": "Show me details about a system packages by given inventory id",
"description": "Show me details about a system packages by given inventory id",
"description": "Show me details about a system packages by given inventory id. Export endpoints are not paginated.",
"operationId": "exportSystemPackages",
"parameters": [
{
Expand Down Expand Up @@ -2719,7 +2719,7 @@
"/export/templates/{template_id}/systems": {
"get": {
"summary": "Export systems belonging to a template",
"description": "Export systems applicable to a template",
"description": "Export systems applicable to a template. Export endpoints are not paginated.",
"operationId": "exportTemplateSystems",
"parameters": [
{
Expand Down
2 changes: 1 addition & 1 deletion manager/controllers/advisories_export.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
)

// @Summary Export applicable advisories for all my systems
// @Description Export applicable advisories for all my systems
// @Description Export applicable advisories for all my systems. Export endpoints are not paginated.
// @ID exportAdvisories
// @Security RhIdentity
// @Accept json
Expand Down
2 changes: 1 addition & 1 deletion manager/controllers/advisory_systems_export.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ var AdvisorySystemExportOpts = ListOpts{
}

// @Summary Export systems for my account
// @Description Export systems for my account
// @Description Export systems for my account. Export endpoints are not paginated.
// @ID exportAdvisorySystems
// @Security RhIdentity
// @Accept json
Expand Down
2 changes: 1 addition & 1 deletion manager/controllers/baseline_systems_export.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (

// nolint: lll
// @Summary Export systems belonging to a baseline
// @Description Export systems applicable to a baseline
// @Description Export systems applicable to a baseline. Export endpoints are not paginated.
// @ID exportBaselineSystems
// @Security RhIdentity
// @Accept json
Expand Down
2 changes: 1 addition & 1 deletion manager/controllers/package_systems_export.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
)

// @Summary Show me all my systems which have a package installed
// @Description Show me all my systems which have a package installed
// @Description Show me all my systems which have a package installed. Export endpoints are not paginated.
// @ID exportPackageSystems
// @Security RhIdentity
// @Accept json
Expand Down
2 changes: 1 addition & 1 deletion manager/controllers/packages_export.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (

// nolint: lll
// @Summary Show me all installed packages across my systems
// @Description Show me all installed packages across my systems
// @Description Show me all installed packages across my systems. Export endpoints are not paginated.
// @ID exportPackages
// @Security RhIdentity
// @Accept json
Expand Down
2 changes: 1 addition & 1 deletion manager/controllers/system_advisories_export.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
)

// @Summary Export applicable advisories for all my systems
// @Description Export applicable advisories for all my systems
// @Description Export applicable advisories for all my systems. Export endpoints are not paginated.
// @ID exportSystemAdvisories
// @Security RhIdentity
// @Accept json
Expand Down
2 changes: 1 addition & 1 deletion manager/controllers/system_packages_export.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ type SystemPackageInline struct {
}

// @Summary Show me details about a system packages by given inventory id
// @Description Show me details about a system packages by given inventory id
// @Description Show me details about a system packages by given inventory id. Export endpoints are not paginated.
// @ID exportSystemPackages
// @Security RhIdentity
// @Accept json
Expand Down
2 changes: 1 addition & 1 deletion manager/controllers/systems_export.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
)

// @Summary Export systems for my account
// @Description Export systems for my account
// @Description Export systems for my account. Export endpoints are not paginated.
// @ID exportSystems
// @Security RhIdentity
// @Accept json
Expand Down
2 changes: 1 addition & 1 deletion manager/controllers/template_systems_export.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (

// nolint: lll
// @Summary Export systems belonging to a template
// @Description Export systems applicable to a template
// @Description Export systems applicable to a template. Export endpoints are not paginated.
// @ID exportTemplateSystems
// @Security RhIdentity
// @Accept json
Expand Down

0 comments on commit b666b29

Please sign in to comment.