satisfly redocly lint with operationIds

operationIds don't need to be meaningful, but they are used in links, so should be stable
This commit is contained in:
Min RK
2024-02-07 12:54:51 +01:00
parent 3a8851004c
commit c520102008

View File

@@ -6,6 +6,7 @@ info:
<a href="./">Return to JupyterHub documentation</a>.
license:
name: BSD-3-Clause
identifier: BSD-3-Clause
version: 5.0.0.dev
servers:
- url: /hub/api
@@ -16,6 +17,7 @@ security:
paths:
/:
get:
operationId: get-api
summary: Get JupyterHub version
description: |
This endpoint is not authenticated for the purpose of clients and user
@@ -33,6 +35,7 @@ paths:
description: The version of JupyterHub itself
/info:
get:
operationId: get-info
summary: Get detailed info about JupyterHub
description: |
Detailed JupyterHub information, including Python version,
@@ -82,6 +85,7 @@ paths:
- read:hub
/user:
get:
operationId: get-current-user
summary: Return authenticated user's model
responses:
200:
@@ -104,6 +108,7 @@ paths:
- admin:server_state
/users:
get:
operationId: get-users
summary: List users
parameters:
- name: state
@@ -155,6 +160,7 @@ paths:
- admin:auth_state
- admin:server_state
post:
operationId: post-users
summary: Create multiple users
requestBody:
content:
@@ -187,6 +193,7 @@ paths:
x-codegen-request-body-name: body
/users/{name}:
get:
operationId: get-user
summary: Get a user by name
parameters:
- $ref: "#/components/parameters/userName"
@@ -214,6 +221,7 @@ paths:
- admin:auth_state
- admin:server_state
post:
operationId: post-user
summary: Create a single user
parameters:
- $ref: "#/components/parameters/userName"
@@ -228,6 +236,7 @@ paths:
- oauth2:
- admin:users
delete:
operationId: delete-user
summary: Delete a user
parameters:
- $ref: "#/components/parameters/userName"
@@ -239,6 +248,7 @@ paths:
- oauth2:
- admin:users
patch:
operationId: patch-user
summary: Modify a user
description: Change a user's name or admin status
parameters:
@@ -276,6 +286,7 @@ paths:
x-codegen-request-body-name: body
/users/{name}/activity:
post:
operationId: post-user-activity
summary: Notify Hub of activity for a given user
description:
Notify the Hub of activity by the user, e.g. accessing a service
@@ -335,6 +346,7 @@ paths:
x-codegen-request-body-name: body
/users/{name}/server:
post:
operationId: post-user-server
summary: Start a user's single-user notebook server
parameters:
- $ref: "#/components/parameters/userName"
@@ -365,6 +377,7 @@ paths:
- servers
x-codegen-request-body-name: options
delete:
operationId: delete-user-server
summary: Stop a user's server
parameters:
- $ref: "#/components/parameters/userName"
@@ -382,6 +395,7 @@ paths:
- servers
/users/{name}/servers/{server_name}:
post:
operationId: post-user-server-name
summary: Start a user's named server
parameters:
- $ref: "#/components/parameters/userName"
@@ -411,6 +425,7 @@ paths:
- servers
x-codegen-request-body-name: options
delete:
operationId: delete-user-server-name
summary: Stop a user's named server
description: |
To remove the named server in addition to deleting it,
@@ -453,6 +468,7 @@ paths:
/users/{name}/shared:
get:
operationId: get-user-shared
summary: List servers shared with user
description:
Returns list of Shares granting the user access to servers owned
@@ -480,6 +496,7 @@ paths:
/users/{name}/shared/{owner}/{server_name}:
get:
operationId: get-user-shared-server
summary: |
Get user's shared access to server
description: |
@@ -501,6 +518,7 @@ paths:
- oauth2:
- read:users:shares
delete:
operationId: delete-user-shared-server
summary: |
Leave a shared server
description: |
@@ -523,6 +541,7 @@ paths:
/users/{name}/tokens:
get:
operationId: get-user-tokens
summary: List tokens for the user
parameters:
- $ref: "#/components/parameters/userName"
@@ -545,6 +564,7 @@ paths:
- oauth2:
- read:tokens
post:
operationId: post-user-tokens
summary: Create a new token for the user
description: |
Creates a new token owned by the user.
@@ -605,6 +625,7 @@ paths:
x-codegen-request-body-name: token_params
/users/{name}/tokens/{token_id}:
get:
operationId: get-user-token
summary: Get one token
description: Get the details for one token by id
parameters:
@@ -625,6 +646,7 @@ paths:
- oauth2:
- read:tokens
delete:
operationId: delete-user-token
summary: Delete (revoke) a token by id
parameters:
- $ref: "#/components/parameters/userName"
@@ -642,6 +664,7 @@ paths:
- tokens
/groups:
get:
operationId: get-groups
summary: List groups
parameters:
- $ref: "#/components/parameters/paginationOffset"
@@ -662,6 +685,7 @@ paths:
- read:roles:groups
/groups/{name}:
get:
operationId: get-group
summary: Get a group by name
parameters:
- $ref: "#/components/parameters/groupName"
@@ -678,6 +702,7 @@ paths:
- read:groups:name
- read:roles:groups
post:
operationId: post-group
summary: Create a group
parameters:
- $ref: "#/components/parameters/groupName"
@@ -692,6 +717,7 @@ paths:
- oauth2:
- admin:groups
delete:
operationId: delete-group
summary: Delete a group
parameters:
- $ref: "#/components/parameters/groupName"
@@ -705,6 +731,7 @@ paths:
/groups/{name}/shared:
get:
operationId: get-group-shared
summary: List servers shared with group
description: |
Lists shares granting `group` access to shared servers
@@ -731,6 +758,7 @@ paths:
/groups/{name}/shared/{owner}/{server_name}:
get:
operationId: get-group-shared-server
summary: Get group's shared access
description: |
Get the Share representing a single group's access to a single server
@@ -750,6 +778,7 @@ paths:
- oauth2:
- read:groups:shares
delete:
operationId: delete-group-shared-server
summary: Leave a share (group)
description: |
Leave a share by revoking a group's permissions on a single server
@@ -770,6 +799,7 @@ paths:
/groups/{name}/users:
post:
operationId: get-group-users
summary: Add users to a group
parameters:
- $ref: "#/components/parameters/groupName"
@@ -798,6 +828,7 @@ paths:
- groups
x-codegen-request-body-name: body
delete:
operationId: delete-group-users
summary: |
Remove users from a group
description: |
@@ -836,6 +867,7 @@ paths:
/groups/{name}/properties:
put:
operationId: put-group-properties
summary: Set group properties
description: |
Set properties on a group
@@ -865,6 +897,7 @@ paths:
/shares/{owner}:
get:
operationId: get-shares-owner
summary: List shares by owner
description: |
List shares granting access to any of owner's servers
@@ -893,6 +926,7 @@ paths:
/shares/{owner}/{server_name}:
get:
operationId: get-shares-server
summary: List server shares
description: |
List shares granting access to a single server
@@ -920,6 +954,7 @@ paths:
- oauth2:
- read:shares
post:
operationId: post-shares-server
summary: Grant shared access
description: |
Grant shared access to a single server
@@ -970,6 +1005,7 @@ paths:
- read:users:name
- read:groups:name
patch:
operationId: patch-shares-server
summary: Revoke shared access
description: |
Revoke shared access to a single server for a single user or group.
@@ -1022,6 +1058,7 @@ paths:
- read:users:name
- read:groups:name
delete:
operationId: delete-shares-server
summary: Revoke all shared access
description: |
Revoke all shared access to a given server
@@ -1039,6 +1076,7 @@ paths:
/share-codes/{owner}:
get:
operationId: get-share-codes-owner
summary: List share codes by owner
description: |
List share codes granting access to a user's servers
@@ -1067,6 +1105,7 @@ paths:
/share-codes/{owner}/{server_name}:
get:
operationId: get-share-codes-server
summary: List share codes
description: |
List share codes which can be exchanged for access to a single server
@@ -1094,6 +1133,7 @@ paths:
- oauth2:
- read:shares
post:
operationId: post-share-code
summary: Issue share code
description: |
Issue a share code, which can be exchanged for shared access to a single server
@@ -1147,6 +1187,7 @@ paths:
- oauth2:
- shares
delete:
operationId: delete-share-code
summary: Revoke share code
description: |
Revoke a share code by id or code.
@@ -1176,6 +1217,7 @@ paths:
/services:
get:
operationId: get-services
summary: List services
parameters:
- $ref: "#/components/parameters/paginationOffset"
@@ -1196,6 +1238,7 @@ paths:
- read:roles:services
/services/{name}:
get:
operationId: get-service
summary: Get a service by name
parameters:
- name: name
@@ -1218,6 +1261,7 @@ paths:
- read:roles:services
/proxy:
get:
operationId: get-proxy
summary: Get the proxy's routing table
description:
A convenience alias for getting the routing table directly from
@@ -1239,6 +1283,7 @@ paths:
- oauth2:
- proxy
post:
operationId: post-proxy
summary: Force the Hub to sync with the proxy
responses:
200:
@@ -1248,6 +1293,7 @@ paths:
- oauth2:
- proxy
patch:
operationId: patch-proxy
summary: Notify the Hub about a new proxy
description: Notifies the Hub of a new proxy to use.
requestBody:
@@ -1282,6 +1328,7 @@ paths:
x-codegen-request-body-name: body
/authorizations/token:
post:
operationId: post-auth-token
summary: Request a new API token
description: |
Request a new API token to use with the JupyterHub REST API.
@@ -1320,6 +1367,7 @@ paths:
x-codegen-request-body-name: credentials
/authorizations/token/{token}:
get:
operationId: get-auth-token
summary: Identify a user or service from an API token
parameters:
- name: token
@@ -1339,6 +1387,7 @@ paths:
- (no_scope)
/authorizations/cookie/{cookie_name}/{cookie_value}:
get:
operationId: get-auth-cookie
summary: Identify a user from a cookie
description:
Used by single-user notebook servers to hand off cookie authentication
@@ -1367,6 +1416,7 @@ paths:
deprecated: true
/oauth2/authorize:
get:
operationId: get-oauth-authorize
summary: OAuth 2.0 authorize endpoint
description: |
Redirect users to this URL to begin the OAuth process.
@@ -1404,6 +1454,7 @@ paths:
content: {}
/oauth2/token:
post:
operationId: post-oauth-token
summary: Request an OAuth2 token
description: |
Request an OAuth2 token from an authorization code.
@@ -1451,6 +1502,7 @@ paths:
description: Will always be 'Bearer'
/shutdown:
post:
operationId: post-shutdown
summary: Shutdown the Hub
requestBody:
content: