mobrovac added a comment.

  In T220402#5146064 <https://phabricator.wikimedia.org/T220402#5146064>, 
@Pablo-WMDE wrote:
  
  > @mobrovac During T221755 <https://phabricator.wikimedia.org/T221755> & 
T221754 <https://phabricator.wikimedia.org/T221754> we tended to `/?spec` 
<https://ssr-termbox.wmflabs.org/?spec> and `/_info` 
<https://ssr-termbox.wmflabs.org/_info> - could you please take a look?
  
  
  Yup, lookin' good! Now service-checker can get the spec. The next step is to 
define (a) whether a specific end point should be tested; and (b) if so, what 
are the request/response pairs that it ought to send/expect.
  
  For the former, each end point + method combo should have an `x-monitor` 
stanza that is set to `true` or `false` (whether to test the end point + method 
combo or not). If this stanza is not present, service-checker assumes its value 
to be `true`. For the latter, if `x-monitor: true`, then you need an additional 
stanza - `x-amples`. It is an array of objects, consisting of `request` and 
`response` properties that define the request to be sent and the response that 
is expected back. Both properties are objects themselves that can have the 
`uri`, `headers` and `body` properties, depending on the request.
  
  Here are some examples of its usage to get you an idea of how this works in 
practice: RESTBase 
<https://github.com/wikimedia/restbase/blob/bd2f9de08cbe6d999ac6678282dd5d8f5fc99594/v1/mobileapps.yaml#L96-L109>,
 Mathoid 
<https://github.com/wikimedia/mathoid/blob/1107c4c5b42eafb0464e33b175e8097cf928e07c/spec.yaml#L119-L197>,
 MCS 
<https://github.com/wikimedia/mediawiki-services-mobileapps/blob/8bcdae5618e98b4d9d20497ecee3604e9a4bdddb/spec.yaml#L207-L220>,
 Citoid 
<https://github.com/wikimedia/citoid/blob/063afebb6304d7cc3125dbdc0b1fec1c0f49f029/spec.yaml#L99-L145>.

TASK DETAIL
  https://phabricator.wikimedia.org/T220402

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: mobrovac
Cc: fsero, mobrovac, Matthias_Geisler_WMDE, Pablo-WMDE, Dzahn, Addshore, 
Tarrow, Lea_WMDE, WMDE-leszek, Jakob_WMDE, Aklapper, akosiaris, alaa_wmde, 
joker88john, Legado_Shulgin, CucyNoiD, Nandana, NebulousIris, thifranc, 
AndyTan, Gaboe420, Versusxo, Majesticalreaper22, Giuliamocci, Davinaclare77, 
Adrian1985, Qtn1293, Cpaulf30, Lahi, Gq86, Baloch007, Darkminds3113, Bsandipan, 
Lordiis, GoranSMilovanovic, Adik2382, Th3d3v1ls, Hfbn0, Ramalepe, Liugev6, 
QZanden, LawExplorer, WSH1906, Lewizho99, Zppix, Maathavan, _jensen, 
rosalieper, Liudvikas, Wong128hk, Eevans, thcipriani, Hardikj, Wikidata-bugs, 
aude, Lydia_Pintscher, dduvall, faidon, Jdforrester-WMF, Mbch331, Jay8g, 
fgiunchedi
_______________________________________________
Wikidata-bugs mailing list
Wikidata-bugs@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikidata-bugs

Reply via email to