models

type APICollectionMetadata struct {

	// ts when the collection was created
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"CreatedAt,omitempty"`

	// ts when the collection was deleted
	// Format: date-time
	DeletedAt strfmt.DateTime `json:"DeletedAt,omitempty"`

	// cid (aka collectionId) would be used to naming ${collectionId} field, that field should be url safe
	// otherwise an error would be returned.
	// leave it empty would generate a random uuid for ${collectionId}
	CollectionID string `json:"collectionId,omitempty"`

	// pid is used to isolate resources (by projects), making the collections are belonged to a specific project
	ProjectID string `json:"projectId,omitempty"`
}

type APICollectionType string

type APICreateCollectionRequest struct {

	// collection Id
	CollectionID string `json:"collectionId,omitempty"`

	// collection type
	CollectionType *APICollectionType `json:"collectionType,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// project Id
	ProjectID string `json:"projectId,omitempty"`

	// schemas
	Schemas []*APISchemaField `json:"schemas"`
}

type APICreateCollectionResponse struct {

	// metadata
	Metadata *APICollectionMetadata `json:"Metadata,omitempty"`

	// collection type
	CollectionType *APICollectionType `json:"collectionType,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// schemas
	Schemas []*APISchemaField `json:"schemas"`
}

type APICreateDocumentRequest struct {

	// collection Id
	CollectionID string `json:"collectionId,omitempty"`

	// data represents rawdata for any kind of formating
	// Format: byte
	Data strfmt.Base64 `json:"data,omitempty"`

	// dataformat
	Dataformat *APIDataFormat `json:"dataformat,omitempty"`

	// document Id
	DocumentID string `json:"documentId,omitempty"`

	// project Id
	ProjectID string `json:"projectId,omitempty"`
}

type APICreateDocumentResponse struct {

	// metadata
	Metadata *APIDataMetadata `json:"Metadata,omitempty"`
}

type APIDataFormat string

type APIDataMetadata struct {

	// ts when the record was created
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"CreatedAt,omitempty"`

	// ts when the record was deleted
	// Format: date-time
	DeletedAt strfmt.DateTime `json:"DeletedAt,omitempty"`

	// cid is collection id from collection data
	CollectionID string `json:"collectionId,omitempty"`

	// dataformat
	Dataformat *APIDataFormat `json:"dataformat,omitempty"`

	// did (aka dataid) would be used to naming ${documentId} field, that field should be url safe
	DocumentID string `json:"documentId,omitempty"`

	// pid is project id
	ProjectID string `json:"projectId,omitempty"`
}

type APIDeleteCollectionResponse interface{}

type APIDeleteDocumentResponse interface{}

type APIGetCollectionResponse struct {

	// metadata
	Metadata *APICollectionMetadata `json:"Metadata,omitempty"`

	// collection type
	CollectionType *APICollectionType `json:"collectionType,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// schemas
	Schemas []*APISchemaField `json:"schemas"`
}

type APIGetDocumentResponse struct {

	// metadata
	Metadata *APIDataMetadata `json:"Metadata,omitempty"`

	// data
	// Format: byte
	Data strfmt.Base64 `json:"data,omitempty"`
}

type APIHTTPBody struct {

	// The HTTP Content-Type header value specifying the content type of the body.
	ContentType string `json:"contentType,omitempty"`

	// The HTTP request/response body as raw binary.
	// Format: byte
	Data strfmt.Base64 `json:"data,omitempty"`

	// Application specific response metadata. Must be set in the first response
	// for streaming APIs.
	Extensions []*ProtobufAny `json:"extensions"`
}

type APIListCollectionsResponse interface{}

type APIQueryDocumentResponse struct {

	// docs
	Docs *APIGetDocumentResponse `json:"docs,omitempty"`
}

type APISchemaField struct {

	// datatype
	Datatype *APISchemaFieldDataType `json:"datatype,omitempty"`

	// example
	Example *APISchemaFieldExampleValue `json:"example,omitempty"`

	// name
	Name string `json:"name,omitempty"`
}

type APISchemaFieldDataType string

type APISchemaFieldExampleValue struct {

	// bool value
	BoolValue bool `json:"boolValue,omitempty"`

	// integer value
	IntegerValue string `json:"integerValue,omitempty"`

	// number value
	NumberValue float64 `json:"numberValue,omitempty"`

	// string value
	StringValue string `json:"stringValue,omitempty"`
}

type ProtobufAny struct {

	// A URL/resource name that uniquely identifies the type of the serialized
	// protocol buffer message. This string must contain at least
	// one "/" character. The last segment of the URL's path must represent
	// the fully qualified name of the type (as in
	// `path/google.protobuf.Duration`). The name should be in a canonical form
	// (e.g., leading "." is not accepted).
	//
	// In practice, teams usually precompile into the binary all types that they
	// expect it to use in the context of Any. However, for URLs which use the
	// scheme `http`, `https`, or no scheme, one can optionally set up a type
	// server that maps type URLs to message definitions as follows:
	//
	// * If no scheme is provided, `https` is assumed.
	// * An HTTP GET on the URL must yield a [google.protobuf.Type][]
	//   value in binary format, or produce an error.
	// * Applications are allowed to cache lookup results based on the
	//   URL, or have them precompiled into a binary to avoid any
	//   lookup. Therefore, binary compatibility needs to be preserved
	//   on changes to types. (Use versioned type names to manage
	//   breaking changes.)
	//
	// Note: this functionality is not currently available in the official
	// protobuf release, and it is not used for type URLs beginning with
	// type.googleapis.com.
	//
	// Schemes other than `http`, `https` (or the empty scheme) might be
	// used with implementation specific semantics.
	AtType string `json:"@type,omitempty"`
}

type RPCStatus struct {

	// code
	Code int32 `json:"code,omitempty"`

	// details
	Details []*ProtobufAny `json:"details"`

	// message
	Message string `json:"message,omitempty"`
}