diff --git a/.github/workflows/readme-micro.yaml b/.github/workflows/readme-micro.yaml new file mode 100644 index 0000000..a7f316f --- /dev/null +++ b/.github/workflows/readme-micro.yaml @@ -0,0 +1,21 @@ +name: ReadMe Micro + +# Run workflow for every push to the `main` branch +on: + push: + branches: [main] + pull_request: + branches: [main] +jobs: + sync: + runs-on: ubuntu-latest + steps: + - name: Checkout this repo + uses: actions/checkout@v3 + + # Run GitHub Action to sync all OpenAPI files in the repo + - name: GitHub Action + uses: readmeio/readme-micro@v2 + + with: + readme-micro: "'**/*.{yaml,yml,json}' --key=${{ secrets.README_MICRO_SECRET }}" diff --git a/api/hoot.js b/api/hoot.js index c2e4d35..b00daa7 100644 --- a/api/hoot.js +++ b/api/hoot.js @@ -10,7 +10,7 @@ const filter = new Filter({ /* * @oas [post] /hoot - * summary: Create a hoot + * summary: Create a hoot! * description: Post a new hoot to the site * tags: ['Hoots'] * requestBody: @@ -21,7 +21,7 @@ const filter = new Filter({ * schema: * $ref: '#/components/schemas/NewHoot' * responses: - * '201': + * '200': * description: successfully created hoot * content: * application/json: diff --git a/micro.md b/micro.md new file mode 100644 index 0000000..e143b7f --- /dev/null +++ b/micro.md @@ -0,0 +1 @@ +This is my *API*! diff --git a/oas.yaml b/oas.yaml index e98eee7..0313cd5 100644 --- a/oas.yaml +++ b/oas.yaml @@ -1,6 +1,6 @@ openapi: 3.0.0 info: - version: '1.0.0' + version: '1.0.1' title: Hoot license: name: ISC @@ -15,11 +15,11 @@ servers: components: parameters: id: - name: id + name: id2 in: path schema: type: string - description: The id of the hoot you want + description: The id of the hoot you want! required: true example: 5c3e39af342143680d31775c securitySchemes: