LiveRamp / reslang

A language for describing resource-oriented APIs & turning them into Swagger or resource diagrams. Oriented around the concepts we want to expose in the APIs.
Apache License 2.0
23 stars 7 forks source link

Use underscore instead of period for generated topic names #169

Closed JacobCrofts closed 3 years ago

JacobCrofts commented 3 years ago

It looks like we only have two Pub/Sub topics in production right now, configured here and here. The topic names in these config files all follow the format topics/${apiName}_v#{versionNumber}-${resourceName}, even though the autogenerated ones from Reslang assume that there will be a period between the apiName and versionNumber instead of an underscore.

I propose that we change the "standard" such that we use an underscore instead of a period, because:

ops-github-DU4JOAWE commented 3 years ago

This change is Reviewable

JacobCrofts commented 3 years ago

cc @LiveRamp/dev-taxo since your team has the same problem: we're calling our Pub/Sub topics one thing, but Reslang is calling them another, so the events docs we publish have the wrong topic name.

njaczko commented 3 years ago

Ah, would you mind also adding a one-line description to https://github.com/LiveRamp/reslang/blob/master/docs/releases.md ?

You can use this if you'd like: Revert generated topic name format for compatibility with topic names generated by earlier versions of Reslang.