Navigation Menu

Skip to content

Instantly share code, notes, and snippets.

@skalee
Created November 8, 2017 23:48
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save skalee/a66ab5953373022d1a41e32060816df1 to your computer and use it in GitHub Desktop.
Save skalee/a66ab5953373022d1a41e32060816df1 to your computer and use it in GitHub Desktop.
Validator output
Checking apiary.apib… FAIL
warning code 5 in line 195 - ignorning unrecognized block:
[comment]: <> (REFERENCE section)
warning code 6 in line 2667 - no value(s) specified:
`body`: (string) - Body of invitation message to the invitees
warning code 6 in line 2705 - no value(s) specified:
`s`: (string) - pagination synchronization string
warning code 6 in line 2800 - no value(s) specified:
`s`: (string) - pagination synchronization string
warning code 6 in line 2843 - no value(s) specified:
`body`: (string) - Body of invitation message to the invitees
warning code 6 in line 2941 - no value(s) specified:
`s`: (string) - pagination synchronization string
warning code 2 in line 3032 - action with method 'PUT' already defined for resource '/invitations/join_space_request/{invitation_id}':
#### Updating pre-assigned role [PUT]
warning code 6 in line 3067 - no value(s) specified:
`s`: (string) - pagination synchronization string
Checking input.apib… FAIL
warning code 5 in line 13 - ignoring unrecognized block:
:[](sections/common_ds.apib)
warning code 5 in line 15 - ignoring unrecognized block:
[comment]: <> (REFERENCE section)
warning code 5 in line 17 - ignoring unrecognized block:
:[](sections/general.apib)
:[](sections/profile.apib)
:[](sections/app_data.apib)
:[](sections/calendar.apib)
:[](sections/wiki.apib)
:[](sections/connection.apib)
:[](sections/file.apib)
:[](sections/invitation.apib)
:[](sections/setting.apib)
:[](sections/space.apib)
:[](sections/space_member.apib)
:[](sections/user.apib)
:[](sections/user_session.apib)
Checking sections/app_data.apib… FAIL
error code 4 in line 97 - base type 'id' is not defined in the document:
`id`: 135 (id) - Profile object ID
Checking sections/calendar.apib… FAIL
error code 4 in line 517 - base type 'uuid' is not defined in the document:
`calendar[owner_id]` (uuid, required) - Id of the owner of the calendar.
Checking sections/calendar/non_recurrence.apib… FAIL
warning code 1 in line 0 - expected API name, e.g. '# <API Name>':
+ `event[name]` (string) - Name of the event.
+ `event[all_day]` (boolean) - Whether the event is an all-day event.
+ `event[date_start]` (string, required) - The start date of the event.
+ `event[date_finish]` (string, required) - The finish date of the event.
+ `event[time_start]` (string, required) - The start time of the event.
+ `event[time_finish]` (string, required) - The finish time of the event.
+ `event[where]` (string) - The location where the event happens.
+ `event[description]` (string) - The description of the event.
+ `event[recurring_type]` (enum[string]) - The recurring type of the event (absence means `not_repeat`).
+ members
+ `not_repeat`
+ `daily`
+ `weekly`
+ `monthly`
+ `yearly`
+ `weekday`
+ `mo_we_fr`
+ `tu_th`
Checking sections/calendar/recurrence.apib… FAIL
warning code 3 in line 0 - ignoring possible metadata, expected '<key> : <value>', one one per line:
:[](non_recurrence.apib)
+ `event[until]` (enum[string])
+ members
+ `never` - Indicates the recurring series will never end.
+ `to_date` - Indicates the recurring series will end at a date specified in `event[until_date]`.
+ `event[repeat_every]` (number) - Repeats by the number of units given by the recurring type.
+ `event[until_date]`: dd/mm/yyyy, mm/dd/yyyy, dd.mm.yyyy, yyyy-mm-dd (string)
warning code 1 in line 0 - expected API name, e.g. '# <API Name>':
:[](non_recurrence.apib)
+ `event[until]` (enum[string])
+ members
+ `never` - Indicates the recurring series will never end.
+ `to_date` - Indicates the recurring series will end at a date specified in `event[until_date]`.
+ `event[repeat_every]` (number) - Repeats by the number of units given by the recurring type.
+ `event[until_date]`: dd/mm/yyyy, mm/dd/yyyy, dd.mm.yyyy, yyyy-mm-dd (string)
Checking sections/common_ds.apib… OK
Checking sections/connection.apib… OK
Checking sections/file.apib… FAIL
error code 4 in line 197 - base type 'File' is not defined in the document:
Attributes (File)
Checking sections/general.apib… OK
Checking sections/invitation.apib… FAIL
error code 4 in line 458 - base type 'JoinSpaceRequest' is not defined in the document:
Attributes (JoinSpaceRequest)
warning code 6 in line 36 - no value(s) specified:
`body`: (string) - Body of invitation message to the invitees
warning code 6 in line 74 - no value(s) specified:
`s`: (string) - pagination synchronization string
warning code 6 in line 169 - no value(s) specified:
`s`: (string) - pagination synchronization string
warning code 6 in line 212 - no value(s) specified:
`body`: (string) - Body of invitation message to the invitees
warning code 6 in line 310 - no value(s) specified:
`s`: (string) - pagination synchronization string
warning code 2 in line 401 - action with method 'PUT' already defined for resource '/invitations/join_space_request/{invitation_id}':
#### Updating pre-assigned role [PUT]
warning code 6 in line 436 - no value(s) specified:
`s`: (string) - pagination synchronization string
Checking sections/profile.apib… OK
Checking sections/profile/profile.apib… FAIL
warning code 1 in line 0 - expected API name, e.g. '# <API Name>':
+ `user` (object)
+ `first_name` (string)
+ `id` (uuid)
+ `last_name` (string)
+ `indigo_user_id` (uuid)
+ `name` (string)
+ `fields` (array[object])
+ `name` (string)
+ `base_name` (string)
+ `title` (string)
+ `type` (string)
+ `value` (string, nullable)
+ `value_type` (string, nullable)
+ `value_type_title` (string, nullable)
+ `visibility` (string)
+ `avatar` (object, nullable)
+ `id` (number)
+ `last_resize_info_for_cropper` (string)
+ `thumb_width` (number)
+ `thumb_height` (number)
Checking sections/setting.apib… OK
Checking sections/space_member.apib… FAIL
error code 4 in line 93 - base type 'id' is not defined in the document:
`checked_role` (id) - Role ID
Checking sections/space.apib… OK
Checking sections/user_session.apib… OK
Checking sections/user.apib… FAIL
error code 4 in line 41 - base type 'uuid' is not defined in the document:
`user_id` (uuid) - ID of the user
Checking sections/wiki.apib… OK
There were 28 errors or warnings in 19 files.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment