Skip to content

Add Documentation parameter into template definition#15

Open
roman-p wants to merge 5 commits intomasterfrom
DSP-1359
Open

Add Documentation parameter into template definition#15
roman-p wants to merge 5 commits intomasterfrom
DSP-1359

Conversation

@roman-p
Copy link

@roman-p roman-p commented Apr 1, 2019

This MR enables adding of documentation_url into template definition, which currently accepts any URL and renders it under the template description as a href.

import play.api.libs.json._

case class Template(id: String, template: String, description: String, parameterInfos: Map[String, ParameterInfo])
case class Template(id: String, template: String, documentation_url: String, description: String, parameterInfos: Map[String, ParameterInfo])

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use camel caps for uniform naming scheme

@@ -1,3 +1,4 @@
documentation_url = "#curl-test-docs"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change to documentation-url. For uniformity. For example: Look at order-index.

@sohaibiftikhar
Copy link

@roman-p You can use ./scalafmt --test locally to validate formatting errors before pushing.

@sohaibiftikhar sohaibiftikhar removed their assignment May 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants