openapi.yaml 30.8 KB
Newer Older
1
openapi: '3.0.0'
2
3
4
5
6
7
8
9
10
11
12
13
14
15
info:
   version: 1.0.0
   title: Membership portal
   license:
      name: Eclipse Public License - 2.0
      url: https://www.eclipse.org/legal/epl-2.0/
servers:
-  url: TBD - Internal
   description: Production endpoint for the membership portal data
tags:
-  name: Membership form
   description: Definitions related to membership form data in the database
-  name: Contacts
   description: Definitions related to membership form designated contacts
16
17
18
19
-  name: Form Organizations
   description: Definitions related to membership form organizations
-  name: Form Working Groups
   description: Definitions related to membership form working group targets
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
-  name: Organizations
   description: Definitions related to membership form organizations
-  name: Working Groups
   description: Definitions related to membership form working group targets
paths:
   /form:
      get:
         tags:
         - Membership form
         summary: Membership form list
         description: Returns a list of tracked membership forms
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/MembershipForms'
            500:
               description: Error while retrieving data
      post:
         tags:
         - Membership form
         summary: Membership form create
         description: Using the passed form object, updates or inserts are made to save the data.
         requestBody:
            description: The form to be updated or inserted into the data set.
            content:
               application/json:
                  schema:
                     $ref: '#/components/schemas/MembershipFormPush'
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/MembershipForm'
            403:
               description: Unauthorized
   /form/{id}:
      parameters:
      -  name: id
         in: path
         description: Unique ID of the membership form entry
         required: true
         schema:
            $ref: '#/components/schemas/ObjectID'
      get:
         tags:
         - Membership form
         summary: Membership form
         description: Returns a membership form entry that has a matching ID
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/MembershipForm'
            403:
               description: Unauthorized
82
83
            404:
               description: Form not found
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
            500:
               description: Error while retrieving data
      put:
         tags:
         - Membership form
         summary: Membership form update
         description: Using the passed form object, updates or inserts are made to save the data.
         requestBody:
            description: The form to be updated or inserted into the data set.
            content:
               application/json:
                  schema:
                     $ref: '#/components/schemas/MembershipFormPush'
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/MembershipForm'
            403:
               description: Unauthorized
      delete:
         tags:
         - Membership form
         summary: Membership form delete
         description: Remove a membership form entry with the given ID
         responses:
            204:
               description: Success
            403:
               description: Unauthorized
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
   /form/{id}/complete:
      parameters:
      -  name: id
         in: path
         description: Unique ID of the membership form entry
         required: true
         schema:
            $ref: '#/components/schemas/ObjectID'
      post: 
         tags:
         - Membership form
         summary: Membership form submit
         description: Submit a finalized form to the membership team 
         responses:
            200:
               description: Success
132
133
134
135
136
137
            400:
               description: Bad request
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/ConstraintViolations'
138
139
140
141
142
143
            403:
               description: Unauthorized
            404:
               description: Form not found
            500:
               description: Error while retrieving data
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
   /form/{id}/contacts:
      parameters:
      -  name: id
         in: path
         description: Unique ID of the membership form entry
         required: true
         schema:
            $ref: '#/components/schemas/ObjectID'
      get:
         tags:
         - Contacts
         summary: Contacts list
         description: Returns a list of tracked contacts
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/Contacts'
            500:
               description: Error while retrieving data
      post:
         tags:
         - Contacts
         summary: Contacts create
         description: Using the passed contact object, updates or inserts are made to save the data.
         requestBody:
            description: The contact to be updated or inserted into the data set.
            content:
               application/json:
                  schema:
                     $ref: '#/components/schemas/ContactPush'
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/Contact'
            403:
               description: Unauthorized
   /form/{id}/contacts/{contactID}:
      parameters:
      -  name: id
         in: path
         description: Unique ID of the membership form entry
         required: true
         schema:
            $ref: '#/components/schemas/ObjectID'
      -  name: contactID
         in: path
         description: Unique ID of the contact for the current form
         required: true
         schema:
            $ref: '#/components/schemas/ObjectID'
      get:
         tags:
         - Contacts
         summary: Contacts
         description: Returns a contact for the form given a form ID and contact ID
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/Contact'
            403:
               description: Unauthorized
            500:
               description: Error while retrieving data
      put:
         tags:
         - Contacts
         summary: Contacts update
         description: Using the passed contact object, updates or inserts are made to save the data.
         requestBody:
            description: The contact to be updated or inserted into the data set.
            content:
               application/json:
                  schema:
                     $ref: '#/components/schemas/ContactPush'
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/Contact'
            403:
               description: Unauthorized
      delete:
         tags:
         - Contacts
         summary: Contacts delete
         description: Remove a contact entry with the given ID
         responses:
            204:
               description: Success
            403:
               description: Unauthorized
   /form/{id}/organizations:
      parameters:
      -  name: id
         in: path
         description: Unique ID of the membership form entry
         required: true
         schema:
            $ref: '#/components/schemas/ObjectID'
      get:
         tags:
