soap

type Element struct {
	// Name is the element's local name.
	Name string
	// Namespace is the element's namespace URI.
	Namespace string
	// Qualified reports whether the element's DESCENDANTS carry the
	// namespace too, which is the schema's elementFormDefault. The element
	// itself is global and always carries it.
	Qualified bool
	// Schema is the element's content as a JSON Schema object. It is nil
	// when the element declares no content.
	Schema *Schema
}

type Extension struct {
	// Version is Version11 or Version12.
	Version string `json:"version"`
	// Action is the binding's soapAction. It is always written, including
	// when empty: an empty action is sent as an empty header, which is not
	// the same as sending no header at all.
	Action string `json:"action"`
	// Path is the address every operation of the service is sent to. The
	// document's path key is synthetic (see Render), so this is the only
	// place the wire path exists.
	Path string `json:"path"`
	// Input is the element the request body carries.
	Input ExtensionElement `json:"input"`
	// Output is the element a successful response carries. Its Name is
	// empty for a one-way operation.
	Output *ExtensionElement `json:"output,omitempty"`
}

type ExtensionElement struct {
	Element   string `json:"element"`
	Namespace string `json:"namespace,omitempty"`
	// Qualified reports whether the element's descendants carry the
	// namespace, which is the schema's elementFormDefault.
	Qualified bool `json:"qualified,omitempty"`
}

type Fault struct {
	// Code is the fault code: the 1.1 faultcode, or the 1.2 Code/Value.
	Code string
	// Reason is the human-readable text: the 1.1 faultstring, or the 1.2
	// Reason/Text.
	Reason string
	// Detail is the fault's application-specific detail as text, empty when
	// the fault carries none. It is not parsed further: its content is
	// defined by the upstream's own schema, and the decoded response body
	// carries the whole tree for a caller that needs it.
	Detail string
}

type Operation struct {
	// Name is the wsdl:operation name. It becomes the operationId, which is
	// what api_discover lists and what a persona route rule is written
	// against.
	Name string
	// Documentation is the operation's wsdl:documentation, empty when absent.
	Documentation string
	// SOAPAction is the binding's soapAction. An empty action is legal and
	// is sent as an empty header value, which is not the same as omitting
	// the header: several stacks dispatch on its presence.
	SOAPAction string
	// Input is the element the request body carries.
	Input Element
	// Output is the element a successful response body carries. Its Name is
	// empty for a one-way operation, which declares no output message.
	Output Element
}

type Schema struct {
	Type        string             `json:"type,omitempty"`
	Format      string             `json:"format,omitempty"`
	Description string             `json:"description,omitempty"`
	Properties  map[string]*Schema `json:"properties,omitempty"`
	Required    []string           `json:"required,omitempty"`
	Items       *Schema            `json:"items,omitempty"`
	Enum        []string           `json:"enum,omitempty"`
	Nullable    bool               `json:"nullable,omitempty"`
	// Order is the sequence the upstream requires this object's child
	// elements in. An xsd:sequence is ordered and a JSON object is not, so
	// without it the encoder would emit the properties in whatever order a
	// map yields and the upstream would reject a body whose every value was
	// correct. Attributes are absent from it: their position is the start
	// tag, not the sequence.
	Order []string `json:"x-soap-order,omitempty"`
	// Attribute marks a property the envelope writer emits as an XML
	// attribute rather than a child element. It is an extension because
	// JSON Schema has no notion of the distinction and the encoder needs
	// it: a property written in the wrong position is silently ignored by
	// the upstream.
	Attribute bool `json:"x-soap-attribute,omitempty"`
}

type Service struct {
	// Name is the wsdl:service name, used as the rendered document's title.
	Name string
	// Documentation is the service's wsdl:documentation, empty when absent.
	Documentation string
	// TargetNamespace is the document's targetNamespace. It is the default
	// namespace of the body elements and is what an envelope is built with.
	TargetNamespace string
	// Address is the soap:address location of the port that was imported,
	// as written. Only its path reaches the rendered document; the host is
	// dropped because a catalog spec is shared across connections and each
	// connection supplies its own base_url.
	Address string
	// Path is Address's path, always starting with "/".
	Path string
	// SOAPVersion is Version11 or Version12, taken from the binding.
	SOAPVersion string
	// Operations are the port type's operations in document order.
	Operations []Operation
}