Delete a document

API Reference

Documents

Delete a document

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

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

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)[ 1 .. 10485760 ] charactersrequired

The content of the document. Maximum file size is 10Mib.

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)[ 1 .. 10485760 ] charactersrequired

The content of the document. Maximum file size is 10Mib.

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.datacollection.documents.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)[ 1 .. 10485760 ] charactersrequired

The content of the document. Maximum file size is 10Mib.

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"
}