-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Steven Smith
committed
Oct 24, 2024
1 parent
83fb535
commit a030f26
Showing
4 changed files
with
103 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
= createOrgRobotFederation | ||
|
||
Create a federation configuration for the specified organization robot. | ||
|
||
[discrete] | ||
== POST /api/v1/organization/{orgname}/robots/{robot_shortname}/federation | ||
|
||
Retrieve the federation configuration for the specified organization robot. | ||
|
||
**Authorizations: **oauth2_implicit (**user:admin**) | ||
|
||
[discrete] | ||
== Path parameters | ||
|
||
[options="header", width=100%, cols=".^2a,.^3a,.^9a,.^4a"] | ||
|=== | ||
|Type|Name|Description|Schema | ||
|path|*orgname* + *robot_shortname* | ||
_required_|The name of the organization and the short name for the robot, without any user or organization prefix|string | ||
|=== | ||
|
||
[discrete] | ||
== Responses | ||
|
||
[options="header", width=100%, cols=".^2a,.^14a,.^4a"] | ||
|=== | ||
|HTTP Code|Description|Schema | ||
|201|Successful invocation | | ||
|400|Bad Request|<<_apierror,ApiError>> | ||
|401|Session required|<<_apierror,ApiError>> | ||
|403|Unauthorized access|<<_apierror,ApiError>> | ||
|=== | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
= deleteOrgRobotFederation | ||
|
||
Delete a federation configuration for the specified organization robot. | ||
|
||
[discrete] | ||
== DELETE /api/v1/organization/{orgname}/robots/{robot_shortname}/federation | ||
|
||
**Authorizations: **oauth2_implicit (org) | ||
|
||
[discrete] | ||
== Path parameters | ||
|
||
[options="header", width=100%, cols=".^2a,.^3a,.^9a,.^4a"] | ||
|=== | ||
|Type|Name|Description|Schema | ||
|path|orgname + | ||
_required_|The name of the organization and the short name for the robot, without any user or organization prefix|string | ||
|=== | ||
|
||
[discrete] | ||
== Responses | ||
|
||
[options="header", width=100%, cols=".^2a,.^14a,.^4a"] | ||
|=== | ||
|HTTP Code|Description|Schema | ||
|204|Deleted| | ||
|400|Bad Request|<<_apierror,ApiError>> | ||
|401|Session required|<<_apierror,ApiError>> | ||
|403|Unauthorized access|<<_apierror,ApiError>> | ||
|404|Not found|<<_apierror,ApiError>> | ||
|=== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
= getOrgRobotFederation | ||
|
||
Manage federation configuration for a robot account within an organization. | ||
|
||
[discrete] | ||
== GET /api/v1/organization/{orgname}/robots/{robot_shortname}/federation | ||
|
||
Retrieve the federation configuration for the specified organization robot. | ||
|
||
**Authorizations: **oauth2_implicit (**user:admin**) | ||
|
||
[discrete] | ||
== Path parameters | ||
|
||
[options="header", width=100%, cols=".^2a,.^3a,.^9a,.^4a"] | ||
|=== | ||
|Type|Name|Description|Schema | ||
|path|*orgname* + *robot_shortname* | ||
_required_|The name of the organization and the short name for the robot, without any user or organization prefix|string | ||
|=== | ||
|
||
[discrete] | ||
== Responses | ||
|
||
[options="header", width=100%, cols=".^2a,.^14a,.^4a"] | ||
|=== | ||
|HTTP Code|Description|Schema | ||
|200|Successful invocation| | ||
|400|Bad Request|<<_apierror,ApiError>> | ||
|401|Session required|<<_apierror,ApiError>> | ||
|403|Unauthorized access|<<_apierror,ApiError>> | ||
|404|Not found|<<_apierror,ApiError>> | ||
|=== | ||
|