Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Make OpenAPI operation ID mandatory

See original GitHub issue

This is a…


[x] Feature request
[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Documentation issue or request

Description

When we enable editing of OpenAPI specification in the API provider we need to make the operationId property mandatory. This will enable us to track what operation was changed/added/removed.

From what I understand Apicurio already validates the uniqueness of operation ids. We need to add operationId as required by overriding support for checking mandatory properties or by adding our own rule to the list of existing rules.

When a new operation (path in Apicurio terminology) is added we need to assign a unique operationId to it. Most likely we need to override createNewPathCommand flow.

Related to #3459, cc @EricWittmann

Issue Analytics

State:
Created 5 years ago
Comments:11 (8 by maintainers)

Top GitHub Comments

1reaction

EricWittmanncommented, Feb 7, 2019

That’s excellent documentation for this particular rule, but my understanding is that syndesis has three or four other validation rules that it executes and then shows as warnings in a summary page. If we can get all of the relevant syndesis validation rules documented, then I can implement them in oai-ts-core.

@zregvart Opening a ticket in oai-ts-core would be a great start!

1reaction

zregvartcommented, Feb 7, 2019

@EricWittmann should I open an issue for this in oai-ts-core?

Top Results From Across the Web

Paths and Operations - Swagger

OpenAPI defines a unique operation as a combination of a path and an HTTP method. ... parameters: - name: id; in: path; description:...

Make operationId mandatory - OAI/OpenAPI-Specification

Hi, I would like to propose to make operationId required in Operation definition. As the specification states, this field may be used in ......

How is the operationId used from an OpenAPI schema?

operationId is an optional unique string used to identify an operation. If provided, these IDs must be unique among all operations described in ......

10 Essentials When Creating an OpenAPI Specification - Tyk.io

The operationId provides an opportunity to make it clear about the operation capability being offered. Rather than coupling it to your code and ......

Path Operation Advanced Configuration - FastAPI

You can set the OpenAPI operationId to be used in your path operation with the parameter operation_id . You would have to make...