Pure Functional HTTP APIs in Scala/

...

/

Refining the Generated Documentation: Part-II

Refining the Generated Documentation: Part-II

Learn how to refine the generated documentation manually and explore the documentation.

We'll cover the following...

Update the pattern attribute in the documentation

Before you ask, we can update all parameters because we have only one.

C++
(paths composeLens at("/product/{id}") composeOptional possible
    composeLens pathParams composeTraversal each composeOptional
    possible composeLens parameterSchema composeOptional possible
    composeLens schemaPattern)
        .set(Option("Fancy UUID regex here!"))(docs)

It seems that we can check off the first point on our list.

Additional lenses for content schemas

We are left with modifying the pattern field of the actual model schemas. To get to these, we have to define some more lenses.

Scala
val components: Lens[OpenAPI, Option[Components]] =
  GenLens[OpenAPI](_.components)
//typeLens[Components, ListMap[String, OpenAPI.ReferenceOr[Schema]]]
val componentsSchemas =
  GenLens[Components](_.schemas)
//typeLens[Schema,ListMap[String,OpenAPI.ReferenceOr[Schema]]]
val schemaProperties =
  GenLens[Schema](_.properties)

The power of lenses allows us to traverse all of our structures and modify all affected models at once. So, we will use the functionality provided by the Each type class here. Let’s try something like the following code.

Scala
(paths composeTraversal each composeLens getOps).getAll(docs)
Shell
[error] ...: diverging implicit expansion for type cats.kernel.Order[A]
[error] starting with method catsKernelStdOrderForSortedSet in trait
        LowPrioritySortedSetInstancesBinCompat1
[error]     (paths composeTraversal each composeLens getOps).getAll(docs)
[error]                             ^

This looks like an error from a binary incompatible Cats ...