Evaluate proc for RSpec::OpenAPI.title

[alexpapworth]

My use case is generating different openapi files from different RSpec request files. The RSpec::OpenAPI.path proc is great to export YAML to different files, but I was surprised to see I couldn't do the same with RSpec::OpenAPI.title

Unfortunately the following snippet generates: title: !ruby/object:Proc {}

RSpec::OpenAPI.title = -> (example) {
  return "Customer API" if example.file_path == "./spec/requests/customer_api_spec.rb"
  return "Reseller API" if example.file_path == "./spec/requests/resellers_api_spec.rb"

  "API"
}

[exoego]

How about #162

[alexpapworth]

Ah interesting. My usecase is slightly different. I would favour a proc on RSpec::OpenAPI.title in a single config file rather than creating the multiple config files.

[josefggx]

@exoego @alexpapworth, Would it be ideal to assign the title based on the path of the example, or on the file path of the resulting schema? Because if the example is used, I think there could be more titles than schema files, and titles would end up being overwritten if not managed properly. I can provide a solution for both, let me know which would be the preferred configuration:

# Option A - Resulting schema file path:
RSpec::OpenAPI.title = -> (path) {
  case path
  when %r[doc/openapi/v1.yaml] then 'API v1 Documentation'
  when %r[doc/openapi/v2.yaml] then 'API v2 Documentation'
  else 'OpenAPI Documentation'
  end
}

# Option B - Example file path:
RSpec::OpenAPI.title = -> (example) {
  case example.file_path
  when %r[spec/requests/api/v1/] then 'API v1 Documentation'
  when %r[spec/requests/api/v2/] then 'API v2 Documentation'
  else 'OpenAPI Documentation'
  end
}

[alexpapworth]

Ooh interesting. I'm leaning towards Option B, because then the lambda will take the same parameters as RSpec::OpenAPI.path = currently does.