cfdocs icon indicating copy to clipboard operation
cfdocs copied to clipboard

Type "component"

Open shaedrich opened this issue 8 years ago • 7 comments

How to handle type "component" when checking something against schema or another validating system? "application-cfc" is not found by search for example.

shaedrich avatar Oct 26 '17 12:10 shaedrich

UPDATE: Type "component" was added to search by #745

shaedrich avatar Feb 01 '18 09:02 shaedrich

Ok thanks - I'll close this one then.

pfreitag avatar Feb 01 '18 17:02 pfreitag

But this question was left unanswered: "How to handle type "component" when checking something against schema or another validating system?"

shaedrich avatar Feb 01 '18 17:02 shaedrich

Ah ok...

So really the only validating system we have right now are the tests and the json schema.

For the json schema we need to add component to the type enum here: https://github.com/foundeo/cfdocs/blob/master/data/cfdocs.schema.json#L184

pfreitag avatar Feb 01 '18 17:02 pfreitag

Maybe not just "component". We have something like "alias" and "property" as well if you agree.

shaedrich avatar Feb 01 '18 17:02 shaedrich

What would alias be used for?

For property you are thinking things like the query resultset or cfhttp result? I don't know if property is the best term for that, I would say the recordcount is a property maybe, but not the entire query object. I am a little unclear how you would want to use it, can you give an example json snippet?

I think of those more as an object -- maybe even application-cfc should be of that type.

Looping @KamasamaK in since he has been working with the json schema and is using it for integration with the Visual Studio Code plugin.

pfreitag avatar Feb 01 '18 17:02 pfreitag

Ok - so for alias that is discussed here #709

pfreitag avatar Feb 01 '18 17:02 pfreitag