rspec/rules/S3843/xml/rule.adoc

48 lines
1.2 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2021-04-28 16:49:39 +02:00
Certain prefixes are widely recognized and expected to correspond to specific namespaces. For instance, most users will expect "xs" to correspond to "http://www.w3.org/2001/XMLSchema". If you subvert that expected correspondence, you run the risk of severely confusing the users of your XSD.
=== Noncompliant code example
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,xml]
2021-04-28 16:49:39 +02:00
----
<xs:schema targetNamespace="http://www.codeSamples.com/fruit"
elementFormDefault="qualified" version="1"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:wsdl="http://CodeSamples.com/animal> <!-- Noncompliant -->
...
----
=== Compliant solution
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,xml]
2021-04-28 16:49:39 +02:00
----
<xs:schema targetNamespace="http://www.codeSamples.com/fruit"
elementFormDefault="qualified" version="1"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:animal="http://CodeSamples.com/animal>
...
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::message.adoc[]
include::parameters.adoc[]
include::highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::comments-and-links.adoc[]
endif::env-github,rspecator-view[]