github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_attachments.json (about)

     1  {
     2      "openapi":"3.0.0",
     3      "info":{
     4        "description":"",
     5        "version":"1.0",
     6        "title":"Engage Digital API",
     7        "termsOfService":"https://developer.ringcentral.com"
     8      },
     9      "tags":[
    10        {
    11          "name":"Attachments"
    12        }
    13      ],
    14      "paths":{
    15        "/attachments":{
    16          "get":{
    17            "tags":[
    18              "Attachments"
    19            ],
    20            "summary":"Getting all attachments",
    21            "operationId":"getAllAttachments",
    22            "description":"This method renders attachments ordered by creation date (descending).",
    23            "parameters":[
    24              {
    25                "name":"offset",
    26                "in":"query",
    27                "description":"The record index to start. Default value is 0.",
    28                "required":false,
    29                "schema":{
    30                  "type":"integer",
    31                  "format":"int32"
    32                }
    33              },
    34              {
    35                "name":"limit",
    36                "in":"query",
    37                "description":"The max number of records to return. Default value is 30, max value is 150.",
    38                "required":false,
    39                "schema":{
    40                  "type":"integer",
    41                  "format":"int32"
    42                }
    43              }
    44            ],
    45            "responses":{
    46              "200":{
    47                "description":"Success",
    48                "content":{
    49                  "application/json":{
    50                    "schema":{
    51                      "$ref":"#/components/schemas/GetAllAttachmentsResponse"
    52                    }
    53                  }
    54                }
    55              }
    56            }
    57          },
    58          "post":{
    59            "tags":[
    60              "Attachments"
    61            ],
    62            "summary":"Creating an attachment",
    63            "operationId":"createAttachment",
    64            "description":"This method allows you to create an new attachment.",
    65            "requestBody":{
    66              "content":{
    67                "multipart/form-data:":{
    68                  "schema":{
    69                    "properties":{
    70                      "file":{
    71                        "type":"string",
    72                        "format":"binary"
    73                      },
    74                      "private":{
    75                        "type":"string",
    76                        "enum":["true","=1"]
    77                      }
    78                    }
    79                  }
    80                }
    81              }
    82            },
    83            "responses":{
    84              "200":{
    85                "description":"Success",
    86                "content":{
    87                  "application/json":{
    88                    "schema":{
    89                      "$ref":"#/components/schemas/Attachment"
    90                    }
    91                  }
    92                }
    93              },
    94              "422":{
    95                "description":"Compose is not supported on this source (compose_disabled_on_source)"
    96              }
    97            }
    98          }
    99        },
   100        "/attachments/{attachmentId}":{
   101          "get":{
   102            "tags":[
   103              "Attachments"
   104            ],
   105            "summary":"Getting an attachment from its id",
   106            "operationId":"getAttachment",
   107            "description":"This method renders an attachment from given id.",
   108            "parameters":[
   109              {
   110                "name":"attachmentId",
   111                "in":"path",
   112                "required":true,
   113                "schema":{
   114                  "type":"string"
   115                }
   116              }
   117            ],
   118            "responses":{
   119              "200":{
   120                "description":"Success",
   121                "content":{
   122                  "application/json":{
   123                    "schema":{
   124                      "$ref":"#/components/schemas/Attachment"
   125                    }
   126                  }
   127                }
   128              }
   129            }
   130          }
   131        }
   132      },
   133      "servers":[
   134        {
   135          "url":"https://DOMAIN.api.engagement.dimelo.com/1.0"
   136        }
   137      ],
   138      "components":{
   139        "securitySchemes":{
   140          "bearerAuth":{
   141            "type":"http",
   142            "scheme": "bearer"
   143          }
   144        },
   145        "schemas":{
   146          "GetAllAttachmentsResponse":{
   147            "properties":{
   148              "count":{
   149                "type":"integer",
   150                "format":"int32"
   151              },
   152              "limit":{
   153                "type":"integer",
   154                "format":"int32"
   155              },
   156              "offset":{
   157                "type":"integer",
   158                "format":"int32"
   159              },
   160              "records":{
   161                "type":"array",
   162                "items":{
   163                  "$ref":"#/components/schemas/Attachment"
   164                }
   165              }
   166            }
   167          },
   168          "Attachment":{
   169            "properties":{
   170              "id":{
   171                "type":"string"
   172              },
   173              "created_at":{
   174                "type":"string",
   175                "format":"date-time"
   176              },
   177              "updated_at":{
   178                "type":"string",
   179                "format":"date-time"
   180              },
   181              "content_type":{
   182                "type":"string"
   183              },
   184              "filename":{
   185                "type":"string"
   186              },
   187              "foreign_id":{
   188                "type":"string"
   189              },
   190              "size":{
   191                "type":"integer"
   192              },
   193              "url":{
   194                "type":"string"
   195              },
   196              "video_metadata":{
   197                "type":"array",
   198                "items":{
   199                  "type":"string"
   200                }
   201              },
   202              "embed":{
   203                "type":"boolean"
   204              },
   205              "public?":{
   206                "type":"boolean"
   207              }
   208            }
   209          }
   210        }
   211      }
   212    }