Field Squared API Services

WorkspaceFormDocumentation

Detail structural compoments and documentation required for a workspace document for a given binding.

The following routes are available for this service:
GET	/{Workspace}/apidoc/{Binding}

import Foundation
import ServiceStack

/**
* Detail structural compoments and documentation required for a workspace document for a given binding.
*/
public class WorkspaceFormDocumentation : Codable
{
    public var workspace:String
    public var binding:String
    public var matchingTemplates:[TemplateDocumentation] = []

    required public init(){}
}

public class TemplateDocumentation : Codable
{
    public var templateName:String
    public var templateProperties:[String:String] = [:]
    public var controls:[ControlDocumentation] = []

    required public init(){}
}

public class ControlDocumentation : Codable
{
    public var binding:String
    public var inputFormat:String
    public var inputContraints:String
    public var inputExample:String

    required public init(){}
}

Swift WorkspaceFormDocumentation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /{Workspace}/apidoc/{Binding} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv