finos / symphony-api-spec Goto Github PK

For all other apis, the -public-deprecated.yml file is strictly a superset of the contents of the -public.yml file. However, this rule has recently been broken in the agent file.

Using the deprecated rc48 POD spec and Swagger v1.5.16

Swagger generation returns errors on String model being overridden within the spec itself.

[ERROR] ..../symphony-java-api/pod/target/generated-sources/swagger/src/main/java/org/symphonyoss/symphony/pod/model/CompanyCertInfo.java:[200,17] toString() in org.symphonyoss.symphony.pod.model.CompanyCertInfo cannot override toString() in java.lang.Object
return type org.symphonyoss.symphony.pod.model.String is not compatible with java.lang.String

In spec:

String:
type: string

Not seeing https://rest-api.symphony.com/docs/read-presence-feed defined in spec.

According to the documentation, the list of sids for the blast API should be comma-separated. And, if the swagger looks like this:

// line 373, agent api (deprecated version)
       - name: sids
          description: A comma-separated list of Stream IDs
          in: formData
          required: true
          type: string

... all is well.

However, at the moment, the swagger seems to look for a list of strings, which doesn't appear to be supported in my version of Jersey:

       - name: sids
          description: A comma-separated list of Stream IDs
          in: formData
          required: true
          type: array
          items:
            type: string  // doesn't seem supported in Jersey?

Is this a mistake in the api, or intentional? It seems like it might be a mistake, given that the description asks for a comma-separated list.

On about line 561 of agent-api-public-deprecated.yaml, there should be:

      consumes:
        - application/json

.. in order to be consistent with all the other api swagger definitions. This is causing problems for JAX-RS as it doesn't know how to marshall the body object for me.

thanks
Rob

Hello,

We would like to consume Extension API from C#, do you know where I can find the related swagger?

Thx

I've just raised this with Symphony support, but maybe this is this is the right place?

The V4Event specification published here: https://github.com/symphonyoss/symphony-api-spec/blob/master/agent/agent-api-public.yaml#L3821

Doesn't contain the SYMPHONYELEMENTSACTION field, and doesn't contain the object definitions to describe this payload:

"symphonyElementsAction": {
"actionStream": {
"streamId": "0YeiA-neZa1PrdHy1L82jX___pQjntU-dA"
},
"formStream": {
"streamId": "YuK1c2y2yuie6+UfQnjSPX///pQEn69idA=="
},
"formMessageId": "xtZqqBNGwLDkLuvuQTyjH3///pQENvjudA==5454",
"formId": "form_id",
"formValues": {
"action": "submit_button",
"name_01": "John",
"email_01": "[email protected]",
"country": "opt1",
"example_radio": "option_01",
"checkbox_1": "value01",
"checkbox_2": "value02",
"comment": "my comment"
}
}

Can someone take a look at the swagger definitions and update them please?

Hi,

Can someone produce a Schema for checking MessageML/PresentationML? It appears that there is a lot of checking going on in the agent code, so perhaps this exists already and can be surfaced.

Reason being, it would allow client-side checking of messages before getting them refused from the agent.

thanks,
Rob

When will the 1.48 spec be published?

Just concerned about the current release schedule.