github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_communities.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": "Communities"
    12        }
    13      ],
    14      "paths": {
    15        "/communities": {
    16          "get": {
    17            "tags": [
    18              "Communities"
    19            ],
    20            "summary": "Getting all communities",
    21            "operationId": "getAllCommunities",
    22            "description": "This method renders communities ordered by creation date (ascending).",
    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/GetAllCommunitiesResponse"
    52                    }
    53                  }
    54                }
    55              }
    56            }
    57          }
    58        },
    59        "/communities/{communityId}": {
    60          "get": {
    61            "tags": [
    62              "Communities"
    63            ],
    64            "summary": "Getting a community from its id",
    65            "operationId": "getCommunity",
    66            "description": "This method renders a community from given id.",
    67            "parameters": [
    68              {
    69                "name": "communityId",
    70                "in": "path",
    71                "required": true,
    72                "schema": {
    73                  "type": "string"
    74                }
    75              }
    76            ],
    77            "responses": {
    78              "200": {
    79                "description": "Success",
    80                "content": {
    81                  "application/json": {
    82                    "schema": {
    83                      "$ref": "#/components/schemas/Community"
    84                    }
    85                  }
    86                }
    87              }
    88            }
    89          }
    90        }
    91      },
    92      "servers": [
    93        {
    94          "url": "https://DOMAIN.api.engagement.dimelo.com/1.0"
    95        }
    96      ],
    97      "components": {
    98        "schemas": {
    99          "GetAllCommunitiesResponse": {
   100            "properties": {
   101              "count": {
   102                "type": "integer",
   103                "format": "int32"
   104              },
   105              "limit": {
   106                "type": "integer",
   107                "format": "int32"
   108              },
   109              "offset": {
   110                "type": "integer",
   111                "format": "int32"
   112              },
   113              "records": {
   114                "type": "array",
   115                "items": {
   116                  "$ref": "#/components/schemas/Community"
   117                }
   118              }
   119            }
   120          },
   121          "Community": {
   122            "properties": {
   123              "id": {
   124                "type": "string"
   125              },
   126              "created_at": {
   127                "type": "string",
   128                "format": "date-time"
   129              },
   130              "updated_at": {
   131                "type": "string",
   132                "format": "date-time"
   133              },
   134              "active": {
   135                "type": "boolean"
   136              },
   137              "name": {
   138                "type": "string"
   139              },
   140              "type": {
   141                "type": "string"
   142              }
   143            }
   144          }
   145        }
   146      }
   147    }