gbfs-validator-java/gbfs-validator-java-api/src/main/resources/public/openapi.yaml at 2bfae25548daf9e2f8a6b515732f5d2c6edb5282 · entur/gbfs-validator-java · 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
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
82
83
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
openapi: 3.0.0
info:
  title: GBFS Validator API
  version: "0.1"
paths:
  /validate:
    post:
      summary: Validate GBFS feed
      requestBody:
        $ref: '#/components/requestBodies/ValidateRequestBody'
      responses:
        '200':
          description: Validation result
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationResult"

components:
  requestBodies:
    ValidateRequestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            required:
              - feedUrl
            properties:
              feedUrl:
                type: string
                example: "https://example.com/gbfs.json"
              auth:
                oneOf:
                  - $ref: '#/components/schemas/BasicAuth'
                  - $ref: '#/components/schemas/BearerTokenAuth'
                  - $ref: '#/components/schemas/OAuthClientCredentialsGrantAuth'
                discriminator:
                  propertyName: authType
                  mapping:
                    basicAuth: '#/components/schemas/BasicAuth'
                    bearerToken: '#/components/schemas/BearerTokenAuth'
                    oauthClientCredentialsGrant: '#/components/schemas/OAuthClientCredentialsGrantAuth'

  schemas:
    BasicAuth:
      type: object
      properties:
        authType:
          type: string
          example: "BasicAuth"
        username:
          type: string
          example: username
        password:
          type: string
          example: password

    BearerTokenAuth:
      type: object
      properties:
        authType:
          type: string
          example: bearerToken
        token:
          type: string
          example: "THE_TOKEN"

    OAuthClientCredentialsGrantAuth:
      type: object
      properties:
        authType:
          type: string
          example: "OAuthClientCredentialsGrantAuth"
        clientId:
          type: string
          example: "CLIENT_ID"
        clientSecret:
          type: string
          example: "THE_SECRET"
        tokenUrl:
          type: string
          example: "https://token.example.com"

    FileError:
      type: object
      properties:
        keyword:
          type: string
          description: |
            Possible known keywords: type, enum, format, required, minimum, maximum, pattern.
        instancePath:
          type: string
          description: |
            The JSON Pointer path to the part of the instance that failed validation.
        schemaPath:
          type: string
          description: |
            The JSON Pointer path to the part of the schema that triggered the error.
        message:
          type: string
          description: |
            Human-readable message describing the error.
      required:
        - keyword
        - instancePath
        - message

    SystemError:
      type: object
      properties:
        error:
          type: string
          description: "Error code or identifier for the system error. Examples: HTTP_ERROR_404, PARSE_ERROR, CONNECTION_ERROR, FILE_NOT_FOUND."
        message:
          type: string
          description: "Human-readable message describing the system error."
      required:
        - error
        - message

    GbfsFile:
      type: object
      properties:
        name:
          type: string
          description: |
            Key identifying the type of feed this is. The key MUST be the base file name defined in the spec for the corresponding feed type ( system_information for system_information.json file, station_information for station_information.json file).
          example: gbfs
        url:
          type: string
          format: url
          example: https://www.example.com/gbfs/v3/gbfs.json
        version:
          type: string
          example: "3.0"
        language:
          type: string
          nullable: true
          example: "en"
          description: "Only relevant for pre-v3 files"
        errors:
          type: array
          items:
            $ref: "#/components/schemas/FileError"
        schema:
          type: object
        systemErrors:
          type: array
          items:
            $ref: "#/components/schemas/SystemError"
          description: "System errors that occurred while processing this file, such as fetch failures or parsing errors. These are not validation errors but rather issues that prevented proper validation."

    ValidationResult:
      type: object
      properties:
        summary:
          type: object
          properties:
            validatorVersion:
              type: string
              example: "v1.2"
            files:
              type: array
              items:
                $ref: "#/components/schemas/GbfsFile"