256
257
         - Form Organizations
         summary: Form Organizations list
258
259
260
         description: Returns a list of tracked organizationsfor the form
         responses:
            200:
261
262
263
264
265
              description: Success
              content:
                application/json:
                  schema:
                    $ref: '#/components/schemas/FormOrganizations'
266
267
268
269
            500:
               description: Error while retrieving data
      post:
         tags:
270
271
         - Form Organizations
         summary: Form Organizations create
272
273
274
275
276
277
         description: Using the passed organization object, a new organization object is saved to the dataset.
         requestBody:
            description: The organization to be updated or inserted into the data set.
            content:
               application/json:
                  schema:
278
                     $ref: '#/components/schemas/FormOrganizationPush'
279
280
281
282
283
284
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
285
                        $ref: '#/components/schemas/FormOrganization'
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
               
            403:
               description: Unauthorized
   /form/{id}/organizations/{orgID}:
      parameters:
      -  name: id
         in: path
         description: Unique ID of the membership form entry
         required: true
         schema:
            $ref: '#/components/schemas/ObjectID'
      -  name: orgID
         in: path
         description: Unique ID of the organization for the form entry
         required: true
         schema:
            $ref: '#/components/schemas/ObjectID'
      put:
         tags:
305
306
         - Form Organizations
         summary: Form Organizations update
307
308
309
310
311
312
         description: Using the passed organization object, updates or inserts are made to save the data.
         requestBody:
            description: The organization to be updated or inserted into the data set.
            content:
               application/json:
                  schema:
313
                     $ref: '#/components/schemas/FormOrganizationPush'
314
315
316
317
318
319
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
320
                        $ref: '#/components/schemas/FormOrganization'
321
322
323
324
            403:
               description: Unauthorized
      delete:
         tags:
325
326
         - Form Organizations
         summary: Form Organizations delete
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
         description: Remove an organization for the form given a form ID
         responses:
            204:
               description: Success
            403:
               description: Unauthorized
   /form/{id}/working_groups:
      parameters:
      -  name: id
         in: path
         description: Unique ID of the membership form entry
         required: true
         schema:
            $ref: '#/components/schemas/ObjectID'
      get:
         tags:
343
344
345
         - Form Working Groups
         summary: Form Working Groups list
         description: Returns a list of tracked Form Working Groups for membership form
346
347
348
349
350
351
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
352
                        $ref: '#/components/schemas/FormWorkingGroups'
353
354
355
356
357
358
            403:
               description: Unauthorized
            500:
               description: Error while retrieving data
      post:
         tags:
359
360
361
         - Form Working Groups
         summary: Form Working Groups create
         description: Using the passed Form Working Groups object, creates a new object in the dataset.
362
363
364
365
366
         requestBody:
            description: The working group to be updated or inserted into the data set.
            content:
               application/json:
                  schema:
367
                     $ref: '#/components/schemas/FormWorkingGroupPush'
368
369
370
371
372
373
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
374
                        $ref: '#/components/schemas/FormWorkingGroup'
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
            403:
               description: Unauthorized
   /form/{id}/working_groups/{workingGroupID}:
      parameters:
      -  name: id
         in: path
         description: Unique ID of the membership form entry
         required: true
         schema:
            $ref: '#/components/schemas/ObjectID'
      -  name: workingGroupID
         in: path
         description: Unique ID of the working group relationship within a form
         required: true
         schema:
            $ref: '#/components/schemas/ObjectID'
      get:
         tags:
