Skip to content

Commit 90e3968

Browse files
author
Lydia Koller
committed
Update blueprint docs to include organization github app installations
1 parent fb7d645 commit 90e3968

File tree

1 file changed

+132
-0
lines changed

1 file changed

+132
-0
lines changed

blueprint/api.apib

+132
Original file line numberDiff line numberDiff line change
@@ -503,6 +503,100 @@ Note that a Github Repo relates 1:1 to a Github App Installation, since only a s
503503

504504
+ Attributes (Github Repo Response)
505505

506+
# Group Organization Github App Installations
507+
508+
## Organization Github App Installations [/organization-github-app-installations]
509+
510+
### Create an Organization Github app installation [POST]
511+
512+
+ Request
513+
514+
+ Attributes (Organization Github App Installation Create Request)
515+
516+
+ Headers
517+
518+
Accept: application/vnd.api+json
519+
Authorization: Bearer {token}
520+
521+
+ Response 201 (application/vnd.api+json; charset=utf-8)
522+
523+
+ Attributes (Organization Github App Installation Response)
524+
525+
+ Response 401 (application/vnd.api+json; charset=utf-8)
526+
527+
+ Attributes (JSON Web Token Invalid Response)
528+
529+
+ Response 403 (application/vnd.api+json; charset=utf-8)
530+
531+
+ Attributes (Forbidden Response)
532+
533+
### Filter by id [GET /organization-github-app-installations{?filter[id]}]
534+
535+
+ Request
536+
537+
+ Attributes
538+
539+
+ `filter[id]`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.
540+
541+
+ Headers
542+
543+
Accept: application/vnd.api+json
544+
545+
+ Response 200 (application/vnd.api+json; charset=utf-8)
546+
547+
+ Attributes (Organization Github App Installations Response)
548+
549+
### List all organization github app installations [GET]
550+
551+
+ Request
552+
553+
+ Headers
554+
555+
Accept: application/vnd.api+json
556+
557+
+ Response 200 (application/vnd.api+json; charset=utf-8)
558+
559+
+ Attributes (Organization Github App Installations Response)
560+
561+
## Organization Github App Installation [/organization-github-app-installations/{id}]
562+
563+
+ Parameters
564+
565+
+ id (number, required)
566+
567+
### Retrieve an Organization github app installation [GET]
568+
569+
+ Request
570+
571+
+ Headers
572+
573+
Accept: application/vnd.api+json
574+
575+
+ Response 200 (application/vnd.api+json; charset=utf-8)
576+
577+
+ Attributes (Organization Github App Installation Response)
578+
579+
### Delete an Organization Github App Installation [DELETE]
580+
581+
+ Request
582+
583+
+ Headers
584+
585+
Accept: application/vnd.api+json
586+
Authorization: Bearer {token}
587+
588+
+ Response 204 (application/vnd.api+json; charset=utf-8)
589+
590+
+ Attributes (No Content Response)
591+
592+
+ Response 401 (application/vnd.api+json; charset=utf-8)
593+
594+
+ Attributes (JSON Web Token Invalid Response)
595+
596+
+ Response 403 (application/vnd.api+json; charset=utf-8)
597+
598+
+ Attributes (Forbidden Response)
599+
506600
#Group Organization Invites
507601

508602
This endpoint is for Creating, Updating, returning Organization Invites on Code Corps.
@@ -3076,6 +3170,44 @@ The platform stores Stripe customers and cards so they can be reused across diff
30763170
+ data(array[Organization Resource])
30773171
+ include JSON API Version
30783172

3173+
## Organization Github App Installation Attributes (object)
3174+
+ `inserted-at`: `2016-07-08T03:03:51.967Z` (string)
3175+
+ `updated-at`: `2016-07-08T03:03:51.967Z` (string)
3176+
3177+
## Organization Github App Installation Create Request (object)
3178+
+ type: `organization-github-app-installation` (string, required)
3179+
+ attributes(Organization Github App Installation Attributes)
3180+
+ relationships
3181+
+ organization
3182+
+ data(Organization Resource Identifier)
3183+
+ github_app_installation
3184+
+ data(Github App Installation Resource Identifier)
3185+
3186+
## Organization Github App Installation Resource (object)
3187+
+ include Organization Github App Installation Resource Identifier
3188+
+ attributes(Organization Github App Installation Attributes)
3189+
+ relationships
3190+
+ organization
3191+
+ data(Organization Resource Identifier)
3192+
+ github_app_installation
3193+
+ data(Github App Installation Resource Identifier)
3194+
3195+
## Organization Github App Installation Resource Identifier (object)
3196+
+ id: `1` (string, required)
3197+
+ type: `organization-github-app-installation` (string, required)
3198+
3199+
## Organization Github App Installation Response (object)
3200+
+ data(Organization Github App Installation Resource)
3201+
+ include JSON API Version
3202+
3203+
## Organization Github App Installations Response (object)
3204+
+ data(array[Organization Github App Installation Resource])
3205+
+ include JSON API Version
3206+
3207+
## Organization Github App Installation Update Request (object)
3208+
+ include Organization Github App Installation Resource Identifier
3209+
+ attributes(Organization Github App Installation Attributes)
3210+
30793211
## Organization Invite Attributes (object)
30803212
+ title: `Code Corps` (string)
30813213
+ email: `[email protected]` (string)

0 commit comments

Comments
 (0)