https://github.com/gravitee-io/gravitee-policy-xml-validation

Gravitee.io Policy - XML Validation
https://github.com/gravitee-io/gravitee-policy-xml-validation

Last synced: about 1 month ago
JSON representation

Gravitee.io Policy - XML Validation

• Host: GitHub
• URL: https://github.com/gravitee-io/gravitee-policy-xml-validation
• Owner: gravitee-io
• License: apache-2.0
• Created: 2018-09-06T11:33:07.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-06T17:47:07.000Z (9 months ago)
• Last Synced: 2024-04-06T18:39:55.843Z (9 months ago)
• Language: Java
• Size: 57.6 KB
• Stars: 0
• Watchers: 27
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.adoc
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.adoc
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
= XML validation policy

ifdef::env-github[]

image:https://img.shields.io/static/v1?label=Available%20at&message=Gravitee.io&color=1EC9D2["Gravitee.io", link="https://download.gravitee.io/#graviteeio-apim/plugins/policies/gravitee-policy-xml-validation/"]

image:https://img.shields.io/badge/License-Apache%202.0-blue.svg["License", link="https://github.com/gravitee-io/gravitee-policy-xml-validation/blob/master/LICENSE.txt"]

image:https://img.shields.io/badge/semantic--release-conventional%20commits-e10079?logo=semantic-release["Releases", link="https://github.com/gravitee-io/gravitee-policy-xml-validation/releases"]

image:https://circleci.com/gh/gravitee-io/gravitee-policy-xml-validation.svg?style=svg["CircleCI", link="https://circleci.com/gh/gravitee-io/gravitee-policy-xml-validation"]

endif::[]

== Phase

[cols="2*", options="header"]

|===

^|onRequestContent

^|onResponseContent

^.^| X

^.^|

|===

== Description

You can use the `xml-validation` policy to validate XML using an XSD schema. This policy uses `javax.xml`.

A 400 BAD REQUEST error is received with a custom error message body with a custom error message body when validation fails.

Injects processing report messages into request metrics for analytics.

== Compatibility with APIM

|===

| Plugin version | APIM version

| 1.x            | All supported versions

|===

== Configuration

|===

|Property |Required |Description |Type| Default

.^|errorMessage

^.^|

|Custom error message in XML format. Spel is allowed.

^.^|string

|validation/internal

.^|xsdSchema

^.^|X

|Xsd schema.

^.^|string

|

|===

== Error

=== HTTP status code

|===

|Code |Message

.^| ```400```

| Applies to:

* Invalid payload

* Invalid XSD schema

* Invalid error message XML format

|===