393
394
         - Form Working Groups
         summary: Form Working Group
395
396
397
398
399
400
401
         description: Returns a working group entry that has a matching ID 
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
402
                        $ref: '#/components/schemas/FormWorkingGroup'
403
404
405
406
407
408
            403:
               description: Unauthorized
            500:
               description: Error while retrieving data
      put:
         tags:
409
410
411
         - Form Working Groups
         summary: Form Working Groups update
         description: Using the passed Form Working Groups object, updates or inserts are made to save the data.
412
413
414
415
416
         requestBody:
            description: The working group to be updated or inserted into the data set.
            content:
               application/json:
                  schema:
417
                     $ref: '#/components/schemas/FormWorkingGroupPush'
418
419
420
421
422
423
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
424
                        $ref: '#/components/schemas/FormWorkingGroup'
425
426
427
428
            403:
               description: Unauthorized
      delete:
         tags:
429
430
         - Form Working Groups
         summary: Form Working Groups delete
431
432
433
434
435
436
         description: Remove a working group form entry with the given ID
         responses:
            204:
               description: Success
            403:
               description: Unauthorized
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
   /organizations:
      get:
         tags:
         - Organizations
         summary: Organizations List
         description: Returns a list of organizations from the Eclipse API
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/Organizations'
            500:
               description: Error while retrieving data
   /organizations/{organizationID}:
      parameters:
      -  name: organizationID
         in: path
         description: The organization ID for the organization to retrieve
         required: true
         schema:
            type: number
      get:
         tags:
         - Organizations
         summary: Organization
         description: Returns a working group entry that has a matching ID 
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/Organization'
            500:
               description: Error while retrieving data
   /working_groups:
      get:
         tags:
         - Working Groups
         summary: Working Group List
         description: Returns a working group entry that has a matching ID 
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/WorkingGroups'
            500:
               description: Error while retrieving data
   /working_groups/{documentID}:
      parameters:
      -  name: documentID
         in: path
         description: The document ID for the working group to retrieve
         required: true
         schema:
            $ref: '#/components/schemas/ObjectID'
      get:
         tags:
         - Working Groups
         summary: Working Group
         description: Returns a working group entry that has a matching ID 
         responses:
            200:
               description: Success
               content:
                  application/json:
                     schema:
                        $ref: '#/components/schemas/WorkingGroup'
            500:
               description: Error while retrieving data
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
components:
   schemas:
      ObjectID:
         description: Unique identifier for an addressable object in the API.
         type: string
         minimum: 1
      DateTime:
         type: string
         format: datetime
         description: |
            Date string in the RFC 3339 format. Example, `1990-12-31T15:59:60-08:00`.

            More on this standard can be read at https://tools.ietf.org/html/rfc3339.
      Contacts:
         type: array
         items:
            $ref: '#/components/schemas/Contact'
      Contact:
        type: object
        properties:
            id:
               $ref: '#/components/schemas/ObjectID'
            form_id:
               $ref: '#/components/schemas/ObjectID'
            first_name:
               type: string
               description: First name of the contact
            last_name:
               type: string
               description: Last name of the contact
            email:
               type: string
               description: Professional email address at which the individual can be reached at
            job_title:
               type: string
               description: Job title of the contact
            type:
548
               $ref: '#/components/schemas/ContactType'
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
      ContactPush:
        type: object
        properties:
            first_name:
               type: string
               description: First name of the contact
            last_name:
               type: string
               description: Last name of the contact
            email:
               type: string
               description: Professional email address at which the individual can be reached at
            job_title:
               type: string
               description: Job title of the contact
            type:
565
566
567
568
569
570
571
               $ref: '#/components/schemas/ContactType'

      ContactType:
         type: string
         description: The type of contact that is being stored
         enum: [COMPANY, WORKING_GROUP, MARKETING, ACCOUNTING]

572

573
      FormOrganizations:
574
575
         type: array
         items:
576
            $ref: '#/components/schemas/FormOrganization'
577
      
578
      FormOrganization:
