fix: fix Arazzo json pointers and other minor issues (#39)

.github/pull_request_template.md

@@ -6,12 +6,6 @@
 
 ## Screenshots (optional)
 
-## Check yourself
-
-- [ ] Code is linted
-- [ ] Tested with redoc/reference-docs/workflows (internal)
-- [ ] All new/updated code is covered with tests
-
 ## Security
 
 - [ ] Security impact of change has been considered

CONTRIBUTING.md

@@ -39,7 +39,7 @@ Before submitting a pull request, please make sure the following is done:
 
 ## Development setup
 
-[Node.js](http://nodejs.org) at v14.19.0+ and NPM v7.0.0+ are required.
+[Node.js](http://nodejs.org) at the current LTS version is required.
 
 After cloning the repo, install the Redocly CLI by running the following command:
 
@@ -60,15 +60,5 @@ Additions and updates to our documentation are very welcome.
 
 ### Configuration file
 
-The **redocly.yaml** file is the  
+The **redocly.yaml** file is the configuration file for the Redocly tools.
 Please refer to the [configuration file](https://redocly.com/docs/cli/configuration/) documentation for more details.
-
-## Project structure
-
-- **`docs`**: contains the documentation source files. 
-When changes to the documentation are merged, they automatically get published on the [Redocly docs website](https://redoc.ly/docs/cli/).
-
-
-## Release flow
-
-If the pipelines are not starting, close and reopen the PR. Merging that PR triggers the release process.

arazzo/museum-api.arazzo.yaml

@@ -4,12 +4,13 @@ info:
   description: >-
     Use the Museum API with Arazzo as an example of describing multi-step workflows.
     Built with love by Redocly.
-  version: 1.0.0
+  version: 1.0.1
 
 sourceDescriptions:
   - name: museum-api
     type: openapi
     url: ../openapi.yaml
+    x-serverUrl: "http://localhost:4000/_mock/openapi" # For local development testing
   - name: tickets-from-museum-api
     type: arazzo
     url: museum-tickets.arazzo.yaml
@@ -70,8 +71,8 @@ workflows:
             condition: $.name == 'Mermaid Treasure Identification and Analysis'
             type: jsonpath
         outputs:
-          createdEventId: $response.body.eventId
-          name: $response.body.name
+          createdEventId: $response.body#/eventId
+          name: $response.body#/name
       - stepId: get-event-by-id
         description: >-
           Get the details of the event that was created in the previous step.
@@ -106,7 +107,7 @@ workflows:
             condition: $.name == 'Orca Identification and Analysis'
             type: jsonpath
         outputs:
-          updatedEventId: $response.body.eventId
+          updatedEventId: $response.body#/eventId
       - stepId: delete-event
         description: >-
           Delete the event that was updated in the previous step.

arazzo/museum-tickets.arazzo.yaml

@@ -4,12 +4,13 @@ info:
   description: >-
     Use the Museum API as an example in a simple Arazzo workflow.
     Built with love by Redocly.
-  version: 1.0.0
+  version: 1.0.1
 
 sourceDescriptions:
   - name: museum-api
     type: openapi
     url: ../openapi.yaml
+    x-serverUrl: "http://localhost:4000/_mock/openapi" # For local development testing
 
 workflows:
   - workflowId: get-museum-tickets
@@ -27,11 +28,11 @@ workflows:
         requestBody:
           payload:
             ticketType: general
-            ticketDate: 2023-09-07
+            ticketDate: '2023-09-07'
             email: [email protected]
         successCriteria:
           - condition: $statusCode == 201
         outputs:
-          ticketId: $response.body.ticketId
+          ticketId: $response.body#/ticketId
     outputs:
       ticketId: $steps.buy-tickets.outputs.ticketId

index.md

@@ -14,9 +14,9 @@ You can download it and use it as you wish.
 [Redocly CLI](https://github.com/Redocly/redocly-cli) is an open source CLI utility for all things OpenAPI.
 Try Redocly CLI to get to grips with some of the different things you can do with OpenAPI.
 
-- Use `stats` to assess an API: `redocly stats openapi.yaml`.
-- Run `lint` to observe if an OpenAPI is compatible with a set of standards: `redocly lint openapi.yaml`.
-- View API reference documentation: `redocly preview-docs openapi.yaml`.
+- Use `stats` to assess an API: `npx @redocly/cli stats openapi.yaml`.
+- Run `lint` to observe if an OpenAPI is compatible with a set of standards: `npx @redocly/cli lint openapi.yaml`.
+- View localhost preview of the documentation: `npx @redocly/cli preview`.
 
 The [Redocly CLI documentation](https://redocly.com/docs/cli/) has all the information you need to dive into more detail on any of these common tasks, and of course many more!
 
@@ -25,7 +25,7 @@ The [Redocly CLI documentation](https://redocly.com/docs/cli/) has all the infor
 A key part of great API experience is great documentation.
 Taking the API reference as the heart of the experience, Redocly's platform goes much further and includes a full documentation platform.
 
-Run `redocly preview` to run your project locally, and start adding content.
+Run `npx @redocly/cli preview` to run your project locally, and start adding content.
 Or use the cloud editor with immediate preview and collaborative editing.
 
 Write great content with great tools; Redocly supports [Markdoc](https://markdoc.dev/), a modern extension to Markdown.

openapi.yaml

@@ -2,7 +2,7 @@ openapi: 3.1.0
 info:
   title: Redocly Museum API
   description: Imaginary, but delightful Museum API for interacting with museum services and information. Built with love by Redocly.
-  version: 1.2.0
+  version: 1.2.1
   termsOfService: 'https://redocly.com/subscription-agreement/'
   contact:
     email: [email protected]
@@ -285,7 +285,7 @@ components:
         ticketId:
           $ref: "#/components/schemas/TicketId"
         ticketDate:
-          description: Date the ticket is valid for.
+          description: Date when this ticket can be used for museum entry.
           $ref: "#/components/schemas/Date"
         ticketType:
           $ref: "#/components/schemas/TicketType"