github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-05-24 00:21:25 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

document user endpoints (#11894)

Browse Source 
* document user endpoints, allow for empty request/response bodies

* document more user endpoints, improve debugging output if no details are specified

* document some more user endpoints

* minor cleanup

* FIX: flakey tests due to bad regex
This commit is contained in:
Blake Erickson
2021-01-29 11:27:11 -07:00
committed by GitHub
parent 11c812f042
commit 67e185b33e
12 changed files with 1458 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
spec/requests/api/shared/shared_examples.rb
View File

@ -10,7 +10,13 @@ RSpec.shared_examples "a JSON endpoint" do |expected_response_status|
unless valid # for debugging
puts
puts "RESPONSE: #{params}"
puts "VALIDATION DETAILS: #{schemer.validate(params).to_a[0]["details"]}"
validation_result = schemer.validate(params).to_a[0]
details = validation_result["details"]
if details
puts "VALIDATION DETAILS: #{details}"
else
puts "POSSIBLE ISSUE W/: #{validation_result['data_pointer']}"
end
end
expect(valid).to eq(true)
end
@ -23,19 +29,21 @@ RSpec.shared_examples "a JSON endpoint" do |expected_response_status|
describe "request body" do
it "matches the documented request schema" do |example|
schemer = JSONSchemer.schema(expected_request_schema)
expect_schema_valid(schemer, params)
if expected_request_schema
schemer = JSONSchemer.schema(expected_request_schema)
expect_schema_valid(schemer, params)
end
end
end
describe "response body" do
let(:json_response) { JSON.parse(response.body) }
it "matches the documented response schema" do |example|
schemer = JSONSchemer.schema(
expected_response_schema,
)
expect_schema_valid(schemer, json_response)
it "matches the documented response schema" do |example|
if expected_response_schema
schemer = JSONSchemer.schema(expected_response_schema)
expect_schema_valid(schemer, json_response)
end
end
end
end