Dockerfiles used in PingCAP's docs CI pipeline

Related tags

Learning resource openapi-scripts
Overview

openapi-scripts

Scripts used in postprocessing OpenAPI document for ReDoc.

Postprocess the JSON file generated by bufbuild/buf

dereference

Use @apidevtools/json-schema-ref-parser to dereference the auto-generated JSON file.

Generate code sample

ToDo

Convert string to int for int32 type in .proto

ToDo

Import markown files

Embed external Markdown file contents to the info.description auto-generated JSON file. See Redoc documentation for more information.

Add x-logo

x-logo is a vendor extension from Redoc. It allows you to show a custom logo on the left upper corner of your redoc output.

You might also like...

Chappe - 🧑‍💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.

Chappe - 🧑‍💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.

Chappe Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine. Chappe is a Developer Do

Jan 1, 2023

PHEX, but it shows up as Google Docs in the extensions. Useful if you're using it in class.

PHEX, but it shows up as Google Docs in the extensions. Useful if you're using it in class.

PHEX, but it shows up as Google Docs in the extensions. Useful if you're using it in class.

Oct 28, 2022

🧑‍💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.

🧑‍💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.

Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine. Chappe is a Developer Docs buil

Jan 1, 2023

MDN-Dark-Mode - Simple extension to add a dark mode with different themes to the MDN Web Docs website

MDN-Dark-Mode Information Chrome and Firefox extension that adds a dark mode wit

Mar 18, 2022

A Q&A widget for your docs

A Q&A widget for your docs

Squeak! [BETA] Squeak! lets you answer user questions, right in your docs. Even better: it lets your community support itself. Top features Embeds in

Jan 7, 2023

Example implementation of having Google-Docs like comments

Example implementation of having Google-Docs like comments

lexical-comments Example implementation of having Google-Docs like comments in https://lexical.dev . Main ingredient that makes this possible is Comme

Dec 24, 2022

Simple google docs thing in Remix using socket.io.

This is just a simple google docs thing, me playing around with Remix and sockets. TODO: from socket.io to yjs sockets, support CRDT. Installation Aft

Apr 19, 2022

📒 midubot docs - Discord bot for midudev.

📒 midubot docs - Discord bot for midudev.

📒 midubot docs - Discord bot for midudev 📦 Packages: ⚡️ Nextjs - The React Framework for Production. 💅 Chakra UI - Create accessible React apps wit

Jun 15, 2022

The missing CLI for beautiful, interactive API docs powered by with Stoplight Elements

Elements CLI The missing CLI for beautiful, interactive API docs powered by with Stoplight Elements Installation Install using npm as global package:

Nov 22, 2022
Comments
  • Convert string to int for integer type

    Convert string to int for integer type 

    int32 port = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
    format: "int32",
    default: "8080",
    example: "8080"

    The output:

    "port":{
  "type": "integer",
  "format": "int32",
  "example": 8080,
  "default": "8080"
}

    Expected output:

    "port":{
  "type": "integer",
  "format": "int32",
  "example": 8080,
  "default": 8080
}

    JSON Mapping in Proto3 image

    feature 
    opened by Oreoxmt 0
  • feat(deref): use in-filename to overwrite out-filename

    feat(deref): use in-filename to overwrite out-filename

    close https://github.com/Oreoxmt/openapi-scripts/issues/1

    I have tested it locally and it worked fine for me:

    $ node src/main.js deref openapi-spec.swagger.json # without an outfile
Wrote dereferenced schema to openapi-spec.swagger.json
    opened by ran-huang 0
