model

Type Members

1. case class AbsoluteFragmentId(root: RootId, fragments: List[String]) extends AbsoluteId with Product with Serializable

   

   This is the absolute version of a fragment id.

   This is the absolute version of a fragment id. It is prepended with its root's achor. E.g. "http://atomicbits.io/schema/User.json#/some/schema/path/license"

   root

   The root of this absolute fragment id.

   fragments

   The path that composes the fragment id.

2. trait AbsoluteId extends UniqueId

   

3. case class Action(actionType: Method, headers: Parameters, queryParameters: Parameters, body: Body, responses: Responses, queryString: Option[QueryString] = None) extends Product with Serializable

   

   Created by peter on 10/02/16.

4. case class ActualMediaType(value: String) extends MediaType with Product with Serializable

   

5. case class Body(contentMap: Map[MediaType, BodyContent] = Map.empty) extends Product with Serializable

   

   Created by peter on 26/08/16.

6. case class BodyContent(mediaType: MediaType, bodyType: Option[TypeRepresentation] = None, formParameters: Parameters = new Parameters()) extends Product with Serializable

   

   Created by peter on 10/02/16.

7. sealed trait DateFormat extends AnyRef

   

   Created by peter on 19/08/16.

8. case class FragmentId(fragments: List[String]) extends Id with Product with Serializable

   

   A fragment id identifies its schema uniquely by the schema path (JSON path in the original JSON representation) from its nearest root schema towards itself.

   A fragment id identifies its schema uniquely by the schema path (JSON path in the original JSON representation) from its nearest root schema towards itself. In other words, the fragment id should always match this schema path and is redundant from that point of view. It is of the form "#/some/schema/path/license"

   fragments

   The path that composes the fragment id.

9. sealed trait Id extends AnyRef

   

   The base class for all Id's.

10. trait MediaType extends AnyRef

    

    Created by peter on 26/08/16.

11. case class MergeApplication(name: String, substitutions: Seq[MergeSubstitution]) extends Product with Serializable

    

12. case class MergeApplicationMap(mergeApplications: Seq[MergeApplication] = Seq.empty) extends Product with Serializable

    

13. case class MergeSubstitution(name: String, value: JsValue) extends Product with Serializable

    

    In:

    In:

    /books: type: { searchableCollection: { queryParamName: title, fallbackParamName: digest_all_fields } } get: is: [ secured: { tokenName: access_token }, paged: { maxPages: 10 } ]

    these are the MergeSubstitutions:

    MergeSubstitution(tokenName, access_token) MergeSubstitution(maxPages, 10)

    and the MergeApplications:

    MergeApplication(secured, ...) MergeApplication(paged, ...)

14. sealed trait Method extends AnyRef

    

    Created by peter on 10/02/16.

15. trait ModelMerge extends AnyRef

    

    Created by peter on 25/05/17.

16. case class NativeId(id: String) extends UniqueId with Product with Serializable

    

    A native id is like a relative id, but it is not expected to have an absolute parent id.

    A native id is like a relative id, but it is not expected to have an absolute parent id. NativeId's should not be used in json-schema definitions. They have been added to cope with the native RAML 1.0 types that either have an NativeId or an ImplicitId.

    We cannot use the RootId concept here, because a NativeID has a free format whereas the RootId is a json-schema concept that has to meet strict formatting rules.

17. case class Parameter(name: String, parameterType: TypeRepresentation, required: Boolean = true) extends Product with Serializable

    

    Created by peter on 10/02/16.

18. case class Parameters(valueMap: Map[String, Parameter] = Map.empty) extends Product with Serializable

    

19. case class QueryString(queryStringType: TypeRepresentation) extends Product with Serializable

    

    Created by peter on 14/05/17.

20. case class Raml(title: String, mediaType: Option[MediaType], description: Option[String], version: Option[String], baseUri: Option[String], baseUriParameters: Parameters, protocols: Option[Seq[String]], traits: Traits, types: Types, resources: List[Resource]) extends Product with Serializable

    

    Created by peter on 10/02/16.

21. case class RelativeId(id: String) extends Id with Product with Serializable

    

    A relative id identifies its schema uniquely when expanded with the anchor of its root schema.

    A relative id identifies its schema uniquely when expanded with the anchor of its root schema. Its root schema is its nearest parent that has an absolute id. A schema with a relative id is the root for its child-schemas that don't have an absolute or relative id. A relative id is of the form "contact/ShippingAddress.json".

    id

    The string representation of the id

22. sealed trait ReplaceOp extends AnyRef

    

23. case class ReplaceString(toReplace: String, matchString: String, operations: Seq[ReplaceOp], partial: Boolean) extends Product with Serializable

    

24. case class Resource(urlSegment: String, urlParameter: Option[Parameter] = None, displayName: Option[String] = None, description: Option[String] = None, actions: List[Action] = List.empty, resources: List[Resource] = List.empty, parent: Option[Resource] = None) extends Product with Serializable

    

    Created by peter on 10/02/16.

25. case class ResourceTypes(resourceTypesMap: Map[String, JsObject]) extends ModelMerge with Product with Serializable

    

    Created by peter on 25/05/17.

26. case class Response(status: StatusCode, headers: Parameters, body: Body) extends Product with Serializable

    

    Created by peter on 10/02/16.

27. case class Responses(responseMap: Map[StatusCode, Response] = Map.empty) extends Product with Serializable

    

    Created by peter on 26/08/16.

28. case class RootId(hostPath: List[String], path: List[String], name: String) extends AbsoluteId with Product with Serializable

    

    An absolute id uniquely identifies a schema.

    An absolute id uniquely identifies a schema. A schema with an absolute id is the root for its child-schemas that don't have an absolute or relative id. An absolute id is of the form "http://atomicbits.io/schema/User.json" and often it ends with a "#".

29. case class StatusCode(code: String) extends Product with Serializable

    

    Created by peter on 26/08/16.

30. case class Traits(traitsMap: Map[String, JsObject]) extends ModelMerge with Product with Serializable

    

    Created by peter on 10/02/16.

31. sealed trait TypeModel extends AnyRef

    

    Created by peter on 26/09/16.

32. case class TypeRepresentation(parsed: ParsedType, canonical: Option[TypeReference] = None) extends Product with Serializable

    

    Created by peter on 12/12/16.

33. sealed trait UniqueId extends Id

    

    UniqueId's are Id's that are expected to be unique by value within a RAML document.