API Reference
/
Documents

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://docs.bndry.net/_mock/apis/openapi/

Automations

Service for managing and executing automations.

This description was generated by a custom Redocly generator.

Operations

Documents

Service for managing documents.

Operations

Create a document

Request

Creates a new document.

Bodyapplication/json

Required. The document to create.

namestring(name)

(IDENTIFIER) The resource name of the document. Format: documents/{document}

displayNamestring(display_name)[ 1 .. 128 ] charactersrequired

Optional. A mutable, user-settable field for providing a human-readable name for the document, to be used in user interfaces. Must be <= 63 characters.

contentstring(byte)(content)non-emptyrequired

The content of the document.

curl -i -X POST \
  https://docs.bndry.net/_mock/apis/openapi/v1alpha/documents \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "string",
    "content": "string",
    "createTime": "1s",
    "updateTime": "1s"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the document. Format: documents/{document}

displayNamestring(display_name)[ 1 .. 128 ] charactersrequired

Optional. A mutable, user-settable field for providing a human-readable name for the document, to be used in user interfaces. Must be <= 63 characters.

contentstring(byte)(content)non-emptyrequired

The content of the document.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the document was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the document was most recently updated.

Response
application/json
{
  "name": "string",
  "displayName": "string",
  "content": "string",
  "createTime": "1s",
  "updateTime": "1s"
}

Retrieve a document

Request

Retrieves a document.

Path
documentstringrequired

The document id.

Query
namestring(name)required

Required. The resource name of the document to retrieve. Format: documents/{document}

viewstring(bndry.api.core.v1alpha.DocumentView)

Optional. Specifies the view of the document to retrieve.

Enum"DOCUMENT_VIEW_UNSPECIFIED""DOCUMENT_VIEW_BASIC""DOCUMENT_VIEW_FULL"
curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/documents/{document}?name=string&view=DOCUMENT_VIEW_UNSPECIFIED'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the document. Format: documents/{document}

displayNamestring(display_name)[ 1 .. 128 ] charactersrequired

Optional. A mutable, user-settable field for providing a human-readable name for the document, to be used in user interfaces. Must be <= 63 characters.

contentstring(byte)(content)non-emptyrequired

The content of the document.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the document was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the document was most recently updated.

Response
application/json
{
  "name": "string",
  "displayName": "string",
  "content": "string",
  "createTime": "1s",
  "updateTime": "1s"
}

Delete a document

Request

Deletes a document.

Path
documentstringrequired

The document id.

Query
namestring(name)required

Required. The resource name of the document to delete. Format: documents/{document}

curl -i -X DELETE \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/documents/{document}?name=string'

Responses

Success

Bodyapplication/json
object(google.protobuf.Empty)

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Response
application/json
{}

Tenants

Service for managing tenants.

Operations

Form Definitions

Service for managing form definitions.

Operations

Workspaces

Service for managing workspaces and their associated forms and documents.

Operations

Entities

Operations