Skip to content

Commit

Permalink
Adds API endpoints for robot fed
Browse files Browse the repository at this point in the history
  • Loading branch information
Steven Smith committed Oct 24, 2024
1 parent 83fb535 commit a030f26
Show file tree
Hide file tree
Showing 4 changed files with 103 additions and 0 deletions.
4 changes: 4 additions & 0 deletions api/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,10 @@ include::modules/api-robot-getOrgRobots.adoc[leveloffset=+3]
include::modules/api-robot-getUserRobot.adoc[leveloffset=+3]
include::modules/api-robot-createUserRobot.adoc[leveloffset=+3]
include::modules/api-robot-deleteUserRobot.adoc[leveloffset=+3]
include::modules/api-robot-getOrgRobotFederation.adoc[leveloffset=+3]
include::modules/api-robot-createOrgRobotFederation.adoc[leveloffset=+3]
include::modules/api-robot-deleteOrgRobotFederation.adoc[leveloffset=+3]


include::modules/api-search.adoc[leveloffset=+2]
include::modules/api-search-conductRepoSearch.adoc[leveloffset=+3]
Expand Down
34 changes: 34 additions & 0 deletions modules/api-robot-createOrgRobotFederation.adoc
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>>
|===


31 changes: 31 additions & 0 deletions modules/api-robot-deleteOrgRobotFederation.adoc
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>>
|===
34 changes: 34 additions & 0 deletions modules/api-robot-getOrgRobotFederation.adoc
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>>
|===

0 comments on commit a030f26

Please sign in to comment.