Giter VIP home page Giter VIP logo

braze-specification's Introduction

braze-specification

NPM

NPM version build commitlint lint

Braze API specification:

See the original Postman collection.

Installation

NPM:

npm install braze-specification

Yarn:

yarn add braze-specification

Usage

Require OpenAPI spec and Postman collection with CommonJS:

const spec = require('braze-specification/openapi/spec.json');
const collection = require('braze-specification/postman/collection.json');

Or import OpenAPI spec and Postman collection with ES Modules:

import spec from 'braze-specification/openapi/spec.json';
import collection from 'braze-specification/postman/collection.json';

License

MIT

braze-specification's People

Contributors

dependabot[bot] avatar github-actions[bot] avatar remarkablemark avatar

Stargazers

avatar

Watchers

avatar

braze-specification's Issues

Exception in thread "main" org.openapitools.codegen.SpecValidationException: There were issues with the specification.

Expected Behavior

openapi-generator generates spec without issues

Actual Behavior

openapi-generator throws error:

Exception in thread "main" org.openapitools.codegen.SpecValidationException: There were issues with the specification. The option can be disabled via validateSpec (Maven/Gradle) or --skip-validate-spec (CLI).
 | Error count: 3, Warning count: 0
Errors:
        -attribute paths.'//rest.example.braze.com/catalogs/{catalog_name}/items'(patch).requestBody.content with no media type is unsupported
        -attribute paths.'//rest.example.braze.com/catalogs'(post).requestBody.content with no media type is unsupported
        -attribute paths.'//rest.example.braze.com/catalogs/{catalog_name}/items'(post).requestBody.content with no media type is unsupported

        at org.openapitools.codegen.config.CodegenConfigurator.toContext(CodegenConfigurator.java:620)
        at org.openapitools.codegen.config.CodegenConfigurator.toClientOptInput(CodegenConfigurator.java:647)
        at org.openapitools.codegen.cmd.Generate.execute(Generate.java:479)
        at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
        at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)

Exception in thread "main" java.lang.RuntimeException: Could not process operation:
  Tag: class Tag {
    name: Catalogs > Catalog Management > Synchronous
    description: null
    externalDocs: null
}
  Operation: null
  Resource: post //rest.example.braze.com/catalogs
  Schemas: {}
  Exception: Request body cannot be null. Possible cause: missing schema in body parameter (OAS v2): class RequestBody {
    description: null
    content: null
    required: null
}
        at org.openapitools.codegen.DefaultGenerator.processOperation(DefaultGenerator.java:1221)
        at org.openapitools.codegen.DefaultGenerator.processPaths(DefaultGenerator.java:1115)
        at org.openapitools.codegen.DefaultGenerator.generateApis(DefaultGenerator.java:586)
        at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:949)
        at org.openapitools.codegen.cmd.Generate.execute(Generate.java:487)
        at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
        at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)
Caused by: java.lang.RuntimeException: Request body cannot be null. Possible cause: missing schema in body parameter (OAS v2): class RequestBody {
    description: null
    content: null
    required: null
}
        at org.openapitools.codegen.DefaultCodegen.fromRequestBody(DefaultCodegen.java:7362)
        at org.openapitools.codegen.DefaultCodegen.fromOperation(DefaultCodegen.java:4489)
        at org.openapitools.codegen.DefaultGenerator.processOperation(DefaultGenerator.java:1189)
        ... 6 more

Steps to Reproduce

openapi-generator generate -i openapi/spec.json -g php -o src
openapi-generator generate -i openapi/spec.json -g php -o src  --skip-validate
-spec

Reproducible Demo

N/A

Environment

  • Version:
  • Platform:
  • Browser:
  • OS: macOS

Keywords

openapi, error, exception

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.