swagger: '2.0' info: title: The Things Stack — Application Server AppAs UserBookmarkRegistry API version: v3.36 description: The Things Stack is an open-source LoRaWAN Network Server implementation. This OpenAPI was derived from the upstream gRPC-Gateway generated api.swagger.json published by TheThingsNetwork/lorawan-stack v3.36. license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 contact: name: The Things Industries url: https://www.thethingsindustries.com host: eu1.cloud.thethings.industries basePath: /api/v3 schemes: - https consumes: - application/json produces: - application/json security: - ApiKeyAuth: [] tags: - name: UserBookmarkRegistry paths: /users/{user_ids.user_id}/bookmarks: get: summary: List the bookmarks for the given user. operationId: UserBookmarkRegistry_List responses: '200': description: A successful response. schema: $ref: '#/definitions/v3UserBookmarks' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: user_ids.user_id description: This ID shares namespace with organization IDs. in: path required: true type: string - name: user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string - name: limit description: Limit the number of results per page. in: query required: false type: integer format: int64 - name: page description: Page number for pagination. 0 is interpreted as 1. in: query required: false type: integer format: int64 - name: order description: 'Order the results by this field path. Default ordering is by ID. Prepend with a minus (-) to reverse the order.' in: query required: false type: string - name: deleted description: Only return recently deleted bookmarks. in: query required: false type: boolean - name: entity_types description: 'Specifies that only bookmarks that reference the given entity type should be returned. If empty the filter is not applied.' in: query required: false type: array items: type: string collectionFormat: multi tags: - UserBookmarkRegistry post: summary: Create a bookmark for the given user. operationId: UserBookmarkRegistry_Create responses: '200': description: A successful response. schema: $ref: '#/definitions/v3UserBookmark' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: user_ids.user_id description: This ID shares namespace with organization IDs. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/v3UserBookmarkRegistryCreateBody' tags: - UserBookmarkRegistry /users/{user_ids.user_id}/bookmarks/applications/{entity_ids.application_ids.application_id}: delete: summary: Delete the given user's bookmark. operationId: UserBookmarkRegistry_Delete responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: user_ids.user_id description: This ID shares namespace with organization IDs. in: path required: true type: string - name: entity_ids.application_ids.application_id in: path required: true type: string - name: user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string - name: entity_ids.client_ids.client_id in: query required: false type: string - name: entity_ids.device_ids.device_id in: query required: false type: string - name: entity_ids.device_ids.dev_eui description: The LoRaWAN DevEUI. in: query required: false type: string format: string - name: entity_ids.device_ids.join_eui description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices). in: query required: false type: string format: string - name: entity_ids.device_ids.dev_addr description: The LoRaWAN DevAddr. in: query required: false type: string format: string - name: entity_ids.gateway_ids.gateway_id in: query required: false type: string - name: entity_ids.gateway_ids.eui description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string format: string - name: entity_ids.organization_ids.organization_id description: This ID shares namespace with user IDs. in: query required: false type: string - name: entity_ids.user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string tags: - UserBookmarkRegistry ? /users/{user_ids.user_id}/bookmarks/applications/{entity_ids.device_ids.application_ids.application_id}/devices/{entity_ids.device_ids.device_id} : delete: summary: Delete the given user's bookmark. operationId: UserBookmarkRegistry_Delete6 responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: user_ids.user_id description: This ID shares namespace with organization IDs. in: path required: true type: string - name: entity_ids.device_ids.application_ids.application_id in: path required: true type: string - name: entity_ids.device_ids.device_id in: path required: true type: string - name: user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string - name: entity_ids.client_ids.client_id in: query required: false type: string - name: entity_ids.device_ids.dev_eui description: The LoRaWAN DevEUI. in: query required: false type: string format: string - name: entity_ids.device_ids.join_eui description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices). in: query required: false type: string format: string - name: entity_ids.device_ids.dev_addr description: The LoRaWAN DevAddr. in: query required: false type: string format: string - name: entity_ids.gateway_ids.gateway_id in: query required: false type: string - name: entity_ids.gateway_ids.eui description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string format: string - name: entity_ids.organization_ids.organization_id description: This ID shares namespace with user IDs. in: query required: false type: string - name: entity_ids.user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string tags: - UserBookmarkRegistry /users/{user_ids.user_id}/bookmarks/batch: delete: summary: 'Delete a list of bookmarks of the given user. This operation is atomic; either all bookmarks are deleted or none. Bookmarks not found are skipped and no error is returned.' operationId: UserBookmarkRegistry_BatchDelete responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: user_ids.user_id description: This ID shares namespace with organization IDs. in: path required: true type: string - name: user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string tags: - UserBookmarkRegistry /users/{user_ids.user_id}/bookmarks/clients/{entity_ids.client_ids.client_id}: delete: summary: Delete the given user's bookmark. operationId: UserBookmarkRegistry_Delete2 responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: user_ids.user_id description: This ID shares namespace with organization IDs. in: path required: true type: string - name: entity_ids.client_ids.client_id in: path required: true type: string - name: user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string - name: entity_ids.application_ids.application_id in: query required: false type: string - name: entity_ids.device_ids.device_id in: query required: false type: string - name: entity_ids.device_ids.application_ids.application_id in: query required: false type: string - name: entity_ids.device_ids.dev_eui description: The LoRaWAN DevEUI. in: query required: false type: string format: string - name: entity_ids.device_ids.join_eui description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices). in: query required: false type: string format: string - name: entity_ids.device_ids.dev_addr description: The LoRaWAN DevAddr. in: query required: false type: string format: string - name: entity_ids.gateway_ids.gateway_id in: query required: false type: string - name: entity_ids.gateway_ids.eui description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string format: string - name: entity_ids.organization_ids.organization_id description: This ID shares namespace with user IDs. in: query required: false type: string - name: entity_ids.user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string tags: - UserBookmarkRegistry /users/{user_ids.user_id}/bookmarks/gateways/{entity_ids.gateway_ids.gateway_id}: delete: summary: Delete the given user's bookmark. operationId: UserBookmarkRegistry_Delete3 responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: user_ids.user_id description: This ID shares namespace with organization IDs. in: path required: true type: string - name: entity_ids.gateway_ids.gateway_id in: path required: true type: string - name: user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string - name: entity_ids.application_ids.application_id in: query required: false type: string - name: entity_ids.client_ids.client_id in: query required: false type: string - name: entity_ids.device_ids.device_id in: query required: false type: string - name: entity_ids.device_ids.application_ids.application_id in: query required: false type: string - name: entity_ids.device_ids.dev_eui description: The LoRaWAN DevEUI. in: query required: false type: string format: string - name: entity_ids.device_ids.join_eui description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices). in: query required: false type: string format: string - name: entity_ids.device_ids.dev_addr description: The LoRaWAN DevAddr. in: query required: false type: string format: string - name: entity_ids.gateway_ids.eui description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string format: string - name: entity_ids.organization_ids.organization_id description: This ID shares namespace with user IDs. in: query required: false type: string - name: entity_ids.user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string tags: - UserBookmarkRegistry /users/{user_ids.user_id}/bookmarks/organizations/{entity_ids.organization_ids.organization_id}: delete: summary: Delete the given user's bookmark. operationId: UserBookmarkRegistry_Delete4 responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: user_ids.user_id description: This ID shares namespace with organization IDs. in: path required: true type: string - name: entity_ids.organization_ids.organization_id description: This ID shares namespace with user IDs. in: path required: true type: string - name: user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string - name: entity_ids.application_ids.application_id in: query required: false type: string - name: entity_ids.client_ids.client_id in: query required: false type: string - name: entity_ids.device_ids.device_id in: query required: false type: string - name: entity_ids.device_ids.application_ids.application_id in: query required: false type: string - name: entity_ids.device_ids.dev_eui description: The LoRaWAN DevEUI. in: query required: false type: string format: string - name: entity_ids.device_ids.join_eui description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices). in: query required: false type: string format: string - name: entity_ids.device_ids.dev_addr description: The LoRaWAN DevAddr. in: query required: false type: string format: string - name: entity_ids.gateway_ids.gateway_id in: query required: false type: string - name: entity_ids.gateway_ids.eui description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string format: string - name: entity_ids.user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string tags: - UserBookmarkRegistry /users/{user_ids.user_id}/bookmarks/users/{entity_ids.user_ids.user_id}: delete: summary: Delete the given user's bookmark. operationId: UserBookmarkRegistry_Delete5 responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: user_ids.user_id description: This ID shares namespace with organization IDs. in: path required: true type: string - name: entity_ids.user_ids.user_id description: This ID shares namespace with organization IDs. in: path required: true type: string - name: user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string - name: entity_ids.application_ids.application_id in: query required: false type: string - name: entity_ids.client_ids.client_id in: query required: false type: string - name: entity_ids.device_ids.device_id in: query required: false type: string - name: entity_ids.device_ids.application_ids.application_id in: query required: false type: string - name: entity_ids.device_ids.dev_eui description: The LoRaWAN DevEUI. in: query required: false type: string format: string - name: entity_ids.device_ids.join_eui description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices). in: query required: false type: string format: string - name: entity_ids.device_ids.dev_addr description: The LoRaWAN DevAddr. in: query required: false type: string format: string - name: entity_ids.gateway_ids.gateway_id in: query required: false type: string - name: entity_ids.gateway_ids.eui description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string format: string - name: entity_ids.organization_ids.organization_id description: This ID shares namespace with user IDs. in: query required: false type: string - name: entity_ids.user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string tags: - UserBookmarkRegistry definitions: v3UserBookmarks: type: object properties: bookmarks: type: array items: type: object $ref: '#/definitions/v3UserBookmark' googlerpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/definitions/protobufAny' v3EntityIdentifiers: type: object properties: application_ids: $ref: '#/definitions/v3ApplicationIdentifiers' client_ids: $ref: '#/definitions/v3ClientIdentifiers' device_ids: $ref: '#/definitions/v3EndDeviceIdentifiers' gateway_ids: $ref: '#/definitions/lorawanv3GatewayIdentifiers' organization_ids: $ref: '#/definitions/v3OrganizationIdentifiers' user_ids: $ref: '#/definitions/v3UserIdentifiers' description: EntityIdentifiers contains one of the possible entity identifiers. v3UserBookmarkRegistryCreateBody: type: object properties: user_ids: type: object properties: email: type: string description: Secondary identifier, which can only be used in specific requests. entity_ids: $ref: '#/definitions/v3EntityIdentifiers' v3UserBookmark: type: object properties: user_ids: $ref: '#/definitions/v3UserIdentifiers' entity_ids: $ref: '#/definitions/v3EntityIdentifiers' created_at: type: string format: date-time v3EndDeviceIdentifiers: type: object properties: device_id: type: string application_ids: $ref: '#/definitions/v3ApplicationIdentifiers' dev_eui: type: string format: string example: 70B3D57ED000ABCD description: The LoRaWAN DevEUI. join_eui: type: string format: string example: 70B3D57ED000ABCD description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices). dev_addr: type: string format: string example: 2600ABCD description: The LoRaWAN DevAddr. v3ApplicationIdentifiers: type: object properties: application_id: type: string lorawanv3GatewayIdentifiers: type: object properties: gateway_id: type: string eui: type: string format: string example: 70B3D57ED000ABCD description: Secondary identifier, which can only be used in specific requests. v3UserIdentifiers: type: object properties: user_id: type: string description: This ID shares namespace with organization IDs. email: type: string description: Secondary identifier, which can only be used in specific requests. v3ClientIdentifiers: type: object properties: client_id: type: string protobufAny: type: object properties: '@type': type: string description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics." additionalProperties: {} description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": ,\n \"lastName\": \n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }" v3OrganizationIdentifiers: type: object properties: organization_id: type: string description: This ID shares namespace with user IDs. securityDefinitions: ApiKeyAuth: type: apiKey in: header name: Authorization description: 'Bearer API key. Set Authorization: Bearer NNSXS.xxxxxxxxxx.'