muSrvSanitize

furo muSrvSanitize #

Sanitize the muServices, to avoid errors in your protos or es6 services.

Sanitizing includes at the moment:

  • Adding of query params which are part of the url and needs to be listed as qp’s for the request body.

A method definition like:

1
2
    - md: 'Get: GET /sample/{smp} google.protobuf.Empty , sample.SampleEntity #Returns a single Sample.'

will become to

1
2
3
    - md: 'Get: GET /sample/{smp} google.protobuf.Empty , sample.SampleEntity #Returns a single Sample.'
      qp:
        smp: 'string #The query param smp stands for XXX id.'

and you can change it to

1
2
3
    - md: 'Get: GET /sample/{smp} google.protobuf.Empty , sample.SampleEntity #Returns a single Sample.'
      qp:
        smp: 'string #The query param smp stands for a sample id.'
Notice: A existing query param will not be touched or modified.
furo muSrvSanitize [flags]

Options #

  -h, --help   help for muSrvSanitize

Options inherited from parent commands #

      --config string   config file (default is CWD/.furo.yaml)
Auto generated by spf13/cobra on 23-Oct-2020 #