lornajane

API design pipeline: overview

graph TD;
    oas["`**Complete OpenAPI**`"]

    subgraph input[Input phase];
        normalise["`**Normalise** 
        combine mulitple sources
 add missing elements`"]

lornajane

openapi: 3.1.0
info:
  title: Potion Inventory API
  contact:
    url: https://github.com/lornajane
  version: 1.0.0
paths:
  /potions:
    get:
      summary: Get a list of potions

lornajane

openapi: 3.1.1
info:
  title: Blog Backend API
  version: 1.0.0
  description: API for managing blog posts, categories, and featured images. This API allows clients to create, retrieve, and manage blog content and organizational categories.

tags:
  - name: post
    description: Endpoints related to creating, retrieving, and managing blog posts and their associated resources, such as featured images.
  - name: category

lornajane

import requests
import json
import os
import sys

if len(sys.argv) != 2:
    print("Usage: python3 github-api.py name")
    sys.exit(1)
name = sys.argv[1]

lornajane

const fs = require('fs');
const { exec } = require('child_process');
const jsonSourceMap = require('json-source-map');

const filePath = './input.json'; // Path to your JSON file

// Recursive function to process all string values with their locations
function processStringsWithLocations(json, pointerMap, processValue) {
  if (typeof json === 'string') {
    const pointer = pointerMap.json;

lornajane

const fs = require('fs');
const yaml = require('js-yaml');
const cheerio = require("cheerio");

const sidebars_file = "sidebars.yaml";

async function getTitle(url) {
  await fetch(url)
    .then(result => result.text())
    .then(html => {

lornajane

const NamedBooleans = require('./rules/named-booleans');

module.exports = {
  id: 'extras-plugin',
  rules: {
    oas3: {
      'boolean-naming-rules': NamedBooleans,
    }
  }

lornajane

Resources for Sphinx as used on Aiven DevPortal

Site: https://developer.aiven.io/ Repo: https://github.com/aiven/devportal

Reading list:

• Sphinx homepage https://www.sphinx-doc.org/en/master/
• Furo theme https://github.com/pradyunsg/furo
• Vale https://github.com/errata-ai/vale and its GitHub Action https://github.com/errata-ai/vale-action

lornajane

import logging
import pprint
from flask import Flask
from flask import jsonify
from flask import request
from pprint import pformat


app = Flask(__name__)
logging.basicConfig(level=logging.DEBUG)

lornajane

<?php
// composer require guzzlehttp/guzzle
require "vendor/autoload.php";

$client = new GuzzleHttp\Client(["base_uri" => "https://api.github.com/"]);

try {
    $response = $client->get("/users/lornajane/repos");
    
    if($response->getStatusCode() == 200) {