osr-plastic/osr-discourse-src
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
This repository has been archived on 2023-03-18. You can view files and clone it, but cannot push or open issues or pull requests.
2ea202b30a
osr-discourse-src/spec/requests/api/schemas/json
History
Blake Erickson 2861b9337d
DEV: Fix flaky admin badges.json api docs spec (#17210) 
* DEV: Fix flaky admin badges.json api docs spec

This commit is to fix this incredibly vague error message:

```
Failure/Error: expect(valid).to eq(true)

  expected: true
       got: false
```

From this test:

> Assertion: badges /admin/badges.json get success response behaves like
> a JSON endpoint response body matches the documented response schema

I was finally able to repro locally using parallel tests:

```
RAILS_ENV=test bundle exec ./bin/turbo_rspec
```

I *think* the parallel tests might be swallowing the `puts` output, but
when I also specified the individual spec file

```
RAILS_ENV=test bundle exec ./bin/turbo_rspec spec/requests/api/badges_spec.rb
```

It revealed the issue:

```
VALIDATION DETAILS: {"missing_keys"=>["i18n_name"]}
```

``` ruby
...
  def include_i18n_name?
    object.system?
  end
```

Looks like if the "system" user isn't being used the `i18n_name` won't
be returned in the json response so we shouldn't mark it as a required
attribute.

* Switch to using fab!

When using `let(:badge)` to fabricate a test badge it wouldn't be
returned from the controller, but switching to using `fab!` allows it to
be returned in the json data giving us a non-system badge to test
against.
2022-06-23 14:32:17 -06:00
..
admin_user_list_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
admin_user_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
backups_create_request.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
backups_list_response.json api docs example (#11997) 2021-02-08 10:09:44 -07:00
badge_create_request.json DEV: Document some of the badge api endpoints (#13919) 2021-08-03 06:25:12 -06:00
badge_create_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
badge_list_response.json DEV: Fix flaky admin badges.json api docs spec (#17210) 2022-06-23 14:32:17 -06:00
badge_update_request.json DEV: Document some of the badge api endpoints (#13919) 2021-08-03 06:25:12 -06:00
badge_update_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
category_create_request.json DEV: Update category api docs (#12017) 2021-02-09 06:27:23 -07:00
category_create_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
category_list_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
category_topics_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
category_update_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
group_add_members_request.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
group_add_members_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
group_members_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
group_remove_members_request.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
group_remove_members_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
group_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
groups_list_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
post_delete_request.json DEV: Document delete post API endpoint (#15495) 2022-01-07 16:09:32 -07:00
post_replies_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
search_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
site_response.json DEV: Fix flakey site.json rswag specs (#17161) 2022-06-20 12:33:33 -06:00
success_ok_response.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
tag_group_create_request.json DEV: Updates to api docs schema validation (#11801) 2021-01-21 18:23:23 -07:00
tag_group_create_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
topic_create_request.json DEV: Document external topic id endpoints (#15897) 2022-02-10 19:01:19 -07:00
topic_create_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
topic_show_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
upload_abort_multipart_request.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_batch_presign_multipart_parts_request.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_batch_presign_multipart_parts_response.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_complete_external_upload_request.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_complete_multipart_request.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_create_multipart_request.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_create_multipart_response.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_create_request.json DEV: More API Doc improvements (#11849) 2021-01-26 07:38:46 -07:00
upload_create_response.json DEV: More API Doc improvements (#11849) 2021-01-26 07:38:46 -07:00
upload_generate_presigned_put_request.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_generate_presigned_put_response.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
user_actions_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
user_anonymize_response.json DEV: Document anonymize user api endpoint (#13893) 2021-07-29 17:40:41 -06:00
user_badges_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
user_create_request.json FEATURE: API to create user's associated account (#15737) 2022-03-03 18:17:02 +02:00
user_create_response.json DEV: Refactor the api docs for the user endpoint (#14377) 2021-09-20 10:04:57 -06:00
user_delete_request.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
user_delete_response.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
user_emails_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
user_get_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00
user_password_change_request.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
user_password_reset_request.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
user_password_reset_response.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
user_refresh_gravatar_response.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
user_silence_request.json FIX: Show suspended by user (#16927) 2022-06-01 14:54:23 +02:00
user_silence_response.json FIX: Show suspended by user (#16927) 2022-06-01 14:54:23 +02:00
user_suspend_request.json DEV: Document the user suspend api endpoint (#12179) 2021-02-23 05:58:22 -07:00
user_suspend_response.json FIX: Show suspended by user (#16927) 2022-06-01 14:54:23 +02:00
user_update_avatar_request.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
user_update_email_request.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
user_update_request.json FEATURE: API to create user's associated account (#15737) 2022-03-03 18:17:02 +02:00
user_update_response.json FEATURE: API to create user's associated account (#15737) 2022-03-03 18:17:02 +02:00
user_update_username_request.json DEV: Update api docs to update username and to get post replies (#15881) 2022-02-09 15:04:36 -07:00
users_public_list_response.json repair structural problems with the openapi spec (#16710) 2022-06-20 10:56:56 -06:00