Releases(v2.0.0)

  • v2.0.0(Sep 23, 2022)

    What's Changed

    • Add patch.js to apply JSON patch by @Oreoxmt
    • Remove addlogo.js and devTier.js by @Oreoxmt

    Full Changelog: https://github.com/Oreoxmt/openapi-scripts/compare/v1.4.1...v2.0.0

    Source code(tar.gz)
    Source code(zip)

  • v1.4.1(Aug 9, 2022)

    What's Changed

    • Modify cluster_type field of developer tier cluster by @LinuxGit in https://github.com/Oreoxmt/openapi-scripts/pull/19

    Full Changelog: https://github.com/Oreoxmt/openapi-scripts/compare/v1.4...v1.4.1

    Source code(tar.gz)
    Source code(zip)

  • v1.4(Aug 9, 2022)

    What's Changed

    • Add an x-tagGroups field to the auto-generated JSON file and group all tags under that a specified tag by @ran-huang in https://github.com/Oreoxmt/openapi-scripts/pull/18

    Full Changelog: https://github.com/Oreoxmt/openapi-scripts/compare/v1.3...v1.4

    Source code(tar.gz)
    Source code(zip)

  • v1.3(Aug 8, 2022)

    What's Changed

    • use webpack to bundle scripts by @Oreoxmt in https://github.com/Oreoxmt/openapi-scripts/pull/16
    • Convert string to int for integer type by @Oreoxmt in https://github.com/Oreoxmt/openapi-scripts/pull/15
    • fix entrypoint by @Oreoxmt in https://github.com/Oreoxmt/openapi-scripts/pull/17

    Full Changelog: https://github.com/Oreoxmt/openapi-scripts/compare/v1.2...v1.3

    Source code(tar.gz)
    Source code(zip)

  • v1.2(Aug 4, 2022)

    What's Changed

    • cm: update dev tier example by @LinuxGit in https://github.com/Oreoxmt/openapi-scripts/pull/12

    New Contributors

    • @LinuxGit made their first contribution in https://github.com/Oreoxmt/openapi-scripts/pull/12

    Full Changelog: https://github.com/Oreoxmt/openapi-scripts/compare/v1.1...v1.2

    Source code(tar.gz)
    Source code(zip)

  • v1.1(Aug 3, 2022)

    What's Changed

    • add devTier.js to add dev tier curl by @ran-huang in https://github.com/Oreoxmt/openapi-scripts/pull/11

    Full Changelog: https://github.com/Oreoxmt/openapi-scripts/compare/v1.0...v1.1

    Source code(tar.gz)
    Source code(zip)

  • v1.0(Jul 27, 2022)

    What's Changed

    openapi-scripts v1.0 is used to postprocess the JSON file generated by bufbuild/buf.

    Override the reference component

    • Use @apidevtools/json-schema-ref-parser to dereference by @Oreoxmt in https://github.com/Oreoxmt/openapi-scripts/commit/47b49311389bee4aa00b0b24de2dab945b4504a6
    • Use <in-filename> to overwrite [out-filename] by @ran-huang in https://github.com/Oreoxmt/openapi-scripts/pull/2

    Generate code sample

    • Use openapi-snippet to generate code samples of curl and wget by @Oreoxmt in https://github.com/Oreoxmt/openapi-scripts/pull/8
    • Add the Digest authentication to code sample by @clark1013 in https://github.com/Oreoxmt/openapi-scripts/pull/9
    • Replace comundefined with com by @Oreoxmt in https://github.com/Oreoxmt/openapi-scripts/pull/10

    Embed external Markdown files

    • Support importing Markdown files into a json schema by @ran-huang in https://github.com/Oreoxmt/openapi-scripts/pull/4
    • Support importing Markdown files from folder by @Oreoxmt in https://github.com/Oreoxmt/openapi-scripts/pull/7

    Add logo

    • Support adding a logo from a URL to be compatible with Redocly x-logo by @ran-huang in https://github.com/Oreoxmt/openapi-scripts/pull/5
    • Remove the background color from logo by @ran-huang in https://github.com/Oreoxmt/openapi-scripts/pull/6

    New Contributors

    • @ran-huang made their first contribution in https://github.com/Oreoxmt/openapi-scripts/pull/2
    • @Oreoxmt made their first contribution in https://github.com/Oreoxmt/openapi-scripts/pull/7
    • @clark1013 made their first contribution in https://github.com/Oreoxmt/openapi-scripts/pull/9

    Full Changelog: https://github.com/Oreoxmt/openapi-scripts/commits/v1.0

    Source code(tar.gz)
    Source code(zip)
Owner
Aolin
Aolin
GitHub
Dockerfiles Generator (Experimental)

Easypanel Builders In this repository, you will find the builders available in Easypanel. Playground URL Builder Definition Example Here is how you de

Easypanel 12 Jun 15, 2022
Write Dockerfiles and CI pipelines in TypeScript.

Trellis Write Dockerfiles and CI pipelines in TypeScript. Trellis is a portable CI/CD tool. With Trellis, you can define your Dockerfiles and CI/CD pi

Charlie Marsh 12 Nov 3, 2022
JavaScript Express.js app serving static vanilla JS. This sample app is used in Microsoft Docs to demonstrate how to integrate Azure Storage, Azure Cosmos DB, and Azure Active Directory.

JavaScript on Azure Learn Path - Module 2 - Deploying a basic app to Azure This Learn module requires the following Azure resources to deploy correctl

Azure Samples 13 Dec 31, 2022
Example-browserstack-reporting - This repository contains an example of running Selenium tests and reporting BrowserStack test results, including full CI pipeline integration.

BrowserStack reporting and Selenium test result example This repository contains an example of running Selenium tests and reporting BrowserStack test

Testmo 1 Jan 1, 2022
Use pipeline to prettier code.

js-pipy Use pipeline to prettier code. Installation guide clone this repo locally npm i @htibor/js-pipy --save Usage const {pipy} = require('@htibor/j

Tibor Hegedűs 1 Feb 12, 2022
A sample CICD Deployment Pipeline for your Alexa Skills, using AWS CDK, CodeBuild and CodePipeline

Alexa Skils - CI/CD CDK Pipeline This repository will help you setting up a CI/CD pipeline for your Alexa Skills. This pipeline is powered by AWS Clou

null 5 Nov 23, 2022
A data pipeline to generate stats from logs.

Logs Data Pipeline This project consists of implementing a data pipeline. The goal of our pipeline is to bring insights from the logs of deployed micr

Amine Haj Ali 10 May 21, 2022
Github action to collect metrics (CPU, memory, I/O, etc ...) from your workflows to help you debug and optimize your CI/CD pipeline

workflow-telemetry-action A GitHub Action to track and monitor the resource metrics of your GitHub Action workflow runs. If the run is triggered via a

Thundra 32 Dec 30, 2022
Sample solution to build a deployment pipeline for Amazon SageMaker.

Amazon SageMaker MLOps Build, Train and Deploy your own container using AWS CodePipeline and AWS CDK This’s a sample solution to build a deployment pi

AWS Samples 4 Aug 4, 2022
Exemplo de como deve ser implementação de nirvana do teste de contrato com Pact seguindo todas as práticas descritas em https://docs.pact.io/pact_nirvana

Exemplo de 'Nirvana' do teste de contrato Esse repositório exemplifica as melhores implementações de teste de contrato, atingindo o nirvana e tendo co

Paulo Gonçalves 66 Nov 28, 2022