diff --git a/spec/api/v2/openapi.rb b/spec/api/v2/openapi.rb index 1770b9d52..b8f36d589 100644 --- a/spec/api/v2/openapi.rb +++ b/spec/api/v2/openapi.rb @@ -46,8 +46,6 @@ def info end def description - 'UNDER DEVELOPMENT: This version of the API is not fully done ' \ - 'and some parts of it might change! ' \ 'This is the API for Cloud Services for RHEL Compliance. ' \ 'You can find out more about Red Hat Cloud Services for RHEL at ' \ '[https://console.redhat.com/]' \ diff --git a/spec/integration/v2/policies_spec.rb b/spec/integration/v2/policies_spec.rb index 08c6c78ac..61a255e9a 100644 --- a/spec/integration/v2/policies_spec.rb +++ b/spec/integration/v2/policies_spec.rb @@ -14,7 +14,9 @@ get 'Request Policies' do v2_auth_header tags 'Policies' - description 'Lists Policies' + description 'You can see what policies are currently in place.'\ + 'Policies are statements that manage API scenarios'\ + 'such as authentication, rate limiting, caching, requests and responses.' operationId 'Policies' content_types pagination_params_v2 @@ -70,7 +72,7 @@ post 'Create a Policy' do v2_auth_header tags 'Policies' - description 'Create a Policy with the provided attributes' + description 'Use this endpoint to create a new security policy.' operationId 'CreatePolicy' content_types @@ -102,7 +104,7 @@ get 'Request a Policy' do v2_auth_header tags 'Policies' - description 'Returns a Policy' + description 'Use this endpoint to retrieve a specific policy.' operationId 'Policy' content_types @@ -130,7 +132,7 @@ patch 'Update a Policy' do v2_auth_header tags 'Policies' - description 'Updates a Policy with the provided attributes' + description 'Use this endpoint to edit or update an existing policy.' operationId 'UpdatePolicy' content_types @@ -152,7 +154,7 @@ delete 'Delete a Policy' do v2_auth_header tags 'Policies' - description 'Deletes a Policy' + description 'Use this endpoint to delete a specific policy.' operationId 'DeletePolicy' content_types @@ -186,7 +188,7 @@ get 'Request Policies assigned to a System' do v2_auth_header tags 'Systems' - description 'Lists Policies under a System' + description 'List all policies assigned to a single system' operationId 'SystemsPolicies' content_types pagination_params_v2 diff --git a/spec/integration/v2/profiles_spec.rb b/spec/integration/v2/profiles_spec.rb index 2ae1f8546..d330b76b6 100644 --- a/spec/integration/v2/profiles_spec.rb +++ b/spec/integration/v2/profiles_spec.rb @@ -15,7 +15,7 @@ get 'Request Profiles' do v2_auth_header tags 'Content' - description 'Lists Profiles' + description 'List all security guide profiles.' operationId 'Profiles' content_types pagination_params_v2 @@ -77,7 +77,7 @@ get 'Request a Profile' do v2_auth_header tags 'Content' - description 'Returns a Profile' + description 'Retrieve a specific profile.' operationId 'Profile' content_types diff --git a/spec/integration/v2/reports_spec.rb b/spec/integration/v2/reports_spec.rb index 5f8e2bf2e..55449993b 100644 --- a/spec/integration/v2/reports_spec.rb +++ b/spec/integration/v2/reports_spec.rb @@ -21,7 +21,7 @@ get 'Request Reports' do v2_auth_header tags 'Reports' - description 'Lists Reports' + description 'Use this endpoint to retrieve a list of all available reports.' operationId 'Reports' content_types pagination_params_v2 @@ -101,7 +101,7 @@ get 'Request a Report' do v2_auth_header tags 'Reports' - description 'Returns a Report' + description 'Use this endpoint to retrieve a specific report.' operationId 'Report' content_types @@ -129,7 +129,7 @@ delete 'Delete a Report results' do v2_auth_header tags 'Reports' - description "Deletes Report's test results" + description 'Use this endpoint to delete test results for a specific report.' operationId 'DeleteReport' content_types diff --git a/spec/integration/v2/rule_groups_spec.rb b/spec/integration/v2/rule_groups_spec.rb index 8cd7c8ec1..619331003 100644 --- a/spec/integration/v2/rule_groups_spec.rb +++ b/spec/integration/v2/rule_groups_spec.rb @@ -15,7 +15,7 @@ get 'Request Rule Groups' do v2_auth_header tags 'Content' - description 'Lists Rule Groups' + description 'List all rules groups.' operationId 'Rule Groups' content_types pagination_params_v2 @@ -68,7 +68,7 @@ get 'Request a Rule Group' do v2_auth_header tags 'Content' - description 'Returns a Rule Group' + description 'Retrieve a specific rule group.' operationId 'RuleGroup' content_types diff --git a/spec/integration/v2/rule_results_spec.rb b/spec/integration/v2/rule_results_spec.rb index efd234e40..07c1dcc90 100644 --- a/spec/integration/v2/rule_results_spec.rb +++ b/spec/integration/v2/rule_results_spec.rb @@ -33,7 +33,7 @@ get 'Request Rule Results under a Report' do v2_auth_header tags 'Reports' - description 'Lists Rule Results under a Report' + description 'Use this endpoint to retrieve all of the rule results for a specific report.' operationId 'ReportRuleResults' content_types pagination_params_v2 diff --git a/spec/integration/v2/rules_spec.rb b/spec/integration/v2/rules_spec.rb index be3ae270e..fb68070d6 100644 --- a/spec/integration/v2/rules_spec.rb +++ b/spec/integration/v2/rules_spec.rb @@ -16,7 +16,7 @@ get 'Request Rules' do v2_auth_header tags 'Content' - description 'Lists Rules assigned' + description 'This is a list of all security guide rules.' operationId 'Rules' content_types pagination_params_v2 @@ -69,7 +69,7 @@ get 'Request a Rule' do v2_auth_header tags 'Content' - description 'Returns a Rule' + description 'Retrieve a specific rule.' operationId 'Rule' content_types @@ -110,7 +110,7 @@ get 'Request Rules assigned to a Profile' do v2_auth_header tags 'Content' - description 'Lists Rules assigned to a Profile' + description 'This is a list of all security guide rules for a specific profile.' operationId 'ProfileRules' content_types pagination_params_v2 @@ -164,7 +164,7 @@ get 'Request a Rule assigned to a Profile' do v2_auth_header tags 'Content' - description 'Returns a Rule assigned to a Profile' + description 'Retrieve a specific security guide rule for a specific profile.' operationId 'ProfileRule' content_types @@ -223,7 +223,8 @@ get 'Request Rules assigned to a Tailoring' do v2_auth_header tags 'Policies' - description 'Lists Rules assigned to a Tailoring' + description 'Use this to get a list of rules relating to specific tailorings. '\ + 'Tailorings are customizations of rules.' operationId 'TailoringRules' content_types pagination_params_v2 @@ -318,7 +319,7 @@ v2_auth_header tags 'Policies' - description 'Assigns a Rule to a Tailoring' + description 'Add a rule to a specific tailoring.' operationId 'AssignRule' content_types @@ -355,7 +356,7 @@ v2_auth_header tags 'Policies' - description 'Unassigns a Rule from a Tailoring' + description 'Customizing of the tailoring by removing rule' operationId 'UnassignRule' content_types diff --git a/spec/integration/v2/security_guides_spec.rb b/spec/integration/v2/security_guides_spec.rb index 7272cbf57..5091e4cf8 100644 --- a/spec/integration/v2/security_guides_spec.rb +++ b/spec/integration/v2/security_guides_spec.rb @@ -13,7 +13,7 @@ get 'Request Security Guides' do v2_auth_header tags 'Content' - description 'Lists Security Guides' + description 'This is a list of all SCAP guides.' operationId 'SecurityGuides' content_types pagination_params_v2 @@ -95,7 +95,7 @@ get 'Request a Security Guide' do v2_auth_header tags 'Content' - description 'Returns a Security Guide' + description 'Retrieve a specific security guide.' operationId 'SecurityGuide' content_types @@ -127,7 +127,7 @@ get 'Request the Rule Tree of a Security Guide' do v2_auth_header tags 'Content' - description 'Returns the Rule Tree of a Security Guide' + description 'Returns the Rule Tree of a Security Guide' # FIXME: Get the security guide rule tree operationId 'SecurityGuideRuleTree' content_types diff --git a/spec/integration/v2/supported_profiles_spec.rb b/spec/integration/v2/supported_profiles_spec.rb index 8f63bf9e7..2bfeee599 100644 --- a/spec/integration/v2/supported_profiles_spec.rb +++ b/spec/integration/v2/supported_profiles_spec.rb @@ -13,7 +13,7 @@ get 'Request Supported Profiles' do v2_auth_header tags 'Content' - description 'Lists Supported Profiles' + description 'List of profiles supported by certain RHEL versions.' operationId 'SupportedProfiles' content_types pagination_params_v2 diff --git a/spec/integration/v2/systems_spec.rb b/spec/integration/v2/systems_spec.rb index 48b563d4c..faf375143 100644 --- a/spec/integration/v2/systems_spec.rb +++ b/spec/integration/v2/systems_spec.rb @@ -14,7 +14,7 @@ get 'Request Systems' do v2_auth_header tags 'Systems' - description 'Lists Systems' + description 'List all systems that are accessible when you are logged into your account.' operationId 'Systems' content_types tags_params @@ -75,7 +75,7 @@ get 'Request the list of available OS versions' do v2_auth_header tags 'Systems' - description 'This feature is exclusively used by the frontend' + description 'This feature is exclusively used by the frontend.' operationId 'SystemsOS' content_types deprecated true @@ -97,7 +97,7 @@ get 'Request a System' do v2_auth_header tags 'Systems' - description 'Returns a System' + description 'Get information about one specific system.' operationId 'System' content_types @@ -147,7 +147,7 @@ get 'Request Systems assigned to a Policy' do v2_auth_header tags 'Policies' - description 'Lists Systems assigned to a Policy' + description 'This is a list of all systems assigned to a specific policy.' operationId 'PolicySystems' content_types tags_params @@ -299,7 +299,7 @@ v2_auth_header tags 'Policies' - description 'Assigns a System to a Policy' + description 'Use this endpoint to connect a specific system to a policy.' operationId 'AssignSystem' content_types @@ -338,7 +338,7 @@ v2_auth_header tags 'Policies' - description 'Unassigns a System from a Policy' + description 'Use this endpoint to remove the connection between a system and a policy.' operationId 'UnassignSystem' content_types @@ -390,7 +390,7 @@ get 'Request Systems assigned to a Report' do v2_auth_header tags 'Reports' - description 'Lists Systems assigned to a Report' + description 'Use this endpoint to retrieve all of the systems for a specific report.' operationId 'ReportSystems' content_types tags_params @@ -506,7 +506,7 @@ get 'Request a System' do v2_auth_header tags 'Reports' - description 'Returns a System under a Report' + description 'Use this endpoint to retrieve a specific system for a specific report.' operationId 'ReportSystem' content_types diff --git a/spec/integration/v2/tailorings_spec.rb b/spec/integration/v2/tailorings_spec.rb index 435a9989c..019554e6b 100644 --- a/spec/integration/v2/tailorings_spec.rb +++ b/spec/integration/v2/tailorings_spec.rb @@ -26,7 +26,7 @@ get 'Request Tailorings' do v2_auth_header tags 'Policies' - description 'Lists Tailorings' + description 'Use this endpoint to retrieve a list of all tailorings' operationId 'Tailorings' content_types pagination_params_v2 @@ -139,7 +139,7 @@ get 'Request a Tailoring' do v2_auth_header tags 'Policies' - description 'Returns a Tailoring' + description 'Use this endpoint to retrieve a specific tailoring.' operationId 'Tailoring' content_types @@ -170,7 +170,7 @@ patch 'Update a Tailoring' do v2_auth_header tags 'Policies' - description 'Updates a Tailoring with the provided value_overrides' + description 'Use this endpoint to edit or update an existing tailoring.' operationId 'UpdateTailoring' content_types @@ -260,7 +260,7 @@ get 'Request a Tailoring file' do v2_auth_header tags 'Policies' - description 'Returns a Tailoring File' + description 'Use this endpoint to retrieve a tailoring file of a specific tailoring.' operationId 'TailoringFile' content_types diff --git a/spec/integration/v2/test_results_spec.rb b/spec/integration/v2/test_results_spec.rb index 37eb13735..02afeb9b5 100644 --- a/spec/integration/v2/test_results_spec.rb +++ b/spec/integration/v2/test_results_spec.rb @@ -34,7 +34,7 @@ get 'Request Test Results under a Report' do v2_auth_header tags 'Reports' - description 'Lists Test Results under a Report' + description 'Use this endpoint to retrieve all of the test results for a specific report.' operationId 'ReportTestResults' content_types tags_params @@ -194,7 +194,7 @@ get 'Request a Test Result' do v2_auth_header tags 'Reports' - description 'Returns a Test Result under a Report' + description 'Use this endpoint to retrieve a specific test result for a specific report.' operationId 'ReportTestResult' content_types diff --git a/spec/integration/v2/value_definitions_spec.rb b/spec/integration/v2/value_definitions_spec.rb index e604a5a50..28fa4ce83 100644 --- a/spec/integration/v2/value_definitions_spec.rb +++ b/spec/integration/v2/value_definitions_spec.rb @@ -15,7 +15,7 @@ get 'Request Value Definitions' do v2_auth_header tags 'Content' - description 'Lists Value Definitions' + description 'List the fields that can be edited within your profile.' operationId 'ValueDefinitions' content_types pagination_params_v2 @@ -79,7 +79,7 @@ get 'Request a Value Definition' do v2_auth_header tags 'Content' - description 'Returns a Value Definition' + description 'Retrieve a specific value definition.' operationId 'ValueDefinition' content_types diff --git a/swagger/v2/openapi.json b/swagger/v2/openapi.json index ee211ae57..850e3a324 100644 --- a/swagger/v2/openapi.json +++ b/swagger/v2/openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Cloud Services for RHEL Compliance API v2", "version": "v2", - "description": "UNDER DEVELOPMENT: This version of the API is not fully done and some parts of it might change! This is the API for Cloud Services for RHEL Compliance. You can find out more about Red Hat Cloud Services for RHEL at [https://console.redhat.com/](https://console.redhat.com/)" + "description": "This is the API for Cloud Services for RHEL Compliance. You can find out more about Red Hat Cloud Services for RHEL at [https://console.redhat.com/](https://console.redhat.com/)" }, "servers": [ { @@ -101,7 +101,7 @@ "tags": [ "Policies" ], - "description": "Lists Policies", + "description": "You can see what policies are currently in place.Policies are statements that manage API scenariossuch as authentication, rate limiting, caching, requests and responses.", "operationId": "Policies", "responses": { "200": { @@ -475,7 +475,7 @@ "tags": [ "Policies" ], - "description": "Create a Policy with the provided attributes", + "description": "Use this endpoint to create a new security policy.", "operationId": "CreatePolicy", "responses": { "201": { @@ -554,7 +554,7 @@ "tags": [ "Policies" ], - "description": "Returns a Policy", + "description": "Use this endpoint to retrieve a specific policy.", "operationId": "Policy", "responses": { "200": { @@ -643,7 +643,7 @@ "tags": [ "Policies" ], - "description": "Updates a Policy with the provided attributes", + "description": "Use this endpoint to edit or update an existing policy.", "operationId": "UpdatePolicy", "responses": { "202": { @@ -720,7 +720,7 @@ "tags": [ "Policies" ], - "description": "Deletes a Policy", + "description": "Use this endpoint to delete a specific policy.", "operationId": "DeletePolicy", "responses": { "202": { @@ -853,7 +853,7 @@ "tags": [ "Systems" ], - "description": "Lists Policies under a System", + "description": "List all policies assigned to a single system", "operationId": "SystemsPolicies", "responses": { "200": { @@ -1108,7 +1108,7 @@ "tags": [ "Content" ], - "description": "Lists Profiles", + "description": "List all security guide profiles.", "operationId": "Profiles", "responses": { "200": { @@ -1430,7 +1430,7 @@ "tags": [ "Content" ], - "description": "Returns a Profile", + "description": "Retrieve a specific profile.", "operationId": "Profile", "responses": { "200": { @@ -1756,7 +1756,7 @@ "tags": [ "Reports" ], - "description": "Lists Reports", + "description": "Use this endpoint to retrieve a list of all available reports.", "operationId": "Reports", "responses": { "200": { @@ -2103,7 +2103,7 @@ "tags": [ "Reports" ], - "description": "Returns a Report", + "description": "Use this endpoint to retrieve a specific report.", "operationId": "Report", "responses": { "200": { @@ -2197,7 +2197,7 @@ "tags": [ "Reports" ], - "description": "Deletes Report's test results", + "description": "Use this endpoint to delete test results for a specific report.", "operationId": "DeleteReport", "responses": { "202": { @@ -2748,7 +2748,7 @@ "tags": [ "Content" ], - "description": "Lists Rule Groups", + "description": "List all rules groups.", "operationId": "Rule Groups", "responses": { "200": { @@ -3063,7 +3063,7 @@ "tags": [ "Content" ], - "description": "Returns a Rule Group", + "description": "Retrieve a specific rule group.", "operationId": "RuleGroup", "responses": { "200": { @@ -3228,7 +3228,7 @@ "tags": [ "Reports" ], - "description": "Lists Rule Results under a Report", + "description": "Use this endpoint to retrieve all of the rule results for a specific report.", "operationId": "ReportRuleResults", "responses": { "200": { @@ -3434,7 +3434,7 @@ "tags": [ "Content" ], - "description": "Lists Rules assigned", + "description": "This is a list of all security guide rules.", "operationId": "Rules", "responses": { "200": { @@ -4350,7 +4350,7 @@ "tags": [ "Content" ], - "description": "Returns a Rule", + "description": "Retrieve a specific rule.", "operationId": "Rule", "responses": { "200": { @@ -4542,7 +4542,7 @@ "tags": [ "Content" ], - "description": "Lists Rules assigned to a Profile", + "description": "This is a list of all security guide rules for a specific profile.", "operationId": "ProfileRules", "responses": { "200": { @@ -5486,7 +5486,7 @@ "tags": [ "Content" ], - "description": "Returns a Rule assigned to a Profile", + "description": "Retrieve a specific security guide rule for a specific profile.", "operationId": "ProfileRule", "responses": { "200": { @@ -5679,7 +5679,7 @@ "tags": [ "Policies" ], - "description": "Lists Rules assigned to a Tailoring", + "description": "Use this to get a list of rules relating to specific tailorings. Tailorings are customizations of rules.", "operationId": "TailoringRules", "responses": { "200": { @@ -6391,7 +6391,7 @@ "tags": [ "Policies" ], - "description": "Assigns a Rule to a Tailoring", + "description": "Add a rule to a specific tailoring.", "operationId": "AssignRule", "responses": { "202": { @@ -6508,7 +6508,7 @@ "tags": [ "Policies" ], - "description": "Unassigns a Rule from a Tailoring", + "description": "Customizing of the tailoring by removing rule", "operationId": "UnassignRule", "responses": { "202": { @@ -6665,7 +6665,7 @@ "tags": [ "Content" ], - "description": "Lists Security Guides", + "description": "This is a list of all SCAP guides.", "operationId": "SecurityGuides", "responses": { "200": { @@ -7043,7 +7043,7 @@ "tags": [ "Content" ], - "description": "Returns a Security Guide", + "description": "Retrieve a specific security guide.", "operationId": "SecurityGuide", "responses": { "200": { @@ -7355,7 +7355,7 @@ "tags": [ "Content" ], - "description": "Lists Supported Profiles", + "description": "List of profiles supported by certain RHEL versions.", "operationId": "SupportedProfiles", "responses": { "200": { @@ -7600,7 +7600,7 @@ "tags": [ "Systems" ], - "description": "Lists Systems", + "description": "List all systems that are accessible when you are logged into your account.", "operationId": "Systems", "responses": { "200": { @@ -8980,7 +8980,7 @@ "tags": [ "Systems" ], - "description": "This feature is exclusively used by the frontend", + "description": "This feature is exclusively used by the frontend.", "operationId": "SystemsOS", "deprecated": true, "responses": { @@ -9033,7 +9033,7 @@ "tags": [ "Systems" ], - "description": "Returns a System", + "description": "Get information about one specific system.", "operationId": "System", "responses": { "200": { @@ -9231,7 +9231,7 @@ "tags": [ "Policies" ], - "description": "Lists Systems assigned to a Policy", + "description": "This is a list of all systems assigned to a specific policy.", "operationId": "PolicySystems", "responses": { "200": { @@ -11148,7 +11148,7 @@ "tags": [ "Policies" ], - "description": "Assigns a System to a Policy", + "description": "Use this endpoint to connect a specific system to a policy.", "operationId": "AssignSystem", "responses": { "202": { @@ -11273,7 +11273,7 @@ "tags": [ "Policies" ], - "description": "Unassigns a System from a Policy", + "description": "Use this endpoint to remove the connection between a system and a policy.", "operationId": "UnassignSystem", "responses": { "202": { @@ -11470,7 +11470,7 @@ "tags": [ "Reports" ], - "description": "Lists Systems assigned to a Report", + "description": "Use this endpoint to retrieve all of the systems for a specific report.", "operationId": "ReportSystems", "responses": { "200": { @@ -13069,7 +13069,7 @@ "tags": [ "Reports" ], - "description": "Returns a System under a Report", + "description": "Use this endpoint to retrieve a specific system for a specific report.", "operationId": "ReportSystem", "responses": { "200": { @@ -13251,7 +13251,7 @@ "tags": [ "Policies" ], - "description": "Lists Tailorings", + "description": "Use this endpoint to retrieve a list of all tailorings", "operationId": "Tailorings", "responses": { "200": { @@ -13691,7 +13691,7 @@ "tags": [ "Policies" ], - "description": "Returns a Tailoring", + "description": "Use this endpoint to retrieve a specific tailoring.", "operationId": "Tailoring", "responses": { "200": { @@ -13787,7 +13787,7 @@ "tags": [ "Policies" ], - "description": "Updates a Tailoring with the provided value_overrides", + "description": "Use this endpoint to edit or update an existing tailoring.", "operationId": "UpdateTailoring", "responses": { "202": { @@ -14053,7 +14053,7 @@ "tags": [ "Policies" ], - "description": "Returns a Tailoring File", + "description": "Use this endpoint to retrieve a tailoring file of a specific tailoring.", "operationId": "TailoringFile", "responses": { "200": { @@ -14201,7 +14201,7 @@ "tags": [ "Reports" ], - "description": "Lists Test Results under a Report", + "description": "Use this endpoint to retrieve all of the test results for a specific report.", "operationId": "ReportTestResults", "responses": { "200": { @@ -15311,7 +15311,7 @@ "tags": [ "Reports" ], - "description": "Returns a Test Result under a Report", + "description": "Use this endpoint to retrieve a specific test result for a specific report.", "operationId": "ReportTestResult", "responses": { "200": { @@ -15489,7 +15489,7 @@ "tags": [ "Content" ], - "description": "Lists Value Definitions", + "description": "List the fields that can be edited within your profile.", "operationId": "ValueDefinitions", "responses": { "200": { @@ -15831,7 +15831,7 @@ "tags": [ "Content" ], - "description": "Returns a Value Definition", + "description": "Retrieve a specific value definition.", "operationId": "ValueDefinition", "responses": { "200": {