Skip to content

Commit e740119

Browse files
docs(boxsdkgen): Add missing tag to API resources (box/box-openapi#580) (#1368)
1 parent abe6e2c commit e740119

17 files changed

Lines changed: 33 additions & 33 deletions

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "3e11b6f", "specHash": "4beaa19", "version": "6.3.0" }
1+
{ "engineHash": "3e11b6f", "specHash": "ad08e8c", "version": "6.3.0" }

BoxSdkGen/Sources/Managers/Authorization/AuthorizationManager.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public class AuthorizationManager {
3434
/// An Access Token is a string that enables Box to verify that a
3535
/// request belongs to an authorized session. In the normal order of
3636
/// operations you will begin by requesting authentication from the
37-
/// [authorize](#get-authorize) endpoint and Box will send you an
37+
/// [authorize](https://developer.box.com/reference/get-authorize) endpoint and Box will send you an
3838
/// authorization code.
3939
///
4040
/// You will then send this code to this endpoint to exchange it for

BoxSdkGen/Sources/Managers/Events/EventsManager.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ public class EventsManager {
1111
}
1212

1313
/// Returns a list of real-time servers that can be used for long-polling updates
14-
/// to the [event stream](#get-events).
14+
/// to the [event stream](https://developer.box.com/reference/get-events).
1515
///
1616
/// Long polling is the concept where a HTTP request is kept open until the
1717
/// server sends a response, then repeating the process over and over to receive
@@ -26,7 +26,7 @@ public class EventsManager {
2626
/// When an event occurs in monitored account a response with the value
2727
/// `new_change` will be sent. The response contains no other details as
2828
/// it only serves as a prompt to take further action such as sending a
29-
/// request to the [events endpoint](#get-events) with the last known
29+
/// request to the [events endpoint](https://developer.box.com/reference/get-events) with the last known
3030
/// `stream_position`.
3131
///
3232
/// After the server sends this response it closes the connection. You must now

BoxSdkGen/Sources/Managers/Folders/CreateFolderRequestBody.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ public class CreateFolderRequestBody: Codable, RawJSONReadable {
2424
/// (`/`, `\`), names with trailing spaces, and names `.` and `..` are
2525
/// not allowed.
2626
///
27-
/// Folder names must be unique within their parent folder. The name check is case-insensitive,
28-
/// so a folder named `New Folder` cannot be created in a parent folder that already contains
27+
/// Folder names must be unique within their parent folder. The name check is case-insensitive,
28+
/// so a folder named `New Folder` cannot be created in a parent folder that already contains
2929
/// a folder named `new folder`.
3030
public let name: String
3131

@@ -49,8 +49,8 @@ public class CreateFolderRequestBody: Codable, RawJSONReadable {
4949
/// (`/`, `\`), names with trailing spaces, and names `.` and `..` are
5050
/// not allowed.
5151
///
52-
/// Folder names must be unique within their parent folder. The name check is case-insensitive,
53-
/// so a folder named `New Folder` cannot be created in a parent folder that already contains
52+
/// Folder names must be unique within their parent folder. The name check is case-insensitive,
53+
/// so a folder named `New Folder` cannot be created in a parent folder that already contains
5454
/// a folder named `new folder`.
5555
/// - parent: The parent folder to create the new folder within.
5656
/// - folderUploadEmail:

BoxSdkGen/Sources/Managers/Folders/FoldersManager.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ public class FoldersManager {
9999
/// folders, and web links.
100100
///
101101
/// To request more information about the folder itself, like its size,
102-
/// use the [Get a folder](#get-folders-id) endpoint instead.
102+
/// use the [Get a folder](https://developer.box.com/reference/get-folders-id) endpoint instead.
103103
///
104104
/// - Parameters:
105105
/// - folderId: The unique identifier that represent a folder.

BoxSdkGen/Sources/Managers/Users/CreateUserRequestBody.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public class CreateUserRequestBody: Codable, RawJSONReadable {
4747
public let role: CreateUserRequestBodyRoleField?
4848

4949
/// The language of the user, formatted in modified version of the
50-
/// [ISO 639-1](/guides/api-calls/language-codes) format.
50+
/// [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.
5151
public let language: String?
5252

5353
/// Whether the user can use Box Sync.
@@ -108,7 +108,7 @@ public class CreateUserRequestBody: Codable, RawJSONReadable {
108108
/// - isPlatformAccessOnly: Specifies that the user is an app user.
109109
/// - role: The user’s enterprise role.
110110
/// - language: The language of the user, formatted in modified version of the
111-
/// [ISO 639-1](/guides/api-calls/language-codes) format.
111+
/// [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.
112112
/// - isSyncEnabled: Whether the user can use Box Sync.
113113
/// - jobTitle: The user’s job title.
114114
/// - phone: The user’s phone number.

BoxSdkGen/Sources/Managers/Users/UpdateUserByIdRequestBody.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public class UpdateUserByIdRequestBody: Codable, RawJSONReadable {
5555
public let role: UpdateUserByIdRequestBodyRoleField?
5656

5757
/// The language of the user, formatted in modified version of the
58-
/// [ISO 639-1](/guides/api-calls/language-codes) format.
58+
/// [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.
5959
public let language: String?
6060

6161
/// Whether the user can use Box Sync.
@@ -133,7 +133,7 @@ public class UpdateUserByIdRequestBody: Codable, RawJSONReadable {
133133
/// primary login address cannot be changed.
134134
/// - role: The user’s enterprise role.
135135
/// - language: The language of the user, formatted in modified version of the
136-
/// [ISO 639-1](/guides/api-calls/language-codes) format.
136+
/// [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.
137137
/// - isSyncEnabled: Whether the user can use Box Sync.
138138
/// - jobTitle: The user’s job title.
139139
/// - phone: The user’s phone number.

BoxSdkGen/Sources/Schemas/RealtimeServer/RealtimeServer.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public class RealtimeServer: Codable, RawJSONReadable {
3131

3232
/// The maximum number of retries this server will
3333
/// allow before a new long poll should be started by
34-
/// getting a [new list of server](#options-events).
34+
/// getting a [new list of server](https://developer.box.com/reference/options-events).
3535
public let maxRetries: String?
3636

3737
/// The maximum number of seconds without a response
@@ -50,7 +50,7 @@ public class RealtimeServer: Codable, RawJSONReadable {
5050
/// - ttl: The time in minutes for which this server is available.
5151
/// - maxRetries: The maximum number of retries this server will
5252
/// allow before a new long poll should be started by
53-
/// getting a [new list of server](#options-events).
53+
/// getting a [new list of server](https://developer.box.com/reference/options-events).
5454
/// - retryTimeout: The maximum number of seconds without a response
5555
/// after which you should retry the long poll connection.
5656
///

BoxSdkGen/Sources/Schemas/User/User.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public class User: UserMini {
3535
public let modifiedAt: Date?
3636

3737
/// The language of the user, formatted in modified version of the
38-
/// [ISO 639-1](/guides/api-calls/language-codes) format.
38+
/// [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.
3939
public let language: String?
4040

4141
/// The user's timezone.
@@ -81,7 +81,7 @@ public class User: UserMini {
8181
/// - createdAt: When the user object was created.
8282
/// - modifiedAt: When the user object was last modified.
8383
/// - language: The language of the user, formatted in modified version of the
84-
/// [ISO 639-1](/guides/api-calls/language-codes) format.
84+
/// [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.
8585
/// - timezone: The user's timezone.
8686
/// - spaceAmount: The user’s total available space amount in bytes.
8787
/// - spaceUsed: The amount of space in use by the user.

BoxSdkGen/Sources/Schemas/UserFull/UserFull.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ public class UserFull: User {
8080
/// - createdAt: When the user object was created.
8181
/// - modifiedAt: When the user object was last modified.
8282
/// - language: The language of the user, formatted in modified version of the
83-
/// [ISO 639-1](/guides/api-calls/language-codes) format.
83+
/// [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.
8484
/// - timezone: The user's timezone.
8585
/// - spaceAmount: The user’s total available space amount in bytes.
8686
/// - spaceUsed: The amount of space in use by the user.

0 commit comments

Comments
 (0)