SmartGridready / SGrSpecifications

SmartGridready Specifications
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

REST query and form parameters #298

Closed mkrebs81 closed 2 weeks ago

mkrebs81 commented 2 weeks ago
ergo-furrer commented 2 weeks ago

@mkrebs81 I think we should leave the URL for the Clemap as it was and not add the requestQuery element. So I it remains:

  <requestMethod>GET</requestMethod>
                  <requestPath>/digitaltwins?sensor_id={{sensor_id}}</requestPath>
                  <responseQuery>
                    <queryType>JMESPathExpression</queryType>
                    <query>sum([[0].ten_sec.p_l1,[0].ten_sec.p_l2,[0].ten_sec.p_l3])</query>
                  </responseQuery>

Sorry that I did not see that while merging before pushing the BearerToken/Content-Type fix. Can I revert to the Clemap EI to the status above?

mkrebs81 commented 2 weeks ago

@ergo-furrer if you like, revert them. note that the path should be /digitaltwins/?sensor_id={{sensor_id}} (i fixed that in my latest commit)

ergo-furrer commented 2 weeks ago

Hmm your latest commit seems to be:

                  <requestPath>/digitaltwins/</requestPath>
                  <requestQuery>
                    <parameter>
                      <name>sensor_id</name>
                      <value>{{sensor_id}}</value>
                    </parameter>
                  </requestQuery>

Still contains the <requestQuery>

ergo-furrer commented 2 weeks ago

@mkrebs81 Regarding /digitaltwins/?sensor_id={{sensor_id}} and /digitaltwins?sensor_id={{sensor_id}} i think the version without / before the ? is correct:

"When specifying query parameters in a URL, you should not include a forward slash ("/") before the question mark ("?"). The question mark separates the base URL from the query string."

ergo-furrer commented 2 weeks ago

@mkrebs81 Regarding /digitaltwins/?sensor_id={{sensor_id}} and /digitaltwins?sensor_id={{sensor_id}} i think the version without / before the ? is correct:

"When specifying query parameters in a URL, you should not include a forward slash ("/") before the question mark ("?"). The question mark separates the base URL from the query string."

I am preparing the corrections regarding this.

mkrebs81 commented 2 weeks ago

@ergo-furrer I agree, usually the path should not include the trailing slash.

However, I have no idea if CLEMAP requires the slash or not. All existing EIDs and the CLEMAP API Python mock some students made last year have had the trailing slash so far.

ergo-furrer commented 2 weeks ago

@ergo-furrer I agree, usually the path should not include the trailing slash.

However, I have no idea if CLEMAP requires the slash or not. All existing EIDs and the CLEMAP API Python mock some students made last year have had the trailing slash so far.

Surprisingly Clemap accepts both versions 😄 !

ergo-furrer commented 2 weeks ago

I pushed the rolled-back versions of the two CLEMAP EI-XML now.