579
580
581
582
583
584
585
586
587
         type: object
         properties:
            id:
               $ref: '#/components/schemas/ObjectID'
            form_id:
               $ref: '#/components/schemas/ObjectID'
            legal_name:
               type: string
               description: Legal Name of the Organization
588
589
590
591
            organization_type:
               type: string
               description: The category of organization used for fee determination for current entity
               enum: [NON_PROFIT_OPEN_SOURCE, ACADEMIC, STANDARDS, GOVERNMENT_ORGANIZATION_AGENCY_NGO, MEDIA_ORGANIZATION, RESEARCH, OTHER]
592
593
594
            twitter:
               type: string
               description: The Twitter handle of the organization
595
596
597
598
            aggregate_revenue:
               type: string
               description: The aggregate revenue of the organization and its affiliates
            employee_count:
599
               type: string
600
               description: The number of employees for the given organization
601
602
603
            address:
               type: object
               properties:
604
                  address_line_1:
605
606
                     type: string
                     description: Street address of the organization
607
                  address_line_2:
608
                     type: string
609
610
                     description: Additional information about the street address of the organization
                  locality:
611
                     type: string
612
613
614
615
                     description: The city/township in which the organization is based
                  administrative_area:
                     type: string
                     description: The province/state/area in which the organization is based
616
617
618
619
620
621
                  country:
                     type: string
                     description: The country in which the organization is based
                  postal_code:
                     type: string
                     description: The postal code of the physical address of the organization
622
      FormOrganizationPush:
623
624
625
626
627
         type: object
         properties:
            legal_name:
               type: string
               description: Legal Name of the Organization
628
629
630
631
            organization_type:
               type: string
               description: The category of organization used for fee determination for current entity
               enum: [NON_PROFIT_OPEN_SOURCE, ACADEMIC, STANDARDS, GOVERNMENT_ORGANIZATION_AGENCY_NGO, MEDIA_ORGANIZATION, RESEARCH, OTHER]
632
633
634
            twitter:
               type: string
               description: The Twitter handle of the organization
635
636
637
638
            aggregate_revenue:
               type: string
               description: The aggregate revenue of the organization and its affiliates
            employee_count:
639
               type: string
640
               description: The number of employees for the given organization
641
642
643
            address:
               type: object
               properties:
644
                  address_line_1:
645
646
                     type: string
                     description: Street address of the organization
647
648
649
650
                  address_line_2:
                     type: string
                     description: Additional information about the street address of the organization
                  locality:
651
                     type: string
652
653
                     description: The city/township in which the organization is based
                  administrative_area:
654
                     type: string
655
                     description: The province/state/area in which the organization is based
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
                  country:
                     type: string
                     description: The country in which the organization is based
                  postal_code:
                     type: string
                     description: The postal code of the physical address of the organization
      MembershipForms:
         type: array
         items:
            $ref: '#/components/schemas/MembershipForm'
      MembershipForm:
         type: object
         properties:
            id:
               $ref: '#/components/schemas/ObjectID'
            user_id:
               $ref: '#/components/schemas/ObjectID'
            membership_level:
               type: string
               description: The level of membership with the Eclipse Foundation that is being targeted.
            signing_authority:
               type: boolean
               description: Whether the currently submitting user has signing authority for membership contracts.
679
680
681
682
683
684
685
686
687
688
            purchase_order_required:
               type: string
               description: Indicator for whether a purchase order is required, either yes, no, or not applicable.
               enum: [yes, no, na]
            vat_number:
               type: string
               description: The EU VAT registration number, if applicable
            registration_country:
               type: string
               description: The EU country the organization is registered under for VAT.
689
690
691
692
693
694
695
696
697
698
699
            updated_date:
               $ref: '#/components/schemas/DateTime'
      MembershipFormPush:
         type: object
         properties:
            membership_level:
               type: string
               description: The level of membership with the Eclipse Foundation that is being targeted.
            signing_authority:
               type: boolean
               description: Whether the currently submitting user has signing authority for membership contracts.
700
701
702
703
704
705
706
707
708
709
710
711
            purchase_order_required:
               type: string
               description: Indicator for whether a purchase order is required, either yes, no, or not applicable.
               enum: [yes, no, na]
            vat_number:
               type: string
               description: The EU VAT registration number, if applicable
            registration_country:
               type: string
               description: The EU country the organization is registered under for VAT.


