I completed a major devportal migration. Yay!
Now I'm doing a lot of git housekeeping, merging and pruning branches. Ugh.
As a git noob, these big changes are all very stressful. Thank goodness I'm the only one working in the repo. Does it ever get any easier?
#git #gitHub #techWriterLife #technicalWriting #writeTheDocs #redocly
I'm migrating our devportal in Redocly Realm (highly recommended). Ran the preview server & something didn't look right. The prompt was just "Press (q) to quit". Started to worry then realized it's missing total error counts & "or (e) for full error log". The migration has been smooth, but it's taken a while because I'm doing all the refactoring, coding, writing, and styling. I've never seen a run with no errors before.
Yay!
🚀 We’ve revamped our API documentation on the help site. It's got all the info to get you started on passbolt's API and the developer guide covers the big-picture stuff.
Shoutout to #Redocly and #Docusaurus for helping us build a sleek, DIY, easy-to-navigate experience.
Explore the documentation and let us know what you think! ➡️ https://hubs.li/Q02QgS2k0
--- ### Welcome This document is a raw low-level overview describing the API and its endpoints. For a higher-level overview of the API and some guides on interacting with the different endpoints, please follow the [Developer guide](../development). ### Base URL The API is served over HTTPS. All occurrences of `{{API_BASE_URL}}` referenced in the following documentation should be replaced by the base url of your passbolt installation domain, such as: `https://<passbolt.your-organization.com>`.
@lornajane
Ended up switching to #redocly for my linting as well - thank your team for such a great tool.
Do you happen to know of an example openapi.yaml that throws no errors given the default "recommended" linting rule?
PetStore and PetStore-extended still do. I looked at your planets example as well and it doesn't have 400s, operations summaries, and security defined. This will throw the same errors as the pet store example.
I am using the #redocly cli to take my single file JSON to a multi-file JSON. It makes every path into it's own file - this is fine. The problem is if the path has a parameter {x} . Which means it creates a file with the name
"$ref": "paths/users_{id}.json"
{ or } is a forbidden character in Linux (and maybe other) filenames. If I change the file name to
"$ref": "paths/users_-id-.json" there is no longer an error.
My thought is just to use a script rename the files. You got anything better?
AsyncAPI: Any folks with experience documenting non-RESTful APIs and other async message protocols?
Any tips or advice?
I'm having way too much fun in Redocly's beta sandbox.
I've got a bit of experience with OpenAPI/Swagger/REST so I'm mostly worried about "false friend" equivalencies and gotchas.
I'm also excited about bringing some APIs out of the Stone Age of pages of PDF tables.
#apiDoc #apiDocumentation #redocly #technicalWriting #documentation #techWriterLife #asyncAPI
Meet Redocly CLI: The Modern OpenAPI Sidekick
https://apisyouwonthate.com/blog/redocly-cli/
"This CLI tool goes a lot further than documentation, and helps with “linting” (automated API Style Guides), and solves the biggest problem that I had previously been lumbered with trying to maintain: bundling!" -- #PhilSturgeon
Redocly CLI is a brilliant new tool from the folks who made ReDoc, the first beautiful API reference documentation tool powered by OpenAPI. This CLI tool goes a lot further than documentation, and helps with “linting” (automated API Style Guides), and solves the biggest problem that I had previously been
Phil Davis
LornaJane
passbolt
TheSteve0
Timothée Mazzucotelli 
Qiita - 人気の記事
Mike Amundsen