adidas / api-guidelines Goto Github PK

• I'm submitting a ...

  • bug report
  • feature request
  • support request

• What is the current behavior?

spectral lint ./demo-orderapi-v3.oas2.yaml -r ./api-guidelines/.spectral.yml
Could not parse https://unpkg.com/spectral:oas2: Forbidden

• What is the expected behavior?

Showing the potentials warnings / errors to validate the API Spec against the guidelines

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)

node version: v12.16.1
spectral version: 5.2.0

The README.md file could have these sections:

• "How to Build";
• "How to test locally";

So any contributor knows how to test the repository locally.

/cc @zdne @Amzani

@zdne @Amzani @apidesigner

Both
https://github.com/adidas-group/api-guidelines/tree/master/rest-api-guidelines/quality

and
https://github.com/adidas-group/api-guidelines/tree/master/rest-api-guidelines/functionality

are completely empty in terms of description or links to other pages.

It's dangerous to go alone! Take this:

^[A-Z][a-z0-9]*(?:-[A-Z][a-z0-9]*)*$

@zdne @Amzani @apidesigner
Let's add Issue and Pull Request templates for both internal and external contributors to know how best to contribute to the API Guidelines:

Example: https://blog.github.com/2016-02-17-issue-and-pull-request-templates/

• I'm submitting a ...

  • feature request

• What is the current behavior?
  While we have guidelines on how to request multiple fields or embedded resources, search request section does not consider multi-value filters. OpenAPI defines different serialization options so we could mention all of them or choose one format as preferred option: https://swagger.io/docs/specification/serialization/

• What is the expected behavior?
  Search filter structures for multi-value attributes are mentioned in the search request section.

• What is the motivation / use case for changing the behavior?
  I think it is always advisable to provide guidelines for complex search filters as it is a common user case for many APIs.