712
      FormWorkingGroups:
713
714
         type: array
         items:
715
716
            $ref: '#/components/schemas/FormWorkingGroup'
      FormWorkingGroup:
717
718
719
720
721
722
723
724
725
726
727
728
729
730
         type: object
         properties:
            id:
               $ref: '#/components/schemas/ObjectID'
            working_group:
               type: string
               description: The ID of the working group relationship to be formed
            participation_level:
               type: string
               description: The desired participation level desired within the new working group
            effective_date:
               $ref: '#/components/schemas/DateTime'
            contact:
               $ref: '#/components/schemas/Contact'
731
      FormWorkingGroupPush:
732
733
734
735
736
737
738
739
740
741
742
743
         type: object
         properties:
            working_group:
               type: string
               description: The ID of the working group relationship to be formed
            participation_level:
               type: string
               description: The desired participation level desired within the new working group
            effective_date:
               $ref: '#/components/schemas/DateTime'
            contact:
               $ref: '#/components/schemas/Contact'
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
      Organizations:
         type: array
         items:
            $ref: '#/components/schemas/Organization'
      Organization:
         type: object
         properties:
            id:
               $ref: '#/components/schemas/ObjectID'
            name:
               type: string
            member_level:
               type: object
               properties:
                  level:
                     type: string
                  description:
                     type: string
            description:
               type: object
               properties:
                  short:
                     type: string
                  full:
                     type: string
            website:
               type: string
            logos:
               type: object
               properties:
                  small:
                     type: string
                     description: URL of compressed for web logo 
                  full:
                     type: string
                     description: URL of full resolution logo
            wgpa:
               type: array
               items:
                  type: object
                  properties:
                     document_id:
                        $ref: '#/components/schemas/ObjectID'
                     level:
                        type: string
                     working_group:
                        type: string
                     description:
                        type: string
      WorkingGroups:
         type: array
         items:
            $ref: '#/components/schemas/WorkingGroup'
      WorkingGroup:
         type: object
         properties:
800
            alias:
801
               type: string
802
803
804
805
806
807
808
809
810
811
812
813
814
815
               description: internal alias for the working group 
            title:
               type: string
               description: Public-facing or official name of the working group
            status:
               type: string
               description: Current status of the working group (e.g. incubating, active, archived)
            logo:
               type: string
               description: image link for the working groups logo
            description:
               type: string
               description: Short description of the working group
            resources:
816
817
               type: object
               properties:
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
                  charter:
                     type: string
                     description: Link to the charter for the current working group
                  contact_form:
                     type: string
                     description: URL link to the contact form
                  members:
                     type: string
                     description: URL to the members list for the given working group
                  participation_agreements:
                     type: object
                     properties:
                        individual:
                           $ref: '#/components/schemas/WorkingGroupParticipationAgreement'
                        organization:
                           $ref: '#/components/schemas/WorkingGroupParticipationAgreement'
                  sponsorship:
835
                     type: string
836
837
                     description: link to the sponsorship agreement document
                  website:
838
                     type: string
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
                     description: the URL for the homepage of this working group
            levels:
               type: array
               items:
                  type: object
                  description: Definition of the participation level for the working group, including its relation code
                  properties:
                     relation:
                        type: string
                        description: code representing the relation, used internally when using common relation types
                     description:
                        type: string
                        description: the label for the participation level
      WorkingGroupParticipationAgreement:
         type: object
         properties:
            document_id:
               $ref: '#/components/schemas/ObjectID'
            pdf:
               type: string
               description: Link to the PDF version of the participation agreement
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
                     
      ConstraintViolations:
         type: array
         items:
            $ref: '#/components/schemas/ConstraintViolation'
      ConstraintViolation:
         type: object
         properties:
            root_id:
               $ref: '#/components/schemas/ObjectID'
               description: ID of the object that was validated.
            path:
               type: string
               description: path to the property that had an error.
            type:
               type: string
               description: name of the type of object that had errors (i.e, Contact, FormOrganization, MembershipForm etc.).
            value:
               type: object
               description: the bad value in question.
880