| santhosh | |
| Dec 17 2024, 4:26 AM |
| F58916004: image.png | |
| Mar 25 2025, 12:37 PM |
| F58915994: image.png | |
| Mar 25 2025, 12:37 PM |
| F58915989: image.png | |
| Mar 25 2025, 12:37 PM |
| F58118801: image.png | |
| Jan 4 2025, 5:40 AM |
| F58118807: image.png | |
| Jan 4 2025, 5:40 AM |
| F58118767: image.png | |
| Jan 4 2025, 5:40 AM |
| F58118782: image.png | |
| Jan 4 2025, 5:40 AM |
cxserver uses a non-standard scheme for the openapi spec to defined API input, output example. we use x-amples key which was introduced in service-runner templates many years ago.
Currently, OpenAPI 3.0 allows defining examples in the spec. Documentation: https://swagger.io/docs/specification/v3_0/adding-examples/
Migrating from nonstandard examples to new format allows us to use standard tooling around the examples to create mock tests and present the examples in betterway in swagger UI.
Change #1108144 had a related patch set uploaded (by Wangombe; author: Wangombe):
[mediawiki/services/cxserver@master] cxserver spec.yaml: Update endpoint to use openapi compliant examples
Change #1109751 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):
[mediawiki/services/cxserver@master] Error handling: Skip passing the error to Express
Change #1109751 had a related patch set uploaded (by Abijeet Patro; author: Abijeet Patro):
[mediawiki/services/cxserver@master] Error handling: Skip passing the error to Express
Change #1109751 merged by jenkins-bot:
[mediawiki/services/cxserver@master] Error handling: Skip passing the error to Express
Change #1111373 had a related patch set uploaded (by KartikMistry; author: KartikMistry):
[operations/deployment-charts@master] Update cxserver to 2025-01-13-044601-production
Change #1111373 merged by jenkins-bot:
[operations/deployment-charts@master] Update cxserver to 2025-01-13-044601-production
Mentioned in SAL (#wikimedia-operations) [2025-01-15T05:23:23Z] <kart_> Updated cxserver to 2025-01-13-044601-production (T382294)
Note that this patch is related to T377966: Make cxserver Logstash logs readable and reliable
I need to make some updates to spec.js file to update the logic responsible for validating examples for the spec.yaml file as described in this patch .. Keeping the testing of endpoints dynamic is crucial for the new spec.yaml file and seeing that it's structure has changed, we should now have logic to match it.
service-checker doesn't have support yet for the swagger example stanzas. Given it is the underlying library that does all the monitoring based on openapi specs SRE should add support for this to it. That being said, and to ensure a smooth migration, I suggest to not drop the x-amples stanzas from specs until we 've added support. Definitely do deploy the new stanzas though, they 'll definitely help in ensuring support in the service checker's side.
Change #1122072 had a related patch set uploaded (by Wangombe; author: Wangombe):
[mediawiki/services/cxserver@master] cxserver spec.yaml: Update endpoints to use openapi compliant examples
Change #1122072 merged by jenkins-bot:
[mediawiki/services/cxserver@master] cxserver spec.yaml: Update endpoints to use openapi compliant examples
https://gerrit.wikimedia.org/r/1122072 has been merged. We can do a sanity check on it. After, we are not planning on continuing work on this so it should ideally be moved back to Ready for Dev column.
Change #1128066 had a related patch set uploaded (by KartikMistry; author: KartikMistry):
[operations/deployment-charts@master] Update cxserver to 2025-03-14-045617-production
Change #1128066 merged by jenkins-bot:
[operations/deployment-charts@master] Update cxserver to 2025-03-14-045617-production
Mentioned in SAL (#wikimedia-operations) [2025-03-19T05:16:51Z] <kart_> Updated cxserver to 2025-03-14-045617-production (T382294)
These changes have been deployed.
Some improvements:
