Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Conversation

adamaltman
Copy link
Member

What/Why/How?

This fixes a variety of issues:

  • Fix Arazzo syntax to use JSON Pointer for body according to ABNF (Museum API Arazzo Example Issues #37 ).
  • Add x-serverUrl examples in Arazzo.
  • Update contributing file to correct for this specific repo where there are no release pipelines or docs folder.
  • Streamline the PR template because one section doesn't make very much sense in this repo.
  • Improve the sentence case pattern to allow for acronyms and allowing to remove the lint ignore file.
  • Fix the index.md docs for consistency and to use the preview command.
  • Clarify ticketDate description in the OpenAPI description.
  • Remove package-lock.json as it shouldn't typically be distributed in a template type of repo.

Reference

Testing

  • tested in my local environment.

Screenshots (optional)

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines


sourceDescriptions:
- name: museum-api
type: openapi
url: ../openapi.yaml
x-serverUrl: "http://localhost:4000/_mock/openapi" # For local development testing
Copy link
Contributor

@DmitryAnansky DmitryAnansky Nov 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last time I added changes to this file I intentionally updated the openapi.yaml with mock-server

servers:
  - url: "https://redocly.com/_mock/docs/openapi/museum-api"

The main idea was that users don't need to set any mock-server on their own and Spot run will work out of the box.

Copy link
Contributor

@DmitryAnansky DmitryAnansky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me,
I only have some doubts about x-serverUrl example.

@adamaltman
Copy link
Member Author

I want to show how x-serverUrl is used in practice.

openapi.yaml Outdated Show resolved Hide resolved
@adamaltman adamaltman merged commit 2770b2b into main Nov 20, 2024
2 checks passed
@adamaltman adamaltman deleted the minor-fixes branch November 20, 2024 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Museum API Arazzo Example Issues
3 participants