Skip to content

Commit 9327feb

Browse files
docs: Add missing tag to API resources (box/box-openapi#580) (#1689)
1 parent 215c0f3 commit 9327feb

File tree

15 files changed

+34
-32
lines changed

15 files changed

+34
-32
lines changed

.codegen.json

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

docs/authorization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ authorization code or a server-side JWT assertion.
4646
An Access Token is a string that enables Box to verify that a
4747
request belongs to an authorized session. In the normal order of
4848
operations you will begin by requesting authentication from the
49-
[authorize](#get-authorize) endpoint and Box will send you an
49+
[authorize](https://developer.box.com/reference/get-authorize) endpoint and Box will send you an
5050
authorization code.
5151

5252
You will then send this code to this endpoint to exchange it for

docs/comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ This function returns a value of type `CommentFull`.
165165
Returns the newly created comment object.
166166

167167
Not all available fields are returned by default. Use the
168-
[fields](#param-fields) query parameter to explicitly request
168+
[fields](#parameter-fields) query parameter to explicitly request
169169
any specific fields.
170170

171171

docs/events.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
## Get events long poll endpoint
99

1010
Returns a list of real-time servers that can be used for long-polling updates
11-
to the [event stream](#get-events).
11+
to the [event stream](https://developer.box.com/reference/get-events).
1212

1313
Long polling is the concept where a HTTP request is kept open until the
1414
server sends a response, then repeating the process over and over to receive
@@ -23,7 +23,7 @@ URLs. Next, make a long poll request to any of the provided URLs.
2323
When an event occurs in monitored account a response with the value
2424
`new_change` will be sent. The response contains no other details as
2525
it only serves as a prompt to take further action such as sending a
26-
request to the [events endpoint](#get-events) with the last known
26+
request to the [events endpoint](https://developer.box.com/reference/get-events) with the last known
2727
`stream_position`.
2828

2929
After the server sends this response it closes the connection. You must now

docs/files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This function returns a value of type `FileFull`.
3939
Returns a file object.
4040

4141
Not all available fields are returned by default. Use the
42-
[fields](#param-fields) query parameter to explicitly request
42+
[fields](#parameter-fields) query parameter to explicitly request
4343
any specific fields.
4444

4545

@@ -77,7 +77,7 @@ This function returns a value of type `FileFull`.
7777
Returns a file object.
7878

7979
Not all available fields are returned by default. Use the
80-
[fields](#param-fields) query parameter to explicitly request
80+
[fields](#parameter-fields) query parameter to explicitly request
8181
any specific fields.
8282

8383

@@ -148,7 +148,7 @@ This function returns a value of type `FileFull`.
148148
Returns a new file object representing the copied file.
149149

150150
Not all available fields are returned by default. Use the
151-
[fields](#param-fields) query parameter to explicitly request
151+
[fields](#parameter-fields) query parameter to explicitly request
152152
any specific fields.
153153

154154

docs/fileversions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ This function returns a value of type `FileVersionFull`.
7676
Returns a specific version of a file.
7777

7878
Not all available fields are returned by default. Use the
79-
[fields](#param-fields) query parameter to explicitly request
79+
[fields](#parameter-fields) query parameter to explicitly request
8080
any specific fields.
8181

8282

docs/folders.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ To fetch more items within the folder, use the
5454
[Get items in a folder](https://developer.box.com/reference/get-folders-id-items)) endpoint.
5555

5656
Not all available fields are returned by default. Use the
57-
[fields](#param-fields) query parameter to explicitly request
57+
[fields](#parameter-fields) query parameter to explicitly request
5858
any specific fields.
5959

6060

@@ -92,7 +92,7 @@ This function returns a value of type `FolderFull`.
9292
Returns a folder object for the updated folder
9393

9494
Not all available fields are returned by default. Use the
95-
[fields](#param-fields) query parameter to explicitly request
95+
[fields](#parameter-fields) query parameter to explicitly request
9696
any specific fields.
9797

9898
If the user is moving folders with a large number of items in all of
@@ -140,7 +140,7 @@ Retrieves a page of items in a folder. These items can be files,
140140
folders, and web links.
141141

142142
To request more information about the folder itself, like its size,
143-
use the [Get a folder](#get-folders-id) endpoint instead.
143+
use the [Get a folder](https://developer.box.com/reference/get-folders-id) endpoint instead.
144144

145145
This operation is performed by calling function `getFolderItems`.
146146

@@ -200,7 +200,7 @@ This function returns a value of type `FolderFull`.
200200
Returns a folder object.
201201

202202
Not all available fields are returned by default. Use the
203-
[fields](#param-fields) query parameter to explicitly request
203+
[fields](#parameter-fields) query parameter to explicitly request
204204
any specific fields.
205205

206206

@@ -239,7 +239,7 @@ This function returns a value of type `FolderFull`.
239239
Returns a new folder object representing the copied folder.
240240

241241
Not all available fields are returned by default. Use the
242-
[fields](#param-fields) query parameter to explicitly request
242+
[fields](#parameter-fields) query parameter to explicitly request
243243
any specific fields.
244244

245245

docs/users.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ This function returns a value of type `UserFull`.
154154
Returns a single user object.
155155

156156
Not all available fields are returned by default. Use the
157-
[fields](#param-fields) query parameter to explicitly request
158-
any specific fields using the [fields](#get-users-id--request--fields)
157+
[fields](#parameter-fields) query parameter to explicitly request
158+
any specific fields using the [fields](#parameter-fields)
159159
parameter.
160160

161161

src/main/java/com/box/sdkgen/managers/authorization/AuthorizationManager.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ public void authorizeUser(AuthorizeUserQueryParams queryParams, AuthorizeUserHea
9090
*
9191
* <p>An Access Token is a string that enables Box to verify that a request belongs to an
9292
* authorized session. In the normal order of operations you will begin by requesting
93-
* authentication from the [authorize](#get-authorize) endpoint and Box will send you an
94-
* authorization code.
93+
* authentication from the [authorize](https://developer.box.com/reference/get-authorize) endpoint
94+
* and Box will send you an authorization code.
9595
*
9696
* <p>You will then send this code to this endpoint to exchange it for an Access Token. The
9797
* returned Access Token can then be used to to make Box API calls.
@@ -108,8 +108,8 @@ public AccessToken requestAccessToken(PostOAuth2Token requestBody) {
108108
*
109109
* <p>An Access Token is a string that enables Box to verify that a request belongs to an
110110
* authorized session. In the normal order of operations you will begin by requesting
111-
* authentication from the [authorize](#get-authorize) endpoint and Box will send you an
112-
* authorization code.
111+
* authentication from the [authorize](https://developer.box.com/reference/get-authorize) endpoint
112+
* and Box will send you an authorization code.
113113
*
114114
* <p>You will then send this code to this endpoint to exchange it for an Access Token. The
115115
* returned Access Token can then be used to to make Box API calls.

src/main/java/com/box/sdkgen/managers/events/EventsManager.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ protected EventsManager(Builder builder) {
3434

3535
/**
3636
* Returns a list of real-time servers that can be used for long-polling updates to the [event
37-
* stream](#get-events).
37+
* stream](https://developer.box.com/reference/get-events).
3838
*
3939
* <p>Long polling is the concept where a HTTP request is kept open until the server sends a
4040
* response, then repeating the process over and over to receive updated responses.
@@ -46,7 +46,8 @@ protected EventsManager(Builder builder) {
4646
*
4747
* <p>When an event occurs in monitored account a response with the value `new_change` will be
4848
* sent. The response contains no other details as it only serves as a prompt to take further
49-
* action such as sending a request to the [events endpoint](#get-events) with the last known
49+
* action such as sending a request to the [events
50+
* endpoint](https://developer.box.com/reference/get-events) with the last known
5051
* `stream_position`.
5152
*
5253
* <p>After the server sends this response it closes the connection. You must now repeat the long
@@ -69,7 +70,7 @@ public RealtimeServers getEventsWithLongPolling() {
6970

7071
/**
7172
* Returns a list of real-time servers that can be used for long-polling updates to the [event
72-
* stream](#get-events).
73+
* stream](https://developer.box.com/reference/get-events).
7374
*
7475
* <p>Long polling is the concept where a HTTP request is kept open until the server sends a
7576
* response, then repeating the process over and over to receive updated responses.
@@ -81,7 +82,8 @@ public RealtimeServers getEventsWithLongPolling() {
8182
*
8283
* <p>When an event occurs in monitored account a response with the value `new_change` will be
8384
* sent. The response contains no other details as it only serves as a prompt to take further
84-
* action such as sending a request to the [events endpoint](#get-events) with the last known
85+
* action such as sending a request to the [events
86+
* endpoint](https://developer.box.com/reference/get-events) with the last known
8587
* `stream_position`.
8688
*
8789
* <p>After the server sends this response it closes the connection. You must now repeat the long

0 commit comments

Comments
 (0)