Post AySAdlVQsF2DBkqF6m by wndxlori@ruby.social
 (DIR) More posts by wndxlori@ruby.social
 (DIR) Post #AyRj91cMDv35Q1CLtg by foone@digipres.club
       2025-09-21T23:31:23Z
       
       0 likes, 0 repeats
       
       is there any documentation system that's good for documenting how a complex JSON format works?like, being plain json, I don't have a strict schema or anything, but I'd like to document which optional keys are possible and what they do. The only ones of these I've used are pydoc and javadoc, but obviously that's not going to do for something like json.
       
 (DIR) Post #AyRjc81vSfPFhj2FCy by ryanvade@mas.to
       2025-09-21T23:36:36Z
       
       0 likes, 0 repeats
       
       @foone something like https://json-schema.org/ ?
       
 (DIR) Post #AyRkRK6yIpNTwVo5jc by bsmedberg@mastodon.cloud
       2025-09-21T23:45:49Z
       
       0 likes, 0 repeats
       
       @foone json schema has a bunch of tooling around it, and can even be generated from rust and python/pydantic definitions.
       
 (DIR) Post #AyRkcw9LDZ5J6MS9OC by milena_zen@mstdn.social
       2025-09-21T23:47:41Z
       
       0 likes, 0 repeats
       
       @foone jsonnet has several advantages as an input format for json content including comments and maybe expressing some structure and enforcement
       
 (DIR) Post #AyRoSbFsRqalDdpvo8 by foone@digipres.club
       2025-09-22T00:30:52Z
       
       0 likes, 0 repeats
       
       basically I want to write some kind of schema or in-line documentation somewhere, and have that turned into HTML webpages, a la pydoc.
       
 (DIR) Post #AyRokjOwtni3hGj2zw by silvermoon82@wandering.shop
       2025-09-22T00:34:15Z
       
       0 likes, 0 repeats
       
       @foone The syntax sucks and isn't as inline as I'd like, but jsdoc lets you document js object shapes, and has a mature toolchain around turning it I to reasonable outputs like HTML.
       
 (DIR) Post #AyRp2ahJzvALuopqpE by foone@digipres.club
       2025-09-22T00:37:32Z
       
       0 likes, 0 repeats
       
       @silvermoon82 ugh. I'm working on a rewrite that'd make that make more sense, but that'd mean I can't do the documentation before the rewrite. still, a good suggestion
       
 (DIR) Post #AySAdlVQsF2DBkqF6m by wndxlori@ruby.social
       2025-09-22T04:39:25Z
       
       0 likes, 0 repeats
       
       @foone I’m wondering if Swagger.io would help? I know it’s for API’s, but maybe it could help?
       
 (DIR) Post #AySnpf3oYmugsyaS4u by okennedy@discuss.systems
       2025-09-22T11:58:34Z
       
       0 likes, 0 repeats
       
       @foone Something like https://json-schema.org/ ?
       
 (DIR) Post #AyT3xHggwV49ylQc6K by trouble@masto.ai
       2025-09-22T14:59:12Z
       
       0 likes, 0 repeats
       
       @foone Google protocol buffer
       
 (DIR) Post #AyU9wNpBQx8XbdJVrs by thorsummoner@ibite.lol
       2025-09-23T03:41:04Z
       
       0 likes, 0 repeats
       
       @foone considered openapi schema files?