Swagger Spec Compatibility
latest
Content:
Errors description
API reference
Changelog
Swagger Spec Compatibility
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
add_rule_discovery_argument() (in module swagger_spec_compatibility.cli.common)
add_rules_arguments() (in module swagger_spec_compatibility.cli.common)
add_sub_parser() (in module swagger_spec_compatibility.cli.explain)
(in module swagger_spec_compatibility.cli.info)
(in module swagger_spec_compatibility.cli.run)
AddedEnumValueInRequest (class in swagger_spec_compatibility.rules.added_enum_value_in_response)
AddedPropertiesInResponseObjectsWithAdditionalPropertiesSetToFalse (class in swagger_spec_compatibility.rules.added_properties_in_response_objects_with_additional_properties_set_to_false)
AddedRequiredPropertyInRequest (class in swagger_spec_compatibility.rules.added_required_property_in_request)
AdditionalPropertiesDiff (class in swagger_spec_compatibility.walkers.additional_properties)
AdditionalPropertiesDifferWalker (class in swagger_spec_compatibility.walkers.additional_properties)
additionalPropertiesValue (swagger_spec_compatibility.walkers.additional_properties.AdditionalPropertiesDifferWalker attribute)
B
BaseRule (class in swagger_spec_compatibility.rules.common)
blacklist_rules (swagger_spec_compatibility.cli.common.CLIRulesProtocol attribute)
C
cached_function (swagger_spec_compatibility.cache.typed_lru_cache attribute)
ChangedType (class in swagger_spec_compatibility.rules.changed_type)
ChangedTypesDiff (class in swagger_spec_compatibility.walkers.changed_types)
ChangedTypesDifferWalker (class in swagger_spec_compatibility.walkers.changed_types)
cli_rules() (in module swagger_spec_compatibility.cli.common)
CLIProtocol (class in swagger_spec_compatibility.cli.common)
CLIRulesProtocol (class in swagger_spec_compatibility.cli.common)
command (swagger_spec_compatibility.cli.common.CLIProtocol attribute)
compatibility_status() (in module swagger_spec_compatibility.rules)
D
DELETE (swagger_spec_compatibility.spec_utils.HTTPVerb attribute)
DeletedEndpoint (class in swagger_spec_compatibility.rules.deleted_endpoint)
description (swagger_spec_compatibility.rules.added_enum_value_in_response.AddedEnumValueInRequest attribute)
(swagger_spec_compatibility.rules.added_properties_in_response_objects_with_additional_properties_set_to_false.AddedPropertiesInResponseObjectsWithAdditionalPropertiesSetToFalse attribute)
(swagger_spec_compatibility.rules.added_required_property_in_request.AddedRequiredPropertyInRequest attribute)
(swagger_spec_compatibility.rules.changed_type.ChangedType attribute)
(swagger_spec_compatibility.rules.common.BaseRule attribute)
(swagger_spec_compatibility.rules.common.RuleProtocol attribute)
(swagger_spec_compatibility.rules.deleted_endpoint.DeletedEndpoint attribute)
(swagger_spec_compatibility.rules.removed_enum_value_from_request.RemovedEnumValueFromRequest attribute)
(swagger_spec_compatibility.rules.removed_properties_from_request_objects_with_additional_properties_set_to_false.RemovedPropertiesFromRequestObjectsWithAdditionalPropertiesSetToFalse attribute)
(swagger_spec_compatibility.rules.removed_required_property_from_response.RemovedRequiredPropertyFromResponse attribute)
dict_check() (swagger_spec_compatibility.walkers.additional_properties.AdditionalPropertiesDifferWalker method)
(swagger_spec_compatibility.walkers.Walker method)
(swagger_spec_compatibility.walkers.changed_types.ChangedTypesDifferWalker method)
(swagger_spec_compatibility.walkers.enum_values.EnumValuesDifferWalker method)
(swagger_spec_compatibility.walkers.request_parameters.RequestParametersWalker method)
(swagger_spec_compatibility.walkers.required_properties.RequiredPropertiesDifferWalker method)
(swagger_spec_compatibility.walkers.response_paths.ResponsePathsWalker method)
diffs (swagger_spec_compatibility.walkers.additional_properties.AdditionalPropertiesDifferWalker attribute)
(swagger_spec_compatibility.walkers.changed_types.ChangedTypesDifferWalker attribute)
(swagger_spec_compatibility.walkers.required_properties.RequiredPropertiesDifferWalker attribute)
DiffType (class in swagger_spec_compatibility.walkers.additional_properties)
documentation_link (swagger_spec_compatibility.rules.common.BaseRule attribute)
(swagger_spec_compatibility.rules.common.RuleProtocol attribute)
E
Endpoint (class in swagger_spec_compatibility.spec_utils)
EntityMapping (class in swagger_spec_compatibility.util)
EnumValuesDiff (class in swagger_spec_compatibility.walkers.enum_values)
EnumValuesDifferWalker (class in swagger_spec_compatibility.walkers.enum_values)
ERROR (swagger_spec_compatibility.rules.common.Level attribute)
error_code (swagger_spec_compatibility.rules.added_enum_value_in_response.AddedEnumValueInRequest attribute)
(swagger_spec_compatibility.rules.added_properties_in_response_objects_with_additional_properties_set_to_false.AddedPropertiesInResponseObjectsWithAdditionalPropertiesSetToFalse attribute)
(swagger_spec_compatibility.rules.added_required_property_in_request.AddedRequiredPropertyInRequest attribute)
(swagger_spec_compatibility.rules.changed_type.ChangedType attribute)
(swagger_spec_compatibility.rules.common.BaseRule attribute)
(swagger_spec_compatibility.rules.common.RuleProtocol attribute)
(swagger_spec_compatibility.rules.deleted_endpoint.DeletedEndpoint attribute)
(swagger_spec_compatibility.rules.removed_enum_value_from_request.RemovedEnumValueFromRequest attribute)
(swagger_spec_compatibility.rules.removed_properties_from_request_objects_with_additional_properties_set_to_false.RemovedPropertiesFromRequestObjectsWithAdditionalPropertiesSetToFalse attribute)
(swagger_spec_compatibility.rules.removed_required_property_from_response.RemovedRequiredPropertyFromResponse attribute)
error_level (swagger_spec_compatibility.rules.added_enum_value_in_response.AddedEnumValueInRequest attribute)
(swagger_spec_compatibility.rules.added_properties_in_response_objects_with_additional_properties_set_to_false.AddedPropertiesInResponseObjectsWithAdditionalPropertiesSetToFalse attribute)
(swagger_spec_compatibility.rules.added_required_property_in_request.AddedRequiredPropertyInRequest attribute)
(swagger_spec_compatibility.rules.changed_type.ChangedType attribute)
(swagger_spec_compatibility.rules.common.BaseRule attribute)
(swagger_spec_compatibility.rules.common.RuleProtocol attribute)
(swagger_spec_compatibility.rules.deleted_endpoint.DeletedEndpoint attribute)
(swagger_spec_compatibility.rules.removed_enum_value_from_request.RemovedEnumValueFromRequest attribute)
(swagger_spec_compatibility.rules.removed_properties_from_request_objects_with_additional_properties_set_to_false.RemovedPropertiesFromRequestObjectsWithAdditionalPropertiesSetToFalse attribute)
(swagger_spec_compatibility.rules.removed_required_property_from_response.RemovedRequiredPropertyFromResponse attribute)
execute() (in module swagger_spec_compatibility.cli.explain)
(in module swagger_spec_compatibility.cli.info)
(in module swagger_spec_compatibility.cli.run)
explain() (swagger_spec_compatibility.rules.common.BaseRule class method)
F
fix_parameter_path() (swagger_spec_compatibility.walkers.additional_properties.AdditionalPropertiesDiff method)
(swagger_spec_compatibility.walkers.SchemaWalker method)
(swagger_spec_compatibility.walkers.changed_types.ChangedTypesDiff method)
(swagger_spec_compatibility.walkers.enum_values.EnumValuesDiff method)
(swagger_spec_compatibility.walkers.request_parameters.RequestParametersWalker method)
(swagger_spec_compatibility.walkers.required_properties.RequiredPropertiesDiff method)
format_path() (in module swagger_spec_compatibility.walkers)
from_swagger_operation (swagger_spec_compatibility.spec_utils.HTTPVerb attribute)
from_swagger_operation() (swagger_spec_compatibility.spec_utils.Endpoint static method)
func (swagger_spec_compatibility.cli.common.CLIProtocol attribute)
G
GET (swagger_spec_compatibility.spec_utils.HTTPVerb attribute)
get_endpoints (in module swagger_spec_compatibility.spec_utils)
get_operation_mappings() (in module swagger_spec_compatibility.spec_utils)
get_operations (in module swagger_spec_compatibility.spec_utils)
get_properties() (in module swagger_spec_compatibility.spec_utils)
get_required_properties() (in module swagger_spec_compatibility.spec_utils)
get_rule_documentation_link() (in module swagger_spec_compatibility.rules.common)
H
has_rule() (swagger_spec_compatibility.rules.common.RuleRegistry static method)
HEAD (swagger_spec_compatibility.spec_utils.HTTPVerb attribute)
HTTPVerb (class in swagger_spec_compatibility.spec_utils)
I
INFO (swagger_spec_compatibility.rules.common.Level attribute)
is_path_in_top_level_paths() (in module swagger_spec_compatibility.util)
iterate_on_responses_status_codes() (in module swagger_spec_compatibility.spec_utils)
J
json_representation() (swagger_spec_compatibility.rules.common.ValidationMessage method)
L
left_spec (swagger_spec_compatibility.walkers.additional_properties.AdditionalPropertiesDifferWalker attribute)
(swagger_spec_compatibility.walkers.changed_types.ChangedTypesDifferWalker attribute)
(swagger_spec_compatibility.walkers.enum_values.EnumValuesDifferWalker attribute)
(swagger_spec_compatibility.walkers.request_parameters.RequestParametersWalker attribute)
(swagger_spec_compatibility.walkers.required_properties.RequiredPropertiesDifferWalker attribute)
(swagger_spec_compatibility.walkers.response_paths.ResponsePathsWalker attribute)
Level (class in swagger_spec_compatibility.rules.common)
list_check() (swagger_spec_compatibility.walkers.additional_properties.AdditionalPropertiesDifferWalker method)
(swagger_spec_compatibility.walkers.Walker method)
(swagger_spec_compatibility.walkers.changed_types.ChangedTypesDifferWalker method)
(swagger_spec_compatibility.walkers.enum_values.EnumValuesDifferWalker method)
(swagger_spec_compatibility.walkers.request_parameters.RequestParametersWalker method)
(swagger_spec_compatibility.walkers.required_properties.RequiredPropertiesDifferWalker method)
(swagger_spec_compatibility.walkers.response_paths.ResponsePathsWalker method)
load_spec_from_spec_dict() (in module swagger_spec_compatibility.spec_utils)
load_spec_from_uri (in module swagger_spec_compatibility.spec_utils)
M
mapping (swagger_spec_compatibility.spec_utils.StatusCodeSchema attribute)
maxsize (swagger_spec_compatibility.cache.typed_lru_cache attribute)
MISCELLANEOUS (swagger_spec_compatibility.rules.common.RuleType attribute)
N
new (swagger_spec_compatibility.util.EntityMapping attribute)
NoValue (class in swagger_spec_compatibility.walkers)
O
old (swagger_spec_compatibility.util.EntityMapping attribute)
OPTIONS (swagger_spec_compatibility.spec_utils.HTTPVerb attribute)
P
PARAMETERS (swagger_spec_compatibility.spec_utils.HTTPVerb attribute)
parser() (in module swagger_spec_compatibility.cli)
PATCH (swagger_spec_compatibility.spec_utils.HTTPVerb attribute)
paths (swagger_spec_compatibility.walkers.response_paths.ResponsePathsWalker attribute)
POST (swagger_spec_compatibility.spec_utils.HTTPVerb attribute)
post_process_rules_cli_arguments() (in module swagger_spec_compatibility.cli.common)
pre_process_cli_to_discover_rules() (in module swagger_spec_compatibility.cli.common)
PROPERTIES (swagger_spec_compatibility.walkers.additional_properties.DiffType attribute)
PUT (swagger_spec_compatibility.spec_utils.HTTPVerb attribute)
R
RemovedEnumValueFromRequest (class in swagger_spec_compatibility.rules.removed_enum_value_from_request)
RemovedPropertiesFromRequestObjectsWithAdditionalPropertiesSetToFalse (class in swagger_spec_compatibility.rules.removed_properties_from_request_objects_with_additional_properties_set_to_false)
RemovedRequiredPropertyFromResponse (class in swagger_spec_compatibility.rules.removed_required_property_from_response)
REQUEST_CONTRACT (swagger_spec_compatibility.rules.common.RuleType attribute)
RequestParametersWalker (class in swagger_spec_compatibility.walkers.request_parameters)
RequiredPropertiesDiff (class in swagger_spec_compatibility.walkers.required_properties)
RequiredPropertiesDifferWalker (class in swagger_spec_compatibility.walkers.required_properties)
RESPONSE_CONTRACT (swagger_spec_compatibility.rules.common.RuleType attribute)
ResponsePathsWalker (class in swagger_spec_compatibility.walkers.response_paths)
right_spec (swagger_spec_compatibility.walkers.additional_properties.AdditionalPropertiesDifferWalker attribute)
(swagger_spec_compatibility.walkers.changed_types.ChangedTypesDifferWalker attribute)
(swagger_spec_compatibility.walkers.enum_values.EnumValuesDifferWalker attribute)
(swagger_spec_compatibility.walkers.request_parameters.RequestParametersWalker attribute)
(swagger_spec_compatibility.walkers.required_properties.RequiredPropertiesDifferWalker attribute)
(swagger_spec_compatibility.walkers.response_paths.ResponsePathsWalker attribute)
rule() (swagger_spec_compatibility.rules.common.RuleRegistry static method)
rule_names() (swagger_spec_compatibility.rules.common.RuleRegistry static method)
rule_type (swagger_spec_compatibility.rules.added_enum_value_in_response.AddedEnumValueInRequest attribute)
(swagger_spec_compatibility.rules.added_properties_in_response_objects_with_additional_properties_set_to_false.AddedPropertiesInResponseObjectsWithAdditionalPropertiesSetToFalse attribute)
(swagger_spec_compatibility.rules.added_required_property_in_request.AddedRequiredPropertyInRequest attribute)
(swagger_spec_compatibility.rules.changed_type.ChangedType attribute)
(swagger_spec_compatibility.rules.common.BaseRule attribute)
(swagger_spec_compatibility.rules.common.RuleProtocol attribute)
(swagger_spec_compatibility.rules.deleted_endpoint.DeletedEndpoint attribute)
(swagger_spec_compatibility.rules.removed_enum_value_from_request.RemovedEnumValueFromRequest attribute)
(swagger_spec_compatibility.rules.removed_properties_from_request_objects_with_additional_properties_set_to_false.RemovedPropertiesFromRequestObjectsWithAdditionalPropertiesSetToFalse attribute)
(swagger_spec_compatibility.rules.removed_required_property_from_response.RemovedRequiredPropertyFromResponse attribute)
RuleProtocol (class in swagger_spec_compatibility.rules.common)
RuleRegistry (class in swagger_spec_compatibility.rules.common)
rules (swagger_spec_compatibility.cli.common.CLIRulesProtocol attribute)
rules() (in module swagger_spec_compatibility.cli.common)
(swagger_spec_compatibility.rules.common.RuleRegistry static method)
RuleType (class in swagger_spec_compatibility.rules.common)
S
SchemaWalker (class in swagger_spec_compatibility.walkers)
short_name (swagger_spec_compatibility.rules.added_enum_value_in_response.AddedEnumValueInRequest attribute)
(swagger_spec_compatibility.rules.added_properties_in_response_objects_with_additional_properties_set_to_false.AddedPropertiesInResponseObjectsWithAdditionalPropertiesSetToFalse attribute)
(swagger_spec_compatibility.rules.added_required_property_in_request.AddedRequiredPropertyInRequest attribute)
(swagger_spec_compatibility.rules.changed_type.ChangedType attribute)
(swagger_spec_compatibility.rules.common.BaseRule attribute)
(swagger_spec_compatibility.rules.common.RuleProtocol attribute)
(swagger_spec_compatibility.rules.deleted_endpoint.DeletedEndpoint attribute)
(swagger_spec_compatibility.rules.removed_enum_value_from_request.RemovedEnumValueFromRequest attribute)
(swagger_spec_compatibility.rules.removed_properties_from_request_objects_with_additional_properties_set_to_false.RemovedPropertiesFromRequestObjectsWithAdditionalPropertiesSetToFalse attribute)
(swagger_spec_compatibility.rules.removed_required_property_from_response.RemovedRequiredPropertyFromResponse attribute)
should_path_be_walked_through() (swagger_spec_compatibility.walkers.request_parameters.RequestParametersWalker method)
(swagger_spec_compatibility.walkers.Walker method)
(swagger_spec_compatibility.walkers.response_paths.ResponsePathsWalker method)
status_code (swagger_spec_compatibility.spec_utils.StatusCodeSchema attribute)
StatusCodeSchema (class in swagger_spec_compatibility.spec_utils)
string_representation() (swagger_spec_compatibility.rules.common.ValidationMessage method)
swagger_spec_compatibility (module)
swagger_spec_compatibility.cache (module)
swagger_spec_compatibility.cli (module)
swagger_spec_compatibility.cli.common (module)
swagger_spec_compatibility.cli.explain (module)
swagger_spec_compatibility.cli.info (module)
swagger_spec_compatibility.cli.run (module)
swagger_spec_compatibility.rules (module)
swagger_spec_compatibility.rules.added_enum_value_in_response (module)
swagger_spec_compatibility.rules.added_properties_in_response_objects_with_additional_properties_set_to_false (module)
swagger_spec_compatibility.rules.added_required_property_in_request (module)
swagger_spec_compatibility.rules.changed_type (module)
swagger_spec_compatibility.rules.common (module)
swagger_spec_compatibility.rules.deleted_endpoint (module)
swagger_spec_compatibility.rules.removed_enum_value_from_request (module)
swagger_spec_compatibility.rules.removed_properties_from_request_objects_with_additional_properties_set_to_false (module)
swagger_spec_compatibility.rules.removed_required_property_from_response (module)
swagger_spec_compatibility.spec_utils (module)
swagger_spec_compatibility.util (module)
swagger_spec_compatibility.walkers (module)
swagger_spec_compatibility.walkers.additional_properties (module)
swagger_spec_compatibility.walkers.changed_types (module)
swagger_spec_compatibility.walkers.enum_values (module)
swagger_spec_compatibility.walkers.request_parameters (module)
swagger_spec_compatibility.walkers.required_properties (module)
swagger_spec_compatibility.walkers.response_paths (module)
T
typed_lru_cache (class in swagger_spec_compatibility.cache)
U
uncached_function (swagger_spec_compatibility.cache.typed_lru_cache attribute)
uri() (in module swagger_spec_compatibility.cli.common)
V
validate() (swagger_spec_compatibility.rules.added_enum_value_in_response.AddedEnumValueInRequest class method)
(swagger_spec_compatibility.rules.added_properties_in_response_objects_with_additional_properties_set_to_false.AddedPropertiesInResponseObjectsWithAdditionalPropertiesSetToFalse class method)
(swagger_spec_compatibility.rules.added_required_property_in_request.AddedRequiredPropertyInRequest class method)
(swagger_spec_compatibility.rules.changed_type.ChangedType class method)
(swagger_spec_compatibility.rules.common.BaseRule class method)
(swagger_spec_compatibility.rules.common.RuleProtocol class method)
(swagger_spec_compatibility.rules.deleted_endpoint.DeletedEndpoint class method)
(swagger_spec_compatibility.rules.removed_enum_value_from_request.RemovedEnumValueFromRequest class method)
(swagger_spec_compatibility.rules.removed_properties_from_request_objects_with_additional_properties_set_to_false.RemovedPropertiesFromRequestObjectsWithAdditionalPropertiesSetToFalse class method)
(swagger_spec_compatibility.rules.removed_required_property_from_response.RemovedRequiredPropertyFromResponse class method)
validation_message() (swagger_spec_compatibility.rules.common.BaseRule class method)
ValidationMessage (class in swagger_spec_compatibility.rules.common)
VALUE (swagger_spec_compatibility.walkers.additional_properties.DiffType attribute)
value_check() (swagger_spec_compatibility.walkers.additional_properties.AdditionalPropertiesDifferWalker method)
(swagger_spec_compatibility.walkers.Walker method)
(swagger_spec_compatibility.walkers.changed_types.ChangedTypesDifferWalker method)
(swagger_spec_compatibility.walkers.enum_values.EnumValuesDifferWalker method)
(swagger_spec_compatibility.walkers.request_parameters.RequestParametersWalker method)
(swagger_spec_compatibility.walkers.required_properties.RequiredPropertiesDifferWalker method)
(swagger_spec_compatibility.walkers.response_paths.ResponsePathsWalker method)
W
walk() (swagger_spec_compatibility.walkers.Walker method)
Walker (class in swagger_spec_compatibility.walkers)
WARNING (swagger_spec_compatibility.rules.common.Level attribute)
wrap() (in module swagger_spec_compatibility.util)
Read the Docs
v: latest
Versions
master
latest
stable
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.