VRIExamples/swagger.yaml at master · HiltonRoscoe/VRIExamples · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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
openapi: 3.0.0
info:
  contact:
    name: John Wack
    email: john.wack@nist.gov
    url: 'https://www.nist.gov/itl/voting'
  license:
    name: Public Domain
  version: 1.0.0
  title: Voter Records Interchange
  description: Example showing how the NIST VRI spec could be exposed over a web api
servers:
  - description: Fictitious address
    url: 'https://voterportal.electionsagency.us'
paths:
  /voterReg:
    post:
      summary: Submit a voter registration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VoterRecordsRequest'
      responses:
        '200':
          description: A response object
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/RegistrationAcknowledgement'
                  - $ref: '#/components/schemas/RegistrationRejection'
                  - $ref: '#/components/schemas/RegistrationSuccess'
components:
  schemas:
    VoterRecordsRequest:
      $ref: 'https://raw.githubusercontent.com/usnistgov/VoterRecordsInterchange/master/NIST_V0_voter_records_interchange.json#/definitions/VRI.VoterRecordsRequest'
    RegistrationAcknowledgement:
      $ref: 'https://raw.githubusercontent.com/usnistgov/VoterRecordsInterchange/master/NIST_V0_voter_records_interchange.json#/definitions/VRI.RequestAcknowledgement'
    RegistrationRejection:
      $ref: 'https://raw.githubusercontent.com/usnistgov/VoterRecordsInterchange/master/NIST_V0_voter_records_interchange.json#/definitions/VRI.RequestRejection'
    RegistrationSuccess:
      $ref: 'https://raw.githubusercontent.com/usnistgov/VoterRecordsInterchange/master/NIST_V0_voter_records_interchange.json#/definitions/VRI.RequestSuccess'