Openwhisk: Consolidate action annotation constants

[mdeuser]

Currently, the defined action annotation names are not centrally defined. Consolidate them as constants into a single location and change the existing code to use those constants.

Example annotations

• web-export
• final
• raw-http
• web-custom-options
• require-whisk-auth

[kiran002]

@mdeuser I would be interested in taking this up.

My task would be to move the actions in here, to another object class and reference them in the core and in tests. Is this correct?

[rabbah]

Awesome @kiran002 - welcome to the community.

[mdeuser]

@kiran002 - thanks for picking this up :heart: i defer to @rabbah, but in addition to what you have suggested, you may want to consider providing the list of these annotations via the openwhisk endpoint. just like what is done with the set of system limits and runtime..

[kiran002]

@mdeuser can you please point me to where the system limits and runtime endpoints are defined?

[mdeuser]

@kiran002 - i'm not sure exactly where that code is. it's the output from the curl https://openwhiskhost this might be a good starting place https://github.com/apache/incubator-openwhisk/blob/d22ef30fe613d60d84a5310a6b89cdbe2c495995/core/controller/src/main/scala/org/apache/openwhisk/core/controller/Controller.scala#L190

[kiran002]

cool thanks will look into it! :)

[kiran002]

@rabbah, @mdeuser

Before i go all out and implement these changes, I wanted to get some feedback from you guys, So my idea is to have an annotations object

object Annotations {
  val FinalParamsAnnotationName = "final"
  val WebActionAnnotationName = "web-export"
  val WebCustomOptionsAnnotationName = "web-custom-options"
  val RawHttpAnnotationName = "raw-http"
  val RequireWhiskAuthAnnotation = "require-whisk-auth"
  val ProvideApiKeyAnnotationName = "provide-api-key"

  def toJSON(): JsValue = ??? 
}

and i intend to change all instances of

 annotations = Map(WhiskAction.provideApiKeyAnnotationName -> JsBoolean(true)))

to

 annotations = Map(Annotations.ProvideApiKeyAnnotationName -> JsBoolean(true)))

Am i heading in the right direction here?

[rabbah]

👍 sounds like a good plan to me.

[rabbah]

Don’t think you need to toJson method - not sure what your intent is there.

[kiran002]

toJson method was for providing the list of these annotations via the openwhisk endpoint, do you think its necessary?

[rabbah]

Interesting thought. That hadn't occurred to me. Do you know how clients might use this?