 |
Post AyRtFy1HzU9aVPHzE0 by [email protected] |
 |
More posts by [email protected] |
|
Post #AyRj8yUErD3mNvrCHg by [email protected] |
|
0 likes, 0 repeats |
|
|
|
is there any documentation system that's good for documenting how a complex… |
|
|
|
Post #AyRjbnfMAQl1DtnoDA by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone something like https://json-schema.org/ ? |
|
|
|
Post #AyRkR6CH1saXSrf00u by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone json schema has a bunch of tooling around it, and can even be generated … |
|
|
|
Post #AyRkcdtw3fM1BKaSps by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone jsonnet has several advantages as an input format for json content inclu… |
|
|
|
Post #AyRoSVr1WO1p94eNpg by [email protected] |
|
0 likes, 0 repeats |
|
|
|
basically I want to write some kind of schema or in-line documentation somewher… |
|
|
|
Post #AyRokZXwX4FZoEKxaS by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone The syntax sucks and isn't as inline as I'd like, but jsdoc lets… |
|
|
|
Post #AyRp2WSmjaRvSXU3ZQ by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@silvermoon82 ugh. I'm working on a rewrite that'd make that make more … |
|
|
|
Post #AyRt7jL8gbP8eze7ii by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone there's json schema but I'm not sure what viewers are there for … |
|
|
|
Post #AyRt8P9DFKouKAOBxg by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@[email protected] I use typespec personally https://typespec.io/ |
|
|
|
Post #AyRt8tziYge1zhBXxw by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone a typescript type? |
|
|
|
Post #AyRt9hM52KeD5F1b7o by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@ryanvade @foone Yeah JSON Schema would be my go-to for this, but it's not … |
|
|
|
Post #AyRt9hTWaebPSKVXjE by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@diazona @ryanvade @foone my only experience with json schema is that it's … |
|
|
|
Post #AyRt9hbg6L7lrcK3RA by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@aburka @ryanvade @foone IIRC it does support comments, there's a custom fi… |
|
|
|
Post #AyRt9hiPhIVoCVTQw4 by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@aburka @ryanvade @foone but to be fair, your point is not lost on me 😀 I me… |
|
|
|
Post #AyRtAupmPJy5B4UsKW by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone Can you document individual decomposed subunits, each no more complex th… |
|
|
|
Post #AyRtCASlmjuNwIKbIG by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone @eniko OpenAPI? There are tools to generate html documentation from the … |
|
|
|
Post #AyRtCAZVNhIQHBTynA by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@andymoose @foone @eniko I was going to suggest Swagger, which I think is techn… |
|
|
|
Post #AyRtDRazZWQTMfmmZs by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone I don't know what the "right" answer is, but for my curren… |
|
|
|
Post #AyRtF3VS6fPfERxlpI by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone (troll answer) there is json encoding rules for asn.1 |
|
|
|
Post #AyRtF6qTgx0vaWp6W0 by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone There are tools that can convert Zod schemas to docs.https://www.npmjs.c… |
|
|
|
Post #AyRtFy1HzU9aVPHzE0 by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone Last time I had to document something like that I just did "JSON wi… |
|
|
|
Post #AyRtGGM9odXdNLBuFc by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone If you have the money...https://www.liquid-technologies.com/xml-studio |
|
|
|
Post #AyRtGiYAzXnCoj1ts8 by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@ryanvade @foone seconding json schema, I’m a big fan. |
|
|
|
Post #AyRtHS5Ngw5k2juYNM by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@xssfox @foone is there anything asn.1 can't do! That's kind of intere… |
|
|
|
Post #AyRtIdK7OaFtBaMqyu by [email protected] |
|
0 likes, 0 repeats |
|
|
|
I swear Rust's Serde is better at documenting and defining schemas than any… |
|
|
|
Post #AyRyrpZiKtQN5cGVdI by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@lunareclipse @foone Its old, bit I have used docson for this before https://gi… |
|
|
|
Post #AyRysUnd43uswe5hVw by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@diazona @ryanvade @foone what I did for acars-processor's config (Golang) … |
|
|
|
Post #AyRytGRHwQZChG0XM8 by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone openapi/swagger is for entire APIs but they provide useful JSON specs fo… |
|
|
|
Post #AyS6AlBDbHfAdimTD6 by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@hp @xssfox @foone Oh no... |
|
|
|
Post #AySAdR6jhugUbKc6nQ by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone I’m wondering if Swagger.io would help? I know it’s for API’s, but… |
|
|
|
Post #AySnpU62JkRVYe1RTM by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone Something like https://json-schema.org/ ? |
|
|
|
Post #AyT3x1i1LLuV6DPJuS by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone Google protocol buffer |
|
|
|
Post #AyU9wBwKc70pQI2vIm by [email protected] |
|
0 likes, 0 repeats |
|
|
|
@foone considered openapi schema files? |
